Endpunkt für Segmentdefinitionen
Mit Adobe Experience Platform können Sie Segmentdefinitionen erstellen, die eine Gruppe spezifischer Attribute oder Verhaltensweisen aus einer Gruppe von Profilen definieren. Eine Segmentdefinition ist ein Objekt, das eine in Profile Query Language (PQL) geschriebene Abfrage kapselt. Segmentdefinitionen werden auf Profile angewendet, um Zielgruppen zu erstellen. Dieses Objekt (Segmentdefinition) wird auch als PQL-Prädikat bezeichnet. PQL-Prädikate definieren die Regeln für die Segmentdefinition basierend auf Bedingungen, die sich auf Datensatz- oder Zeitreihendaten beziehen, die Sie Real-Time Customer Profile bereitstellen. Weitere Informationen zum Schreiben von PQL-Abfragen 🔗 Sie im Handbuch zu PQL .
Dieses Handbuch enthält Informationen, die Ihnen dabei helfen, Segmentdefinitionen besser zu verstehen, und enthält 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.
Abrufen einer Liste von Segmentdefinitionen list
Sie können eine Liste aller Segmentdefinitionen für Ihr Unternehmen abrufen, indem Sie eine GET-Anfrage an den /segment/definitions
-Endpunkt stellen.
API-Format
Der /segment/definitions
-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 Segmentdefinitionen abgerufen. Es können mehrere Parameter eingeschlossen werden, die durch kaufmännische Und-Zeichen (&
) voneinander getrennt werden.
GET /segment/definitions
GET /segment/definitions?{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 Anfangsversatz für die zurückgegebenen Segmentdefinitionen an. | start=4 |
limit |
Gibt die Anzahl der pro Seite zurückgegebenen Segmentdefinitionen an. | limit=20 |
page |
Gibt an, auf welcher Seite die Ergebnisse der Segmentdefinitionen beginnen. | page=5 |
sort |
Gibt an, nach welchem Feld die Ergebnisse sortiert werden sollen. Wird im folgenden Format geschrieben: [attributeName]:[desc/asc] . |
sort=updateTime:desc |
evaluationInfo.continuous.enabled |
Gibt an, ob die Segmentdefinition Streaming-fähig ist. | evaluationInfo.continuous.enabled=true |
Anfrage
Die folgende Anfrage ruft die letzten beiden Segmentdefinitionen ab, die in Ihrer Organisation veröffentlicht wurden.
code language-shell |
---|
|
Antwort
Eine erfolgreiche Antwort gibt den HTTP-Status-Code 200 mit einer Liste von Segmentdefinitionen für die angegebene Organisation als JSON zurück.
code language-json |
---|
|
Erstellen einer neuen Segmentdefinition create
Sie können eine neue Segmentdefinition erstellen, indem Sie eine POST-Anfrage an den /segment/definitions
-Endpunkt senden.
API-Format
POST /segment/definitions
Anfrage
Beim Erstellen einer neuen Segmentdefinition können Sie diese entweder im pql/text
- oder im pql/json
-Format erstellen.
accordion | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Eine Beispielanfrage zum Erstellen einer Segmentdefinition. | ||||||||||||||||||||||
|
accordion | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Eine Beispielanfrage zum Erstellen einer Segmentdefinition. | ||||||||||||||||||||||
|
Antwort
Eine erfolgreiche Antwort gibt den HTTP-Status 200 mit Details zur neu erstellten Segmentdefinition zurück.
code language-json |
---|
|
table 0-row-2 1-row-2 2-row-2 | |
---|---|
Eigenschaft | Beschreibung |
id |
Eine systemgenerierte ID Ihrer neu erstellten Segmentdefinition. |
evaluationInfo |
Ein -Objekt, das angibt, welcher Art der Auswertung die Segmentdefinition unterzogen wird. Dabei kann es sich um Batch-, Streaming- (auch als fortlaufende Segmentierung bezeichnet) oder Edge- (auch als synchrone Segmentierung bezeichnet) handeln. |
Abrufen einer bestimmten Segmentdefinition get
Sie können detaillierte Informationen zu einer bestimmten Segmentdefinition abrufen, indem Sie eine GET-Anfrage an den /segment/definitions
-Endpunkt senden und im Anfragepfad die ID der Segmentdefinition angeben, die Sie abrufen möchten.
API-Format
GET /segment/definitions/{SEGMENT_ID}
{SEGMENT_ID}
id
Wert der Segmentdefinition, die Sie abrufen möchten.Anfrage
code language-shell |
---|
|
Antwort
Eine erfolgreiche Antwort gibt den HTTP-Status 200 mit detaillierten Informationen zur angegebenen Segmentdefinition 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 9-row-2 | |
---|---|
Eigenschaft | Beschreibung |
id |
Eine systemgenerierte schreibgeschützte ID der Segmentdefinition. |
name |
Ein eindeutiger Name, mit dem auf die Segmentdefinition verwiesen werden kann. |
schema |
Das Schema, das mit den Entitäten im Segment verknüpft ist. Besteht entweder aus einem id oder aus name Feld. |
expression |
Eine Entität, die Feldinformationen zur Segmentdefinition enthält. |
expression.type |
Gibt den Ausdruckstyp an. Derzeit wird nur PQL unterstützt. |
expression.format |
Gibt die Struktur des Ausdrucks im Wert an. Derzeit wird das folgende Format unterstützt:
|
expression.value |
Ein Ausdruck, der dem in expression.format angegebenen Typ entspricht. |
description |
Eine für Menschen lesbare Beschreibung der Definition. |
evaluationInfo |
Ein Objekt, das angibt, welchem Typ von Auswertung, Batch, Streaming (auch als fortlaufend bezeichnet) oder Edge (auch als synchron bezeichnet) die Segmentdefinition unterzogen wird. |
Massenabruf von Segmentdefinitionen bulk-get
Sie können detaillierte Informationen zu mehreren angegebenen Segmentdefinitionen abrufen, indem Sie eine POST-Anfrage an den /segment/definitions/bulk-get
-Endpunkt senden und die id
Werte der Segmentdefinitionen im Anfragetext angeben.
API-Format
POST /segment/definitions/bulk-get
Anfrage
code language-shell |
---|
|
table 0-row-2 1-row-2 | |
---|---|
Eigenschaft | Beschreibung |
ids |
Ein Array, das Objekte mit den IDs der Segmentdefinitionen enthält, die Sie abrufen möchten. |
Antwort
Bei einer erfolgreichen Antwort wird der HTTP-Status 207 mit den angeforderten Segmentdefinitionen zurückgegeben.
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 |
id |
Eine systemgenerierte schreibgeschützte ID der Segmentdefinition. |
name |
Ein eindeutiger Name, mit dem auf die Segmentdefinition verwiesen werden kann. |
schema |
Das Schema, das mit den Entitäten im Segment verknüpft ist. Besteht entweder aus einem id oder aus name Feld. |
expression |
Eine Entität, die Feldinformationen zur Segmentdefinition enthält. |
expression.type |
Gibt den Ausdruckstyp an. Derzeit wird nur PQL unterstützt. |
expression.format |
Gibt die Struktur des Ausdrucks im Wert an. Derzeit wird das folgende Format unterstützt:
|
expression.value |
Ein Ausdruck, der dem in expression.format angegebenen Typ entspricht. |
description |
Eine für Menschen lesbare Beschreibung der Definition. |
evaluationInfo |
Ein Objekt, das angibt, welchem Typ von Auswertung, Batch, Streaming (auch als fortlaufend bezeichnet) oder Edge (auch als synchron bezeichnet) die Segmentdefinition unterzogen wird. |
Löschen einer bestimmten Segmentdefinition delete
DELETE Sie können das Löschen einer bestimmten Segmentdefinition anfordern, indem Sie eine Segmentanfrage an den /segment/definitions
-Endpunkt senden und im Anfragepfad die ID der Segmentdefinition angeben, die Sie löschen möchten.
API-Format
DELETE /segment/definitions/{SEGMENT_ID}
{SEGMENT_ID}
id
der Segmentdefinition, die Sie löschen möchten.Anfrage
code language-shell |
---|
|
Antwort
Eine erfolgreiche Antwort gibt den HTTP-Status 200 ohne Meldung zurück.
Aktualisieren einer bestimmten Segmentdefinition
Sie können eine bestimmte Segmentdefinition aktualisieren, indem Sie eine PATCH-Anfrage an den /segment/definitions
-Endpunkt senden und im Anfragepfad die ID der Segmentdefinition angeben, die Sie aktualisieren möchten.
API-Format
PATCH /segment/definitions/{SEGMENT_ID}
{SEGMENT_ID}
id
der Segmentdefinition, die Sie aktualisieren möchten.Anfrage
Mit der folgenden Anfrage wird das Land der Arbeitsadresse von den USA nach Kanada aktualisiert.
code language-shell |
---|
|
Antwort
Eine erfolgreiche Antwort gibt den HTTP-Status 200 mit Details zu Ihrer neu aktualisierten Segmentdefinition zurück.
code language-json |
---|
|
Segmentdefinition konvertieren
Sie können eine Segmentdefinition zwischen pql/text
und pql/json
oder pql/json
in pql/text
konvertieren, indem Sie eine POST-Anfrage an den /segment/conversion
-Endpunkt senden.
API-Format
POST /segment/conversion
Anfrage
Die folgende Anfrage ändert das Format der Segmentdefinition von pql/text
in pql/json
.
code language-shell |
---|
|
Antwort
Bei einer erfolgreichen Antwort wird der HTTP-Status 200 mit Details zur neu konvertierten Segmentdefinition zurückgegeben.
code language-json |
---|
|
Nächste Schritte
Nach dem Lesen dieses Handbuchs wissen Sie jetzt besser, wie Segmentdefinitionen funktionieren. Weitere Informationen zum Erstellen eines Segments finden Sie im Tutorial Erstellen eines Segments .