Endpoint “profile system jobs” (richieste di eliminazione)

Adobe Experience Platform consente di acquisire dati da più origini e di creare profili affidabili per i singoli clienti. I dati acquisiti in Experience Platform sono memorizzati in Data Lake e se i set di dati sono stati abilitati per il profilo, tali dati vengono memorizzati anche nell’archivio dati Real-Time Customer Profile. Talvolta può essere necessario eliminare i dati di profilo associati a un set di dati dall’archivio Profili per rimuovere i dati non più necessari o che sono stati aggiunti per errore. È necessario utilizzare l’API Real-Time Customer Profile per creare un processo di sistema Profile o “richiesta di eliminazione”.

Introduzione

L’endpoint API utilizzato in questa guida fa parte di Real-Time Customer Profile API. Prima di continuare, consulta la guida introduttiva per i collegamenti alla documentazione correlata, una guida alla lettura delle chiamate API di esempio in questo documento e per le informazioni importanti sulle intestazioni necessarie per effettuare correttamente le chiamate a qualsiasi API di Experience Platform.

Visualizzare le richieste di eliminazione view

Una richiesta di eliminazione è un processo asincrono a lungo termine, il che significa che l’organizzazione potrebbe eseguire più richieste di eliminazione contemporaneamente. Per visualizzare tutte le richieste di eliminazione attualmente in esecuzione nell’organizzazione, è possibile eseguire una richiesta GET all’endpoint /system/jobs.

Puoi anche utilizzare parametri di query facoltativi per filtrare l’elenco delle richieste di eliminazione restituite nella risposta. Per utilizzare più parametri, separare ogni parametro utilizzando una e commerciale (&).

Formato API

Quando si utilizza questo endpoint, i primi 100 processi di sistema vengono restituiti in ordine crescente in base alla data di creazione.

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

Ad esempio, se il parametro di query è ?start=1&limit=10, la risposta restituirà i record da 10 a 19.

Richiesta

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

Risposta

In caso di esito positivo, la risposta restituisce le informazioni di pagina e un array secondario contenente un oggetto per ciascuna richiesta di sistema.

{
    "_page": {
        "pageSize": 2,
        "start": "0",
        "totalCount": 2,
        "next": 1
    },
    "children:" [
        {
            "requestId": "80a9405a-21ca-4278-aedf-99367f90c055",
            "requestType": "DELETE_EE_BATCH",
            "imsOrgId": "{ORG_ID}",
            "sandbox": {
                "sandboxName": "prod",
                "sandboxId": "8129954b-fa83-43ba-a995-4bfa8373ba2b"
            },
            "status": "SUCCESS",
            "properties": {
                "batchId": "01JFSYFDFW9JAAEKHX672JMPSB",
                "datasetId": "66a92c5910df2d1767de13f3"
            },
            "createdAt": "2024-12-22T19:44:50.250006Z",
            "updatedAt": "2024-12-22T19:52:13.380706Z"
        },
        {
            "requestId": "38a835eb-b491-4864-902b-be07fa4d6a6d",
            "requestType": "TRUNCATE_DATASET",
            "imsOrgId": "{ORG_ID}",
            "sandbox": {
                "sandboxName": "prod",
                "sandboxId": "8129954b-fa83-43ba-a995-4bfa8373ba2b"
            },
            "status": "SUCCESS",
            "properties": {
                "datasetId": "66a92c5910df2d1767de13f3"
            },
            "createdAt": "2024-12-22T19:44:50.250006Z",
            "updatedAt": "2024-12-22T19:52:13.380706Z"
        }
    ]
}

Creare una richiesta di eliminazione create-a-delete-request

L’avvio di una nuova richiesta di eliminazione viene eseguito tramite una richiesta POST all’endpoint /systems/jobs, dove l’ID del set di dati o del batch da eliminare viene fornito nel corpo della richiesta.

Eliminare un set di dati e i dati del profilo associati

Per eliminare un set di dati e tutti i dati di profilo associati al set di dati dall’archivio profili, l’ID del set di dati deve essere incluso nel corpo della richiesta POST. Questa azione eliminerà TUTTI i dati per un dato set di dati. Experience Platform consente di eliminare i set di dati basati su schemi di record e serie temporali.

Formato API

POST /system/jobs

Richiesta

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": "66a92c5910df2d1767de13f3"
      }'

Risposta

