DokumentationExperience PlatformAnvändarhandbok om kataloger och datauppsättningar

Aktivera en datauppsättning för profiluppdateringar med API:er

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Skapat för:

  • Utvecklare

Den här självstudiekursen handlar om hur du aktiverar en datauppsättning med"upsert"-funktioner för att uppdatera kundprofildata i realtid. Detta inkluderar steg för att skapa en ny datauppsättning och konfigurera en befintlig datauppsättning.

NOTE
Arbetsflödet som beskrivs i den här självstudiekursen fungerar bara för batchinmatning. För direktuppspelande ingessionsöverföringar, se guiden om att skicka uppdateringar (del av rad) till kundprofilen i realtid med Data Prep.

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:

  • Real-Time Customer Profile: Tillhandahåller en enhetlig konsumentprofil i realtid baserad på aggregerade data från flera källor.
  • Catalog Service: Ett RESTful-API som gör att du kan skapa datauppsättningar och konfigurera dem för Real-Time Customer Profile och Identity Service.
  • Experience Data Model (XDM): Det standardiserade ramverket som Platform organiserar kundupplevelsedata med.
  • Gruppinmatning: Med API:t för gruppinmatning kan du importera data till Experience Platform som gruppfiler.

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:

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {ORG_ID}

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 som är aktiverad för profiluppdateringar

När du skapar en ny datauppsättning kan du aktivera datauppsättningen för profilen och aktivera uppdateringsfunktioner när du skapar den.

NOTE
Om du vill skapa en ny profilaktiverad datauppsättning måste du känna till ID:t för ett befintligt XDM-schema som är aktiverat för profilen. Information om hur du söker efter eller skapar ett profilaktiverat schema finns i självstudiekursen Skapa ett schema med API:t för schemaregister.

Om du vill skapa en datauppsättning som är aktiverad för profil och uppdateringar använder du en POST-förfrågan till slutpunkten /dataSets.

API-format

POST /dataSets

Begäran

Genom att inkludera både unifiedIdentity och unifiedProfile under tags i begärandetexten aktiveras datauppsättningen för Profile när den skapas. Om du lägger till isUpsert:true i unifiedProfile-arrayen kan datauppsättningen ha stöd för uppdateringar.

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 '{
        "name": "Sample dataset",
        "description: "A sample dataset with a sample description.",
        "schemaRef": {
            "id": "https://ns.adobe.com/{TENANT_ID}/schemas/31670881463308a46f7d2cb09762715",
            "contentType": "application/vnd.adobe.xed-full-notext+json; version=1"
        },
        "tags": {
            "unifiedIdentity": [
                "enabled: true"
            ],
            "unifiedProfile": [
                "enabled: true",
                "isUpsert: true"
            ]
        }
      }'
Egenskap
Beskrivning
schemaRef.id
ID:t för det Profile-aktiverade schemat som datauppsättningen ska baseras på.
{TENANT_ID}
Namnområdet i Schema Registry som innehåller resurser som tillhör din organisation. Mer information finns i avsnittet TENANT_ID i Schema Registry-utvecklarhandboken.

Svar

Ett lyckat svar visar en matris som innehåller ID:t för den nya datamängden i formatet "@/dataSets/{DATASET_ID}".

[
    "@/dataSets/5b020a27e7040801dedbf46e"
]

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

Följande steg beskriver hur du konfigurerar en befintlig profilaktiverad datauppsättning för uppdateringsfunktioner (upsert).

NOTE
Om du vill konfigurera en befintlig profilaktiverad datauppsättning för uppdatering måste du först inaktivera datauppsättningen för profilen och sedan återaktivera den tillsammans med taggen isUpsert. Om den befintliga datauppsättningen inte är aktiverad för profilen kan du fortsätta direkt till stegen för att aktivera datauppsättningen för profil och upsert. Om du är osäker visar följande steg hur du kontrollerar om datauppsättningen redan är aktiverad.

Kontrollera om datauppsättningen är aktiverad för profilen

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. Följande anrop hämtar information om en datauppsättning per ID.

API-format

