DokumentationExperience PlatformHandbuch zum Segmentierungs-Service

Zielgruppen-Endpunkt

Last update: Thu Apr 03 2025 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Themen:

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 list

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}
NOTE
Wenn Sie diesen Endpunkt ohne Abfrageparameter verwenden, werden inaktive Zielgruppen zurückgegeben. Wenn Sie diesen Endpunkt jedoch zusammen mit dem property=audienceId Abfrageparameter verwenden, werden inaktive Zielgruppen zurückgegeben.

Beim Abrufen einer Liste von Zielgruppen können die folgenden Abfrageparameter verwendet werden:

Abfrageparameter
Beschreibung
Beispiel
start
Gibt den Anfangsoffset für die zurückgegebenen Zielgruppen an.
start=5
limit
Gibt die maximale Anzahl von Zielgruppen an, die pro Seite zurückgegeben wird.
limit=10
sort
Gibt die Reihenfolge an, nach der die Ergebnisse sortiert werden sollen. Dieses wird im Format attributeName:[desc/asc] geschrieben.
sort=updateTime:desc
property
Ein Filter, mit dem Sie Zielgruppen angeben können die dem Wert eines Attributs entsprechen. Dieses wird im Format property= geschrieben
property=audienceId==test-audience-id
name
Ein Filter, mit dem Sie Zielgruppen angeben können, deren Namen angegebenen enthalten. Bei diesem Wert wird nicht zwischen Groß- und Kleinschreibung unterschieden.
name=Sample
description
Ein Filter, mit dem Sie Zielgruppen angeben können, deren Beschreibungen angegebenen enthalten. Bei diesem Wert wird nicht zwischen Groß- und Kleinschreibung unterschieden.
description=Test Description
entityType
Ein Filter, mit dem Sie den Typ der Zielgruppe angeben können, nach der Sie suchen.
entityType=_xdm.context.account

Anfrage

Mit der folgenden Anfrage werden die letzten beiden in Ihrer Organisation erstellten Zielgruppen abgerufen.

Eine Beispielanfrage zum Abrufen einer Liste von Zielgruppen.
code language-shell 
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.

Eine Beispielantwort, die die letzten beiden erstellten Zielgruppen Ihrer Organisation enthält
code language-json 
{
    "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"
      }
   }
}
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

Beispielanfrage zum Erstellen einer Platform-generierten Zielgruppe
code language-shell 
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"
        ]
    }'
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.

Eine Beispielantwort beim Erstellen einer Platform-generierten Zielgruppe.
code language-json 
{
    "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 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}
Parameter
Beschreibung
{AUDIENCE_ID}
Die ID der Zielgruppe, die Sie abrufen möchten. Beachten Sie, dass es sich hierbei um das id Feld handelt nicht das audienceId.

Anfrage

Eine Beispielanfrage zum Abrufen einer Zielgruppe
code language-shell 
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.

Eine Beispielantwort beim Abrufen einer von Platform generierten Zielgruppe.
code language-json 
{
    "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 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}
Parameter
Beschreibung
{AUDIENCE_ID}
Die ID der Zielgruppe, die Sie aktualisieren möchten. Beachten Sie, dass es sich hierbei um das id Feld handelt nicht das audienceId.

Anfrage

Eine Beispielanfrage zum Aktualisieren einer gesamten Zielgruppe.
code language-shell 
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"
    ]
}'
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
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 Experience Platform generiert wurde, während ein ExternalSegment auf eine Zielgruppe verweist, die nicht in Experience Platform generiert wurde.
expression Ein -Objekt, das den PQL-Ausdruck der Zielgruppe enthält.
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 von Experience Platform generierte Zielgruppe oder eine extern generierte Zielgruppe handelt.

Beispielantwort beim Aktualisieren einer gesamten Zielgruppe.
code language-json 
{
    "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 patch

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}
Parameter
Beschreibung
{AUDIENCE_ID}
Die ID der Zielgruppe, die Sie aktualisieren möchten. Beachten Sie, dass es sich hierbei um das id Feld handelt nicht das audienceId.

Anfrage

Eine Beispielanfrage zum Aktualisieren einer Zielgruppe.
code language-shell 
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"
    }
 ]'
table 0-row-2 1-row-2 2-row-2 3-row-2
Eigenschaft Beschreibung
op Der Typ des ausgeführten PATCH-Vorgangs. Für diesen Endpunkt ist dieser Wert immer /add.
path Der Pfad des zu aktualisierenden Felds. Systemgenerierte Felder wie id, audienceId und namespace können bearbeitet werden.
value Der neue Wert, der der in path angegebenen Eigenschaft zugewiesen ist.

Antwort

Bei einer erfolgreichen Antwort wird der HTTP-Status 200 mit der aktualisierten Zielgruppe zurückgegeben.

Beispielantwort beim Patchen eines Felds in einer Zielgruppe.
code language-json 
{
    "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 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}
Parameter
Beschreibung
{AUDIENCE_ID}
Die ID der Zielgruppe, die Sie löschen möchten. Beachten Sie, dass es sich hierbei um das id Feld handelt nicht das audienceId.

Anfrage

Eine Beispielanfrage zum Löschen einer Zielgruppe.
code language-shell 
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 bulk-get

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

Eine Beispielanfrage zum Abrufen mehrerer Zielgruppen.
code language-shell 
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.

Eine Beispielantwort beim Abrufen mehrerer Zielgruppen.
code language-json 
{
   "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.

recommendation-more-help
770bc05d-534a-48a7-9f07-017ec1e14871