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

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.

OBSERVERA

Arbetsflödet för att infoga fungerar bara för gruppinmatning. Direktinmatning är not stöds.

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.
  • 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.
  • Batchförtäring: 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 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 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.

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 profil och uppdateringar använder du en POST-förfrågan till /dataSets slutpunkt.

API-format

POST /dataSets

Begäran

Genom att unifiedProfile under tags i begärandetexten kommer datauppsättningen att aktiveras för Profile när de skapas. I unifiedProfile array, lägga till isUpsert:true kommer att lägga till möjligheten för datauppsättningen att stödja 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 '{
        "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",
            "isUpsert: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}".

[
    "@/dataSets/5b020a27e7040801dedbf46e"
]

Konfigurera en befintlig datauppsättning

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

OBSERVERA

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 bredvid isUpsert -tagg. Om den befintliga datauppsättningen inte är aktiverad för profilen kan du fortsätta direkt till stegen för 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

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. 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"
            ],
            "unifiedProfile": [
                "enabled:true"
            ]
        },
        "lastBatchId": "{BATCH_ID}",
        "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": "{VIEW_ID}",
        "status": "enabled",
        "transforms": "@/dataSets/5b020a27e7040801dedbf46e/views/5b020a27e7040801dedbf46f/transforms",
        "files": "@/dataSets/5b020a27e7040801dedbf46e/views/5b020a27e7040801dedbf46f/files",
        "schema": "{SCHEMA}",
        "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 finns med värdet enabled:true. Därför Real-time Customer Profile är 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 unifiedProfile och sedan aktivera om det tillsammans med isUpsert -tagg. Detta görs med två PATCH-begäranden, en gång för att inaktivera och en för att återaktivera.

VARNING

Data som hämtas till datauppsättningen när den är inaktiverad kommer inte att hämtas till profilarkivet. Vi rekommenderar att du undviker 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 texten i PATCH-begäran innehåller en path till unifiedProfile ställa in value till enabled:false för att inaktivera taggen.

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

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 -taggen har nu inaktiverats.

[
    "@/dataSets/5b020a27e7040801dedbf46e"
]

Aktivera datauppsättningen för profil och upsert

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

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 ställa in value som innehåller enabled och isUpsert taggar, båda inställda 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"] },
      ]'

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 -taggen 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 inmatning av data i Adobe Experience Platform börjar du med att läsa dataöverföring - översikt.

På denna sida