DocumentationExperience PlatformGuide de Segmentation Service

Point de terminaison Audiences

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Rubriques :

Créé pour :

  • Développeur

Une audience est un groupe de personnes qui partagent des comportements et/ou des caractéristiques similaires. Ces collections de personnes peuvent être générées à l’aide de Adobe Experience Platform ou à partir de sources externes. Vous pouvez utiliser le point d’entrée /audiences dans l’API Segmentation, ce qui vous permet de récupérer, créer, mettre à jour et supprimer des audiences par programmation.

Commencer

Les points de terminaison utilisés dans ce guide font partie de l’API Adobe Experience Platform Segmentation Service. Avant de poursuivre, consultez le guide de prise en main pour obtenir des informations importantes à connaître afin d’effectuer avec succès des appels vers l’API, y compris les en-têtes requis et comment lire des exemples d’appels API.

Récupération d’une liste d’audiences list

Vous pouvez récupérer une liste de toutes les audiences de votre organisation en envoyant une requête de GET au point de terminaison /audiences.

Format d’API

Le point d’entrée /audiences prend en charge plusieurs paramètres de requête pour vous aider à filtrer vos résultats. Bien que ces paramètres soient facultatifs, leur utilisation est vivement recommandée pour réduire les frais de gestion élevés lors de l’inscription de ressources. Si vous effectuez un appel vers ce point de terminaison sans paramètres, toutes les audiences disponibles pour votre organisation seront récupérées. Plusieurs paramètres peuvent être inclus et séparés par des esperluettes (&).

GET /audiences
GET /audiences?{QUERY_PARAMETERS}

Les paramètres de requête suivants peuvent être utilisés lors de la récupération d’une liste d’audiences :

Paramètre de requête
Description
Exemple
start
Indique le décalage de début pour les audiences renvoyées.
start=5
limit
Indique le nombre maximal d’audiences renvoyées par page.
limit=10
sort
Spécifie l’ordre de tri des résultats. Il est écrit au format attributeName:[desc/asc].
sort=updateTime:desc
property
Filtre permettant de spécifier des audiences qui correspondent exactement à la valeur d’un attribut. Il est écrit au format property=
property=audienceId==test-audience-id
name
Un filtre permettant de spécifier les audiences dont les noms contiennent la valeur fournie. Cette valeur n’est pas sensible à la casse.
name=Sample
description
Filtre permettant de spécifier les audiences dont les descriptions contiennent la valeur fournie. Cette valeur n’est pas sensible à la casse.
description=Test Description

Requête

La requête suivante récupère les deux dernières audiences créées dans votre organisation.

Exemple de requête pour récupérer une liste d’audiences.
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}'

Réponse

Une réponse réussie renvoie un état HTTP 200 avec une liste des audiences créées dans votre organisation au format JSON.

