Segmentauftrags-Endpunkt
Ein Segmentauftrag ist ein asynchroner Prozess, der bei Bedarf ein Zielgruppensegment erstellt. Es verweist auf Segmentdefinition sowie auf alle Zusammenführungsrichtlinien die steuern, wie Real-Time Customer Profile überlappende Attribute über Ihre Profilfragmente hinweg zusammenführt. Nach erfolgreichem Abschluss eines Segmentauftrags können Sie verschiedene Informationen über das Segment sammeln, z. B. Fehler, die bei der Verarbeitung aufgetreten sind, oder die endgültige Größe Ihrer Zielgruppe.
Dieses Handbuch enthält Informationen zum besseren Verständnis von Segmentaufträgen und umfasst Beispiel-API-Aufrufe zum Ausführen grundlegender Aktionen mit der API.
Erste Schritte
Die in diesem Handbuch verwendeten Endpunkte sind Teil der Adobe Experience Platform Segmentation Service-API. Bevor Sie fortfahren, lesen Sie den Abschnitt Erste Schritte. Dort erhalten Sie wichtige Informationen darüber, wie Sie die API aufrufen und die erforderlichen Kopfzeilen sowie Beispiele für API-Aufrufe lesen können.
Liste mit Segmentaufträgen abrufen retrieve-list
Sie können eine Liste aller Segmentaufträge für Ihr Unternehmen abrufen, indem Sie eine GET-Anfrage an den /segment/jobs
-Endpunkt senden.
API-Format
Der /segment/jobs
-Endpunkt unterstützt verschiedene Abfrageparameter, mit denen Sie Ihre Ergebnisse filtern können. Obwohl diese Parameter optional sind, wird ihre Verwendung dringend empfohlen, um kostspieligen Aufwand 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 /segment/jobs
GET /segment/jobs?{QUERY_PARAMETERS}
Abfrageparameter
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 | ||
---|---|---|
Parameter | Beschreibung | Beispiel |
start |
Gibt den Startversatz für die zurückgegebenen Segmentaufträge an. | start=1 |
limit |
Gibt die Anzahl der pro Seite zurückgegebenen Segmentaufträge an. | limit=20 |
status |
Filtert die Ergebnisse anhand ihres Status. Unterstützte Werte sind „NEW“ (neu), „QUEUED“ (in Warteschlange), „PROCESSING“ (Verarbeitung läuft), „SUCCEEDED“ (erfolgreich abgeschlossen), „FAILED“ (fehlgeschlagen), „CANCELLING“ (wird abgebrochen) und „CANCELLED“ (abgebrochen). | status=NEW |
sort |
Ordnet die zurückgegebenen Segmentaufträge. Ist im Format `[attributeName]:[desc | asc]` geschrieben. |
property |
Filtert Segmentaufträge und erhält genaue Übereinstimmungen für den angegebenen Filter. Das kann in einem der folgenden Formate geschrieben sein:
|
property=segments~segmentId==workInUS |
Anfrage
code language-shell |
---|
|
Antwort
Eine erfolgreiche Antwort gibt den HTTP-Status-Code 200 mit einer Liste von Segmentvorgängen für die angegebene Organisation als JSON zurück. Eine vollständige Liste aller Segmentdefinitionen wird innerhalb des children.segments
angezeigt.
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 10-row-2 11-row-2 12-row-2 | |
---|---|
Eigenschaft | Beschreibung |
id |
Eine systemgenerierte schreibgeschützte Kennung für den Segmentauftrag. |
status |
Der aktuelle Status für den Segmentauftrag. Zu den möglichen Statuswerten gehören „NEU“, „VERARBEITUNG LÄUFT“, „ABBRUCH“, „ABGEBROCHEN“, „FEHLGESCHLAGEN“ und „ERFOLGREICH“. |
segments |
Ein -Objekt, das Informationen zu den Segmentdefinitionen enthält, die im Segmentauftrag zurückgegeben werden. |
segments.segment.id |
Die ID der Segmentdefinition. |
segments.segment.expression |
Ein -Objekt, das Informationen zum Ausdruck der Segmentdefinition enthält, der in PQL geschrieben wurde. |
metrics |
Ein Objekt, das Diagnoseinformationen zum Segmentauftrag enthält. |
metrics.totalTime |
Ein -Objekt, das Informationen zu den Zeiten enthält, zu denen der Segmentierungsauftrag gestartet und beendet wurde, sowie zur insgesamt benötigten Zeit. |
metrics.profileSegmentationTime |
Ein -Objekt, das Informationen zu den Zeiten enthält, zu denen die Segmentierungsauswertung begonnen und beendet hat, sowie zur insgesamt benötigten Zeit. |
metrics.segmentProfileCounter |
Die Anzahl der qualifizierten Profile auf Segmentbasis. |
metrics.segmentedProfileByNamespaceCounter |
Die Anzahl der Profile, die für jeden Identity-Namespace auf Basis einer Segmentdefinition qualifiziert sind. |
metrics.segmentProfileByStatusCounter |
Die Anzahl der Profile für jeden Status. Die folgenden drei Status werden unterstützt:
|
metrics.totalProfilesByMergePolicy |
Die Gesamtzahl der zusammengeführten Profile pro Zusammenführungsrichtlinie. |
Neuen Segmentauftrag erstellen create
Sie können einen neuen Segmentauftrag erstellen, indem Sie eine POST-Anfrage an den /segment/jobs
-Endpunkt senden und die IDs der Segmentdefinition in den Anfragetext aufnehmen.
API-Format
POST /segment/jobs
Anfrage
code language-shell |
---|
|
table 0-row-2 1-row-2 | |
---|---|
Eigenschaft | Beschreibung |
segmentId |
Die ID der Segmentdefinition, die Sie auswerten möchten. Diese Segmentdefinitionen können zu verschiedenen Zusammenführungsrichtlinien gehören. Weitere Informationen zu Segmentdefinitionen finden Sie im Handbuch zum Segmentdefinitionenendpunkt. |
Antwort
Bei einer erfolgreichen Antwort wird der HTTP-Status 200 mit Informationen zu Ihrem neu erstellten Segmentauftrag zurückgegeben.
code language-json |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 | |
---|---|
Eigenschaft | Beschreibung |
id |
Eine systemgenerierte schreibgeschützte Kennung für den neu erstellten Segmentauftrag. |
status |
Der aktuelle Status für den Segmentauftrag. Da der Segmentvorgang neu erstellt wurde, ist der Status immer „NEU“. |
segments |
Ein -Objekt, das Informationen zu den Segmentdefinitionen enthält, für die dieser Segmentauftrag ausgeführt wird. |
segments.segment.id |
Die ID der von Ihnen angegebenen Segmentdefinition. |
segments.segment.expression |
Ein -Objekt, das Informationen zum Ausdruck der Segmentdefinition enthält, der in PQL geschrieben wurde. |
Bestimmten Segmentauftrag abrufen get
Sie können detaillierte Informationen zu einem bestimmten Segmentauftrag abrufen, indem Sie eine GET-Anfrage an den /segment/jobs
-Endpunkt senden und im Anfragepfad die ID des Segmentauftrags angeben, den Sie abrufen möchten.
API-Format
GET /segment/jobs/{SEGMENT_JOB_ID}
{SEGMENT_JOB_ID}
id
-Wert des Segmentauftrags, den Sie abrufen möchten.Anfrage
code language-shell |
---|
|
Antwort
Eine erfolgreiche Antwort gibt den HTTP-Status-Code 200 mit detaillierten Informationen zum angegebenen Segmentauftrag zurück. Eine vollständige Liste aller Segmentdefinitionen wird innerhalb des children.segments
angezeigt.
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 | |
---|---|
Eigenschaft | Beschreibung |
id |
Eine systemgenerierte schreibgeschützte Kennung für den Segmentauftrag. |
status |
Der aktuelle Status für den Segmentauftrag. Zu den möglichen Statuswerten gehören „NEU“, „VERARBEITUNG LÄUFT“, „ABBRUCH“, „ABGEBROCHEN“, „FEHLGESCHLAGEN“ und „ERFOLGREICH“. |
segments |
Ein -Objekt, das Informationen zu den Segmentdefinitionen enthält, die im Segmentauftrag zurückgegeben werden. |
segments.segment.id |
Die ID der Segmentdefinition. |
segments.segment.expression |
Ein -Objekt, das Informationen zum Ausdruck der Segmentdefinition enthält, der in PQL geschrieben wurde. |
metrics |
Ein Objekt, das Diagnoseinformationen zum Segmentauftrag enthält. |
[!ENDTABS]
Massenabruf von Segmentaufträgen bulk-get
Sie können detaillierte Informationen zu mehreren Segmentvorgängen abrufen, indem Sie eine POST-Anfrage an den /segment/jobs/bulk-get
-Endpunkt senden und die id
Werte der Segmentvorgänge im Anfragetext angeben.
API-Format
POST /segment/jobs/bulk-get
Anfrage
code language-shell |
---|
|
Antwort
Bei einer erfolgreichen Antwort wird der HTTP-Status 207 mit den angeforderten Segmentvorgängen zurückgegeben.
code language-json |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 | |
---|---|
Eigenschaft | Beschreibung |
id |
Eine systemgenerierte schreibgeschützte Kennung für den Segmentauftrag. |
status |
Der aktuelle Status für den Segmentauftrag. Zu den möglichen Statuswerten gehören „NEU“, „VERARBEITUNG LÄUFT“, „ABBRUCH“, „ABGEBROCHEN“, „FEHLGESCHLAGEN“ und „ERFOLGREICH“. |
segments |
Ein -Objekt, das Informationen zu den Segmentdefinitionen enthält, die im Segmentauftrag zurückgegeben werden. |
segments.segment.id |
Die ID der Segmentdefinition. |
segments.segment.expression |
Ein -Objekt, das Informationen zum Ausdruck der Segmentdefinition enthält, der in PQL geschrieben wurde. |
Bestimmten Segmentauftrag abbrechen oder löschen delete
Sie können einen bestimmten Segmentauftrag löschen, indem Sie eine DELETE-Anfrage an den /segment/jobs
-Endpunkt senden und im Anfragepfad die ID des Segmentauftrags angeben, den Sie löschen möchten.
API-Format
DELETE /segment/jobs/{SEGMENT_JOB_ID}
{SEGMENT_JOB_ID}
id
-Wert des Segmentauftrags, den Sie löschen möchten.Anfrage
code language-shell |
---|
|
Antwort
Eine erfolgreiche Antwort gibt den HTTP-Status 204 mit einem leeren Antworttext zurück.
Nächste Schritte
Nach dem Lesen dieses Handbuchs wissen Sie jetzt besser, wie Segmentvorgänge funktionieren.