Dokumentation Experience Platform Användarhandbok om Real-Time Customer Profile

Slutpunkt för profilsystemjobb (Delete-begäranden)

Last update: Fri Apr 19 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Ämnen:
Profiles

Skapat för:

Developer

Med Adobe Experience Platform kan ni importera data från flera olika källor och skapa robusta profiler för enskilda kunder. Data insamlade i Platform lagras i Data Lakeoch om datauppsättningarna har aktiverats för profilen lagras dessa data i Real-Time Customer Profile även datalagring. Ibland kan det vara nödvändigt att ta bort profildata som är kopplade till en datauppsättning från profilarkivet för att ta bort data som inte längre behövs eller som har lagts till av misstag. Detta kräver att du använder Real-Time Customer Profile API för att skapa en Profile systemjobb, eller delete request, som också kan ändras, övervakas eller tas bort vid behov.

NOTE

Om du försöker ta bort datauppsättningar eller grupper från Data Lake, besök Katalogtjänst - översikt för mer information.

Komma igång

API-slutpunkten som används i den här guiden är en del av Real-Time Customer Profile API. Innan du fortsätter bör du granska komma igång-guide för länkar till relaterad dokumentation, en guide till hur du läser exempelanrop till API:er i det här dokumentet och viktig information om vilka huvuden som behövs för att kunna anropa ett Experience Platform-API.

Visa borttagningsbegäranden

En borttagningsbegäran är en långvarig, asynkron process, vilket innebär att din organisation kan köra flera borttagningsbegäranden samtidigt. Om du vill visa alla borttagningsbegäranden som din organisation för närvarande kör kan du utföra en GET-förfrågan till /system/jobs slutpunkt.

Du kan också använda valfria frågeparametrar för att filtrera listan med borttagningsbegäranden som returneras i svaret. Om du vill använda flera parametrar avgränsar du varje parameter med ett et-tecken (&).

API-format

GET /system/jobs
GET /system/jobs?{QUERY_PARAMETERS}

Parameter

Beskrivning

start

Förskjut den returnerade resultatsidan enligt skapandetiden för begäran. Exempel: start=4

limit

Begränsa antalet returnerade resultat. Exempel: limit=10

page

Returnera en specifik resultatsida enligt skapandetiden för begäran. Exempel: page=2

sort

Sortera resultat efter ett specifikt fält i stigande (asc) eller fallande (desc). Sorteringsparametern fungerar inte när flera resultatsidor returneras. Exempel: sort=batchId:asc

Begäran

curl -X GET \
  https://platform.adobe.io/data/core/ups/system/jobs \
  -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

Svaret innehåller en "children"-array med ett objekt för varje borttagningsbegäran som innehåller information om den begäran.

{
  "_page": {
    "count": 100,
    "next": "K1JJRDpFaWc5QUwyZFgtMEpBQUFBQUFBQUFBPT0jUlQ6MSNUUkM6MiNGUEM6QWdFQUFBQVFBQWZBQUg0Ly9yL25PcmpmZndEZUR3QT0="
  },
  "children": [
    {
      "id": "9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4",
      "imsOrgId": "{ORG_ID}",
      "batchId": "8d075b5a178e48389126b9289dcfd0ac",
      "jobType": "DELETE",
      "status": "COMPLETED",
      "metrics": "{\"recordsProcessed\":5,\"timeTakenInSec\":1}",
      "createEpoch": 1559026134,
      "updateEpoch": 1559026137
    },
    {
      "id": "3f225e7e-ac8c-4904-b1d5-0ce79e03c2ec",
      "imsOrgId": "{ORG_ID}",
      "dataSetId": "5c802d3cd83fc114b741c4b5",
      "jobType": "DELETE",
      "status": "PROCESSING",
      "metrics": "{\"recordsProcessed\":0,\"timeTakenInSec\":15}",
      "createEpoch": 1559025404,
      "updateEpoch": 1559025406
    }
  ]
}

Egenskap

Beskrivning

_page.count

Totalt antal begäranden. Svaret har trunkerats för utrymme.

_page.next

Om det finns ytterligare en resultatsida kan du visa nästa resultatsida genom att ersätta ID-värdet i en sökförfrågan med "next" angivet värde.