Exemple de réponse contenant les deux dernières audiences créées appartenant à votre organisation
code language-json 
{
    "children": [
        {
            "id": "60ccea95-1435-4180-97a5-58af4aa285ab",
            "audienceId": "60ccea95-1435-4180-97a5-58af4aa285ab",
            "schema": {
                "name": "_xdm.context.profile"
            },
            "ttlInDays": 60,
            "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
Propriété Type d’audience Description
id Les deux Identifiant en lecture seule généré par le système pour l’audience.
audienceId Les deux Si l’audience est une audience générée par Platform, il s’agit de la même valeur que le id. Si l’audience est générée en externe, cette valeur est fournie par le client.
schema Les deux Schéma du modèle de données d’expérience (XDM) de l’audience.
imsOrgId Les deux ID de l’organisation à laquelle appartient l’audience.
sandbox Les deux Informations sur l’environnement de test auquel l’audience appartient. Vous trouverez plus d’informations sur les environnements de test dans la présentation des environnements de test.
name Les deux Nom de l’audience.
description Les deux Description de l’audience.
expression Généré par la plateforme Expression Profile Query Language (PQL) de l’audience. Vous trouverez plus d’informations sur les expressions PQL dans le guide des expressions PQL.
mergePolicyId Généré par la plateforme Identifiant de la stratégie de fusion à laquelle l’audience est associée. Pour plus d’informations sur les politiques de fusion, consultez le guide des politiques de fusion.
evaluationInfo Généré par la plateforme Affiche la manière dont l’audience sera évaluée. Les méthodes d’évaluation possibles sont par lots, synchrones (diffusion en continu) ou continues (périphérie). Vous trouverez plus d’informations sur les méthodes d’évaluation dans la présentation de la segmentation
dependents Les deux Tableau d’identifiants d’audience qui dépendent de l’audience actuelle. Cela serait utilisé si vous créez une audience qui est un segment d’un segment.
dependencies Les deux Tableau d’identifiants d’audience dont dépend l’audience. Cela serait utilisé si vous créez une audience qui est un segment d’un segment.
type Les deux Champ généré par le système qui affiche si l’audience est générée par Platform ou est générée en externe. Les valeurs possibles sont SegmentDefinition et ExternalSegment. Un SegmentDefinition fait référence à une audience qui a été générée dans Platform, tandis qu’un ExternalSegment fait référence à une audience qui n’a pas été générée dans Platform.
originName Les deux Champ qui fait référence au nom de l’origine de l’audience. Pour les audiences générées par Platform, cette valeur sera REAL_TIME_CUSTOMER_PROFILE. Pour les audiences générées dans Audience Orchestration, cette valeur sera AUDIENCE_ORCHESTRATION. Pour les audiences générées dans Adobe Audience Manager, cette valeur sera AUDIENCE_MANAGER. Pour les autres audiences générées en externe, cette valeur sera CUSTOM_UPLOAD.
createdBy Les deux L’identifiant de l’utilisateur qui a créé l’audience.
labels Les deux Utilisation des données au niveau de l’objet et libellés de contrôle d’accès basés sur des attributs pertinents pour l’audience.
namespace Les deux Espace de noms auquel l’audience appartient. Les valeurs possibles sont AAM, AAMSegments, AAMTraits et AEPSegments.
linkedAudienceRef Les deux Objet contenant des identifiants pour d’autres systèmes liés à l’audience.

Création d’une audience create

Vous pouvez créer une nouvelle audience en envoyant une requête de POST au point de terminaison /audiences.

Format d’API

POST /audiences

Requête

Audience générée par la plateforme
accordion
Exemple de requête pour créer une audience générée par Platform
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": "ups",
        "description": "Last 30 days",
        "type": "SegmentDefinition",
        "expression": {
            "type": "PQL",
            "format": "pql/text",
            "value": "workAddress.country = \"US\""
        },
        "schema": {
            "name": "_xdm.context.profile"
        },
        "labels": [
          "core/C1"
        ],
        "ttlInDays": 60
    }'
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
Propriété Description
name Nom de l’audience.
description Description de l’audience.
type Champ qui affiche si l’audience est générée par Platform ou est générée de l’extérieur. Les valeurs possibles sont SegmentDefinition et ExternalSegment. Un SegmentDefinition fait référence à une audience qui a été générée dans Platform, tandis qu’un ExternalSegment fait référence à une audience qui n’a pas été générée dans Platform.
expression Expression Profile Query Language (PQL) de l’audience. Vous trouverez plus d’informations sur les expressions PQL dans le guide des expressions PQL.
schema Schéma du modèle de données d’expérience (XDM) de l’audience.
labels Utilisation des données au niveau de l’objet et libellés de contrôle d’accès basés sur des attributs pertinents pour l’audience.
ttlInDays Représente la valeur d’expiration des données de l’audience, en jours.
Audience générée de manière externe
accordion
Exemple de requête pour créer une audience générée de l’extérieur
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 '{
        "audienceId":"test-external-audience-id",
        "name":"externalAudience",
        "namespace":"aam",
        "description":"Last 30 days",
        "type":"ExternalSegment",
        "originName":"CUSTOM_UPLOAD",
        "lifecycleState":"published",
        "datasetId":"6254cf3c97f8e31b639fb14d",
        "labels":[
            "core/C1"
        ],
        "linkedAudienceRef":{
            "flowId": "4685ea90-d2b6-11ec-9d64-0242ac120002"
        }
    }'
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
Propriété Description
audienceId Identifiant fourni par l’utilisateur pour l’audience.
name Nom de l’audience.
namespace Espace de noms de l’audience.
description Description de l’audience.
type Champ qui affiche si l’audience est générée par Platform ou est générée de l’extérieur. Les valeurs possibles sont SegmentDefinition et ExternalSegment. Un SegmentDefinition fait référence à une audience qui a été générée dans Platform, tandis qu’un ExternalSegment fait référence à une audience qui n’a pas été générée dans Platform.
originName Nom de l’origine de l’audience. Pour les audiences générées en externe, la valeur par défaut est CUSTOM_UPLOAD. Les autres valeurs prises en charge sont REAL_TIME_CUSTOMER_PROFILE, CUSTOM_UPLOAD, AUDIENCE_ORCHESTRATION et AUDIENCE_MATCH.
lifecycleState Champ facultatif qui détermine l’état initial de l’audience que vous essayez de créer. Les valeurs prises en charge sont draft, published et inactive.
datasetId L’identifiant du jeu de données où se trouvent les données qui constituent l’audience.
labels Utilisation des données au niveau de l’objet et libellés de contrôle d’accès basés sur des attributs pertinents pour l’audience.
audienceMeta Métadonnées qui appartiennent à l’audience générée en externe.
linkedAudienceRef

Objet contenant des identifiants pour d’autres systèmes liés à l’audience. Cela peut inclure les éléments suivants :

  • flowId : cet identifiant est utilisé pour connecter l’audience au flux de données utilisé pour importer les données d’audience. Vous trouverez plus d’informations sur les ID requis dans le guide de création d’un flux de données.
  • aoWorkflowId : cet identifiant est utilisé pour connecter l’audience à une composition d’Audience Orchestration associée.</li/>
  • payloadFieldGroupRef : cet identifiant est utilisé pour faire référence au schéma de groupe de champs XDM qui décrit la structure de l’audience. Vous trouverez plus d’informations sur la valeur de ce champ dans le guide de point d’entrée XDM Field Group.
  • audienceFolderId : cet identifiant est utilisé pour faire référence à l’ID de dossier dans Adobe Audience Manager pour l’audience. Vous trouverez plus d’informations sur cette API dans le guide de l’API Adobe Audience Manager.

Réponse

Une réponse réussie renvoie un état HTTP 200 avec des informations sur votre nouvelle audience.

Audience générée par la plateforme
accordion
Exemple de réponse lors de la récupération d’une audience générée par Platform.
code language-json 
{
    "id": "60ccea95-1435-4180-97a5-58af4aa285ab",
    "audienceId": "60ccea95-1435-4180-97a5-58af4aa285ab",
    "schema": {
        "name": "_xdm.context.profile"
    },
    "ttlInDays": 60,
    "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"
}
Audience générée de manière externe
accordion
Exemple de réponse lors de la récupération d’une audience générée en externe.
code language-json 
{
    "id": "60ccea95-1435-4180-97a5-58af4aa285ab",
    "audienceId": "test-external-audience-id",
    "name": "externalAudience",
    "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",
    "lifecycleState": "active",
    "createdBy": "{CREATED_BY_ID}",
    "datasetId": "6254cf3c97f8e31b639fb14d",
    "labels": [
        "core/C1"
    ],
    "_etag": "\"f4102699-0000-0200-0000-625cd61a0000\"",
    "creationTime": 1650251290000,
    "updateEpoch": 1650251290,
    "updateTime": 1650251290000,
    "createEpoch": 1650251290
}

Mise à jour d’un champ dans une audience update-field

Vous pouvez mettre à jour les champs d’une audience spécifique en envoyant une requête de PATCH au point de terminaison /audiences et en fournissant l’identifiant de l’audience que vous souhaitez mettre à jour dans le chemin d’accès de la requête.

Format d’API

PATCH /audiences/{AUDIENCE_ID}
Paramètre
Description
{AUDIENCE_ID}
L’identifiant de l’audience que vous souhaitez mettre à jour. Notez qu’il s’agit du champ id et qu’il ne s’agit pas du champ audienceId.

Requête

Exemple de requête pour mettre à jour un champ dans une audience.
code language-shell 
curl -X PATCH 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 '
     [
        {
            "op": "add",
            "path": "/expression",
            "value": {
                "type": "PQL",
                "format": "pql/text",
                "value": "workAddress.country = \"CA\""
            }
        }
      ]'
table 0-row-2 1-row-2 2-row-2 3-row-2
Propriété Description
op Pour la mise à jour des audiences, cette valeur est toujours add.
path Le chemin du champ que vous souhaitez mettre à jour.
value Valeur vers laquelle vous souhaitez mettre à jour le champ.

Réponse

Une réponse réussie renvoie un état HTTP 200 avec des informations sur votre audience nouvellement mise à jour.

Exemple de réponse lors de la mise à jour d’un champ dans une audience.
code language-json 
{
    "id": "60ccea95-1435-4180-97a5-58af4aa285ab",
    "audienceId": "60ccea95-1435-4180-97a5-58af4aa285ab",
    "schema": {
        "name": "_xdm.context.profile"
    },
    "ttlInDays": 60,
    "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 = \"CA\""
    },
    "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"
}

