Zielgruppen-Endpunkt
Erstellt für:
- Entwickler
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
Sie können eine Liste aller Zielgruppen für Ihr Unternehmen abrufen, indem Sie eine GET-Anfrage an den /audiences
-Endpunkt stellen.
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.
curl -X GET https://platform.adobe.io/data/core/ups/audiences?limit=2 \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
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.
{
"children": [
{
"id": "60ccea95-1435-4180-97a5-58af4aa285ab",
"audienceId": "60ccea95-1435-4180-97a5-58af4aa285ab",
"schema": {
"name": "_xdm.context.profile"
},
"profileInstanceId": "ups",
"imsOrgId": "{ORG_ID}",
"sandbox": {
"sandboxId": "6ed34f6f-fe21-4a30-934f-6ffe21fa3075",
"sandboxName": "prod",
"type": "production",
"default": true
},
"name": "People who ordered in the last 30 days",
"description": "Last 30 days",
"expression": {
"type": "PQL",
"format": "pql/text",
"value": "workAddress.country = \"US\""
},
"mergePolicyId": "ef006bbe-750e-4e81-85f0-0c6902192dcc",
"evaluationInfo": {
"batch": {
"enabled": false
},
"continuous": {
"enabled": true
},
"synchronous": {
"enabled": false
}
},
"dataGovernancePolicy": {
"excludeOptOut": true
},
"isSystem": false,
"creationTime": 1650374572000,
"updateEpoch": 1650374573,
"updateTime": 1650374573000,
"createEpoch": 1650374572,
"_etag": "\"33120d7c-0000-0200-0000-625eb7ad0000\"",
"dependents": [],
"definedOn": [
{
"meta: resourceType": "unions",
"meta: containerId": "tenant",
"$ref": "https: //ns.adobe.com/xdm/context/profile__union"
}
],
"dependencies": [],
"type": "SegmentDefinition",
"originName": "REAL_TIME_CUSTOMER_PROFILE",
"overridePerformanceWarnings": false,
"createdBy": "{CREATED_BY_ID}",
"lifecycleState": "published",
"labels": [
"core/C1"
],
"namespace": "AEPSegments"
},
{
"id": "32a83b5d-a118-4bd6-b3cb-3aee2f4c30a1",
"audienceId": "test-external-audience-id",
"name": "externalSegment1",
"namespace": "aam",
"imsOrgId": "{ORG_ID}",
"sandbox":{
"sandboxId": "6ed34f6f-fe21-4a30-934f-6ffe21fa3075",
"sandboxName": "prod",
"type": "production",
"default": true
},
"isSystem": false,
"description": "Last 30 days",
"type": "ExternalSegment",
"originName": "CUSTOM_UPLOAD",
"lifecycleState": "published",
"createdBy": "{CREATED_BY_ID}",
"datasetId": "6254cf3c97f8e31b639fb14d",
"labels":[
"core/C1"
],
"linkedAudienceRef": {
"flowId": "4685ea90-d2b6-11ec-9d64-0242ac120002"
},
"creationTime": 1642745034000000,
"updateEpoch": 1649926314,
"updateTime": 1649926314000,
"createEpoch": 1642745034
}
],
"_page":{
"totalCount": 111,
"pageSize": 2,
"next": "1"
},
"_links":{
"next":{
"href":"@/audiences?start=1&limit=2&totalCount=111"
}
}
}
id
audienceId
id
. Wenn die Zielgruppe extern generiert wird, wird dieser Wert vom Client bereitgestellt.schema
imsOrgId
sandbox
name
description
expression
mergePolicyId
evaluationInfo
dependents
dependencies
type
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
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
labels
namespace
AAM
, AAMSegments
, AAMTraits
und AEPSegments
.linkedAudienceRef
Neue Zielgruppe erstellen
Sie können eine neue Zielgruppe erstellen, indem Sie eine POST-Anfrage an den /audiences
-Endpunkt senden.
API-Format
POST /audiences
Anfrage
curl -X POST https://platform.adobe.io/data/core/ups/audiences
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
-d '{
"name": "People who ordered in the last 30 days",
"profileInstanceId": "AEPSegments",
"description": "Last 30 days",
"type": "SegmentDefinition",
"expression": {
"type": "PQL",
"format": "pql/text",
"value": "workAddress.country = \"US\""
},
"schema": {
"name": "_xdm.context.profile"
},
"labels": [
"core/C1"
]
}'
name
description
type
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
schema
labels
Antwort
Bei einer erfolgreichen Antwort wird der HTTP-Status 200 mit Informationen zur neu erstellten Zielgruppe zurückgegeben.
{
"id": "60ccea95-1435-4180-97a5-58af4aa285ab",
"audienceId": "60ccea95-1435-4180-97a5-58af4aa285ab",
"schema": {
"name": "_xdm.context.profile"
},
"profileInstanceId": "ups",
"imsOrgId": "{ORG_ID}",
"sandbox": {
"sandboxId": "6ed34f6f-fe21-4a30-934f-6ffe21fa3075",
"sandboxName": "prod",
"type": "production",
"default": true
},
"isSystem":false,
"name": "People who ordered in the last 30 days",
"description": "Last 30 days",
"expression": {
"type": "PQL",
"format": "pql/text",
"value": "workAddress.country = \"US\""
},
"mergePolicyId": "ef006bbe-750e-4e81-85f0-0c6902192dcc",
"evaluationInfo": {
"batch": {
"enabled": false
},
"continuous": {
"enabled": true
},
"synchronous": {
"enabled": false
}
},
"dataGovernancePolicy": {
"excludeOptOut": true
},
"creationTime": 1650374572000,
"updateEpoch": 1650374573,
"updateTime": 1650374573000,
"createEpoch": 1650374572,
"_etag": "\"33120d7c-0000-0200-0000-625eb7ad0000\"",
"dependents": [],
"definedOn": [
{
"meta:resourceType": "unions",
"meta:containerId": "tenant",
"$ref": "https://ns.adobe.com/xdm/context/profile__union"
}
],
"dependencies": [],
"type": "SegmentDefinition",
"originName": "REAL_TIME_CUSTOMER_PROFILE",
"overridePerformanceWarnings": false,
"createdBy": "{CREATED_BY_ID}",
"lifecycleState": "active",
"labels": [
"core/C1"
],
"namespace": "AEPSegments"
}
Suchen einer bestimmten Zielgruppe
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
curl -X GET https://platform.adobe.io/data/core/ups/audiences/60ccea95-1435-4180-97a5-58af4aa285ab \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Antwort
Eine erfolgreiche Antwort gibt den HTTP-Status-Code 200 mit Informationen zur angegebenen Zielgruppe zurück.
{
"id": "60ccea95-1435-4180-97a5-58af4aa285ab",
"audienceId": "60ccea95-1435-4180-97a5-58af4aa285ab",
"schema": {
"name": "_xdm.context.profile"
},
"profileInstanceId": "ups",
"imsOrgId": "{ORG_ID}",
"sandbox": {
"sandboxId": "6ed34f6f-fe21-4a30-934f-6ffe21fa3075",
"sandboxName": "prod",
"type": "production",
"default": true
},
"isSystem": false,
"name": "People who ordered in the last 30 days",
"description": "Last 30 days",
"expression": {
"type": "PQL",
"format": "pql/text",
"value": "workAddress.country = \"US\""
},
"mergePolicyId": "ef006bbe-750e-4e81-85f0-0c6902192dcc",
"evaluationInfo": {
"batch": {
"enabled": false
},
"continuous": {
"enabled": true
},
"synchronous": {
"enabled": false
}
},
"dataGovernancePolicy": {
"excludeOptOut": true
},
"creationTime": 1650374572000,
"updateEpoch": 1650374573,
"updateTime": 1650374573000,
"createEpoch": 1650374572,
"_etag": "\"33120d7c-0000-0200-0000-625eb7ad0000\"",
"dependents": [],
"definedOn": [
{
"meta:resourceType": "unions",
"meta:containerId": "tenant",
"$ref": "https://ns.adobe.com/xdm/context/profile__union"
}
],
"dependencies": [],
"type": "SegmentDefinition",
"overridePerformanceWarnings": false,
"createdBy": "{CREATED_BY_ID}",
"lifecycleState": "active",
"labels": [
"core/C1"
],
"namespace": "AEPSegments"
}
Überschreiben einer Zielgruppe
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
curl -X PUT https://platform.adobe.io/data/core/ups/audiences/4afe34ae-8c98-4513-8a1d-67ccaa54bc05 \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '{
"audienceId": "test-platform-audience-id",
"name": "New Platform audience",
"namespace": "AEPSegments",
"description": "Last 30 days",
"type": "SegmentDefinition",
"expression": {
"type": "PQL",
"format": "pql/text",
"value": "workAddress.country=\"US\""
}
"lifecycleState": "published",
"datasetId": "6254cf3c97f8e31b639fb14d",
"labels": [
"core/C1"
]
}'
audienceId
name
namespace
description
type
SegmentDefinition
und ExternalSegment
. Ein SegmentDefinition
bezieht sich auf eine Zielgruppe, die in Experience Platform generiert wurde, während ein ExternalSegment
auf eine Zielgruppe verweist, die nicht in Experience Platform generiert wurde.expression
lifecycleState
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
labels
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 von Experience Platform generierte Zielgruppe oder eine extern generierte Zielgruppe handelt.
{
"id": "4afe34ae-8c98-4513-8a1d-67ccaa54bc05",
"audienceId": "test-platform-audience-id",
"name": "New Experience Platform audience",
"namespace": "AEPSegments",
"imsOrgId": "{ORG_ID}",
"sandbox": {
"sandboxId": "6ed34f6f-fe21-4a30-934f-6ffe21fa3075",
"sandboxName": "prod",
"type": "production",
"default": true
},
"description": "Last 30 days",
"type": "SegmentDefinition",
"lifecycleState": "published",
"createdBy": "{CREATED_BY_ID}",
"datasetId": "6254cf3c97f8e31b639fb14d",
"_etag": "\"f4102699-0000-0200-0000-625cd61a0000\"",
"creationTime": 1650251290000,
"updateEpoch": 1650251290,
"updateTime": 1650251290000,
"createEpoch": 1650251290
}
Aktualisieren einer Audience
Sie können eine bestimmte Zielgruppe aktualisieren, indem Sie eine PATCH-Anfrage an den /audiences
-Endpunkt senden und im Anfragepfad die ID der Zielgruppe angeben, die Sie aktualisieren möchten.
API-Format
PATCH /audiences/{AUDIENCE_ID}
{AUDIENCE_ID}
id
Feld handelt nicht das audienceId
.Anfrage
curl -X PATCH https://platform.adobe.io/data/core/ups/audiences/60ccea95-1435-4180-97a5-58af4aa285ab5
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '[
{
"op": "add",
"path": "/lifecycleState",
"value": "inactive"
}
]'
op
/add
.path
id
, audienceId
und namespace
können bearbeitet werden.value
path
angegebenen Eigenschaft zugewiesen ist.Antwort
Bei einer erfolgreichen Antwort wird der HTTP-Status 200 mit der aktualisierten Zielgruppe zurückgegeben.
{
"id": "60ccea95-1435-4180-97a5-58af4aa285ab5",
"audienceId": "test-platform-audience-id",
"name": "New Experience Platform audience",
"namespace": "AEPSegments",
"imsOrgId": "{ORG_ID}",
"sandbox": {
"sandboxId": "6ed34f6f-fe21-4a30-934f-6ffe21fa3075",
"sandboxName": "prod",
"type": "production",
"default": true
},
"description": "Last 30 days",
"type": "SegmentDefinition",
"lifecycleState": "inactive",
"createdBy": "{CREATED_BY_ID}",
"datasetId": "6254cf3c97f8e31b639fb14d",
"_etag": "\"f4102699-0000-0200-0000-625cd61a0000\"",
"creationTime": 1650251290000,
"updateEpoch": 1650251290,
"updateTime": 1650251290000,
"createEpoch": 1650251290
}
Löschen einer Zielgruppe
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
curl -X DELETE https://platform.adobe.io/data/core/ups/audiences/60ccea95-1435-4180-97a5-58af4aa285ab5 \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Antwort
Eine erfolgreiche Antwort gibt den HTTP-Status 204 ohne Meldung zurück.
Abrufen mehrerer Zielgruppen
Sie können mehrere Zielgruppen abrufen, indem Sie eine POST-Anfrage an den /audiences/bulk-get
-Endpunkt senden und die IDs der Zielgruppen angeben, die Sie abrufen möchten.
API-Format
POST /audiences/bulk-get
Anfrage
curl -X POST https://platform.adobe.io/data/core/ups/audiences/bulk-get
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d ' {
"ids": [
{
"id": "72c393ea-caed-441a-9eb6-5f66bb1bd6cd"
},
{
"id": "QU9fLTEzOTgzNTE0MzY0NzY0NDg5NzkyOTkx_6ed34f6f-fe21-4a30-934f-6ffe21fa3075"
}
]
}
Antwort
Bei einer erfolgreichen Antwort wird der HTTP-Status 207 mit Informationen zu den von Ihnen angeforderten Zielgruppen zurückgegeben.
{
"results":{
"72c393ea-caed-441a-9eb6-5f66bb1bd6cd":{
"id": "72c393ea-caed-441a-9eb6-5f66bb1bd6cd",
"audienceId": "72c393ea-caed-441a-9eb6-5f66bb1bd6cd",
"schema": {
"name": "_xdm.context.profile"
},
"imsOrgId": "{ORG_ID}",
"sandbox": {
"sandboxId": "6ed34f6f-fe21-4a30-934f-6ffe21fa3075",
"sandboxName": "prod",
"type": "production",
"default": true
},
"name": "Sample audience",
"expression": {
"type": "pql",
"format": "pql/text",
"value": "_id = \"abc\""
},
"mergePolicyId": "87c94d51-239c-4391-932c-29c2412100e5",
"evaluationInfo": {
"batch": {
"enabled": false
},
"continuous": {
"enabled": true
},
"synchronous": {
"enabled": false
}
},
"ansibleUiEnabled": false,
"dataGovernancePolicy": {
"excludeOptOut": true
},
"creationTime": 1623889553000000,
"updateEpoch": 1674646369,
"updateTime": 1674646369000,
"createEpoch": 1623889552,
"_etag": "\"61030ec7-0000-0200-0000-63d113610000\"",
"dependents": [],
"definedOn": [
{
"meta:resourceType": "unions",
"meta:containerId": "tenant",
"$ref": "https://ns.adobe.com/xdm/context/profile__union"
}
],
"dependencies": [],
"type": "SegmentDefinition",
"state": "enabled",
"overridePerformanceWarnings": false,
"lastModifiedBy": "{CREATED_ID}",
"lifecycleState": "published",
"namespace": "AEPSegments",
"isSystem": false,
"saveSegmentMembership": true,
"originName": "REAL_TIME_CUSTOMER_PROFILE"
},
"QU9fLTEzOTgzNTE0MzY0NzY0NDg5NzkyOTkx_6ed34f6f-fe21-4a30-934f-6ffe21fa3075":{
"id": "QU9fLTEzOTgzNTE0MzY0NzY0NDg5NzkyOTkx_6ed34f6f-fe21-4a30-934f-6ffe21fa3075",
"name": "label test24764489707692",
"namespace": "AO",
"imsOrgId": "{ORG_ID}",
"sandbox":{
"sandboxId": "6ed34f6f-fe21-4a30-934f-6ffe21fa3075",
"sandboxName": "prod",
"type": "production",
"default": true
},
"type": "ExternalSegment",
"lifecycleState": "published",
"sourceId": "source-id",
"createdBy": "{USER_ID}",
"datasetId": "62bf31a105e9891b63525c92",
"_etag": "\"3100da6d-0000-0200-0000-62bf31a10000\"",
"creationTime": 1656697249000,
"updateEpoch": 1656697249,
"updateTime": 1656697249000,
"createEpoch": 1656697249,
"audienceId": "test-audience-id",
"isSystem": false,
"saveSegmentMembership": true,
"linkedAudienceRef": {
"aoWorkflowId": "62bf31858e87e34c8364befa"
},
"originName": "AUDIENCE_ORCHESTRATION"
}
}
}
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.