Show Menu
TEMAS×

Administrar etiquetas de uso de datos mediante API

La API de servicio de dataset permite administrar mediante programación etiquetas de uso para conjuntos de datos. Forma parte de las funciones del catálogo de datos de Adobe Experience Platform, pero está separado de la API del servicio de catálogos, que administra los metadatos del conjunto de datos.
Este documento proporciona pasos sobre cómo administrar las etiquetas de uso de datos a nivel de conjunto de datos y campo mediante la API de servicio de DataSet.

Primeros pasos

Para realizar llamadas a los extremos descritos en las secciones siguientes, debe tener el valor único id de un conjunto de datos específico. Si no tiene este valor, consulte la guía de listado de objetos de catálogo para encontrar los ID de los conjuntos de datos existentes.

Buscar etiquetas para un conjunto de datos

Puede buscar las etiquetas de uso de datos que se han aplicado a un conjunto de datos existente haciendo una solicitud GET.
Formato API
GET /datasets/{DATASET_ID}/labels

Parámetro
Descripción
{DATASET_ID}
El valor único id del conjunto de datos cuyas etiquetas desee buscar.
Solicitud
curl -X GET \
  'https://platform.adobe.io/data/foundation/dataset/datasets/5abd49645591445e1ba04f87/labels' \
  -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}'

Respuesta
Una respuesta correcta devuelve las etiquetas de uso de datos que se han aplicado al conjunto de datos.
{
  "AEP:dataset:5abd49645591445e1ba04f87": {
    "imsOrg": "{IMS_ORG}",
    "labels": [ "C1", "C2", "C3", "I1", "I2" ],
    "optionalLabels": [
      {
        "option": {
          "id": "https://ns.adobe.com/{TENANT_ID}/schemas/c6b1b09bc3f2ad2627c1ecc719826836",
          "contentType": "application/vnd.adobe.xed-full+json;version=1",
          "schemaPath": "/properties/repositoryCreatedBy"
        },
        "labels": [ "S1", "S2" ]
      }
    ]
  }
}

Propiedad
Descripción
labels
lista de las etiquetas de uso de datos que se han aplicado al conjunto de datos.
optionalLabels
lista de campos individuales dentro del conjunto de datos que tienen etiquetas de uso de datos aplicadas a ellos.

Aplicar etiquetas a un conjunto de datos

Puede crear un conjunto de etiquetas para un conjunto de datos proporcionándolas en la carga útil de una solicitud POST o PUT. El uso de cualquiera de estos métodos sobrescribe las etiquetas existentes y las reemplaza por las proporcionadas en la carga útil.
Formato API
POST /datasets/{DATASET_ID}/labels
PUT /datasets/{DATASET_ID}/labels

Parámetro
Descripción
{DATASET_ID}
El valor único id del conjunto de datos para el que está creando etiquetas.
Solicitud
La siguiente solicitud POST agrega una serie de etiquetas al conjunto de datos, así como un campo específico dentro de ese conjunto de datos. Los campos proporcionados en la carga útil son los mismos que se requerirían para una solicitud PUT.
curl -X POST \
  'https://platform.adobe.io/data/foundation/dataset/datasets/5abd49645591445e1ba04f87/labels' \
  -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}' \
  -H 'Content-Type: application/json' \
  -d '{
  "labels": [ "C1", "C2", "C3", "I1", "I2" ],
  "optionalLabels": [
    {
      "option": {
        "id": "https://ns.adobe.com/{TENANT_ID}/schemas/c6b1b09bc3f2ad2627c1ecc719826836",
        "contentType": "application/vnd.adobe.xed-full+json;version=1",
        "schemaPath": "/properties/repositoryCreatedBy"
      },
      "labels": [ "S1", "S2" ]
    }
  ]
}'

Propiedad
Descripción
labels
lista de las etiquetas de uso de datos que desea agregar al conjunto de datos.
optionalLabels
lista de cualquier campo individual dentro del conjunto de datos al que desee agregar etiquetas. Cada elemento de esta matriz debe tener las siguientes propiedades:
option :: Objeto que contiene los atributos del campo del Modelo de datos de experiencia (XDM). Se requieren las tres propiedades siguientes:
  • id: El valor de URI $id del esquema asociado al campo.
  • contentType: Tipo de contenido y número de versión del esquema. Esto debe tomar la forma de uno de los encabezados Buscar un recurso Accept válidos para una solicitud de búsqueda XDM.
  • schemaPath: Ruta al campo dentro del esquema del conjunto de datos.
labels :: lista de las etiquetas de uso de datos que desea agregar al campo.
Respuesta
Una respuesta correcta devuelve las etiquetas que se han agregado al conjunto de datos.
{
  "labels": [ "C1", "C2", "C3", "I1", "I2" ],
  "optionalLabels": [
    {
      "option": {
        "id": "https://ns.adobe.com/{TENANT_ID}/schemas/c6b1b09bc3f2ad2627c1ecc719826836",
        "contentType": "application/vnd.adobe.xed-full+json;version=1",
        "schemaPath": "/properties/repositoryCreatedBy"
      },
      "labels": [ "S1", "S2" ]
    }
  ]
}

Eliminar etiquetas para un conjunto de datos

Puede eliminar las etiquetas aplicadas a un conjunto de datos haciendo una solicitud de ELIMINACIÓN.
Formato API
DELETE /datasets/{DATASET_ID}/labels

Parámetro
Descripción
{DATASET_ID}
El valor único id del conjunto de datos cuyas etiquetas desee eliminar.
Solicitud
curl -X DELETE \
  'https://platform.adobe.io/data/foundation/dataset/datasets/5abd49645591445e1ba04f87/labels' \
  -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}'

Respuesta
Una respuesta correcta de estado HTTP 200 (Aceptar), que indica que se han eliminado las etiquetas. Puede buscar las etiquetas existentes para el conjunto de datos en una llamada separada para confirmarlo.

Pasos siguientes

Ahora que ha agregado etiquetas de uso de datos a nivel de conjunto de datos y campo, puede empezar a ingestar datos en la plataforma de experiencia. Para obtener más información, lea la documentación sobre la ingestión de datos para obtener inicios.
Ahora también puede definir directivas de uso de datos en función de las etiquetas que haya aplicado. Para obtener más información, consulte la descripción general de las directivas de uso de datos.
Para obtener más información sobre la administración de conjuntos de datos en Experience Platform, consulte la descripción general de conjuntos de datos.