Mettre à jour une audience put

Vous pouvez mettre à jour (remplacer) une audience spécifique en envoyant une requête de PUT au point de terminaison /audiences et en fournissant l’identifiant de l’audience que vous souhaitez mettre à jour dans le chemin d’accès de la requête.

Format d’API

PUT /audiences/{AUDIENCE_ID}
Paramètre
Description
{AUDIENCE_ID}
L’identifiant de l’audience que vous souhaitez mettre à jour. Notez qu’il s’agit du champ id et qu’il ne s’agit pas du champ audienceId.

Requête

Exemple de requête de mise à jour d’une audience entière.
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-external-audience-id",
    "name": "New external audience",
    "namespace": "aam",
    "description": "Last 30 days",
    "type": "ExternalSegment",
    "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
Propriété Description
audienceId ID de l’audience. Pour les audiences générées en externe, cette valeur peut être fournie par l’utilisateur.
name Nom de l’audience.
namespace Espace de noms de l’audience.
description Description de l’audience.
type Champ généré par le système qui affiche si l’audience est générée par Platform ou est générée en externe. Les valeurs possibles sont SegmentDefinition et ExternalSegment. Un SegmentDefinition fait référence à une audience qui a été générée dans Platform, tandis qu’un ExternalSegment fait référence à une audience qui n’a pas été générée dans Platform.
lifecycleState Statut de l’audience. Les valeurs possibles sont draft, published et inactive. draft représente le moment de création de l’audience, published celui de publication de l’audience et inactive celui de non-activité de l’audience.
datasetId L’identifiant du jeu de données que les données d’audience peuvent être trouvées.
labels Utilisation des données au niveau de l’objet et libellés de contrôle d’accès basés sur des attributs pertinents pour l’audience.

