Endpoint processi del sistema di profilo (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 Platform vengono memorizzati sia nell'archivio Data Lake che nell'archivio Real-time Customer Profile dati. Talvolta potrebbe essere necessario eliminare un set di dati o un batch dall'archivio profili per rimuovere i dati non più necessari o che sono stati aggiunti per errore. Ciò richiede l'utilizzo dell' Real-time Customer Profile API per creare un processo di Profile sistema, noto anche come "delete request", che può essere modificato, monitorato o rimosso se necessario.

NOTA

Se state tentando di eliminare i set di dati o i batch dal Data Lake, consultate la panoramica del servizio catalogo per le istruzioni.

Introduzione

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

Visualizza richieste di eliminazione

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, potete eseguire una richiesta di GET all’ /system/jobs endpoint.

È inoltre possibile utilizzare parametri di query facoltativi per filtrare l'elenco delle richieste di eliminazione restituite nella risposta. Per utilizzare più parametri, separateli utilizzando una e commerciale (&).

Formato API

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

Parametro	Descrizione
`start`	Consente di scostare la pagina dei risultati restituiti, in base al tempo di creazione della richiesta. Esempio: `start=4`
`limit`	Limita il numero di risultati restituiti. Esempio: `limit=10`
`page`	Restituisce una pagina specifica di risultati, in base all’ora di creazione della richiesta. Esempio: `page=2`
`sort`	Ordinare i risultati in base a un campo specifico in ordine crescente (`asc`) o decrescente (`desc`). Il parametro sort non funziona quando si restituiscono più pagine di risultati. Esempio: `sort=batchId:asc`

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: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \

Risposta

La risposta include un array "child" con un oggetto per ogni richiesta di eliminazione contenente i dettagli di tale richiesta.

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

Proprietà	Descrizione
`_page.count`	Numero totale di richieste. Questa risposta è stata troncata per lo spazio.
`_page.next`	Se esiste una pagina aggiuntiva di risultati, puoi visualizzare la pagina successiva dei risultati sostituendo il valore ID in una richiesta di ricerca con il `"next"` valore fornito.
`jobType`	Tipo di processo da creare. In questo caso, tornerà sempre `"DELETE"`.
`status`	Stato della richiesta di eliminazione. I valori possibili sono `"NEW"`, `"PROCESSING"`, `"COMPLETED"`, `"ERROR"`.
`metrics`	Un oggetto che include il numero di record elaborati (`"recordsProcessed"`) e il tempo in secondi durante il quale la richiesta è stata elaborata, oppure il tempo necessario per completare (`"timeTakenInSec"`) la richiesta.

Creare una richiesta di eliminazione

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

Eliminare un dataset

Per eliminare un set di dati, l'ID del set di dati deve essere incluso nel corpo della richiesta del POST. Questa azione eliminerà TUTTI i dati per un dato dataset. Experience Platform consente di eliminare i set di dati basati su schemi di record e serie temporali.

ATTENZIONE

Quando si tenta di eliminare un set di dati Profileabilitato tramite l' Experience Platform interfaccia utente, il set di dati viene disabilitato per l'inserimento ma non viene eliminato finché non viene creata una richiesta di eliminazione tramite l'API. Per ulteriori informazioni, vedere l' appendice di questo documento.

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: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
        "dataSetId": "5c802d3cd83fc114b741c4b5"
      }'

Proprietà	Descrizione
`dataSetId`	(Obbligatorio) L'ID del set di dati da eliminare.

Risposta

Una risposta corretta restituisce i dettagli della nuova richiesta di eliminazione, incluso un ID di sola lettura univoco generato dal sistema per la richiesta. Questo può essere utilizzato per cercare la richiesta e controllarne lo stato. La richiesta status al momento della creazione è "NEW" fino all’inizio dell’elaborazione. Il contenuto dataSetId della risposta deve corrispondere a quello dataSetId inviato nella richiesta.

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

Proprietà	Descrizione
`id`	ID univoco, generato dal sistema, di sola lettura della richiesta di eliminazione.
`dataSetId`	L'ID del dataset, come specificato nella richiesta POST.

Eliminare un batch

Per eliminare un batch, l'ID batch deve essere incluso nel corpo della richiesta POST. Non è possibile eliminare i batch per i set di dati basati sugli schemi di record. È possibile eliminare solo i batch per i set di dati basati sugli schemi delle serie temporali.

NOTA

Il motivo per cui non è possibile eliminare i batch per i set di dati basati su schemi di record è che i batch di set di dati di tipo record sovrascrivono i record precedenti e pertanto non possono essere "annullati" o eliminati. L'unico modo per rimuovere l'impatto dei batch errati per i set di dati basati sugli schemi di record consiste nel ripetere l'inserimento del batch con i dati corretti per sovrascrivere i record errati.

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

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: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
       "batchId": "8d075b5a178e48389126b9289dcfd0ac"
      }'

Proprietà	Descrizione
`batchId`	(Obbligatorio) L'ID del batch da eliminare.

Risposta