In caso di esito positivo, la risposta restituisce i dettagli della richiesta di sistema appena creata, incluso un ID univoco generato dal sistema e di sola lettura per la richiesta. Può essere utilizzato per cercare la richiesta e verificarne lo stato. Il status per la richiesta al momento della creazione è NEW finché non inizia l’elaborazione (IN-PROGRESS). DataSetId nella risposta deve corrispondere a dataSetId inviato nella richiesta.

{
    "requestId": "80a9405a-21ca-4278-aedf-99367f90c055",
    "requestType": "TRUNCATE_DATASET",
    "imsOrgId": "{ORG_ID}",
    "sandbox": {
        "sandboxName": "prod",
        "sandboxId": "8129954b-fa83-43ba-a995-4bfa8373ba2b"
    },
    "status": "NEW",
    "properties": {
        "datasetId": "66a92c5910df2d1767de13f3"
    },
    "createdAt": "2024-12-22T19:44:50.250006Z",
    "updatedAt": "2024-12-22T19:44:50.250006Z"
}

Eliminare un batch

Per eliminare un batch, l’ID del batch deve essere incluso nel corpo della richiesta POST. Si noti che non è possibile eliminare batch per set di dati basati su schemi di record. È possibile eliminare solo i batch per i set di dati basati su schemi di serie temporali.

Per ulteriori informazioni sul comportamento di record e serie temporali, consulta la sezione sui comportamenti dei dati XDM nella panoramica di XDM System.

Formato API

POST /system/jobs

Richiesta

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": "66a92c5910df2d1767de13f3",
        "batchId": "01JFSYFDFW9JAAEKHX672JMPSB"
      }'

Risposta

In caso di esito positivo, la risposta restituisce i dettagli della richiesta di sistema appena creata.

{
    "requestId": "80a9405a-21ca-4278-aedf-99367f90c055",
    "requestType": "DELETE_EE_BATCH",
    "imsOrgId": "{ORG_ID}",
    "sandbox": {
        "sandboxName": "prod",
        "sandboxId": "8129954b-fa83-43ba-a995-4bfa8373ba2b"
    },
    "status": "NEW",
    "properties": {
        "datasetId": "66a92c5910df2d1767de13f3",
        "batchId": "01JFSYFDFW9JAAEKHX672JMPSB"
    },
    "createdAt": "2024-12-22T19:44:50.250006Z",
    "updatedAt": "2024-12-22T19:44:50.250006Z"
}

Se si tenta di avviare una richiesta di eliminazione per un batch di set di dati Record, la richiesta non riuscirà.

Visualizzare una richiesta di eliminazione specifica view-a-specific-delete-request

Per visualizzare una richiesta di eliminazione specifica, inclusi dettagli quali lo stato, è possibile eseguire una richiesta di ricerca (GET) all’endpoint /system/jobs e includere l’ID della richiesta di eliminazione nel percorso.

Formato API

GET /system/jobs/{DELETE_REQUEST_ID}

Richiesta

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

Risposta

In caso di esito positivo, la risposta restituisce i dettagli della richiesta di sistema specificata, compreso lo stato aggiornato. L’ID della richiesta di sistema nella risposta deve corrispondere all’ID inviato nel percorso della richiesta.

{
    "requestId": "9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4",
    "requestType": "DELETE_EE_BATCH",
    "imsOrgId": "{ORG_ID}",
    "sandbox": {
        "sandboxName": "prod",
        "sandboxId": "8129954b-fa83-43ba-a995-4bfa8373ba2b"
    },
    "status": "SUCCESS",
    "properties": {
        "batchId": "01JFSYFDFW9JAAEKHX672JMPSB",
        "datasetId": "66a92c5910df2d1767de13f3"
    },
    "createdAt": "2024-12-22T19:44:50.250006Z",
    "updatedAt": "2024-12-22T19:52:13.380706Z"
}

Quando lo stato della richiesta di eliminazione è "SUCCESS", è possibile confermare che i dati sono stati eliminati tentando di accedere ai dati eliminati tramite l’API di accesso ai dati. Per istruzioni su come utilizzare l’API di accesso ai dati per accedere ai set di dati e ai batch, consulta la documentazione sull’accesso ai dati.

Passaggi successivi

Ora che si conoscono i passaggi necessari per eliminare i set di dati e i batch da Profile store in Experience Platform, è possibile eliminare in modo sicuro i dati aggiunti erroneamente o di cui l’organizzazione non ha più bisogno. Tieni presente che una richiesta di cancellazione non può essere annullata, pertanto devi eliminare solo i dati che ritieni non necessari al momento e che non saranno necessari in futuro.