Aktivera en datauppsättning för Profile och Identity Service med API:er

I den här självstudiekursen beskrivs hur du aktiverar en datauppsättning för användning i Real-Time Customer Profile och Identity Service, som delas upp i följande steg:

Komma igång

Den här självstudiekursen kräver en fungerande förståelse av flera Adobe Experience Platform-tjänster som arbetar med att hantera profilaktiverade datauppsättningar. Innan du börjar med den här självstudiekursen bör du läsa igenom dokumentationen för de här relaterade Platform-tjänsterna:

I följande avsnitt finns ytterligare information som du behöver känna till för att kunna anropa API:erna för plattformen.

Läser exempel-API-anrop

I den här självstudiekursen finns exempel-API-anrop som visar hur du formaterar dina begäranden. Det kan vara sökvägar, obligatoriska rubriker och korrekt formaterade begärandenyttolaster. Ett exempel på JSON som returneras i API-svar finns också. Information om de konventioner som används i dokumentationen för exempel-API-anrop finns i avsnittet Så här läser du exempel-API-anrop i felsökningsguiden för Experience Platform.

Samla in värden för obligatoriska rubriker

För att kunna anropa Platform API:er måste du först slutföra autentiseringssjälvstudiekursen. När du slutför självstudiekursen för autentisering visas värdena för var och en av de obligatoriska rubrikerna i alla Experience Platform API-anrop, vilket visas nedan:

Alla begäranden som innehåller en nyttolast (POST, PUT, PATCH) kräver ytterligare ett Content-Type-huvud. Rätt värde för den här rubriken visas vid behov i exempelbegäranden.

Alla resurser i Experience Platform är isolerade till specifika virtuella sandlådor. Alla begäranden till Platform API:er kräver ett x-sandbox-name-huvud som anger namnet på sandlådan som åtgärden ska utföras i. Mer information om sandlådor i Platform finns i översiktsdokumentationen för sandlådan.

Skapa en datauppsättning aktiverad för profil och identitet create-a-dataset-enabled-for-profile-and-identity

Du kan aktivera en datauppsättning för kundprofil och identitetstjänst i realtid direkt när den skapas eller när som helst efter att datauppsättningen har skapats. Om du vill aktivera en datamängd som redan har skapats följer du stegen för att konfigurera en befintlig datamängd som hittas senare i det här dokumentet.

Om du vill skapa en datauppsättning som är aktiverad för profilen kan du använda en POST-förfrågan till slutpunkten /dataSets.

API-format

POST /dataSets

Begäran

Genom att ta med unifiedProfile och unifiedIdentity under tags i begärandetexten aktiveras datauppsättningen omedelbart för Profile respektive Identity Service. Värdena för dessa taggar måste vara en array som innehåller strängen "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"]
    }
  }'

Svar

Ett lyckat svar visar en matris som innehåller ID:t för den nya datamängden i formatet "@/dataSets/{DATASET_ID}". När du har skapat och aktiverat en datauppsättning fortsätter du till stegen för överföring av data.

[
    "@/dataSets/5b020a27e7040801dedbf46e"
]

Konfigurera en befintlig datauppsättning configure-an-existing-dataset

Följande steg beskriver hur du aktiverar en tidigare skapad datauppsättning för Real-Time Customer Profile och Identity Service. Om du redan har skapat en profilaktiverad datauppsättning fortsätter du till stegen för inhämtning av data.

Kontrollera om datauppsättningen är aktiverad check-if-the-dataset-is-enabled

Med API:t Catalog kan du undersöka en befintlig datauppsättning för att avgöra om den är aktiverad för användning i Real-Time Customer Profile och Identity Service. Följande anrop hämtar information om en datauppsättning per ID.

API-format

GET /dataSets/{DATASET_ID}

Begäran

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

Svar

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

Under egenskapen tags ser du att både unifiedProfile och unifiedIdentity finns med värdet enabled:true. Därför är Real-Time Customer Profile och Identity Service aktiverade för den här datauppsättningen.

Aktivera datauppsättningen enable-the-dataset

Om den befintliga datauppsättningen inte har aktiverats för Profile eller Identity Service kan du aktivera den genom att göra en PATCH-begäran med datauppsättnings-ID:t.

API-format

PATCH /dataSets/{DATASET_ID}

Begäran

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

Begärandetexten innehåller path till två typer av taggar, unifiedProfile och unifiedIdentity. value av var och en är matriser som innehåller strängen enabled:true.

Svar

En lyckad PATCH-begäran returnerar HTTP-status 200 (OK) och en array som innehåller ID:t för den uppdaterade datauppsättningen. Detta ID ska matcha det som skickades i PATCH-begäran. Taggarna unifiedProfile och unifiedIdentity har nu lagts till och datauppsättningen har aktiverats för användning av profiltjänster och identitetstjänster.

[
    "@/dataSets/5b020a27e7040801dedbf46e"
]

Infoga data i datauppsättningen ingest-data-into-the-dataset

Både Real-Time Customer Profile och Identity Service använder XDM-data när de importeras till en datauppsättning. Instruktioner om hur du överför data till en datauppsättning finns i självstudiekursen Skapa en datauppsättning med API:er. När du planerar vilka data som ska skickas till den Profile-aktiverade datauppsättningen bör du tänka på följande metodtips:

Bekräfta dataimport av Real-Time Customer Profile confirm-data-ingest-by-real-time-customer-profile

När du överför data till en ny datauppsättning för första gången, eller som en del av en process som inbegriper en ny ETL eller datakälla, bör du noggrant kontrollera data för att se till att de har överförts som förväntat. Med åtkomst-API:t Real-Time Customer Profile kan du hämta batchdata när de läses in till en datamängd. Om du inte kan hämta någon av de entiteter som du förväntar dig, kanske din datauppsättning inte är aktiverad för Real-Time Customer Profile. När du har bekräftat att datauppsättningen har aktiverats kontrollerar du att källdataformatet och identifierarna stöder dina förväntningar. Detaljerade instruktioner om hur du använder Real-Time Customer Profile-API:t för att komma åt Profile-data finns i entitetens slutpunktshandbok, som också kallas Profile Access-API:t.

Bekräfta datainhämtning via identitetstjänsten confirm-data-ingest-by-identity-service

Varje inkapslat datafragment som innehåller mer än en identitet skapar en länk i ditt privata identitetsdiagram. Om du vill ha mer information om identitetsdiagram och få tillgång till identitetsdata börjar du med att läsa översikten för identitetstjänsten.