Für diese Funktion ist allerdings die Genehmigung von HubSpot erforderlich. Wenn Sie gerne Zugriff auf App-Objekte beantragen oder mehr über die Funktionalität erfahren möchten, senden Sie bitte dieses Formular ein.
Projektstruktur
- Alle App-Funktionen und -Komponenten müssen innerhalb des in der
hsproject.json-Konfigurationsdatei angegebenensrc-Verzeichnisses gespeichert werden. - Alle App-Funktionen und -Komponenten müssen innerhalb des
app/-Verzeichnisses gespeichert werden. - App-Objektzuordnungen werden innerhalb des
app-object-associations/-Verzeichnisses definiert. - Webhook-Abonnements werden innerhalb des
webhooks/-Verzeichnisses definiert. - Benutzerdefinierte Workflow-Aktionen werden innerhalb des
workflow-actions/-Verzeichnisses definiert. - Alle Kartenfunktionen müssen im
cards/-Verzeichnisses gespeichert werden. - Für alle alle Komponenten- und Feature-Instanzen ist anzugeben, dass sie
*-hsmeta.json-Dateien verwenden. Stellen Sie dem Dateinamen etwas Aussagekräftiges voran (z. Bmy-app-hsmeta.json). Diese Dateien müssen sich auf der Stammebene ihres jeweiligen Ordners befinden (z. B.app/my-app-hsmeta.json,cards/my-card-hsmeta.json).
Beispiel auf GitHub anzeigen
App-Objekte
Um ein App-Objekt zu erstellen, fügen Sie einapp-objects-Komponentenverzeichnis zusammen mit einer Konfigurationsdatei in das Projekt ein.
*-object-hsmeta.json.
Beispiel auf GitHub anzeigen
Mit * markierte Felder sind Pflichtfelder.
Der vollständig qualifizierte Name (Fully Qualified Name, FQN) für Ihr App-Objekt lautet
a<appId>_<objectName>. Zum Beispiel: Wenn Ihr appId 16858319 und der Name des App-Objekts CARS lautet , dann wäre a16858319_CARSder FQN. Sie verwenden den FQN, wenn Sie Bereichswerte für Ihre App-Objekte festlegen.App-Design
Um ein App-Objekt zu erstellen, fügen Sie eineapp-hsmeta.json-Konfigurationsdatei in das app-Verzeichnis ein.
app-hsmeta.json.
Änderungszusammenfassung
Änderungszusammenfassung
Beachten Sie die folgenden Änderungen für App-Kartenkonfigurationsdateien:
uid-,type- undconfig-Felder der obersten Ebene wurden hinzugefügt.extensions-Feld wurde entfernt.distribution-Feld wurde hinzugefügt.
Beispiel auf GitHub anzeigen
*-hsmeta.json-Felder für das App-Schema
Mit * markierte Felder sind Pflichtfelder.
Authentifizierungsfelder
Mit * markierte Felder sind Pflichtfelder.
Bereiche
Imauth-Feld einer App-Konfigurationsdatei können Sie drei Arten von Bereichen angeben: erforderliche Bereiche, bedingt erforderliche Bereiche und optionale Bereiche. Für diese Phase der Beta sollten Sie nur Ihre App-Objektbereiche als conditionallyRequiredScopeseinschließen. Auf diese Weise können Sie Ihre neuen Funktionen für bestimmte Kunden isolieren, indem Sie die App-Objektbereiche in die Installations-URL aufnehmen.
App-Objektbereiche haben das folgende Format:
crm.app.schemas.<appObjectFullyQualifiedName>.read
Für ein App-Objekt mit dem FQN a16858319_cars wäre der read-Bereich beispielsweise:
crm.app.schemas.a16858319_cars.read.
Ihre App muss mindestens den oben genannten read-Bereich enthalten, damit Kunden auf das Objekt zugreifen können. Es wird empfohlen, alle App-Objektbereiche in Ihrer App zu berücksichtigen, wie im Folgenden angegeben.
Definition von Webhooks-Komponenten
Um einen Satz von Webhook-Abonnements für Ihre App zu definieren, müssen Sie einwebhooks-Verzeichnis zusammen mit einer *-hsmeta.json-Konfigurationsdatei in das Projekt einschließen.
*-hsmeta.json-Datei.
*-hsmeta.json-Felder für Webhooks
Mit * markierte Felder sind Pflichtfelder.
Für jedes
subscription Objekt können die folgenden Felder angegeben werden, je nachdem, welcher Abonnementdefinitionstyp abonniert wird (d. h. crmObjects, legacyCrmObjectsbzw. hubEvents) oder abhängig davon, ob Sie eine bestimmte Eigenschaftsänderung abonnieren (z B contact.propertyChange).
Schema der App-Karte
Um eine App-Karte zu erstellen, die auf einer App-Objekt-Datensatzseite angezeigt wird, schließen Sie eincards-Komponentenverzeichnis zusammen mit einer Konfigurationsdatei in das Projekt ein.
- Stellen Sie sicher, dass Sie
hs project uploadausgeführt haben, nachdem Sie Ihre App-Objektkomponente und die zugehörigen Konfigurationsdateien erstellt haben. - Fügen Sie in Ihrer
my-app-card-hsmeta.json-Datei die UID Ihres App-Objekts zumobjectTypes-Array hinzu (z. B . hier"app_object_uid"). Jedes der verfügbaren Felder in der.json-Datei ist in der folgenden Tabelle aufgeführt.
Änderungszusammenfassung
Änderungszusammenfassung
Beachten Sie die folgenden Änderungen für App-Kartenkonfigurationsdateien:
uid-,type- undconfig-Felder der obersten Ebene wurden hinzugefügt.- Das
module-Feld wurde inentrypointumbenannt. - Das
title-Feld wurde innameumbenannt. - Das
objectTypes-Feld wurde vereinfacht, um ein Zeichenfolgen-Array zu akzeptieren.
- Nachdem Sie die Änderungen an Ihrer
example-card-hsmeta.json-Datei gespeichert haben, führen Siehs project uploadaus.
Beispiel auf GitHub anzeigen
Felder für *-hsmeta.json-App-Karten
Mit * markierte Felder sind Pflichtfelder.
App-Objektzuordnungen
Um Verknüpfungen zwischen Ihrem App-Objekt und anderen CRM-Objekten zu ermöglichen, fügen Sie einapp-object-associations-Komponentenverzeichnis zusammen mit einer Konfigurationsdatei in das Projekt ein.
*-association-hsmeta.json) aufgeführt.
*-Zuordnungs-hsmeta.json-Felder zur Zuordnung
Mit * markierte Felder sind Pflichtfelder.