Überblick über und Erläuterung der Chronik-API.
objectType
-Feldes auch für Unternehmen oder Deals erstellt werden. Im Abschnitt zur Erstellung einer Vorlage für Chronik-Events finden Sie weitere Informationen.
Jede Event-Vorlage verfügt über einen eigenen Satz an Token und Vorlagen. Sie können Events für Kontakte als Kriterien beim Erstellen neuer Kontaktlisten oder Workflows verwenden, z. B.: „Erstellen einer Liste aller Kontakte mit einem Video-Like, bei der der Videoname XYZ enthält“, wobei die Event-Vorlage „Video-Like“ heißt und über ein Event-Token mit dem Namen „Videoname“ verfügt.”
<appId>
mit Ihrer eigenen App-ID, die Sie sowohl unter Meine Apps als auch auf den App-Detailseiten in Ihrem Entwickler-Account finden können. Sie müssen auch <developerHapikey>
mit Ihrem eigenen Entwickler-API-Schlüssel ersetzen, den Sie finden, indem Sie zu Apps > HubSpot-API-Schlüssel abrufen gehen.
Die Eigenschaften headerTemplate
und detailTemplate
könnten auch hier angegeben werden. Mehr Informationen dazu finden Sie im Abschnitt Header- und Detail-Vorlagen definieren weiter unten.
Diese POST
-Anfrage gibt die vollständige, gespeicherte Definition der Event-Vorlage zurück. Beachten Sie unbedingt die id
-Eigenschaft in dieser Antwort. Dies ist die Event-Vorlagen-ID, die Sie für alle Aktualisierungen dieser Event-Vorlage oder Token in der Zukunft benötigen.
Sie können alle für eine App definierten Event-Vorlagen über diesen GET-Befehl anzeigen. Dabei werden auch die Event-Vorlagen-IDs zurückgegeben:
GET
alle Token zurückgegeben, die in einer Event-Vorlage definiert sind:
string
number
enumeration
: Eine aus einer Reihe von Optionen. Siehe webinarType-Beispiel oben.date
: Alle Datumsangaben müssen in Millisekunden in Unix-Zeit angegeben sein.webinarName
-Token in der Vorlage mithilfe von {{webinarName}}
referenzieren.
Die extraData
eines Events (erläutert unter „Grundlegendes zu extraData”“) können nur in der Details-Vorlage referenziert werden.
PUT
modifiziert wird:
#formatDate
-Direktive. Mit ihr möchten wir eine benutzerfreundliche Datumsformatierung ermöglichen.
Sobald ein Event für einen Kontakt mit ihrer Hilfe erstellt wird (siehe “Erstellen eines Events)”, wird Folgendes in der Chronik des Kontakts angezeigt:
POST
-Aufruf definieren.
contacts
-Event-Vorlage gearbeitet wird. Wenn die Event-Vorlage oben nicht so eingerichtet ist, dass sie über die Token webinarName
und webinarId
verfügt, erhalten Sie einen Fehler beim Versuch, das Event zu erstellen. Hier ein Beispiel-POST
für das Erstellen eines Events:
a.test.contact@email.com
’ erstellt (ausgehend davon, dass die Vorlagen unter „Definieren von Vorlagen“ verwendet werden):
vid
verwenden, um das Event zu verknüpfen. In diesen Fällen würden Sie objectId
im Anfrage-JSON verwenden. Sie müssen die VID eines vorhandenen Kontakts einbeziehen, da Sie keine neuen Kontakte mithilfe von objectId
erstellen können. In diesem Beispiel wird die objectId
anstelle von E-Mail verwendet:
utk
, einem Kontakt zuordnen. Das Benutzertoken wird vom HubSpot-Tracking-Code zum Nachverfolgen von Besuchern verwendet und wird im hubspotutk
-Cookie gespeichert. Verwenden Sie den utk
-Parameter, um ein Event nach Benutzertoken einem Kontakt zuzuordnen. Hinweis: Es ist nicht möglich, Events mit anonymen Besuchern mithilfe des Benutzertokens zuzuordnen. Wenn das Event also nur mithilfe des utk
-Parameters zugeordnet wird und das angegebene Benutzerertoken nicht bereits einem Kontakt zugeordnet ist, würde kein neuer Kontakt erstellt und das Event wäre nicht in HubSpot sichtbar. Das Event wird jedoch in der Chronik angezeigt, wenn ein neuer Kontakt über andere Methoden mit dem Benutzerertoken verknüpft worden ist, (in der Regel über eine Formulareinsendung, einschließlich des hutk, oder über die Methode des Identifizierens der Tracking-Code-API). Aus diesem Grund empfehlen wir, die email
zusätzlich zum utk
zu berücksichtigen, um sicherzustellen, dass das Event einem neuen oder vorhandenen Kontakt zugeordnet wird.
Wenn Sie mit einer Event-Vorlage für Kontakte arbeiten, ist es möglich, mehrere Identifikationsparameters mit dem Event zu berücksichtigen, sodass jede Kombination der email
-, objectId
- und utk
-Parameter berücksichtigt werden kann. Wenn mehrere Parameter berücksichtigt werden, hat die objectId (vid) die höchste Priorität beim Bestimmen des Kontakts, der dem Event zugeordnet werden soll, gefolgt von utk
und email
mit der geringsten Priorität. Dies bedeutet, dass Sie die E-Mail-Adresse eines vorhandenen Objekts aktualisieren können, indem Sie eine neue E-Mail-Adresse im email
-Parameter mit der vid
eines bekannten Objekts in objectId
berücksichtigen können. In diesem Beispiel werden die E-Mail-Adresse und das Benutzertoken zusammen verwendet:
objectId
verwenden, um das Event dem Unternehmen oder Deal zuzuordnen. Für muss die objectId
auf die companyId
des Unternehmens festgelegt sein, dem das Event zugeordnet werden soll, und für müssten Sie die objectId
auf die dealId
des Deal festlegen.
Wenn im folgenden Beispiel davon ausgegangen wird, dass die Event-Vorlage auf den COMPANY
objectType
festgelegt wurde, würde dieses Event mit dem Unternehmensobjekt mit der companyId
528253914 zugeordnet:
linkLabel
: Der Text, der zur Anzeige des Links, der den IFrame-Inhalt anzeigt, verwendet wird.headerLabel
: Das Label des modalen Fensters, das die IFrame-Inhalte anzeigt.url
: Der URI des IFrame-Contents.width
: Die Breite des modalen Fensters.height
: Die Höhe des modalen Fensters.url
festgelegte Seite anzeigt:
PUT
-Befehl zum Aktualisieren einer benutzerdefinierten Event-Vorlage in Betracht. Beachten Sie dabei das objectPropertyName
-Feld:
objectPropertyName
, um dieses benutzerdefinierte Event-Token der Eigenschaft contact
-Objekt zz_webinar_name
zuordnen. Das heißt, dass beim Erstellen eines neuen Events, das ein webinarName
-Token angibt, auch die zz_webinar_name
-Eigenschaft des zugehörigen contact
festgelegt wird. Sie können diese auf benutzerdefinierte oder vordefinierte HubSpot-Eigenschaften festlegen.
Angenommen, wir haben beispielsweise bereits eine companyName
-Token erstellt, das eine benutzerdefinierte zz_company_name
-Eigenschaft im Kontakt referenziert. Dies führt dann dazu, dass bei Erstellen eines Event wie diesem die zz_company_name
- und zz_webinar_name
-Eigenschaften im Kontakt mit der E-Mail-Adresse a.test.contact@email.com festgelegt werden:
extraData
VerstehenextraData
ins Spiel.
Sie können ein extraData
-Attribut zum JSON-Text eines Events hinzufügen. Der Wert dieses extraData
-Attributs kann beliebiger zulässiger JSON sein. Zum Beispiel:
extraData
in einer Details-Vorlage:
extraData
-Attribut kann nur in der Details-Vorlage für ein Event referenziert werden. Es kann weder in der Kopfzeilen-Vorlage oder in der Listensegmentierung verwendet werden.