Point de terminaison des étiquettes

Les étiquettes d’utilisation des données vous permettent de classer les données en fonction des stratégies d’utilisation qui peuvent s’appliquer à ces données. Le /labels point de terminaison de la Policy Service API permet de gérer par programmation les étiquettes d’utilisation des données dans votre application d’expérience.

REMARQUE

Le /labels point de terminaison n’est utilisé que pour récupérer, créer et mettre à jour des étiquettes d’utilisation des données. Pour savoir comment ajouter des libellés aux jeux de données et aux champs à l’aide d’appels d’API, consultez le guide sur la gestion des libellésde jeux de données.

Prise en main

Le point de terminaison API utilisé dans ce guide fait partie du Policy Service API. Avant de continuer, consultez le guide de prise en main pour obtenir des liens vers la documentation connexe, un guide pour lire les exemples d'appels d'API dans ce document et des informations importantes concernant les en-têtes requis nécessaires pour passer des appels à toute Experience Platform API.

Retrieve a list of labels

Vous pouvez liste toutes les core étiquettes ou custom les étiquettes en faisant une demande de GET à /labels/core ou /labels/custom, respectivement.

Format d’API

GET /labels/core
GET /labels/custom

Requête

La requête suivante liste 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: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Réponse

Une réponse réussie renvoie une liste d'étiquettes personnalisées récupérées du système. L’exemple de demande ci-dessus ayant été envoyé à /labels/custom, la réponse ci-dessous affiche uniquement les étiquettes personnalisées.

{
    "_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": "{IMS_ORG}",
            "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": "{IMS_ORG}",
            "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"
                }
            }
        }
    ]
}

Rechercher une étiquette

Vous pouvez rechercher une étiquette spécifique en incluant la name propriété de cette étiquette dans le chemin d’une demande de GET à l’ Policy Service API.

Format d’API

GET /labels/core/{LABEL_NAME}
GET /labels/custom/{LABEL_NAME}
Paramètre Description
{LABEL_NAME} The name property of the custom label you want to look up.

Requête

La requête suivante récupère le libellé personnalisé L2, comme indiqué dans le chemin d’accès.

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: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Réponse

Une réponse réussie renvoie les détails de l’étiquette personnalisée.

{
    "name": "L2",
    "category": "Custom",
    "friendlyName": "Purchase History Data",
    "description": "Data containing information on past transactions",
    "imsOrg": "{IMS_ORG}",
    "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’une étiquette personnalisée

Pour créer ou mettre à jour une étiquette personnalisée, vous devez envoyer une requête de PUT à l’ Policy Service API.

Format d’API

PUT /labels/custom/{LABEL_NAME}
Paramètre Description
{LABEL_NAME} Propriété name d’une étiquette personnalisée. Si aucune étiquette personnalisée portant ce nom n’existe, une nouvelle étiquette est créée. S'il en existe un, cette étiquette sera mise à jour.

Requête

La demande suivante crée une nouvelle étiquette L3, qui vise à décrire des données contenant des informations relatives aux plans de paiement sélectionnés par 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: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
        "name": "L3",
        "category": "Custom",
        "friendlyName": "Payment Plan",
        "description": "Data containing information on selected payment plans."
      }'
Propriété Description
name Identifiant de chaîne unique pour l’étiquette. Cette valeur est utilisée à des fins de recherche et d’application de l’étiquette aux jeux de données et aux champs. Il est donc recommandé qu’elle soit courte et concise.
category Catégorie de l'étiquette. Bien que vous puissiez créer vos propres catégories pour les étiquettes personnalisées, il est vivement recommandé de les utiliser Custom si vous souhaitez qu’elles apparaissent dans l’interface utilisateur.
friendlyName Nom convivial de l’étiquette, utilisé à des fins d’affichage.
description (Facultatif) Description de l’étiquette afin de fournir un contexte plus poussé.

Réponse

Une réponse réussie renvoie les détails d'une étiquette personnalisée, avec le code HTTP 200 (OK) si une étiquette existante a été mise à jour, ou 201 (Créée) si une nouvelle étiquette a été créée.

{
  "name": "L3",
  "category": "Custom",
  "friendlyName": "Payment Plan",
  "description": "Data containing information on selected payment plans.",
  "imsOrg": "{IMS_ORG}",
  "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 traite de l’utilisation du point de /labels terminaison dans l’API Policy Service. Pour savoir comment appliquer des étiquettes à des jeux de données et à des champs, consultez le guide de l'API des étiquettes dejeux de données.

Sur cette page