Extremo de etiquetas

Última actualización: 2023-03-13
  • Creado para:
  • Developer
    User
    Admin
    Leader

Las etiquetas de uso de datos le permiten categorizar los datos según las políticas de uso que puedan aplicarse a esos datos. El /labels punto final en la Policy Service API le permite administrar mediante programación las etiquetas de uso de datos dentro de la aplicación de experiencia.

NOTA

El /labels el punto de conexión solo se utiliza para recuperar, crear y actualizar etiquetas de uso de datos. Para ver los pasos sobre cómo añadir etiquetas a conjuntos de datos y campos mediante llamadas a la API, consulte la guía de administrar etiquetas de conjuntos de datos.

Primeros pasos

El extremo de API utilizado en esta guía forma parte del Policy Service API. Antes de continuar, consulte la guía de introducción para obtener vínculos a documentación relacionada, una guía para leer las llamadas de API de ejemplo en este documento e información importante sobre los encabezados necesarios para realizar correctamente llamadas a cualquier Experience Platform API.

Recuperación de una lista de etiquetas

Puede enumerar todos core o custom mediante una solicitud de GET a /labels/core o /labels/custom, respectivamente.

Formato de API

GET /labels/core
GET /labels/custom

Solicitud

La siguiente solicitud enumera todas las etiquetas personalizadas creadas en su organización.

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}'

Respuesta

Una respuesta correcta devuelve una lista de etiquetas personalizadas recuperadas del sistema. Dado que la solicitud de ejemplo anterior se realizó a /labels/custom, la respuesta siguiente solo muestra etiquetas personalizadas.

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

Búsqueda de una etiqueta

Puede buscar una etiqueta específica incluyendo la de name propiedad en la ruta de una petición de GET a Policy Service API.

Formato de API

GET /labels/core/{LABEL_NAME}
GET /labels/custom/{LABEL_NAME}
Parámetro Descripción
{LABEL_NAME} El name de la etiqueta personalizada que desea buscar.

Solicitud

La siguiente solicitud recupera la etiqueta personalizada L2, tal como se indica en la ruta.

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}'

Respuesta

Una respuesta correcta devuelve los detalles de la etiqueta personalizada.

{
    "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"
        }
    }
}

Crear o actualizar una etiqueta personalizada

Para crear o actualizar una etiqueta personalizada, debe realizar una solicitud de PUT a Policy Service API.

Formato de API

PUT /labels/custom/{LABEL_NAME}
Parámetro Descripción
{LABEL_NAME} El name de una etiqueta personalizada. Si no existe una etiqueta personalizada con este nombre, se creará una nueva. Si existe una, se actualizará esa etiqueta.

Solicitud

La siguiente solicitud crea una etiqueta nueva, L3, que tiene como objetivo describir datos que contienen información relacionada con los planes de pago seleccionados de los clientes.

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."
      }'
Propiedad Descripción
name Un identificador de cadena único para la etiqueta. Este valor se utiliza con fines de búsqueda y para aplicar la etiqueta a conjuntos de datos y campos, por lo que se recomienda que sea corto y conciso.
category La categoría de la etiqueta. Aunque puede crear sus propias categorías para etiquetas personalizadas, se recomienda encarecidamente que utilice Custom si desea que la etiqueta aparezca en la interfaz de usuario.
friendlyName Un nombre descriptivo para la etiqueta, que se utiliza con fines de visualización.
description (Opcional) Una descripción de la etiqueta para proporcionar más contexto.

Respuesta

Una respuesta correcta devuelve los detalles de la etiqueta personalizada, con código HTTP 200 (OK) si se actualizó una etiqueta existente o 201 (Created) si se creó una etiqueta nueva.

{
  "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"
    }
  }
}

Pasos siguientes

Esta guía trata sobre el uso de /labels en la API del servicio de directivas. Para ver los pasos sobre cómo aplicar etiquetas a conjuntos de datos y campos, consulte la guía de API de etiquetas de conjuntos de datos.

Página anterior
Next page

En esta página