GET /dataSets/{DATASET_ID}
Parameter
Beskrivning
{DATASET_ID}
ID:t för en datauppsättning som du vill inspektera.

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": "{DATASET_NAME}",
        "imsOrg": "{ORG_ID}",
        "tags": {
            "adobe/pqs/table": [
                "unifiedprofileingestiontesteventsdataset"
            ],
            "unifiedIdentity": [
                "enabled:true"
            ],
            "unifiedProfile": [
                "enabled:true"
            ]
        },
        "version": "1.0.1",
        "created": 1536536917382,
        "updated": 1539793978215,
        "createdClient": "{CLIENT_CREATED}",
        "createdUser": "{CREATED_BY}",
        "updatedUser": "{CREATED_BY}",
        "viewId": "{VIEW_ID}",
        "files": "@/dataSetFiles?dataSetId=5b020a27e7040801dedbf46e",
        "schema": "{SCHEMA}",
        "schemaRef": {
            "id": "https://ns.adobe.com/xdm/context/experienceevent",
            "contentType": "application/vnd.adobe.xed+json"
        }
    }
}

Under egenskapen tags ser du att unifiedProfile finns med värdet enabled:true. Därför är Real-Time Customer Profile aktiverat för den här datauppsättningen.

Inaktivera datauppsättningen för profilen

Om du vill konfigurera en profilaktiverad datauppsättning för uppdateringar måste du först inaktivera taggarna unifiedProfile och unifiedIdentity och sedan återaktivera dem tillsammans med taggen isUpsert. Detta görs med två PATCH-begäranden, en gång för att inaktivera och en för att återaktivera.

WARNING
Data som hämtas till datauppsättningen när den är inaktiverad kommer inte att hämtas till profilarkivet. Du bör undvika att samla in data i datauppsättningen tills den har återaktiverats för profilen.

API-format

PATCH /dataSets/{DATASET_ID}
Parameter
Beskrivning
{DATASET_ID}
ID:t för den datauppsättning som du vill uppdatera.

Begäran

Den första PATCH-begärandetexten innehåller en path till unifiedProfile och en path till unifiedIdentity som ställer in value på enabled:false för båda sökvägarna för att inaktivera taggarna.

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": "replace",
            "path": "/tags/unifiedProfile",
            "value": ["enabled:false"]
        },
        {
            "op": "replace",
            "path": "/tags/unifiedIdentity",
            "value": ["enabled:false"]
        }
      ]'

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 inaktiverats.

[
    "@/dataSets/5b020a27e7040801dedbf46e"
]

Aktivera datauppsättningen för profil och upsert enable-the-dataset

En befintlig datauppsättning kan aktiveras för profiluppdateringar och attributuppdateringar med en enda begäran från PATCH.

IMPORTANT
När du aktiverar din datauppsättning för profil kontrollerar du att schemat som datauppsättningen är kopplad till är även profilinaktiverat. Om schemat inte är profilaktiverat visas datauppsättningen inte som profilaktiverad i plattformsgränssnittet.

API-format

PATCH /dataSets/{DATASET_ID}
Parameter
Beskrivning
{DATASET_ID}
ID:t för den datauppsättning som du vill uppdatera.

Begäran

Begärandetexten innehåller en path till unifiedProfile som anger att value ska inkludera taggarna enabled och isUpsert, båda inställda på true, och en path till unifiedIdentity som anger att value ska innehålla taggen enabled inställd på true.

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",
                "isUpsert:true"
            ]
        },
        {
            "op": "add",
            "path": "/tags/unifiedIdentity",
            "value": [
                "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. Taggen unifiedProfile och taggen unifiedIdentity har nu aktiverats och konfigurerats för attributuppdateringar.

[
    "@/dataSets/5b020a27e7040801dedbf46e"
]

Nästa steg

Din profilaktiverade och upsert-aktiverade datauppsättning kan nu användas av arbetsflöden för batchimport för att uppdatera profildata. Om du vill veta mer om hur du importerar data till Adobe Experience Platform börjar du med att läsa översikten över dataimporten.

recommendation-more-help
c5c02be6-79a3-4a2f-b766-136bffe8b676