Endpunkt der Segmentexportaufträge
Exportaufträge sind asynchrone Prozesse, mit denen Zielgruppensegmentmitglieder in Datensätzen beibehalten werden. Sie können den Endpunkt /export/jobs
in der Adobe Experience Platform Segmentation API verwenden, mit dem Sie Exportaufträge programmgesteuert abrufen, erstellen und abbrechen können.
Erste Schritte
Die in diesem Handbuch verwendeten Endpunkte sind Teil der Adobe Experience Platform Segmentation Service -API. Bevor Sie fortfahren, lesen Sie zunächst das Erste-Schritte-Handbuch , um wichtige Informationen zu erhalten, die Sie benötigen, um die API erfolgreich aufrufen zu können, einschließlich erforderlicher Kopfzeilen und Anweisungen zum Lesen von Beispiel-API-Aufrufen.
Liste mit Exportaufträgen abrufen retrieve-list
Sie können eine Liste aller Exportaufträge für Ihr Unternehmen abrufen, indem Sie eine GET-Anfrage an den Endpunkt /export/jobs
senden.
API-Format
Der /export/jobs
-Endpunkt unterstützt verschiedene Abfrageparameter, mit denen Sie Ihre Ergebnisse filtern können. Diese Parameter sind zwar optional, doch wird ihre Verwendung dringend empfohlen, um den teuren Verwaltungsaufwand zu reduzieren. Wenn Sie diesen Endpunkt ohne Parameter aufrufen, werden alle für Ihre Organisation verfügbaren Exportaufträge abgerufen. Es können mehrere Parameter eingeschlossen werden, die durch kaufmännische Und-Zeichen (&
) voneinander getrennt werden.
GET /export/jobs
GET /export/jobs?{QUERY_PARAMETERS}
Abfrageparameter
table 0-row-3 1-row-3 2-row-3 3-row-3 | ||
---|---|---|
Parameter | Beschreibung | Beispiel |
limit |
Gibt die Zahl der zurückgegebenen Exportaufträge an. | limit=10 |
offset |
Gibt den Versatz der Ergebnisseiten an. | offset=1540974701302_96 |
status |
Filtert die Ergebnisse anhand ihres Status. Die unterstützten Werte sind "NEW", "SUCCEEDED"und "FAILED". | status=NEW |
Anfrage
Mit der folgenden Anfrage werden die letzten beiden Exportaufträge innerhalb Ihres Unternehmens abgerufen.
code language-shell |
---|
|
Antwort
Die folgende Antwort gibt den HTTP-Status 200 mit einer Liste erfolgreich abgeschlossener Exportaufträge zurück, basierend auf dem Abfrageparameter, der im Anfragepfad angegeben ist.
code language-json |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 | |
---|---|
Eigenschaft | Beschreibung |
destination |
Zielinformationen für die exportierten Daten:
|
fields |
Eine Liste der exportierten Felder, durch Kommas getrennt. |
schema.name |
Der Name des Schemas, das mit dem Datensatz verknüpft ist, in den Daten exportiert werden sollen. |
filter.segments |
Die exportierten Segmente. Die folgenden Felder sind enthalten:
|
mergePolicy |
Informationen zu Zusammenführungsrichtlinien für die exportierten Daten. |
metrics.totalTime |
Ein Feld, das die Gesamtzeit angibt, die die Ausführung des Exportvorgangs dauerte. |
metrics.profileExportTime |
Ein Feld, das angibt, wie lange der Export der Profile dauerte. |
page |
Informationen zur Paginierung der angeforderten Exportaufträge. |
link.next |
Ein Link zur nächsten Seite der Exportaufträge. |
Neuen Exportauftrag erstellen create
Sie können einen neuen Exportauftrag erstellen, indem Sie eine POST-Anfrage an den /export/jobs
-Endpunkt senden.
API-Format
POST /export/jobs
Anfrage
Die folgende Anfrage erstellt einen neuen Exportauftrag, der durch die in der Payload bereitgestellten Parameter konfiguriert wird.
code language-shell |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 11-row-2 12-row-2 13-row-2 | |
---|---|
Eigenschaft | Beschreibung |
fields |
Eine Liste der exportierten Felder, durch Kommas getrennt. Wenn leer gelassen, werden alle Felder exportiert. |
mergePolicy |
Gibt die Zusammenführungsrichtlinie an, die für die exportierten Daten gelten soll. Schließen Sie diesen Parameter ein, wenn mehrere Segmente exportiert werden. Wenn nicht angegeben, wird für den Export dieselbe Zusammenführungsrichtlinie wie für das angegebene Segment verwendet. |
filter |
Ein Objekt, das die Segmente angibt, die je nach Kennung, Qualifikationszeit oder Erfassungszeit in den Exportauftrag aufgenommen werden sollen, abhängig von den unten aufgeführten Untereigenschaften. Wenn leer gelassen, werden alle Daten exportiert. |
filter.segments |
Gibt die zu exportierenden Segmente an. Wird dieser Wert nicht angegeben, werden alle Daten aus allen Profilen exportiert. Akzeptiert ein Array von Segmentobjekten, die jeweils die folgenden Felder enthalten:
|
filter.segmentQualificationTime |
Filtern nach der Segmentqualifizierungszeit. Die Start- und/oder Endzeit kann angegeben werden. |
filter.segmentQualificationTime.startTime |
Startzeit der Segmentqualifizierung für eine Segment-ID für einen bestimmten Status. Wird nicht angegeben, gibt es keinen Filter für die Startzeit einer Segment-ID-Qualifizierung. Der Zeitstempel muss im Format RFC 339 angegeben werden. |
filter.segmentQualificationTime.endTime |
Endzeit der Segmentqualifizierung für eine Segment-ID für einen bestimmten Status. Wird nicht angegeben, gibt es keinen Filter für die Endzeit einer Segment-ID-Qualifizierung. Der Zeitstempel muss im Format RFC 339 angegeben werden. |
filter.fromIngestTimestamp |
Beschränkt exportierte Profile so, dass nur die Profile einbezogen werden, die nach diesem Zeitstempel aktualisiert wurden. Der Zeitstempel muss im Format RFC 339 angegeben werden.
|
filter.emptyProfiles |
Ein boolean -Wert, der anzeigt, ob nach leeren Profilen gefiltert werden soll. Profile können Profildatensätze, ExperienceEvent-Datensätze oder beides enthalten. Profile ohne Profildatensätze und nur ExperienceEvent-Datensätze werden als "emptyProfiles"bezeichnet. Um alle Profile im Profilspeicher zu exportieren, einschließlich der "emptyProfiles", setzen Sie den Wert von emptyProfiles auf true . Wenn emptyProfiles auf false gesetzt ist, werden nur Profile mit Profildatensätzen im Speicher exportiert. Wenn das Attribut emptyProfiles nicht enthalten ist, werden standardmäßig nur Profile exportiert, die Profildatensätze enthalten. |
additionalFields.eventList |
Steuert die Zeitreihen-Ereignisfelder, die für untergeordnete oder verknüpfte Objekte exportiert werden, indem eine oder mehrere der folgenden Einstellungen bereitgestellt werden:
|
destination |
(Erforderlich) Informationen zu den exportierten Daten:
|
schema.name |
(Erforderlich) Der Name des Schemas, das mit dem Datensatz verknüpft ist, in den Daten exportiert werden sollen. |
evaluationInfo.segmentation |
(Optional) Ein boolescher Wert, der, falls nicht angegeben, standardmäßig auf false gesetzt ist. Der Wert true zeigt an, dass die Segmentierung für den Exportauftrag durchgeführt werden muss. |
Antwort
Eine erfolgreiche Antwort gibt den HTTP-Status 200 mit Details zu Ihrem neu erstellten Exportauftrag zurück.
code language-json |
---|
|
table 0-row-2 1-row-2 | |
---|---|
Eigenschaft | Beschreibung |
id |
Ein systemgenerierter schreibgeschützter Wert, der den soeben erstellten Exportauftrag angibt. |
Wenn destination.segmentPerBatch
auf true
gesetzt worden wäre, hätte das obige destination
-Objekt ein batches
-Array, wie unten dargestellt:
code language-json |
---|
|
Bestimmten Exportauftrag abrufen get
Sie können detaillierte Informationen zu einem bestimmten Exportauftrag abrufen, indem Sie eine GET-Anfrage an den /export/jobs
-Endpunkt senden und im Anfragepfad die Kennung des Exportauftrags angeben, den Sie abrufen möchten.
API-Format
GET /export/jobs/{EXPORT_JOB_ID}
{EXPORT_JOB_ID}
id
des Exportauftrags, auf den Sie zugreifen möchten.Anfrage
code language-shell |
---|
|
Antwort
Eine erfolgreiche Antwort gibt den HTTP-Status 200 mit genauen Informationen zum angegebenen Exportauftrag zurück.
code language-json |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 | |
---|---|
Eigenschaft | Beschreibung |
destination |
Zielinformationen für die exportierten Daten:
|
fields |
Eine Liste der exportierten Felder, durch Kommas getrennt. |
schema.name |
Der Name des Schemas, das mit dem Datensatz verknüpft ist, in den Daten exportiert werden sollen. |
filter.segments |
Die exportierten Segmente. Die folgenden Felder sind enthalten:
|
mergePolicy |
Informationen zu Zusammenführungsrichtlinien für die exportierten Daten. |
metrics.totalTime |
Ein Feld, das die Gesamtzeit angibt, die die Ausführung des Exportvorgangs dauerte. |
metrics.profileExportTime |
Ein Feld, das angibt, wie lange der Export der Profile dauerte. |
totalExportedProfileCounter |
Die Gesamtanzahl der Profile, die in allen Stapeln exportiert wurden. |
Bestimmten Exportauftrag abbrechen oder löschen delete
Sie können das Löschen des angegebenen Exportauftrags anfordern, indem Sie eine DELETE-Anfrage an den Endpunkt /export/jobs
senden und im Anfragepfad die Kennung des Exportauftrags angeben, den Sie löschen möchten.
API-Format
DELETE /export/jobs/{EXPORT_JOB_ID}
{EXPORT_JOB_ID}
id
des Exportauftrags, den Sie löschen möchten.Anfrage
code language-shell |
---|
|
Antwort
Eine erfolgreiche Antwort gibt den HTTP-Status 204 mit der folgenden Meldung zurück:
{
"status": true,
"message": "Export job has been marked for cancelling"
}
Nächste Schritte
Nach dem Lesen dieses Handbuchs haben Sie jetzt ein besseres Verständnis davon, wie Exportaufträge funktionieren.