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.
Commencer
Le point de terminaison d’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 les appels à une API Experience Platform.
En outre, veuillez consulter la documentation du 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 de GET au point de terminaison /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 de gestion élevés lors de l’inscription de ressources. Si vous effectuez un appel vers ce point de terminaison sans paramètres, tous les attributs calculés disponibles pour votre organisation seront 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 :
limit
limit=20
offset
offset=5
sortBy
name
, status
, updateEpoch
et createEpoch
. Vous pouvez également choisir de trier dans l’ordre croissant ou décroissant en n’incluant pas ou en incluant une -
devant l’option de tri. Par défaut, les éléments seront triés par updateEpoch
dans l’ordre décroissant.sortBy=name
property
Paramètre permettant de filtrer les données selon différents champs d’attribut 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>=1683669114845
property=name!=testingrelease
property=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 un état HTTP 200 avec une liste des 3 derniers attributs calculés mis à jour appartenant à votre organisation et votre environnement de test.
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 nécessaires 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 active. |
computedAttributes |
Tableau contenant les attributs calculés en fonction de vos paramètres de requête. Vous trouverez plus d’informations sur le tableau d’attributs calculés dans la section de récupération d’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 des attributs calculés renvoyés. |
Création d’un attribut calculé create
Pour créer un attribut calculé, commencez par effectuer une requête de POST sur le point de terminaison /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 attribut calculé, sous forme de 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 must doit être unique parmi tous les attributs calculés. En règle générale, ce nom doit être une version CamelCase de 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 aidera d’autres membres de votre organisation à déterminer l’attribut calculé correct à utiliser. |
displayName |
Nom d’affichage de l’attribut calculé. Il s’agit du nom qui s’affichera lors de la liste de vos attributs calculés dans l’interface utilisateur de Adobe Experience Platform. |
expression |
Un objet qui représente 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 |
La valeur de l’expression. |
keepCurrent |
Valeur booléenne qui détermine si la valeur de l’attribut calculé est actualisée ou non à l’aide d’une actualisation rapide. Actuellement, cette valeur doit être définie sur false . |
duration |
Objet qui représente la période de recherche arrière de l’attribut calculé. La période de recherche en amont représente le délai dans lequel il est possible de revenir en arrière pour calculer l’attribut calculé. |
duration.count |
Un nombre qui représente 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 arrière. Les valeurs possibles sont les suivantes : HOURS , DAYS , WEEKS et MONTHS . |
status |
État 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 votre 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 attribut calculé nouvellement créé. |
status |
État 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 l’attribut calculé a été mis à jour pour la dernière fois, en secondes. |
createdBy |
L’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 effectuant une requête de GET sur le point de terminaison /attributes
et en fournissant l’identifiant de l’attribut calculé que vous souhaitez récupérer dans le chemin d’accès de la 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 indiquant 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’affichera lors de la liste de vos attributs calculé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 aidera d’autres membres de votre organisation à déterminer l’attribut calculé correct à utiliser. |
imsOrgId |
L’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 à l’attribut calculé. |
keepCurrent |
Valeur booléenne qui détermine si la valeur de l’attribut calculé est actualisée ou non à l’aide d’une 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 |
État 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 |
Horodatage qui représente le moment où l’attribut calculé a été évalué pour la dernière fois. |
createEpoch |
Heure à laquelle l’attribut calculé a été créé, en secondes. |
updateEpoch |
Heure à laquelle l’attribut calculé a été mis à jour pour la dernière fois, en secondes. |
createdBy |
L’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 effectuant une requête de DELETE sur le point de terminaison /attributes
et en fournissant l’identifiant de l’attribut calculé que vous souhaitez supprimer dans le chemin d’accès de la requête.
DRAFT
). Ce point d’entrée ne peut pas ê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 un état HTTP 202 avec les détails de l’attribut calculé supprimé.
code language-json |
---|
|
Mise à jour d’un attribut calculé spécifique
Vous pouvez mettre à jour un attribut calculé spécifique en effectuant une requête de PATCH sur le point de terminaison /attributes
et en fournissant l’identifiant de l’attribut calculé que vous souhaitez mettre à jour dans le chemin d’accès de la requête.
- Si l’état actuel est
NEW
, l’état peut uniquement être modifié enDISABLED
. - Si l’état actuel est
DRAFT
, vous pouvez modifier les valeurs des champs suivants :name
,description
,keepCurrent
,expression
etduration
. Vous pouvez également modifier l’état deDRAFT
àNEW
. Toutes les modifications apportées aux champs générés par le système, tels quemergeFunction
oupath
, renverront une erreur. - Si l’état actuel est
PROCESSING
ouPROCESSED
, l’état peut uniquement être modifié enDISABLED
.
Format d’API
PATCH /attributes/{ATTRIBUTE_ID}
{ATTRIBUTE_ID}
id
de l’attribut calculé que vous souhaitez mettre à jour.Requête
La requête suivante mettra à jour l’état de l’attribut calculé de DRAFT
à NEW
.
code language-shell |
---|
|
Réponse
Une réponse réussie renvoie un état HTTP 200 avec des informations sur votre attribut calculé que vous venez de mettre à jour.
code language-json |
---|
|
Étapes suivantes
Maintenant que vous avez appris les bases 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 de l’Experience Platform, consultez le guide de l’interface utilisateur des attributs calculés.