Point d’entrée de l’API des attributs calculés
Les attributs calculés sont des fonctions utilisées pour regrouper des données au niveau de l’événement en attributs au niveau du profil. Ces fonctions sont automatiquement calculées afin de pouvoir être utilisées au niveau de la segmentation, de l’activation et de la personnalisation. Ce guide comprend des exemples d’appels API pour effectuer des opérations CRUD de base à l’aide du point d’entrée /attributes.
Pour en savoir plus sur les attributs calculés, commencez par lire la présentation des attributs calculés.
Prise en main
Le point d’entrée de l’API utilisé dans ce guide fait partie de l’API Real-Time Customer Profile.
Avant de poursuivre, consultez le Guide de prise en main de l’API Profile pour obtenir des liens vers la documentation recommandée, un guide de lecture des exemples d’appels API qui apparaissent dans ce document et des informations importantes sur les en-têtes requis pour réussir des appels vers n’importe quelle API Experience Platform.
De plus, veuillez consulter la documentation pour le service suivant :
- Experience Data Model (XDM) System : cadre normalisé selon lequel Experience Platform organise les données de l’expérience client.
- Guide de prise en main du registre des schémas : des informations sur votre
{TENANT_ID}, qui apparaissent dans les réponses de ce guide, sont fournies.
- Guide de prise en main du registre des schémas : des informations sur votre
Récupération d’une liste d’attributs calculés list
Vous pouvez récupérer une liste de tous les attributs calculés pour votre organisation en envoyant une requête GET au point d’entrée /attributes.
Format d’API
Le point d’entrée /attributes 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, tous les attributs calculés disponibles pour votre organisation sont récupérés. Plusieurs paramètres peuvent être inclus et séparés par des esperluettes (&).
GET /attributes
GET /attributes?{QUERY_PARAMETERS}
Les paramètres de requête suivants peuvent être utilisés lors de la récupération d’une liste d’attributs calculés :
limitlimit=20offsetoffset=5sortByname, status, updateEpoch et createEpoch. Vous pouvez également choisir d’effectuer un tri par ordre croissant ou décroissant en n’incluant pas de - devant l’option de tri. Par défaut, les éléments sont triés par updateEpoch dans l’ordre décroissant.sortBy=namepropertyParamètre qui permet de filtrer différents champs d’attributs calculés. Les propriétés prises en charge sont name, createEpoch, mergeFunction.value, updateEpoch et status. Les opérations prises en charge dépendent de la propriété répertoriée.
name:EQUAL(=),NOT_EQUAL(!=),CONTAINS(=contains()),NOT_CONTAINS(=!contains())createEpoch:GREATER_THAN_OR_EQUALS(<=),LESS_THAN_OR_EQUALS(>=)mergeFunction.value:EQUAL(=),NOT_EQUAL(!=),CONTAINS(=contains()),NOT_CONTAINS(=!contains())updateEpoch:GREATER_THAN_OR_EQUALS(<=),LESS_THAN_OR_EQUALS(>=)status:EQUAL(=),NOT_EQUAL(!=),CONTAINS(=contains()),NOT_CONTAINS(=!contains())
property=updateEpoch>=1683669114845property=name!=testingreleaseproperty=status=contains(new,processing,disabled)Requête
La requête suivante récupère les trois derniers attributs calculés qui ont été mis à jour dans votre organisation.
| code language-shell |
|---|
|
Réponse
Une réponse réussie renvoie le statut HTTP 200 avec une liste des 3 derniers attributs calculés mis à jour appartenant à votre organisation et à votre sandbox.
| code language-json |
|---|
|
| table 0-row-2 1-row-2 2-row-2 3-row-2 | |
|---|---|
| Propriété | Description |
_links |
Objet contenant les informations de pagination requises pour accéder à la dernière page de résultats, à la page de résultats suivante, à la page de résultats précédente ou à la page de résultats actuelle. |
computedAttributes |
Un tableau qui contient les attributs calculés en fonction de vos paramètres de requête. Vous trouverez plus d’informations sur le tableau des attributs calculés dans la section récupérer un attribut calculé spécifique. |
_page |
Objet contenant des métadonnées sur les résultats renvoyés. Cela inclut des informations sur le décalage actuel, le nombre d’attributs calculés renvoyés, le nombre total d’attributs calculés, ainsi que la limite d’attributs calculés renvoyés. |
Création d’un attribut calculé create
Pour créer un attribut calculé, commencez par envoyer une requête POST au point d’entrée /attributes avec un corps de requête contenant les détails de l’attribut calculé que vous souhaitez créer.
Format d’API
POST /attributes
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 9-row-2 10-row-2 11-row-2 12-row-2 | |
|---|---|
| Propriété | Description |
name |
Nom du champ d’attribut calculé, sous la forme d’une chaîne. Le nom de l’attribut calculé ne peut être composé que de caractères alphanumériques, sans espaces ni traits de soulignement. Cette valeur doit est unique parmi tous les attributs calculés. En règle générale, ce nom doit être une version CamelCase du displayName. |
description |
Une description de l’attribut calculé. Cela s’avère particulièrement utile une fois que plusieurs attributs calculés ont été définis, car cela permet à d’autres membres de votre organisation de déterminer l’attribut calculé correct à utiliser. |
displayName |
Nom d’affichage de l’attribut calculé. Il s’agit du nom qui s’affiche lorsque les attributs calculés sont répertoriés dans l’interface utilisateur de Adobe Experience Platform. |
expression |
Objet représentant l’expression de requête de l’attribut calculé que vous essayez de créer. |
expression.type |
Type de l’expression. Actuellement, seul PQL est pris en charge. |
expression.format |
Format de l’expression. Actuellement, seul pql/text est pris en charge. |
expression.value |
Valeur de l’expression. |
keepCurrent |
Valeur booléenne qui détermine si la valeur de l’attribut calculé est maintenue à jour à l’aide de l’actualisation rapide. Actuellement, cette valeur doit être définie sur false. |
duration |
Objet représentant la période de recherche en amont de l’attribut calculé. La période de recherche en amont représente la durée sur laquelle une recherche en amont peut être effectuée pour calculer l’attribut calculé. |
duration.count |
Nombre représentant la durée de la période de recherche en amont. Les valeurs possibles dépendent de la valeur du champ
|
duration.unit |
Chaîne représentant l’unité de temps qui sera utilisée pour la période de recherche en amont. Les valeurs possibles sont les suivantes : HOURS, DAYS, WEEKS et MONTHS. |
status |
Statut de l’attribut calculé. Les valeurs possibles sont DRAFT et NEW. |
Réponse
Une réponse réussie renvoie un état HTTP 200 avec des informations sur l’attribut calculé que vous venez de créer.
| code language-json |
|---|
|
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 | |
|---|---|
| Propriété | Description |
id |
L’identifiant généré par le système de votre nouvel attribut calculé. |
status |
Statut de l’attribut calculé. Il peut s’agir de DRAFT ou de NEW. |
createEpoch |
Heure à laquelle l’attribut calculé a été créé, en secondes. |
updateEpoch |
Heure à laquelle la dernière mise à jour de l’attribut calculé a été effectuée, en secondes. |
createdBy |
Identifiant de l’utilisateur qui a créé l’attribut calculé. |
Récupération d’un attribut calculé spécifique get
Vous pouvez récupérer des informations détaillées sur un attribut calculé spécifique en adressant une requête GET au point d’entrée /attributes et en fournissant l’identifiant de l’attribut calculé que vous souhaitez récupérer dans le chemin de requête.
Format d’API
GET /attributes/{ATTRIBUTE_ID}
Requête
| code language-shell |
|---|
|
Réponse
Une réponse réussie renvoie un état HTTP 200 avec des informations détaillées sur l’attribut calculé spécifié.
| code language-json |
|---|
|
| 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 12-row-2 13-row-2 14-row-2 15-row-2 16-row-2 17-row-2 | |
|---|---|
| Propriété | Description |
id |
Un identifiant unique, en lecture seule, généré par le système que vous pouvez utiliser pour faire référence à l’attribut calculé pendant les autres opérations API. |
type |
Chaîne qui indique que l’objet renvoyé est un attribut calculé. |
name |
Nom de l’attribut calculé. |
displayName |
Nom d’affichage de l’attribut calculé. Il s’agit du nom qui s’affiche lorsque les attributs calculés sont répertoriés dans l’interface utilisateur de Adobe Experience Platform. |
description |
Une description de l’attribut calculé. Cela s’avère particulièrement utile une fois que plusieurs attributs calculés ont été définis, car cela permet à d’autres membres de votre organisation de déterminer l’attribut calculé correct à utiliser. |
imsOrgId |
Identifiant de l’organisation à laquelle appartient l’attribut calculé. |
sandbox |
L’objet Sandbox contient des détails sur le sandbox sur lequel l’attribut calculé a été configuré. Ces informations sont tirées de l’en-tête du sandbox envoyé dans la requête. Pour plus d’informations, consultez la présentation des sandbox. |
path |
path de l’attribut calculé. |
keepCurrent |
Valeur booléenne qui détermine si la valeur de l’attribut calculé est maintenue à jour à l’aide de l’actualisation rapide. |
expression |
Objet contenant l’expression de l’attribut calculé. |
mergeFunction |
Objet contenant la fonction de fusion pour l’attribut calculé. Cette valeur est basée sur le paramètre d’agrégation correspondant dans l’expression de l’attribut calculé. Les valeurs possibles sont SUM, MIN, MAX et MOST_RECENT. |
status |
Statut de l’attribut calculé. Il peut s’agir de l’une des valeurs suivantes : DRAFT, NEW, INITIALIZING, PROCESSING, PROCESSED, FAILED ou DISABLED. |
schema |
Objet contenant des informations sur le schéma dans lequel l’expression est évaluée. Actuellement, seul _xdm.context.profile est pris en charge. |
lastEvaluationTs |
Date et heure de la dernière évaluation de l’attribut calculé. |
createEpoch |
Heure à laquelle l’attribut calculé a été créé, en secondes. |
updateEpoch |
Heure à laquelle la dernière mise à jour de l’attribut calculé a été effectuée, en secondes. |
createdBy |
Identifiant de l’utilisateur qui a créé l’attribut calculé. |
Suppression d’un attribut calculé spécifique delete
Vous pouvez supprimer un attribut calculé spécifique en adressant une requête DELETE au point d’entrée /attributes et en fournissant l’identifiant de l’attribut calculé que vous souhaitez supprimer du chemin de requête.
DRAFT). Ce point d’entrée impossible peut être utilisé pour supprimer des attributs calculés dans un autre état.Format d’API
DELETE /attributes/{ATTRIBUTE_ID}
{ATTRIBUTE_ID}id de l’attribut calculé que vous souhaitez supprimer.Requête
| code language-shell |
|---|
|
Réponse
Une réponse réussie renvoie le statut HTTP 202 avec les détails de l’attribut calculé supprimé.
| code language-json |
|---|
|
Mettre à jour un attribut calculé spécifique
Vous pouvez mettre à jour un attribut calculé spécifique en adressant une requête PATCH au point d’entrée /attributes et en fournissant l’identifiant de l’attribut calculé que vous souhaitez mettre à jour dans le chemin de requête.
- Si le statut actuel est
NEW, le statut ne peut être modifié qu’enDISABLED. - Si le statut actuel est
DRAFT, vous pouvez modifier les valeurs des champs suivants :name,description,keepCurrent,expressionetduration. Vous pouvez également modifier le statut deDRAFTenNEW. Toute modification apportée aux champs générés par le système, tels quemergeFunctionoupath, renvoie une erreur. - Si le statut actuel est soit
PROCESSINGsoitPROCESSED, le statut peut uniquement être modifié enDISABLED.
Format d’API
PATCH /attributes/{ATTRIBUTE_ID}
{ATTRIBUTE_ID}id de l’attribut calculé à mettre à jour.Requête
La requête suivante met à jour le statut de l’attribut calculé de DRAFT vers NEW.
| code language-shell |
|---|
|
Réponse
Une réponse réussie renvoie un état HTTP 200 avec des informations sur votre attribut calculé nouvellement mis à jour.
| code language-json |
|---|
|
Étapes suivantes
Maintenant que vous avez appris les principes de base des attributs calculés, vous êtes prêt à commencer à les définir pour votre organisation. Pour savoir comment utiliser les attributs calculés dans l’interface utilisateur d’Experience Platform, consultez le guide de l’interface utilisateur des attributs calculés.