Création d’un modèle d’audience
platform.adobe.io/data/core/activation/authoring/audience-templatesPour certaines destinations créées à l’aide de Destination SDK, vous devez créer une configuration de métadonnées d’audience afin de concevoir, mettre à jour ou supprimer des métadonnées d’audience dans la destination par programmation. Cette page montre comment utiliser le point d’entrée /authoring/audience-templates de l’API pour créer la configuration.
Pour obtenir une description détaillée des fonctionnalités configurables avec ce point d’entrée, consultez l’article sur la gestion des métadonnées d’audience.
Prise en main des opérations de l’API des modèles d’audience get-started
Avant de poursuivre, consultez le guide de prise en main pour obtenir des informations importantes à connaître avant d’effectuer des appels vers l’API, notamment sur la manière d’obtenir l’autorisation de création de la destination et les en-têtes obligatoires.
Création d’un modèle d’audience create
Vous pouvez créer un modèle d’audience en effectuant une requête POST au point dʼentrée /authoring/audience-templates.
Format d’API
POST /authoring/audience-templates
La requête suivante crée un modèle d’audience configuré en fonction des paramètres fournis dans la payload. La payload ci-dessous inclut tous les paramètres acceptés par le point dʼentrée /authoring/audience-templates. Notez que vous n’avez pas à ajouter tous les paramètres à l’appel et que le modèle est personnalisable, conformément aux exigences de votre API.
| 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 12-row-3 layout-auto | ||
|---|---|---|
| Propriété | Type | Description |
name |
Chaîne | Nom du modèle de métadonnées d’audience pour la destination. Ce nom apparaît dans tout message d’erreur spécifique au partenaire dans l’interface utilisateur d’Experience Platform, suivi du message d’erreur analysé à partir de metadataTemplate.create.errorSchemaMap. |
url |
Chaîne | L’URL et le point d’entrée de votre API, qui est utilisée pour créer, mettre à jour, supprimer ou valider les audiences dans votre plateforme. Deux exemples de secteurs sont : https://adsapi.snapchat.com/v1/adaccounts/{{customerData.accountId}}/segments et https://api.linkedin.com/v2/dmpSegments/{{segment.alias}}. |
httpMethod |
Chaîne | Méthode utilisée sur votre point dʼentrée pour créer, mettre à jour, supprimer ou valider par programmation l’audience dans votre destination. Par exemple : POST, PUT, DELETE. |
headers.header |
Chaîne | Spécifie les en-têtes HTTP à ajouter à l’appel de votre API. Par exemple : "Content-Type". |
headers.value |
Chaîne | Indique la valeur des en-têtes HTTP à ajouter à l’appel de votre API. Par exemple : "application/x-www-form-urlencoded". |
requestBody |
Chaîne | Indique le contenu du corps du message qui doit être envoyé à votre API. Les paramètres qui doivent être ajoutés à l’objet requestBody dépendent des champs que votre API accepte. Pour obtenir un exemple, consultez le premier exemple de modèle dans le document sur les fonctionnalités des métadonnées d’audience. |
responseFields.name |
Chaîne | Spécifie les champs de réponse que votre API renvoie lorsqu’elle est appelée. Pour obtenir un exemple, consultez les exemples de modèles dans le document sur les fonctionnalités des métadonnées d’audience. |
responseFields.value |
Chaîne | Spécifie la valeur de tout champ de réponse que votre API renvoie lorsqu’elle est appelée. |
responseErrorFields.name |
Chaîne | Spécifie les champs de réponse que votre API renvoie lorsqu’elle est appelée. Pour obtenir un exemple, consultez les exemples de modèles dans le document sur les fonctionnalités des métadonnées d’audience. |
responseErrorFields.value |
Chaîne | Analyse tous les messages d’erreur renvoyés par les réponses d’appel API de la destination. Ces messages d’erreur seront affichés aux utilisateurs dans l’interface utilisateur d’Experience Platform. |
validations.field |
Chaîne | Indique si les validations doivent être exécutées pour tout champ avant que des appels d’API ne soient effectués vers votre destination. Par exemple, vous pouvez utiliser {{validations.accountId}} pour valider l’identifiant de compte de l’utilisateur. |
validations.regex |
Chaîne | Indique la structure du champ pour que la validation soit réussie. |
Gestion des erreurs d’API
Les points d’entrée de l’API Destination SDK suivent les principes généraux des messages d’erreur de l’API Experience Platform. Consultez les sections Codes dʼétat d’API et Erreurs dʼen-tête de requête dans le guide de dépannage de Platform.
Étapes suivantes
Vous êtes arrivé au bout de ce document. À présent, vous savez quand utiliser les modèles d’audience et comment configurer un modèle d’audience à l’aide du point dʼentrée /authoring/audience-templates de l’API. Consultez la documentation Comment utiliser Destination SDK pour configurer la destination afin de comprendre la place de cette étape dans le processus de configuration de la destination.