Endpoint etichette

Le etichette di utilizzo dei dati consentono di classificare i dati in base ai criteri di utilizzo che possono essere applicati a tali dati. L' /labels endpoint Policy Service API consente di gestire a livello di programmazione le etichette di utilizzo dei dati all'interno dell'applicazione dell'esperienza.

Nota

L' /labels endpoint viene utilizzato solo per recuperare, creare e aggiornare le etichette di utilizzo dei dati. Per i passaggi su come aggiungere etichette ai set di dati e ai campi utilizzando le chiamate API, fare riferimento alla guida sulla gestione delle etichettedi set di dati.

Introduzione

L'endpoint API utilizzato in questa guida fa parte dell'API Policy Service API. Prima di continuare, consultate la guida introduttiva per i collegamenti alla documentazione correlata, una guida alla lettura delle chiamate API di esempio in questo documento e informazioni importanti sulle intestazioni richieste necessarie per effettuare correttamente chiamate a qualsiasi Experience Platform API.

Recupero di un elenco di etichette

È possibile elencare tutte core o custom le etichette effettuando una richiesta di GET a /labels/core o, rispettivamente, /labels/custom.

Formato API

GET /labels/core
GET /labels/custom

Richiesta

Nella richiesta seguente sono elencate tutte le etichette personalizzate create all'interno dell'organizzazione.

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

Risposta

Una risposta corretta restituisce un elenco di etichette personalizzate recuperate dal sistema. Poiché la richiesta di esempio sopra è stata inoltrata a /labels/custom, la risposta riportata di seguito mostra solo le etichette personalizzate.

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

Cercare un'etichetta

Potete cercare un'etichetta specifica includendo la name proprietà dell'etichetta nel percorso di una richiesta di GET all' Policy Service API.

Formato API

GET /labels/core/{LABEL_NAME}
GET /labels/custom/{LABEL_NAME}
Parametro Descrizione
{LABEL_NAME} La name proprietà dell'etichetta personalizzata che si desidera cercare.

Richiesta

La richiesta seguente recupera l'etichetta personalizzata L2, come indicato nel percorso.

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

Risposta

Una risposta corretta restituisce i dettagli dell'etichetta personalizzata.

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

Creare o aggiornare un'etichetta personalizzata

Per creare o aggiornare un'etichetta personalizzata, dovete effettuare una richiesta di PUT all' Policy Service API.

Formato API

PUT /labels/custom/{LABEL_NAME}
Parametro Descrizione
{LABEL_NAME} La name proprietà di un'etichetta personalizzata. Se non esiste un'etichetta personalizzata con questo nome, verrà creata una nuova etichetta. Se ne esiste uno, l'etichetta verrà aggiornata.

Richiesta

La seguente richiesta crea una nuova etichetta L3, che ha lo scopo di descrivere i dati che contengono informazioni relative ai piani di pagamento selezionati dai clienti.

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."
      }'
Proprietà Descrizione
name Identificatore stringa univoco per l'etichetta. Questo valore viene utilizzato a scopo di ricerca e l'etichetta viene applicata a set di dati e campi, pertanto si consiglia di utilizzarlo in modo breve e conciso.
category La categoria dell'etichetta. Sebbene sia possibile creare categorie personalizzate per le etichette personalizzate, è comunque consigliabile utilizzarle Custom se si desidera che l'etichetta venga visualizzata nell'interfaccia utente.
friendlyName Un nome descrittivo per l'etichetta, utilizzato a scopo di visualizzazione.
description (Facoltativo) Una descrizione dell'etichetta per fornire ulteriore contesto.

Risposta

Una risposta corretta restituisce i dettagli dell'etichetta personalizzata, con codice HTTP 200 (OK) se un'etichetta esistente è stata aggiornata, oppure 201 (Creato) se è stata creata una nuova etichetta.

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

Passaggi successivi

Questa guida riguardava l'utilizzo dell' /labels endpoint nell'API del servizio criteri. Per i passaggi su come applicare etichette a set di dati e campi, consultare la guida API per le etichette deiset di dati.

In questa pagina