jobType

Den typ av jobb som skapas. I det här fallet returneras alltid "DELETE".

status

Status för borttagningsbegäran. Möjliga värden är "NEW", "PROCESSING", "COMPLETED", "ERROR".

metrics

Ett objekt som innehåller antalet poster som har bearbetats ("recordsProcessed") och tiden i sekunder som begäran har behandlats eller hur lång tid det tog att slutföra begäran ("timeTakenInSec").

Skapa en borttagningsbegäran create-a-delete-request

En ny borttagningsbegäran initieras via en POST till /systems/jobs slutpunkt, där ID:t för den datauppsättning eller batch som ska tas bort anges i förfrågningens brödtext.

Ta bort en datauppsättning och associerade profildata

Om du vill ta bort en datauppsättning och alla profildata som är associerade med datauppsättningen från profilarkivet måste datauppsättnings-ID:t inkluderas i POSTENS innehåll. Den här åtgärden tar bort ALLA data för en viss datauppsättning. Experience Platform Med kan du ta bort datauppsättningar baserat på både schema för post- och tidsserier.

API-format

POST /system/jobs

Begäran

curl -X POST \
  https://platform.adobe.io/data/core/ups/system/jobs \
  -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 '{
        "dataSetId": "5c802d3cd83fc114b741c4b5"
      }'

Egenskap

Beskrivning

dataSetId

(Obligatoriskt) ID:t för den datauppsättning som du vill ta bort.

Svar

Ett lyckat svar returnerar information om den nyligen skapade borttagningsbegäran, inklusive ett unikt, systemgenererat, skrivskyddat ID för begäran. Detta kan användas för att slå upp begäran och kontrollera dess status. The status för begäran när den skapas "NEW" tills bearbetningen börjar. The dataSetId i svaret ska matcha dataSetId skickas i begäran.

{
    "id": "3f225e7e-ac8c-4904-b1d5-0ce79e03c2ec",
    "imsOrgId": "{ORG_ID}",
    "dataSetId": "5c802d3cd83fc114b741c4b5",
    "jobType": "DELETE",
    "status": "NEW",
    "createEpoch": 1559025404,
    "updateEpoch": 1559025406
}

Egenskap

Beskrivning

id

Det unika, systemgenererade skrivskyddade ID:t för borttagningsbegäran.

dataSetId

Datauppsättningens ID, enligt POSTENS begäran.

Ta bort en grupp

Om du vill ta bort en batch måste batch-ID:t inkluderas i POSTENS innehåll. Observera att du inte kan ta bort grupper för datauppsättningar baserat på postscheman. Endast batchar för datauppsättningar som baseras på tidsseriescheman kan tas bort.

NOTE

Orsaken till att du inte kan ta bort batchar för datauppsättningar baserade på postscheman är att datauppsättningsbatchar skriver över tidigare poster och därför inte kan ångras eller tas bort. Det enda sättet att ta bort effekten av felaktiga batchar för datauppsättningar som baseras på postscheman är att importera om gruppen med rätt data för att skriva över felaktiga poster.

Mer information om hur man beter sig i protokoll och tidsserier finns i om XDM-databeteenden i XDM System översikt.

API-format

POST /system/jobs

Begäran

curl -X POST \
  https://platform.adobe.io/data/core/ups/system/jobs \
  -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 '{
       "batchId": "8d075b5a178e48389126b9289dcfd0ac"
      }'

Egenskap

Beskrivning

batchId

(Obligatoriskt) ID:t för gruppen som du vill ta bort.

Svar

Ett lyckat svar returnerar information om den nyligen skapade borttagningsbegäran, inklusive ett unikt, systemgenererat, skrivskyddat ID för begäran. Detta kan användas för att slå upp begäran och kontrollera dess status. The "status" för begäran när den skapas "NEW" tills bearbetningen börjar. The "batchId" värdet i svaret ska matcha "batchId" värdet som skickades i begäran.

{
    "id": "9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4",
    "imsOrgId": "{ORG_ID}",
    "batchId": "8d075b5a178e48389126b9289dcfd0ac",
    "jobType": "DELETE",
    "status": "NEW",
    "createEpoch": 1559026131,
    "updateEpoch": 1559026132
}

