Abilita un set di dati per Profile e Identity Service tramite API

Questo tutorial descrive il processo di abilitazione di un set di dati da utilizzare in Real-Time Customer Profile e Identity Service, suddiviso nei seguenti passaggi:

Introduzione

Questo tutorial richiede una buona conoscenza di diversi servizi Adobe Experience Platform coinvolti nella gestione dei set di dati abilitati per il profilo. Prima di iniziare questo tutorial, consulta la documentazione di questi servizi Platform correlati:

Le sezioni seguenti forniscono informazioni aggiuntive che sarà necessario conoscere per effettuare correttamente le chiamate alle API di Platform.

Lettura delle chiamate API di esempio

Questo tutorial fornisce esempi di chiamate API per dimostrare come formattare le richieste. Questi includono percorsi, intestazioni richieste e payload di richieste formattati correttamente. Viene inoltre fornito un codice JSON di esempio restituito nelle risposte API. Per informazioni sulle convenzioni utilizzate nella documentazione per le chiamate API di esempio, consulta la sezione su come leggere chiamate API di esempio nella guida alla risoluzione dei problemi di Experience Platform.

Raccogliere i valori per le intestazioni richieste

Per effettuare chiamate alle API Platform, devi prima completare l'esercitazione di autenticazione. Completando il tutorial sull’autenticazione si ottengono i valori per ciascuna delle intestazioni richieste in tutte le chiamate API di Experience Platform, come mostrato di seguito:

Tutte le richieste che contengono un payload (POST, PUT, PATCH) richiedono un'intestazione Content-Type aggiuntiva. Il valore corretto per questa intestazione viene mostrato nelle richieste di esempio, se necessario.

Tutte le risorse in Experience Platform sono isolate in specifiche sandbox virtuali. Tutte le richieste alle API Platform richiedono un'intestazione x-sandbox-name che specifichi il nome della sandbox in cui verrà eseguita l'operazione. Per ulteriori informazioni sulle sandbox in Platform, consulta la documentazione di panoramica sulle sandbox.

Creare un set di dati abilitato per Profilo e Identità create-a-dataset-enabled-for-profile-and-identity

Puoi abilitare un set di dati per Real-Time Customer Profile e Identity Service immediatamente dopo la creazione o in qualsiasi momento dopo la creazione del set di dati. Se desideri abilitare un set di dati già creato, segui i passaggi per configurare un set di dati esistente che si trova più avanti in questo documento.

Per creare un set di dati abilitato per il profilo, è possibile utilizzare una richiesta POST all'endpoint /dataSets.

Formato API

POST /dataSets

Richiesta

Includendo unifiedProfile e unifiedIdentity in tags nel corpo della richiesta, il set di dati verrà immediatamente abilitato per Profile e Identity Service, rispettivamente. I valori di questi tag devono essere una matrice contenente la stringa "enabled:true".

curl -X POST \
  https://platform.adobe.io/data/foundation/catalog/dataSets \
  -H 'Content-Type: application/json' \
  -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 '{
    "schemaRef": {
        "id": "https://ns.adobe.com/{TENANT_ID}/schemas/31670881463308a46f7d2cb09762715",
        "contentType": "application/vnd.adobe.xed-full-notext+json; version=1"
    },
    "tags": {
       "unifiedProfile": ["enabled:true"],
       "unifiedIdentity": ["enabled:true"]
    }
  }'

Risposta

In caso di esito positivo, la risposta mostra un array contenente l'ID del set di dati appena creato sotto forma di "@/dataSets/{DATASET_ID}". Dopo aver creato e attivato correttamente un set di dati, procedi con i passaggi per il caricamento dei dati.

[
    "@/dataSets/5b020a27e7040801dedbf46e"
]

Configurare un set di dati esistente configure-an-existing-dataset

Nei passaggi seguenti viene descritto come abilitare un set di dati creato in precedenza per Real-Time Customer Profile e Identity Service. Se hai già creato un set di dati abilitato per il profilo, procedi ai passaggi per l'acquisizione dei dati.

Controlla se il set di dati è abilitato check-if-the-dataset-is-enabled

Utilizzando l'API Catalog, è possibile esaminare un set di dati esistente per determinare se è abilitato per l'utilizzo in Real-Time Customer Profile e Identity Service. La chiamata seguente recupera i dettagli di un set di dati per ID.

Formato API

GET /dataSets/{DATASET_ID}

Richiesta

