Endpoint etichette

Le etichette per l’utilizzo dei dati ti consentono di classificare i dati in base a criteri di utilizzo che possono essere applicati a tali dati. La /labels punto finale Policy Service API consente di gestire in modo programmatico le etichette di utilizzo dei dati all’interno dell’applicazione di esperienza.

NOTA

La /labels l’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, consulta la guida su gestione delle etichette dei set di dati.

Introduzione

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

Recupera un elenco di etichette

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

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

Risposta

Una risposta corretta restituisce un elenco di etichette personalizzate recuperate dal sistema. Poiché la richiesta di esempio di cui sopra è stata fatta a /labels/custom, la risposta seguente 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": "{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"
                }
            }
        }
    ]
}

Cerca un'etichetta

Puoi cercare un’etichetta specifica includendo le etichette name nel percorso di una richiesta di GET al Policy Service API.

Formato API

GET /labels/core/{LABEL_NAME}
GET /labels/custom/{LABEL_NAME}
Parametro Descrizione
{LABEL_NAME} La name 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: {ORG_ID}' \
  -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": "{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"
        }
    }
}

Creare o aggiornare un’etichetta personalizzata

Per creare o aggiornare un’etichetta personalizzata, è necessario effettuare una richiesta di PUT al 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 esiste, 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 dalla clientela.

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."
      }'
Proprietà Descrizione
name Identificatore stringa univoco per l'etichetta. Questo valore viene utilizzato a scopo di ricerca e applica l’etichetta ai set di dati e ai campi, pertanto si consiglia di breve e concisa.
category La categoria dell'etichetta. Mentre è possibile creare categorie personalizzate per le etichette personalizzate, si consiglia vivamente di utilizzare Custom se desideri 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 è stata aggiornata un’etichetta esistente, 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": "{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"
    }
  }
}

Passaggi successivi

Questa guida ha trattato l'uso del /labels endpoint nell'API del servizio criteri. Per i passaggi su come applicare etichette ai set di dati e ai campi, consulta la sezione guida API per le etichette dei set di dati.

In questa pagina