Gestire le etichette di utilizzo dei dati per i set di dati tramite API

La Dataset Service API consente di applicare e modificare le etichette di utilizzo per i set di dati. Fa parte delle funzionalità del catalogo dati di Adobe Experience Platform, ma è separato dal Catalog Service API che gestisce i metadati del set di dati.

Questo documento illustra come gestire le etichette per i set di dati e i campi utilizzando Dataset Service API. Per i passaggi su come gestire direttamente le etichette di utilizzo dei dati utilizzando le chiamate API, vedi guida all’endpoint delle etichette per Policy Service API.

Introduzione

Prima di leggere questa guida, segui i passaggi descritti in sezione guida introduttiva nella guida per gli sviluppatori del catalogo per raccogliere le credenziali necessarie per effettuare chiamate a Platform API.

Per effettuare chiamate agli endpoint descritti in questo documento, è necessario disporre di id per un set di dati specifico. Se non disponi di questo valore, consulta la guida su elenco degli oggetti del catalogo per trovare gli ID dei set di dati esistenti.

Cercare etichette per un set di dati

Puoi cercare le etichette di utilizzo dei dati applicate a un set di dati esistente effettuando una richiesta di GET al Dataset Service API.

Formato API

GET /datasets/{DATASET_ID}/labels
Parametro Descrizione
{DATASET_ID} L'unico id valore del set di dati di cui si desidera cercare le etichette.

Richiesta

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

Risposta

Una risposta corretta restituisce le etichette di utilizzo dei dati applicate al set di dati.

{
  "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" ]
      }
    ]
  }
}
Proprietà Descrizione
labels Elenco di etichette di utilizzo dei dati applicate al set di dati.
optionalLabels Elenco di singoli campi all’interno del set di dati a cui sono applicate etichette di utilizzo dei dati.

Applicare etichette a un set di dati

Puoi creare un set di etichette per un set di dati fornendo loro nel payload di una richiesta di POST o PUT al Dataset Service API. L’utilizzo di uno di questi metodi sovrascrive le etichette esistenti e le sostituisce con quelle fornite nel payload.

Formato API

POST /datasets/{DATASET_ID}/labels
PUT /datasets/{DATASET_ID}/labels
Parametro Descrizione
{DATASET_ID} L'unico id valore del set di dati per cui si creano le etichette.

Richiesta

La richiesta PUT di esempio riportata di seguito aggiorna le etichette esistenti per un set di dati, nonché un campo specifico all’interno di tale set di dati. I campi forniti nel payload sono gli stessi richiesti per una richiesta POST.

Quando effettui chiamate API che aggiornano le etichette esistenti di un set di dati (PUT), un If-Match deve essere inclusa l’intestazione che indica la versione corrente dell’entità di etichetta del set di dati nel Servizio set di dati. Per evitare conflitti tra dati, il servizio aggiorna l’entità set di dati solo se la If-Match La stringa corrisponde al tag di versione più recente generato dal sistema per quel set di dati.

NOTA

Se non esistono attualmente etichette per il set di dati in questione, è possibile aggiungere nuove etichette solo tramite una richiesta POST, che non richiede un If-Match intestazione. Una volta aggiunte le etichette a un set di dati, un etag viene assegnato un valore che può essere utilizzato per aggiornare o rimuovere le etichette in un secondo momento.

Per recuperare la versione più recente dell’entità dataset-label, effettua una richiesta GET al /datasets/{DATASET_ID}/labels punto finale. Il valore corrente viene restituito nella risposta in un etag intestazione. Quando si aggiornano le etichette dei set di dati esistenti, si consiglia di eseguire prima una richiesta di ricerca per il set di dati al fine di recuperare le ultime etag prima di utilizzare tale valore nel If-Match intestazione della richiesta PUT successiva.

curl -X PUT \
  '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' \
  -H 'If-Match: 8f00d38e-0000-0200-0000-5ef4fc6d0000' \
  -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" ]
          }
        ]
      }'
Proprietà Descrizione
labels Elenco di etichette di utilizzo dei dati da aggiungere al set di dati.
optionalLabels Elenco di tutti i singoli campi all’interno del set di dati a cui si desidera aggiungere le etichette. Ogni elemento della matrice deve avere le seguenti proprietà:

option: Un oggetto che contiene Experience Data Model Attributi (XDM) del campo. Sono richieste le tre proprietà seguenti:
  • id: URI $id valore dello schema associato al campo.
  • contentType: Il tipo di contenuto e il numero di versione dello schema. Deve assumere la forma di uno dei Accetta intestazioni per una richiesta di ricerca XDM.
  • schemaPath: Percorso del campo nello schema del set di dati.
labels: Elenco di etichette di utilizzo dati da aggiungere al campo.

Risposta

Una risposta corretta restituisce il set aggiornato di etichette per il set di dati.

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

Passaggi successivi

Leggendo questo documento, hai imparato a gestire le etichette di utilizzo dei dati per i set di dati e i campi utilizzando Dataset Service API.

Dopo aver aggiunto le etichette di utilizzo dei dati a livello di set di dati e di campo, puoi iniziare a inserire i dati in Experience Platform. Per saperne di più, inizia leggendo il documentazione sull’acquisizione dei dati.

È inoltre possibile definire criteri di utilizzo dei dati in base alle etichette applicate. Per ulteriori informazioni, consulta la sezione panoramica dei criteri di utilizzo dei dati.

Per ulteriori informazioni sulla gestione dei set di dati in Experience Platform, vedi panoramica dei set di dati.

In questa pagina