DocumentazioneExperience PlatformGuida alla governance dei dati

Endpoint "labels"

Last update: Thu Aug 01 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Argomenti:

Creato per:

  • Sviluppatore

Le etichette di utilizzo dei dati consentono di categorizzare i dati in base ai criteri di utilizzo applicabili a tali dati. L'endpoint /labels in Policy Service API consente di gestire in modo programmatico le etichette di utilizzo dei dati all'interno dell'applicazione Experience.

NOTE
L'endpoint /labels viene utilizzato solo per recuperare, creare e aggiornare le etichette di utilizzo dei dati. Non è possibile eliminare le etichette. Tuttavia, puoi aggiungere o rimuovere etichette ai set di dati e ai campi utilizzando le chiamate API. Per istruzioni, consulta la guida nel documento gestione delle etichette dei set di dati.

Introduzione

L'endpoint API utilizzato in questa guida fa parte di Policy Service API. Prima di continuare, consulta 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 necessarie per effettuare correttamente le chiamate a qualsiasi API Experience Platform.

Recuperare un elenco di etichette list

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

Formato API

GET /labels/core
GET /labels/custom

Richiesta

Nella richiesta seguente sono elencate tutte le etichette personalizzate create nell’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

In caso di esito positivo, la risposta restituisce un elenco di etichette personalizzate recuperate dal sistema. Poiché la richiesta di esempio precedente è stata effettuata a /labels/custom, la risposta seguente mostra solo 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"
                }
            }
        }
    ]
}

Cercare un’etichetta look-up

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

Formato API

GET /labels/core/{LABEL_NAME}
GET /labels/custom/{LABEL_NAME}
Parametro
Descrizione
{LABEL_NAME}
La proprietà 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

In caso di esito positivo, la risposta 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 create-update

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

NOTE
Se si desidera rimuovere le etichette da un set di dati, è possibile eseguire una richiesta PUT sull'API del servizio Set di dati oppure utilizzare l'interfaccia utente Set di dati.

Formato API

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

Richiesta

La richiesta seguente crea una nuova etichetta, L3, che ha lo scopo di descrivere i dati contenenti 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: {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
Un identificatore di stringa univoco per l’etichetta. Questo valore viene utilizzato a scopo di ricerca e per applicare l’etichetta a set di dati e campi, pertanto si consiglia che sia breve e conciso.
category
Categoria dell’etichetta. Sebbene sia possibile creare categorie personalizzate per le etichette personalizzate, si consiglia vivamente di utilizzare 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

In caso di esito positivo, la risposta 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 descrive l'utilizzo dell'endpoint /labels nell'API del servizio criteri. Per i passaggi su come applicare etichette a set di dati e campi, consulta la guida API per le etichette dei set di dati.

recommendation-more-help
834e0cae-2761-454a-be4d-62f0fd4b4456