Una risposta corretta restituisce i dettagli della nuova richiesta di eliminazione, incluso un ID di sola lettura univoco generato dal sistema per la richiesta. Questo può essere utilizzato per cercare la richiesta e controllarne lo stato. La richiesta "status" al momento della creazione è "NEW" fino all’inizio dell’elaborazione. Il contenuto "batchId" della risposta deve corrispondere a quello "batchId" inviato nella richiesta.

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

Proprietà	Descrizione
`id`	ID univoco, generato dal sistema, di sola lettura della richiesta di eliminazione.
`batchId`	L'ID del batch, come specificato nella richiesta POST.

Se si tenta di avviare una richiesta di eliminazione per un batch di set di dati di record, si verificherà un errore a 400 livelli, simile al seguente:

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

Visualizzare una richiesta di eliminazione specifica

Per visualizzare una richiesta di eliminazione specifica, con dettagli quali il relativo stato, potete eseguire una richiesta di ricerca (GET) all' /system/jobs endpoint e includere nel percorso l'ID della richiesta di eliminazione.

Formato API

GET /system/jobs/{DELETE_REQUEST_ID}

Parametro	Descrizione
`{DELETE_REQUEST_ID}`	(Obbligatorio) L'ID della richiesta di eliminazione che si desidera visualizzare.

Richiesta

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: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \

Risposta

La risposta fornisce i dettagli della richiesta di eliminazione, incluso il suo stato aggiornato. L’ID della richiesta di eliminazione nella risposta deve corrispondere all’ID inviato nel percorso della richiesta.

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

Proprietà	Descrizione
`jobType`	Il tipo di processo creato, in questo caso tornerà sempre `"DELETE"`.
`status`	Stato della richiesta di eliminazione. Valori possibili: `"NEW"`, `"PROCESSING"`, `"COMPLETED"`, `"ERROR"`.
`metrics`	Un array che include il numero di record elaborati (`"recordsProcessed"`) e il tempo in secondi durante il quale la richiesta è stata elaborata, oppure il tempo necessario per completare (`"timeTakenInSec"`) la richiesta.

Una volta che lo stato della richiesta di eliminazione è "COMPLETED" possibile confermare che i dati sono stati eliminati cercando 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 a set di dati e batch, consulta la documentazione sull’accesso aidati.

Rimozione di una richiesta di eliminazione

Experience Platform consente di eliminare una richiesta precedente, che può essere utile per una serie di motivi, ad esempio se il processo di eliminazione non è stato completato o si è bloccato nella fase di elaborazione. Per rimuovere una richiesta di eliminazione, potete eseguire una richiesta di DELETE all' /system/jobs endpoint e includere l'ID della richiesta di eliminazione che desiderate rimuovere nel percorso della richiesta.

Formato API

DELETE /system/jobs/{DELETE_REQUEST_ID}

Parametro	Descrizione
	ID della richiesta di eliminazione che si desidera rimuovere.

Richiesta

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: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \

Risposta

Una richiesta di eliminazione riuscita restituisce lo stato HTTP 200 (OK) e un corpo di risposta vuoto. Per confermare che la richiesta è stata eliminata, eseguite una richiesta di GET per visualizzare la richiesta di eliminazione con il relativo ID. Deve restituire uno stato HTTP 404 (non trovato), a indicare che la richiesta di eliminazione è stata rimossa.

Passaggi successivi

Ora che si conoscono i passaggi necessari per eliminare i set di dati e i batch dall' Profile Store interno Experience Platform, è possibile eliminare in modo sicuro i dati che sono stati aggiunti erroneamente o che l'organizzazione non ha più bisogno. Ricorda che una richiesta di eliminazione non può essere annullata, pertanto devi solo eliminare i dati che sono sicuri di non aver bisogno ora e non sarà necessario in futuro.

Appendice

Le seguenti informazioni sono supplementari rispetto all’eliminazione di un set di dati dal Profile Store.

Eliminazione di un set di dati tramite l’ Experience Platform interfaccia utente

Quando si utilizza l'interfaccia Experience Platform utente per eliminare un set di dati abilitato per Profile, si apre una finestra di dialogo in cui viene chiesto: "Eliminare il set di dati dal Experience Data Lake? Utilizzate l'API 'profile systems jobs' per eliminare questo set di dati dal Profile Service."

Facendo clic Delete nell'interfaccia utente, il dataset viene disattivato per l'inserimento, ma NON viene eliminato automaticamente il dataset nel backend. Per eliminare definitivamente il dataset, è necessario creare manualmente una richiesta di eliminazione tramite i passaggi descritti in questa guida per creare una richiestadi eliminazione.

L'immagine seguente mostra l'avviso quando si tenta di eliminare un set di dati Profileabilitato tramite l'interfaccia utente.

Per ulteriori informazioni sull'utilizzo dei set di dati, consultare la panoramica deiset di dati.

Risorse su adobe.com

Omnichannel Personalization Campaign Reporting Customer Journey Email Service Providers First Party Data Attribution

In questa pagina

Visualizza successivo:

Privacy (AGGIORNATO)

Condizioni d’uso