Erfahren Sie, wie Sie die Exporte-API verwenden, um Datensätze in Ansichten oder Listen von Ihrem HubSpot-Account zu exportieren.
POST
-Anfrage an /crm/v3/exports/export/async
durch. Ihr Anforderungstext sollte Informationen wie das Dateiformat, das Objekt und die Eigenschaften, die Sie exportieren möchten, sowie den Typ des Exports angeben, den Sie abschließen (z. B. das Exportieren einer Objektansicht oder einer Liste). Sie können die zu exportierenden Eigenschaftsdaten auch nach bestimmten Operatoren filtern.
Sowohl für Exporte von Ansichten als auch für Listen können Sie die folgenden Felder in Ihre Anfrage aufnehmen:
Parameter | Beschreibung |
---|---|
exportType | Der Typ des Exports, entweder VIEW (exportiert eine Ansicht von einer Objektindexseite) oder LIST (exportiert eine Liste) |
format | Das Dateiformat. Die Optionen umfassen XLSX , CSV oder XLS . |
exportName | Der Name des Exports |
language | Die Sprache der Exportdatei. Die Optionen umfassen DE , EN , ES , FI , FR , IT , JA , NL , PL , PT oder SV . Hier erfahren Sie mehr über die unterstützten Sprachen. |
objectType | Der Name oder die ID des Objekts, das Sie exportieren. Bei Standardobjekten können Sie den Namen des Objekts verwenden (z. B. CONTACT ), für benutzerdefinierte Objekte müssen Sie jedoch den objectTypeId -Wert verwenden. Sie können diesen Wert abrufen, indem Sie eine GET -Anfrage an /crm/v3/schemas durchführen. |
associatedObjectType | Die Namen oder IDs der zugeordneten Objekte, die in den Export aufgenommen werden sollen. Sie können bis zu vier zugeordnete Objekte pro Anfrage exportieren. Bei zugeordneten Objekten enthält der Export die zugeordneten Datensatz-IDs dieses Objekts. Wenn Sie nur ein zugeordnetes Objekt exportieren oder das includePrimaryDisplayPropertyForAssociatedObjects -Feld auf true setzen, werden auch die primären Anzeige-Eigenschaftsdaten der Datensätze exportiert (z. B. name für Unternehmen). |
objectProperties | Eine Liste der Eigenschaften, die Sie in Ihren Export aufnehmen möchten. Standardmäßig werden Eigenschaftsnamen und -werte als menschenlesbare Label angezeigt; Sie können mithilfe des exportInternalValuesOptions -Parameters aber auch interne Namen und Werte abfragen. |
includePrimaryDisplayPropertyForAssociatedObjects | Fügen Sie dieses Feld mit dem Wert true hinzu, um die primären Anzeige-Eigenschaftsdaten für alle zugeordneten Datensätze (z. B. name für Unternehmen) zu exportieren. Wenn Sie nur ein zugeordnetes Objekt exportieren (gekennzeichnet durch das associatedObjectType -Feld), wird dieser Wert standardmäßig auf true festgelegt. Wenn Sie mehr als ein zugeordnetes Objekt exportieren, wird der Wert standardmäßig auf false festgelegt. |
includeLabeledAssociations | Fügen Sie dieses Feld mit dem Wert true hinzu, wenn Sie Zuordnungslabelsexportieren, um die Beziehung zwischen verknüpften Datensätzen zu beschreiben. |
exportInternalValuesOptions | Fügen Sie dieses Array hinzu, um die internen Werte für Eigenschaftsnamen und/oder Eigenschaftswerte zu exportieren. Fügen Sie im Array NAMES zum Exportieren interner Namen von Eigenschaften (angezeigt als Spaltenüberschriften) und/oder VALUES zum Exportieren interner Eigenschaftswerte hinzu (z. B. numerische Werte für benutzerdefinierte Pipeline-Phasen oder Zeitstempel anstelle von menschenlesbaren Daten). |
overrideAssociatedObjectsPerDefinitionPerRowLimit | Fügen Sie dieses Feld mit dem Wert true hinzu, um das Standardlimit von 1.000 Zuordnungen pro Zeile zu überschreiben. |
exportType
-Wert VIEW
sein. Sie können das folgende Feld hinzufügen, um die Datensätze, die Sie exportieren, zu filtern und zu sortieren:
Parameter | Beschreibung |
---|---|
publicCrmSearchRequest | Gibt an, welche Daten basierend auf bestimmten Eigenschaften und Suchanfragen exportiert werden sollen. Sie können Folgendes in das Objekt aufnehmen:filters : die Eigenschaften und Eigenschaftswerte, nach denen Datensätze gefiltert werden sollen.sorts : die Sortierreihenfolge der Werte einer Eigenschaft, entweder aufsteigend, ASC , oder absteigend, DES .query : eine Zeichenfolge, nach der die Werte der Datensätze durchsucht werden sollen. |
email
-Eigenschaft und mit den internen Eigenschaftsnamen und -werten zu exportieren, würde Ihre Anfrage wie folgt aussehen:
exportType
-Wert LIST
sein, aber Sie müssen die Liste, die Sie exportieren, auch mit dem folgenden Feld angeben:
Parameter | Beschreibung |
---|---|
listId | Die ILS-Listen-ID der zu exportierenden Liste. Sie können den ILS-Listen-ID-Wert über die Listendetails in HubSpot finden. Gehen Sie zu Kontakte > Listen, bewegen Sie den Mauszeiger über die Liste in der Tabelle und klicken Sie dann auf Details. Klicken Sie im rechten Bereich neben dem Wert für die ILS-Listen-ID auf Listen-ID kopieren. Kontaktlisten haben zwei verschiedene ID-Werte, aber Sie müssen den ILS-Listen-ID-Wert in Ihrer Anfrage verwenden. |
id
des Exports in der Antwort zurückgegeben. Um einen Export von Ihrem HubSpot-Account abzurufen, führen Sie eine GET
-Anfrage an /crm/v3/exports/export/async/tasks/{exportId}/status
durch.
Beim Abrufen von Exporten wird auch der status
des Exports zurückgegeben. Mögliche Status sind COMPLETE
, PENDING
PROCESSING
oder CANCELED
. Bei Exporten mit einem COMPLETE
-Status wird eine URL zurückgegeben, mit der Sie die exportierte Datei herunterladen können. Die Download-URL läuft fünf Minuten nach Abschluss der Anfrage ab. Nach Ablauf können Sie eine weitere GET
-Anfrage durchführen, um eine neue eindeutige URL zu generieren.
overrideAssociatedObjectsPerDefinitionPerRowLimit
-Feld mit dem Wert true
hinzu.