Aktivera en datauppsättning för Profile och Identity Service använda 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, indelat i följande steg:

  1. Aktivera en datauppsättning för användning i Real-time Customer Profile, med ett av två alternativ:
  2. Infoga data i datauppsättningen
  3. Bekräfta datainmatning med kundprofil i realtid
  4. Bekräfta datainhämtning via identitetstjänsten

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 dokumentationen för dessa relaterade Platform tjänster:

  • Real-time Customer Profile: Ger en enhetlig konsumentprofil i realtid baserad på aggregerade data från flera källor.
  • Identity Service: Aktiverar Real-time Customer Profile genom att överbrygga identiteter från olika datakällor som inhämtas till Platform.
  • 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 ramverk som Platform organiserar kundupplevelsedata.

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 konventionerna som används i dokumentationen för exempel-API-anrop finns i avsnittet om läsa exempel-API-anrop i Experience Platform felsökningsguide.

Samla in värden för obligatoriska rubriker

För att ringa Platform API:er måste du först slutföra självstudiekurs om autentisering. När du är klar med självstudiekursen för autentisering visas värdena för var och en av de obligatoriska rubrikerna i alla Experience Platform API-anrop enligt 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 Content-Type header. Rätt värde för den här rubriken visas vid behov i exempelbegäranden.

Alla resurser i Experience Platform isoleras till specifika virtuella sandlådor. Alla förfrågningar till Platform API:er kräver en x-sandbox-name huvud som anger namnet på den sandlåda som åtgärden ska utföras i. Mer information om sandlådor i Platform, se översiktsdokumentation för sandlåda.

Skapa en datauppsättning som är aktiverad för profil och identitet

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 datauppsättning som redan har skapats följer du stegen för konfigurera en befintlig datauppsättning hittas senare i det här dokumentet.

OBSERVERA

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 om skapa ett schema med API:t för schemaregister.

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

API-format

POST /dataSets

Begäran

Genom att unifiedProfile och unifiedIdentity under tags i begärandetexten aktiveras datauppsättningen omedelbart för Profile och Identity Service, respektive. 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 '{
    "fields":[],
    "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"]
    }
  }'
Egenskap Beskrivning
schemaRef.id ID för Profile-aktiverat schema som datauppsättningen baseras på.
{TENANT_ID} Namnutrymmet i Schema Registry som innehåller resurser som tillhör din IMS-organisation. Se TENANT_ID i Schema Registry för mer information.

Svar

Ett lyckat svar visar en array som innehåller ID:t för den nya datauppsättningen i form av "@/dataSets/{DATASET_ID}". När du har skapat och aktiverat en datauppsättning fortsätter du med stegen för överföra data.

[
    "@/dataSets/5b020a27e7040801dedbf46e"
]

Konfigurera en befintlig datauppsättning

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 går du vidare till stegen för inhämta data.

Kontrollera om datauppsättningen är aktiverad

Använda Catalog API, du kan undersöka en befintlig datamängd 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}
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": "Commission Program Events DataSet",
        "imsOrg": "{ORG_ID}",
        "tags": {
            "adobe/pqs/table": [
                "unifiedprofileingestiontesteventsdataset"
            ],
            "unifiedProfile": [
                "enabled:true"
            ],
            "unifiedIdentity": [
                "enabled:true"
            ]
        },
        "lastBatchId": "6dcd9128a1c84e6aa5177641165e18e4",
        "lastBatchStatus": "success",
        "dule": {},
        "statsCache": {
            "startDate": null,
            "endDate": null
        },
        "namespace": "ACP",
        "state": "DRAFT",
        "version": "1.0.1",
        "created": 1536536917382,
        "updated": 1539793978215,
        "createdClient": "{CLIENT_CREATED}",
        "createdUser": "{CREATED_BY}",
        "updatedUser": "{CREATED_BY}",
        "viewId": "5b020a27e7040801dedbf46f",
        "status": "enabled",
        "transforms": "@/dataSets/5b020a27e7040801dedbf46e/views/5b020a27e7040801dedbf46f/transforms",
        "files": "@/dataSets/5b020a27e7040801dedbf46e/views/5b020a27e7040801dedbf46f/files",
        "schema": "@/xdms/context/experienceevent",
        "schemaMetadata": {
            "primaryKey": [],
            "delta": [],
            "dule": [],
            "gdpr": []
        },
        "schemaRef": {
            "id": "https://ns.adobe.com/xdm/context/experienceevent",
            "contentType": "application/vnd.adobe.xed+json"
        }
    }
}

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

Aktivera datauppsättningen

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

API-format

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

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 en path till två typer av taggar, unifiedProfile och unifiedIdentity. The value av var och en är arrayer 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. The unifiedProfile och unifiedIdentity taggar har nu lagts till och datauppsättningen är aktiverad för användning av profiltjänster och identitetstjänster.

[
    "@/dataSets/5b020a27e7040801dedbf46e"
]

Infoga data i datauppsättningen

Båda Real-time Customer Profile och Identity Service förbruka XDM-data när de hämtas in till en datauppsättning. Instruktioner om hur du överför data till en datauppsättning finns i självstudiekursen om skapa en datauppsättning med API:er. När du planerar vilka data som ska skickas till Profile-aktiverad datauppsättning, använd följande metodtips:

  • Inkludera alla data som du vill använda som segmenteringskriterier.
  • Ta med så många identifierare du kan identifiera från dina profildata för att maximera identitetsdiagrammet. Detta gör att Identity Service att knyta samman identiteter i olika datauppsättningar effektivare.

Bekräfta datainhämtning med 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. Använda Real-time Customer Profile Med åtkomst-API kan du hämta batchdata när de läses in i en datauppsättning. Om du inte kan hämta någon av de enheter 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 anvisningar om hur du använder Real-time Customer Profile API för åtkomst Profile data, se slutpunktsguide för enheter, som också kallasProfile Access" API.

Bekräfta datainhämtning via identitetstjänsten

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 Översikt över identitetstjänsten.

På denna sida