Réponse

Une réponse réussie renvoie un état HTTP 200 avec les détails de l’audience que vous venez de mettre à jour. Notez que les détails de votre audience diffèrent selon qu’il s’agit d’une audience générée par Platform ou d’une audience générée de l’extérieur.

Exemple de réponse lors de la mise à jour d’une audience entière.
code language-json 
{
    "id": "4afe34ae-8c98-4513-8a1d-67ccaa54bc05",
    "audienceId": "test-external-audience-id",
    "name": "New external audience",
    "namespace": "aam",
    "imsOrgId": "{ORG_ID}",
    "sandbox": {
        "sandboxId": "6ed34f6f-fe21-4a30-934f-6ffe21fa3075",
        "sandboxName": "prod",
        "type": "production",
        "default": true
    },
    "description": "Last 30 days",
    "type": "ExternalSegment",
    "lifecycleState": "published",
    "createdBy": "{CREATED_BY_ID}",
    "datasetId": "6254cf3c97f8e31b639fb14d",
    "_etag": "\"f4102699-0000-0200-0000-625cd61a0000\"",
    "creationTime": 1650251290000,
    "updateEpoch": 1650251290,
    "updateTime": 1650251290000,
    "createEpoch": 1650251290
}

Suppression d’une audience delete

Vous pouvez supprimer une audience spécifique en effectuant une requête de DELETE sur le point de terminaison /audiences et en fournissant l’identifiant de l’audience que vous souhaitez supprimer dans le chemin d’accès de la requête.

Format d’API

DELETE /audiences/{AUDIENCE_ID}
Paramètre
Description
{AUDIENCE_ID}
L’identifiant de l’audience que vous souhaitez supprimer. Notez qu’il s’agit du champ id et qu’il ne s’agit pas du champ audienceId.

Requête

Exemple de requête pour supprimer une audience.
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}'

Réponse

Une réponse réussie renvoie un état HTTP 204 sans message.

Récupération de plusieurs audiences bulk-get

Vous pouvez récupérer plusieurs audiences en envoyant une requête de POST au point de terminaison /audiences/bulk-get et en fournissant les identifiants des audiences que vous souhaitez récupérer.

Format d’API

POST /audiences/bulk-get

Requête

Exemple de requête pour récupérer plusieurs audiences.
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"
        }
    ]
 }

Réponse

Une réponse réussie renvoie un état HTTP 207 avec des informations sur les audiences demandées.

Exemple de réponse lors de la récupération de plusieurs audiences.
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"
         },
         "ttlInDays": 30,
         "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"
      }
   }
}

Étapes suivantes

Après avoir lu ce guide, vous comprenez mieux comment créer, gérer et supprimer des audiences à l’aide de l’API Adobe Experience Platform. Pour plus d’informations sur la gestion de l’audience à l’aide de l’interface utilisateur, consultez le guide de l’interface utilisateur de segmentation.

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