curl -X GET \
  'https://platform.adobe.io/data/foundation/catalog/dataSets/5b020a27e7040801dedbf46e' \
  -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

{
    "5b020a27e7040801dedbf46e": {
        "name": "Commission Program Events DataSet",
        "imsOrg": "{ORG_ID}",
        "tags": {
            "adobe/pqs/table": [
                "unifiedprofileingestiontesteventsdataset"
            ],
            "unifiedProfile": [
                "enabled:true"
            ],
            "unifiedIdentity": [
                "enabled:true"
            ]
        },
        "version": "1.0.1",
        "created": 1536536917382,
        "updated": 1539793978215,
        "createdClient": "{CLIENT_CREATED}",
        "createdUser": "{CREATED_BY}",
        "updatedUser": "{CREATED_BY}",
        "viewId": "5b020a27e7040801dedbf46f",
        "files": "@/dataSetFiles?dataSetId=5b020a27e7040801dedbf46e",
        "schema": "@/xdms/context/experienceevent",
        "schemaRef": {
            "id": "https://ns.adobe.com/xdm/context/experienceevent",
            "contentType": "application/vnd.adobe.xed+json"
        }
    }
}

Nella proprietà tags, è possibile vedere che unifiedProfile e unifiedIdentity sono entrambi presenti con il valore enabled:true. Pertanto, Real-Time Customer Profile e Identity Service sono abilitati rispettivamente per questo set di dati.

Abilitare il set di dati enable-the-dataset

Se il set di dati esistente non è stato abilitato per Profile o Identity Service, è possibile abilitarlo effettuando una richiesta PATCH utilizzando l'ID del set di dati.

Formato API

PATCH /dataSets/{DATASET_ID}

Richiesta

curl -X PATCH \
  https://platform.adobe.io/data/foundation/catalog/dataSets/5b020a27e7040801dedbf46e \
  -H 'Content-Type:application/json-patch+json' \
  -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 '[
        { "op": "add", "path": "/tags/unifiedProfile", "value": ["enabled:true"] },
        { "op": "add", "path": "/tags/unifiedIdentity", "value": ["enabled:true"] }
      ]'

Il corpo della richiesta include da path a due tipi di tag, unifiedProfile e unifiedIdentity. I value di ciascuno sono matrici contenenti la stringa enabled:true.

Risposta

In caso di esito positivo, la richiesta PATCH restituisce lo stato HTTP 200 (OK) e una matrice contenente l’ID del set di dati aggiornato. Questo ID deve corrispondere a quello inviato nella richiesta PATCH. I tag unifiedProfile e unifiedIdentity sono stati aggiunti e il set di dati è abilitato per l'utilizzo da parte dei servizi Profilo e Identità.

[
    "@/dataSets/5b020a27e7040801dedbf46e"
]

Inserire dati nel set di dati ingest-data-into-the-dataset

Sia Real-Time Customer Profile che Identity Service utilizzano dati XDM durante l'acquisizione in un set di dati. Per istruzioni su come caricare dati in un set di dati, consulta l'esercitazione su creazione di un set di dati tramite API. Quando si pianificano i dati da inviare al set di dati abilitato per Profile, prendere in considerazione le seguenti best practice:

Conferma acquisizione dati da Real-Time Customer Profile confirm-data-ingest-by-real-time-customer-profile

Quando si caricano dati in un nuovo set di dati per la prima volta, o come parte di un processo che coinvolge una nuova ETL o sorgente di dati, si consiglia di controllare attentamente i dati per assicurarsi che siano stati caricati come previsto. Utilizzando l'API di accesso Real-Time Customer Profile, è possibile recuperare i dati batch durante il caricamento in un set di dati. Se non riesci a recuperare le entità previste, il set di dati potrebbe non essere abilitato per Real-Time Customer Profile. Dopo aver confermato che il set di dati è stato abilitato, assicurati che il formato e gli identificatori dei dati di origine supportino le aspettative. Per istruzioni dettagliate su come utilizzare l'API Real-Time Customer Profile per accedere ai dati Profile, fare riferimento alla guida dell'endpoint entità, nota anche come API "Profile Access".

Conferma dell’acquisizione dei dati da parte del servizio Identity confirm-data-ingest-by-identity-service

Ogni frammento di dati acquisito che contiene più di un’identità crea un collegamento nel grafico dell’identità privata. Per ulteriori informazioni sui grafici delle identità e accedere ai dati delle identità, leggere la panoramica del servizio Identity.