Egenskap

Beskrivning

id

Det unika, systemgenererade skrivskyddade ID:t för borttagningsbegäran.

batchId

Batchens ID, som anges i begäran om POST.

Om du försöker initiera en borttagningsbegäran för en postdatauppsättningsbatch kommer du att få ett 400-nivåfel, som följande:

{
    "requestId": "bc4eb29f-63a8-4653-9133-71238884bb81",
    "errors": {
        "400": [
            {
                "code": "500",
                "message": "Batch can only be specified for EE type 'a294e36d382649dab2cc6ad64a41b674'"
            }
        ]
    }
}

Visa en specifik borttagningsbegäran view-a-specific-delete-request

Om du vill visa en viss borttagningsbegäran, inklusive information om dess status, kan du utföra en uppslagsbegäran (GET) på /system/jobs slutpunkten och ta med ID:t för borttagningsbegäran i sökvägen.

API-format

GET /system/jobs/{DELETE_REQUEST_ID}

Parameter

Beskrivning

{DELETE_REQUEST_ID}

(Obligatoriskt) ID:t för den borttagningsbegäran som du vill visa.

Begäran

curl -X GET \
  https://platform.adobe.io/data/core/ups/system/jobs/9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4 \
  -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

Svaret innehåller information om borttagningsbegäran, inklusive dess uppdaterade status. ID för borttagningsbegäran i svaret ( "id" värdet) ska matcha det ID som skickades i sökvägen för begäran.

{
    "id": "9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4",
    "imsOrgId": "{ORG_ID}",
    "batchId": "8d075b5a178e48389126b9289dcfd0ac",
    "jobType": "DELETE",
    "status": "COMPLETED",
    "metrics": "{\"recordsProcessed\":5,\"timeTakenInSec\":1}",
    "createEpoch": 1559026134,
    "updateEpoch": 1559026137
}

Egenskaper

Beskrivning

jobType

Den typ av jobb som skapas, i det här fallet returneras alltid "DELETE".

status

Status för borttagningsbegäran. Möjliga värden: "NEW", "PROCESSING", "COMPLETED", "ERROR".

metrics

En array som innehåller antalet poster som har bearbetats ("recordsProcessed") och tiden i sekunder som begäran har behandlats eller hur lång tid det tog att slutföra begäran ("timeTakenInSec").

När status för borttagningsbegäran är "COMPLETED" Du kan bekräfta att data har tagits bort genom att försöka komma åt borttagna data med hjälp av API:t för dataåtkomst. Instruktioner om hur du använder API:t för dataåtkomst för att komma åt datauppsättningar och grupper finns i Dokumentation för dataåtkomst.

Ta bort en borttagningsbegäran

Experience Platform I kan du ta bort en tidigare begäran, vilket kan vara användbart av flera anledningar, bland annat om borttagningsjobbet inte slutfördes eller fastnade i bearbetningsfasen. Om du vill ta bort en borttagningsbegäran kan du utföra en DELETE-begäran till /system/jobs slutpunkten och inkludera ID:t för den borttagningsbegäran som du vill ta bort till sökvägen för begäran.

API-format

DELETE /system/jobs/{DELETE_REQUEST_ID}

Parameter

Beskrivning

ID för den borttagningsbegäran som du vill ta bort.

Begäran

curl -X POST \
  https://platform.adobe.io/data/core/ups/system/jobs/9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4 \
  -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

En slutförd borttagningsbegäran returnerar HTTP-status 200 (OK) och en tom svarstext. Du kan bekräfta att begäran har tagits bort genom att utföra en GET-begäran för att visa borttagningsbegäran med dess ID. Detta bör returnera HTTP-status 404 (Hittades inte), vilket anger att borttagningsbegäran togs bort.

Nästa steg

Nu när du vet vilka steg det handlar om att ta bort datauppsättningar och grupper från Profile Store inom Experience Platformkan du ta bort data som har lagts till felaktigt eller som din organisation inte längre behöver. Observera att det inte går att ångra en borttagningsbegäran. Du bör därför bara ta bort data som du är säker på att du inte behöver nu och inte behöver i framtiden.

recommendation-more-help

54550d5b-f1a1-4065-a394-eb0f23a2c38b