Point d’entrée des audiences externes
Les audiences externes vous permettent de charger des données de profil à partir de vos sources externes dans Adobe Experience Platform. Vous pouvez utiliser le point d’entrée /external-audience
dans l’API Segmentation Service pour ingérer une audience externe vers Experience Platform, afficher les détails et mettre à jour vos audiences externes, ainsi que supprimer vos audiences externes.
Commencer
/core/ais
, par opposition à /core/ups
.Pour utiliser les API Experience Platform, vous devez avoir suivi le tutoriel authentification. Le tutoriel sur l’authentification indique les valeurs de chacun des en-têtes requis dans les appels API Experience Platform, comme illustré ci-dessous :
- Authorization:
Bearer {ACCESS_TOKEN}
- x-api-key:
{API_KEY}
- x-gw-ims-org-id :
{ORG_ID}
Dans Experience Platform, toutes les ressources sont isolées dans des sandbox virtuels spécifiques. Toutes les requêtes envoyées aux API Experience Platform nécessitent un en-tête spécifiant le nom du sandbox dans lequel l’opération sera effectuée :
- x-sandbox-name :
{SANDBOX_NAME}
Créer une audience externe create-audience
Vous pouvez créer une audience externe en effectuant une requête POST vers le point d’entrée /external-audience/
.
Format d’API
POST /external-audience/
Requête
code language-shell |
---|
|
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 | ||
---|---|---|
Propriété | Type | Description |
name |
Chaîne | Nom de l’audience externe. |
description |
Chaîne | Description facultative de l’audience externe. |
customAudienceId |
Chaîne | Identifiant facultatif de votre audience externe. |
fields |
Tableau d’objets |
La liste des champs et leurs types de données. Lors de la création de la liste des champs, vous pouvez ajouter les éléments suivants :
|
sourceSpec |
Objet |
Objet contenant les informations sur l’emplacement de l’audience externe. Lors de l’utilisation de cet objet, vous devez inclure les informations suivantes :
|
ttlInDays |
Nombre entier | Expiration des données de l’audience externe, en jours. Cette valeur peut être définie de 1 à 90. Par défaut, l’expiration des données est définie sur 30 jours. |
audienceType |
Chaîne | Type d’audience pour l’audience externe. Actuellement, seul people est pris en charge. |
originName |
Chaîne | Obligatoire Origine de l’audience. Cette information indique d’où vient l’audience. Pour les audiences externes, vous devez utiliser CUSTOM_UPLOAD . |
namespace |
Chaîne | Espace de noms de l’audience. Par défaut, cette valeur est définie sur CustomerAudienceUpload . |
labels |
Tableau de chaînes | Libellés de contrôle d’accès qui s’appliquent à l’audience externe. Vous trouverez plus d’informations sur les libellés de contrôle d’accès disponibles dans le glossaire des libellés d’utilisation des données. |
tags |
Tableau de chaînes | Balises à appliquer à l’audience externe. Vous trouverez plus d’informations sur les balises dans le guide de gestion des balises. |
Réponse
Une réponse réussie renvoie le statut HTTP 202 avec les détails de votre audience externe nouvellement créée.
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 | ||
---|---|---|
Propriété | Type | Description |
operationId |
Chaîne | Identifiant de l’opération. Vous pouvez ensuite utiliser cet identifiant pour récupérer le statut de la création de votre audience. |
operationDetails |
Objet | Objet contenant les détails de la demande que vous avez envoyée pour créer l’audience externe. |
name |
Chaîne | Nom de l’audience externe. |
description |
Chaîne | Description de l’audience externe. |
fields |
Tableau d’objets | La liste des champs et leurs types de données. Ce tableau détermine les champs dont vous avez besoin dans votre audience externe. |
sourceSpec |
Objet | Objet contenant les informations sur l’emplacement de l’audience externe. |
ttlInDays |
Nombre entier | Expiration des données de l’audience externe, en jours. Cette valeur peut être définie de 1 à 90. Par défaut, l’expiration des données est définie sur 30 jours. |
audienceType |
Chaîne | Type d’audience pour l’audience externe. |
originName |
Chaîne | Obligatoire Origine de l’audience. Indique d’où provient l’audience. |
namespace |
Chaîne | Espace de noms de l’audience. |
labels |
Tableau de chaînes | Libellés de contrôle d’accès qui s’appliquent à l’audience externe. Vous trouverez plus d’informations sur les libellés de contrôle d’accès disponibles dans le glossaire des libellés d’utilisation des données. |
Récupérer le statut de création de l’audience retrieve-status
Vous pouvez récupérer le statut de l’envoi de votre audience externe en adressant une requête GET au point d’entrée /external-audiences/operations
et en fournissant l’identifiant de l’opération que vous avez reçu de la réponse de création d’audience externe.
Format d’API
GET /external-audiences/operations/{OPERATION_ID}
{OPERATION_ID}
id
de l’opération que vous souhaitez récupérer.Requête
code language-shell |
---|
|
Réponse
Une réponse réussie renvoie un statut HTTP 200 avec les détails du statut de la tâche de l’audience externe.
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 | ||
---|---|---|
Propriété | Type | Description |
operationId |
Chaîne | Identifiant de l’opération que vous récupérez. |
status |
Chaîne | Statut de l’opération. Il peut s’agir de l’une des valeurs suivantes : SUCCESS , FAILED , PROCESSING . |
operationDetails |
Objet | Un objet contenant les détails de l’audience. |
audienceId |
Chaîne | Identifiant de l’audience externe qui est envoyée par l’opération. |
createdBy |
Chaîne | Identifiant de l’utilisateur qui a créé l’audience externe. |
createdAt |
Date et heure de l’époque longue | Date et heure, en secondes, auxquelles la demande de création de l’audience externe a été envoyée. |
updatedBy |
Chaîne | ID de la dernière personne à avoir mis à jour l’audience. |
updatedAt |
Date et heure de l’époque longue | Date et heure, en secondes, de la dernière mise à jour de l’audience. |
Mise à jour d’une audience externe update-audience
audienceId
de votre audience externe. Vous pouvez obtenir votre audienceId
d’un appel réussi au point d’entrée GET /external-audiences/operations/{OPERATION_ID}
.Vous pouvez mettre à jour les champs de votre audience externe en adressant une requête PATCH au point d’entrée /external-audience
et en fournissant l’identifiant de l’audience dans le chemin de requête.
Lors de l’utilisation de ce point d’entrée, vous pouvez mettre à jour les champs suivants :
- Description de l'audience
- Libellés de contrôle d’accès au niveau du champ
- Libellés de contrôle d’accès au niveau de l’audience
- Expiration des données de l’audience
La mise à jour du champ à l’aide de ce point d’entrée remplace le contenu du champ que vous avez demandé.
Format d’API
PATCH /external-audience/{AUDIENCE_ID}
Requête
code language-shell |
---|
|
table 0-row-3 1-row-3 | ||
---|---|---|
Propriété | Type | Description |
description |
Chaîne | Description mise à jour de l’audience externe. |
De plus, vous pouvez mettre à jour les paramètres suivants :
table 0-row-3 1-row-3 2-row-3 3-row-3 | ||
---|---|---|
Propriété | Type | Description |
labels |
Tableau | Un tableau contenant la liste mise à jour des libellés d’accès pour l’audience. Vous trouverez plus d’informations sur les libellés de contrôle d’accès disponibles dans le glossaire des libellés d’utilisation des données. |
fields |
Tableau d’objets | Tableau contenant les champs et leurs libellés associés pour l’audience externe. Seuls les champs répertoriés dans la demande PATCH seront mis à jour. Vous trouverez plus d’informations sur les libellés de contrôle d’accès disponibles dans le glossaire des libellés d’utilisation des données. |
ttlInDays |
Nombre entier | Expiration des données de l’audience externe, en jours. Cette valeur peut être définie de 1 à 90. |
Réponse
Une réponse réussie renvoie un état HTTP 200 avec les détails de l’audience externe mise à jour.
code language-json |
---|
|
Démarrer l’ingestion de l’audience start-audience-ingestion
audienceId
de votre audience externe. Vous pouvez obtenir votre audienceId
d’un appel réussi au point d’entrée GET /external-audiences/operations/{OPERATION_ID}
.Vous pouvez démarrer une ingestion d’audience en adressant une requête POST au point d’entrée suivant tout en fournissant l’identifiant d’audience.
Format d’API
POST /external-audience/{AUDIENCE_ID}/runs
Requête
La requête suivante déclenche une exécution d’ingestion pour l’audience externe.
code language-shell |
---|
|
table 0-row-3 1-row-3 2-row-3 | ||
---|---|---|
Propriété | Type | Description |
dataFilterStartTime |
Date et heure de l’époque | Obligatoire Plage spécifiant l’heure de début pour déterminer les fichiers à traiter. Cela signifie que les fichiers sélectionnés seront des fichiers après l’heure spécifiée. |
dataFilterEndTime |
Date et heure de l’époque | La plage spécifiant l’heure de fin à laquelle le flux s’exécutera pour sélectionner les fichiers à traiter. Cela signifie que les fichiers sélectionnés seront des fichiers avant l’heure spécifiée. |
Réponse
Une réponse réussie renvoie un état HTTP 200 avec des détails sur l’exécution de l’ingestion.
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 | ||
---|---|---|
Propriété | Type | Description |
audienceName |
Chaîne | Nom de l’audience pour laquelle vous démarrez une exécution d’ingestion. |
audienceId |
Chaîne | Identifiant de l’audience. |
runId |
Chaîne | Identifiant de l’exécution d’ingestion que vous avez démarrée. |
differentialIngestion |
Booléen | Champ qui détermine si l’ingestion est une ingestion partielle en fonction de la différence depuis la dernière ingestion ou une ingestion d’audience complète. |
dataFilterStartTime |
Date et heure de l’époque | La plage spécifiant l’heure de début d’exécution du flux pour sélectionner les fichiers traités. |
dataFilterEndTime |
Date et heure de l’époque | La plage spécifiant l’heure de fin à laquelle le flux s’exécute pour sélectionner les fichiers traités. |
createdAt |
Date et heure de l’époque longue | Date et heure, en secondes, auxquelles la demande de création de l’audience externe a été envoyée. |
createdBy |
Chaîne | Identifiant de l’utilisateur qui a créé l’audience externe. |
Récupération du statut d’ingestion d’audience spécifique retrieve-ingestion-status
audienceId
de votre audience externe et du runId
de votre identifiant d’exécution d’ingestion. Vous pouvez obtenir votre audienceId
à partir d’un appel réussi au point d’entrée GET /external-audiences/operations/{OPERATION_ID}
et votre runId
à partir d’un appel réussi précédent du point d’entrée POST /external-audience/{AUDIENCE_ID}/runs
.Vous pouvez récupérer le statut d’une ingestion d’audience en adressant une requête GET au point d’entrée suivant tout en fournissant les identifiants d’audience et d’exécution.
Format d’API
GET /external-audience/{AUDIENCE_ID}/runs/{RUN_ID}
Requête
La requête suivante récupère le statut de l’ingestion pour l’audience externe.
code language-shell |
---|
|
Réponse
Une réponse réussie renvoie un état HTTP 200 avec les détails de l’ingestion de l’audience externe.
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 | ||
---|---|---|
Propriété | Type | Description |
audienceName |
Chaîne | Nom de l’audience. |
audienceId |
Chaîne | Identifiant de l’audience. |
runId |
Chaîne | Identifiant de l’exécution d’ingestion. |
status |
Chaîne | Statut de l’exécution de l’ingestion. Les statuts possibles incluent SUCCESS et FAILED . |
differentialIngestion |
Booléen | Champ qui détermine si l’ingestion est une ingestion partielle en fonction de la différence depuis la dernière ingestion ou une ingestion d’audience complète. |
dataFilterStartTime |
Date et heure de l’époque | La plage spécifiant l’heure de début d’exécution du flux pour sélectionner les fichiers traités. |
dataFilterEndTime |
Date et heure de l’époque | La plage spécifiant l’heure de fin à laquelle le flux s’exécute pour sélectionner les fichiers traités. |
createdAt |
Date et heure de l’époque longue | Date et heure, en secondes, auxquelles la demande de création de l’audience externe a été envoyée. |
createdBy |
Chaîne | Identifiant de l’utilisateur qui a créé l’audience externe. |
details |
Tableau d’objets |
Objet contenant les détails de l’exécution de l’ingestion.
|
Liste des exécutions d’ingestion d’audience list-ingestion-runs
audienceId
de votre audience externe. Vous pouvez obtenir votre audienceId
d’un appel réussi au point d’entrée GET /external-audiences/operations/{OPERATION_ID}
.Vous pouvez récupérer toutes les exécutions d’ingestion pour l’audience externe sélectionnée en envoyant une requête GET au point d’entrée suivant tout en fournissant l’identifiant d’audience. Plusieurs paramètres peuvent être inclus et séparés par des esperluettes (&
).
Format d’API
GET /external-audience/{AUDIENCE_ID}/runs
Requête
La requête suivante récupère toutes les exécutions d’ingestion pour l’audience externe.
code language-shell |
---|
|
Réponse
Une réponse réussie renvoie un état HTTP 200 avec une liste d’exécutions d’ingestion pour l’audience externe spécifiée.
code language-json |
---|
|
table 0-row-3 1-row-3 | ||
---|---|---|
Propriété | Type | Description |
runs |
Objet | Objet contenant la liste des exécutions d’ingestion appartenant à l’audience. Vous trouverez plus d’informations sur cet objet dans la section récupérer le statut de l’ingestion. |
Suppression d’une audience externe delete-audience
audienceId
de votre audience externe. Vous pouvez obtenir votre audienceId
d’un appel réussi au point d’entrée GET /external-audiences/operations/{OPERATION_ID}
.Vous pouvez supprimer une audience externe en effectuant une requête DELETE au point d’entrée suivant tout en fournissant l’identifiant d’audience.
Format d’API
DELETE /external-audience/{AUDIENCE_ID}
Requête
La requête suivante supprime l’audience externe spécifiée.
code language-shell |
---|
|
Réponse
Une réponse réussie renvoie un état HTTP 204 avec un corps de réponse vide.
Étapes suivantes next-steps
Vous êtes arrivé au bout de ce guide. À présent, vous comprenez mieux comment créer, gérer et supprimer vos audiences externes à l’aide des API d’Experience Platform. Pour savoir comment utiliser des audiences externes avec l’interface utilisateur d’Experience Platform, consultez la documentation du portail Audience.
Annexe appendix
La section suivante répertorie les codes d’erreur disponibles lors de l’utilisation de l’API des audiences externes.
BAD_REQUEST
BAD_REQUEST
UNAUTHORIZED
UNAUTHORIZED
imsOrgId
non valide est fourni.UNAUTHORIZED
NOT_FOUND
DUPLICATE_RESOURCE
UNPROCESSABLE_ENTITY
INTERNAL_SERVER_ERROR
BAD_GATEWAY