Point d’entrée Audiences
Une audience est un ensemble 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 d’entrée 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 la manière de 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 effectuant une requête GET au point d’entrée /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 généraux élevés lors de l’énumération des ressources. Si vous effectuez un appel à ce point d’entrée sans paramètre, 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}
property=audienceId
, les audiences inactives seront seront renvoyées.Les paramètres de requête suivants peuvent être utilisés lors de la récupération d’une liste d’audiences :
start
start=5
limit
limit=10
sort
attributeName:[desc/asc]
.sort=updateTime:desc
property
property=
property=audienceId==test-audience-id
name
name=Sample
description
description=Test Description
entityType
entityType=_xdm.context.account
Requête
La requête suivante récupère les deux dernières audiences créées dans votre organisation.
code language-shell |
---|
|
Réponse
Une réponse réussie renvoie le statut HTTP 200 avec une liste d’audiences créées dans votre organisation au format JSON.
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 | ||
---|---|---|
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 la 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 | Identifiant de l’organisation à laquelle appartient l’audience. |
sandbox |
Les deux | Informations sur le sandbox auquel appartient l’audience. Vous trouverez plus d’informations sur les sandbox dans la présentation des sandbox. |
name |
Les deux | Nom de l’audience. |
description |
Les deux | Description de l’audience. |
expression |
Généré par Platform | Expression Profile Query Language (PQL) de l’audience. Vous trouverez plus d’informations sur les expressions PQL dans le guide des expressions de PQL 🔗. |
mergePolicyId |
Généré par Platform | L’identifiant de la politique 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 Platform | Indique comment l’audience sera évaluée. Les méthodes d’évaluation possibles sont par lots, synchrones (diffusion en continu) ou continues (Edge). Vous trouverez plus d’informations sur les méthodes d’évaluation dans la présentation de la segmentation |
dependents |
Les deux | Tableau d’ID d’audience qui dépendent de l’audience actuelle. Cette option est utile 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. Cette option est utile 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 indique si l’audience est générée par Platform ou est une audience générée en externe. Les valeurs possibles sont SegmentDefinition et ExternalSegment . Une SegmentDefinition fait référence à une audience générée dans Platform, tandis qu’une 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 | 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 les attributs pertinents pour l’audience. |
namespace |
Les deux | Espace de noms auquel appartient l’audience. 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 audience en effectuant une requête de POST au point d’entrée /audiences
.
Format d’API
POST /audiences
Requête
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 | |
---|---|
Propriété | Description |
name |
Nom de l’audience. |
description |
Description de l’audience. |
type |
Champ qui indique si l’audience est générée par Platform ou si elle est générée de manière externe. Les valeurs possibles sont SegmentDefinition et ExternalSegment . Une SegmentDefinition fait référence à une audience générée dans Platform, tandis qu’une 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 de 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 les attributs pertinents pour l’audience. |
Réponse
Une réponse réussie renvoie un état HTTP 200 avec des informations sur votre audience nouvellement créée.
code language-json |
---|
|
Recherche d’une audience spécifiée get
Vous pouvez rechercher des informations détaillées sur une audience spécifique en adressant une requête GET au point d’entrée /audiences
et en fournissant l’identifiant de l’audience que vous souhaitez récupérer dans le chemin de requête.
Format d’API
GET /audiences/{AUDIENCE_ID}
{AUDIENCE_ID}
id
et ’est pas le champ audienceId
.Requête
code language-shell |
---|
|
Réponse
Une réponse réussie renvoie un état HTTP 200 avec des informations sur l’audience spécifiée.
code language-json |
---|
|
Mettre à jour une audience put
Vous pouvez mettre à jour (remplacer) une audience spécifique en adressant une requête de PUT au point d’entrée /audiences
et en fournissant l’identifiant de l’audience que vous souhaitez mettre à jour dans le chemin de requête.
Format d’API
PUT /audiences/{AUDIENCE_ID}
{AUDIENCE_ID}
id
et ’est pas le champ audienceId
.Requête
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 | |
---|---|
Propriété | Description |
audienceId |
Identifiant de l’audience. Pour les audiences générées en externe, cette valeur peut être fournie par l’utilisateur ou l’utilisatrice. |
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 indique si l’audience est générée par Platform ou est une audience générée en externe. Les valeurs possibles sont SegmentDefinition et ExternalSegment . Une SegmentDefinition fait référence à une audience générée dans Platform, tandis qu’une 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 où l’audience est créée, le moment published où elle est publiée et le moment inactive où elle n’est plus active. |
datasetId |
Identifiant du jeu de données dans lequel se trouvent les données 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 les attributs pertinents pour l’audience. |
Réponse
Une réponse réussie renvoie un statut HTTP 200 avec les détails de votre audience nouvellement mise à jour. Notez que les détails de votre audience seront différents selon qu’il s’agit d’une audience générée par Platform ou d’une audience générée en externe.
code language-json |
---|
|
Suppression d’une audience delete
Vous pouvez supprimer une audience spécifique en adressant une requête DELETE au point d’entrée /audiences
et en fournissant l’identifiant de l’audience que vous souhaitez supprimer du chemin d’accès de la requête.
Format d’API
DELETE /audiences/{AUDIENCE_ID}
{AUDIENCE_ID}
id
et ’est pas le champ audienceId
.Requête
code language-shell |
---|
|
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 adressant une requête POST au point d’entrée /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
code language-shell |
---|
|
Réponse
Une réponse réussie renvoie un état HTTP 207 avec des informations sur les audiences demandées.
code language-json |
---|
|
Étapes suivantes
Vous êtes arrivé au bout de ce guide. À présent, 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 des audiences à l’aide de l’interface utilisateur, consultez le guide de l’interface utilisateur de segmentation.