Zielgruppen-Endpunkt
Eine Zielgruppe ist eine Sammlung von Personen, die ähnliche Verhaltensweisen und/oder Merkmale aufweisen. Diese Personensammlungen können entweder mithilfe von Adobe Experience Platform oder aus externen Quellen generiert werden. Sie können den /audiences
-Endpunkt in der Segmentierungs-API verwenden, mit dem Sie Zielgruppen programmgesteuert abrufen, erstellen, aktualisieren und löschen können.
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 Zielgruppen list
Sie können eine Liste aller Zielgruppen für Ihr Unternehmen abrufen, indem Sie eine GET-Anfrage an den /audiences
-Endpunkt senden.
API-Format
Der /audiences
-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 bei der Auflistung von Ressourcen zu reduzieren. Wenn Sie diesen Endpunkt ohne Parameter aufrufen, werden alle für Ihre Organisation verfügbaren Zielgruppen abgerufen. Es können mehrere Parameter eingeschlossen werden, die durch kaufmännische Und-Zeichen (&
) voneinander getrennt werden.
GET /audiences
GET /audiences?{QUERY_PARAMETERS}
property=audienceId
Abfrageparameter verwenden, werden inaktive Zielgruppen zurückgegeben.Beim Abrufen einer Liste von Zielgruppen können die folgenden Abfrageparameter verwendet werden:
start
start=5
limit
limit=10
sort
attributeName:[desc/asc]
geschrieben.sort=updateTime:desc
property
property=
geschriebenproperty=audienceId==test-audience-id
name
name=Sample
description
description=Test Description
entityType
entityType=_xdm.context.account
Anfrage
Mit der folgenden Anfrage werden die letzten beiden in Ihrer Organisation erstellten Zielgruppen abgerufen.
code language-shell |
---|
|
Antwort
Bei einer erfolgreichen Antwort wird der HTTP-Status 200 mit einer Liste von Zielgruppen zurückgegeben, die in Ihrer Organisation als JSON erstellt wurden.
code language-json |
---|
|
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 7-row-3 8-row-3 9-row-3 10-row-3 11-row-3 12-row-3 13-row-3 14-row-3 15-row-3 16-row-3 17-row-3 18-row-3 | ||
---|---|---|
Eigenschaft | Zielgruppentyp | Beschreibung |
id |
Beide | Eine systemgenerierte schreibgeschützte Kennung für die Zielgruppe. |
audienceId |
Beide | Wenn es sich bei der Zielgruppe um eine von Platform generierte Zielgruppe handelt, ist dies derselbe Wert wie die id . Wenn die Zielgruppe extern generiert wird, wird dieser Wert vom Client bereitgestellt. |
schema |
Beide | Das Experience-Datenmodell (XDM)-Schema der Zielgruppe. |
imsOrgId |
Beide | Die ID der Organisation, zu der die Zielgruppe gehört. |
sandbox |
Beide | Informationen über die Sandbox, zu der die Zielgruppe gehört. Weitere Informationen zu Sandboxes finden Sie in der Sandbox-Übersicht. |
name |
Beide | Der Name der Zielgruppe. |
description |
Beide | Eine Beschreibung der Zielgruppe. |
expression |
von Platform generiert | Der Profile Query Language (PQL)-Ausdruck der Zielgruppe. Weitere Informationen zu PQL-Ausdrücken finden Sie im Handbuch zu PQL-Ausdrücken. |
mergePolicyId |
von Platform generiert | Die ID der Zusammenführungsrichtlinie, mit der die Zielgruppe verknüpft ist. Weitere Informationen zu Zusammenführungsrichtlinien finden Sie im Handbuch zu Zusammenführungsrichtlinien. |
evaluationInfo |
von Platform generiert | Zeigt an, wie die Zielgruppe ausgewertet wird. Zu den möglichen Auswertungsmethoden gehören Batch, synchron (Streaming) oder kontinuierlich (Edge). Weitere Informationen zu den Auswertungsmethoden finden Sie in der Segmentierungsübersicht |
dependents |
Beide | Ein Array von Zielgruppen-IDs, die von der aktuellen Zielgruppe abhängen. Dies würde verwendet, wenn Sie eine Zielgruppe erstellen, die ein Segment eines Segments ist. |
dependencies |
Beide | Ein Array von Zielgruppen-IDs, von denen die Zielgruppe abhängig ist. Dies würde verwendet, wenn Sie eine Zielgruppe erstellen, die ein Segment eines Segments ist. |
type |
Beide | Ein systemgeneriertes Feld, das anzeigt, ob die Zielgruppe von Platform oder eine extern generierte Zielgruppe ist. Mögliche Werte sind SegmentDefinition und ExternalSegment . Ein SegmentDefinition bezieht sich auf eine Zielgruppe, die in Platform generiert wurde, während ein ExternalSegment auf eine Zielgruppe verweist, die nicht in Platform generiert wurde. |
originName |
Beide | Ein Feld, das auf den Namen der Herkunft der Zielgruppe verweist. Für Platform-generierte Zielgruppen wird dieser Wert REAL_TIME_CUSTOMER_PROFILE . Für Zielgruppen, die in Audience Orchestration generiert werden, wird dieser Wert AUDIENCE_ORCHESTRATION . Für in Adobe Audience Manager generierte Zielgruppen wird dieser Wert AUDIENCE_MANAGER . Für andere extern generierte Zielgruppen wird dieser Wert CUSTOM_UPLOAD . |
createdBy |
Beide | Die ID des Benutzers, der die Zielgruppe erstellt hat. |
labels |
Beide | Datennutzung auf Objektebene und attributbasierte Zugriffssteuerungsbeschriftungen, die für die Zielgruppe relevant sind. |
namespace |
Beide | Der Namespace, zu dem die Zielgruppe gehört. Zu den möglichen Werten gehören AAM , AAMSegments , AAMTraits und AEPSegments . |
linkedAudienceRef |
Beide | Ein Objekt, das Kennungen zu anderen zielgruppenbezogenen Systemen enthält. |
Neue Zielgruppe erstellen create
Sie können eine neue Zielgruppe erstellen, indem Sie eine POST-Anfrage an den /audiences
-Endpunkt senden.
API-Format
POST /audiences
Anfrage
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 | |
---|---|
Eigenschaft | Beschreibung |
name |
Der Name der Zielgruppe. |
description |
Eine Beschreibung der Zielgruppe. |
type |
Ein Feld, das anzeigt, ob die Zielgruppe von Platform oder eine extern generierte Zielgruppe ist. Mögliche Werte sind SegmentDefinition und ExternalSegment . Ein SegmentDefinition bezieht sich auf eine Zielgruppe, die in Platform generiert wurde, während ein ExternalSegment auf eine Zielgruppe verweist, die nicht in Platform generiert wurde. |
expression |
Der Profile Query Language (PQL)-Ausdruck der Zielgruppe. Weitere Informationen zu PQL-Ausdrücken finden Sie im Handbuch zu PQL-Ausdrücken. |
schema |
Das Experience-Datenmodell (XDM)-Schema der Zielgruppe. |
labels |
Datennutzung auf Objektebene und attributbasierte Zugriffssteuerungsbeschriftungen, die für die Zielgruppe relevant sind. |
Antwort
Bei einer erfolgreichen Antwort wird der HTTP-Status 200 mit Informationen zur neu erstellten Zielgruppe zurückgegeben.
code language-json |
---|
|
Suchen einer bestimmten Zielgruppe get
Sie können detaillierte Informationen zu einer bestimmten Zielgruppe nachschlagen, indem Sie eine GET-Anfrage an den /audiences
-Endpunkt senden und im Anfragepfad die ID der Zielgruppe angeben, die Sie abrufen möchten.
API-Format
GET /audiences/{AUDIENCE_ID}
{AUDIENCE_ID}
id
Feld handelt nicht das audienceId
.Anfrage
code language-shell |
---|
|
Antwort
Eine erfolgreiche Antwort gibt den HTTP-Status-Code 200 mit Informationen zur angegebenen Zielgruppe zurück.
code language-json |
---|
|
Aktualisieren einer Audience put
Sie können eine bestimmte Zielgruppe aktualisieren (überschreiben), indem Sie eine PUT-Anfrage an den /audiences
-Endpunkt senden und im Anfragepfad die ID der Zielgruppe angeben, die Sie aktualisieren möchten.
API-Format
PUT /audiences/{AUDIENCE_ID}
{AUDIENCE_ID}
id
Feld handelt nicht das audienceId
.Anfrage
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 | |
---|---|
Eigenschaft | Beschreibung |
audienceId |
Die ID der Zielgruppe. Für extern generierte Zielgruppen kann dieser Wert vom Benutzer bereitgestellt werden. |
name |
Der Name der Zielgruppe. |
namespace |
Der Namespace für die Zielgruppe. |
description |
Eine Beschreibung der Zielgruppe. |
type |
Ein systemgeneriertes Feld, das anzeigt, ob die Zielgruppe von Platform oder eine extern generierte Zielgruppe ist. Mögliche Werte sind SegmentDefinition und ExternalSegment . Ein SegmentDefinition bezieht sich auf eine Zielgruppe, die in Platform generiert wurde, während ein ExternalSegment auf eine Zielgruppe verweist, die nicht in Platform generiert wurde. |
lifecycleState |
Der Status der Zielgruppe. Zu den möglichen Werten gehören draft , published und inactive . draft gibt an, wann die Zielgruppe erstellt wird, published wann die Zielgruppe veröffentlicht wird, und inactive , wann die Zielgruppe nicht mehr aktiv ist. |
datasetId |
Die ID des Datensatzes, der die Zielgruppendaten enthält. |
labels |
Datennutzung auf Objektebene und attributbasierte Zugriffssteuerungsbeschriftungen, die für die Zielgruppe relevant sind. |
Antwort
Bei einer erfolgreichen Antwort wird der HTTP-Status 200 mit Details zur neu aktualisierten Zielgruppe zurückgegeben. Beachten Sie, dass die Details Ihrer Zielgruppe unterschiedlich sein können, je nachdem, ob es sich um eine Platform-generierte Zielgruppe oder eine extern generierte Zielgruppe handelt.
code language-json |
---|
|
Löschen einer Zielgruppe delete
Sie können eine bestimmte Zielgruppe löschen, indem Sie eine DELETE-Anfrage an den /audiences
-Endpunkt senden und im Anfragepfad die ID der Zielgruppe angeben, die Sie löschen möchten.
API-Format
DELETE /audiences/{AUDIENCE_ID}
{AUDIENCE_ID}
id
Feld handelt nicht das audienceId
.Anfrage
code language-shell |
---|
|
Antwort
Eine erfolgreiche Antwort gibt den HTTP-Status 204 ohne Meldung zurück.
Abrufen mehrerer Zielgruppen bulk-get
Sie können mehrere Zielgruppen abrufen, indem Sie eine POST-Anfrage an den /audiences/bulk-get
-Endpunkt stellen und die IDs der Zielgruppen angeben, die Sie abrufen möchten.
API-Format
POST /audiences/bulk-get
Anfrage
code language-shell |
---|
|
Antwort
Bei einer erfolgreichen Antwort wird der HTTP-Status 207 mit Informationen zu den von Ihnen angeforderten Zielgruppen zurückgegeben.
code language-json |
---|
|
Nächste Schritte
Nach dem Lesen dieses Handbuchs haben Sie jetzt ein besseres Verständnis dafür, wie Sie Zielgruppen mithilfe der Adobe Experience Platform-API erstellen, verwalten und löschen können. Weitere Informationen zur Verwaltung von Audiences mithilfe der Benutzeroberfläche finden Sie im Handbuch zur Segmentierungsbenutzeroberfläche.