Point d’entrée des libellés
Les libellés dʼutilisation des données vous permettent de classer les données en fonction des politiques dʼutilisation qui peuvent sʼappliquer à ces données. Le point d’entrée /labels dans Policy Service API vous permet de gérer par programme les libellés dʼutilisation des données dans votre application Experience.
/labels nʼest utilisé que pour la récupération, la création et la mise à jour des libellés dʼutilisation des données. Vous ne pouvez pas supprimer les libellés. Cependant, vous pouvez ajouter ou supprimer des libellés aux jeux de données et aux champs à l’aide d’appels API. Reportez-vous au guide sur le document gestion des libellés de jeu de données pour obtenir des instructions.Prise en main
Le point d’entrée dʼAPI utilisé dans ce guide fait partie de Policy Service API. Avant de continuer, consultez le guide de prise en main pour obtenir des liens vers la documentation associée, un guide de lecture des exemples dʼappels API dans ce document et des informations importantes sur les en-têtes requis pour réussir des appels à nʼimporte quel API dʼExperience Platform.
Récupération dʼune liste de libellés list
Vous pouvez répertorier tous les libellés core ou custom en réalisant une requête GET à /labels/core ou /labels/custom, respectivement.
Format d’API
GET /labels/core
GET /labels/custom
Requête
La requête suivante répertorie tous les libellés personnalisés créés dans votre organisation.
curl -X GET \
'https://platform.adobe.io/data/foundation/dulepolicy/labels/custom' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Réponse
Une réponse réussie renvoie une liste de libellés personnalisés récupérés du système. Étant donné que lʼexemple de requête ci-dessus a été envoyé à /labels/custom, la réponse ci-dessous nʼaffiche que les libellés personnalisés.
{
"_page": {
"count": 2
},
"_links": {
"page": {
"href": "https://platform.adobe.io:443/data/foundation/dulepolicy/labels/custom?{?limit,start,property}",
"templated": true
}
},
"children": [
{
"name": "L1",
"category": "Custom",
"friendlyName": "Banking Information",
"description": "Data containing banking information for a customer.",
"imsOrg": "{ORG_ID}",
"sandboxName": "{SANDBOX_NAME}",
"created": 1594396718731,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1594396718731,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {
"self": {
"href": "https://platform.adobe.io:443/data/foundation/dulepolicy/labels/custom/L1"
}
}
},
{
"name": "L2",
"category": "Custom",
"friendlyName": "Purchase History Data",
"description": "Data containing information on past transactions",
"imsOrg": "{ORG_ID}",
"sandboxName": "{SANDBOX_NAME}",
"created": 1594397415663,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1594397728708,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {
"self": {
"href": "https://platform.adobe.io:443/data/foundation/dulepolicy/labels/custom/L2"
}
}
}
]
}
Recherche dʼun libellé look-up
Vous pouvez rechercher un libellé spécifique en incluant la propriété name de ce libellé dans le chemin dʼune requête GET à lʼAPI Policy Service.
Format d’API
GET /labels/core/{LABEL_NAME}
GET /labels/custom/{LABEL_NAME}
{LABEL_NAME}name du libellé personnalisé que vous souhaitez rechercher.Requête
La requête suivante récupère le libellé personnalisé L2, comme indiqué dans le chemin.
curl -X GET \
'https://platform.adobe.io/data/foundation/dulepolicy/labels/custom/L2' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Réponse
Une réponse réussie renvoie les détails du libellé personnalisé.
{
"name": "L2",
"category": "Custom",
"friendlyName": "Purchase History Data",
"description": "Data containing information on past transactions",
"imsOrg": "{ORG_ID}",
"sandboxName": "{SANDBOX_NAME}",
"created": 1594397415663,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1594397728708,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {
"self": {
"href": "https://platform.adobe.io:443/data/foundation/dulepolicy/labels/custom/L2"
}
}
}
Création ou mise à jour dʼun libellé personnalisé create-update
Pour créer ou mettre à jour un libellé personnalisé, vous devez envoyer une requête PUT à lʼAPI Policy Service.
Format d’API
PUT /labels/custom/{LABEL_NAME}
{LABEL_NAME}name dʼun libellé personnalisé. Si aucun libellé personnalisé portant ce nom nʼexiste, un nouveau libellé est créé. Sʼil en existe un, ce libellé sera mis à jour.Requête
La requête suivante crée un nouveau libellé, L3, qui vise à décrire les données contenant des informations relatives aux plans de paiement choisis par les clientes et les clients.
curl -X PUT \
'https://platform.adobe.io/data/foundation/dulepolicy/labels/custom/L3' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '{
"name": "L3",
"category": "Custom",
"friendlyName": "Payment Plan",
"description": "Data containing information on selected payment plans."
}'
namecategoryCustom si vous souhaitez que le libellé apparaisse dans lʼinterface utilisateur.friendlyNamedescriptionRéponse
Une réponse réussie renvoie les détails du libellé personnalisé, avec le code HTTP 200 (OK) si un libellé existant a été mis à jour, ou 201 (Created) si un nouveau libellé a été créé.
{
"name": "L3",
"category": "Custom",
"friendlyName": "Payment Plan",
"description": "Data containing information on selected payment plans.",
"imsOrg": "{ORG_ID}",
"sandboxName": "{SANDBOX_NAME}",
"created": 1529696681413,
"createdClient": "{CLIENT_ID}",
"createdUser": "{USER_ID}",
"updated": 1529697651972,
"updatedClient": "{CLIENT_ID}",
"updatedUser": "{USER_ID}",
"_links": {
"self": {
"href": "https://platform.adobe.io:443/data/foundation/dulepolicy/labels/custom/L3"
}
}
}
Étapes suivantes
Ce guide couvre lʼutilisation du point d’entrée /labels dans lʼAPI Policy Service. Pour obtenir des instructions détaillées sur lʼapplication de libellés aux jeux de données et aux champs, consultez le guide de lʼAPI des libellés des jeux de données.