Show Menu
ARGOMENTI×

Processi del sistema dei profili (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 Piattaforma vengono memorizzati nel Data Lake e nell'archivio dati del profilo cliente in tempo reale. Talvolta potrebbe essere necessario eliminare un set di dati o un batch dall'archivio dei profili per rimuovere i dati non più necessari o che sono stati aggiunti per errore. Ciò richiede l’utilizzo dell’API Profilo cliente in tempo reale per creare un processo del sistema di profili, noto anche come "richiesta di eliminazione", che può anche essere modificato, monitorato o rimosso, se necessario.
Se state tentando di eliminare insiemi di dati o batch dal Data Lake, consultate la panoramica del servizio catalogo per le istruzioni.

Introduzione

Gli endpoint API utilizzati in questa guida fanno parte dell'API Profilo cliente in tempo reale. Prima di continuare, consulta la guida per lo sviluppatore di API profilo cliente in tempo reale. In particolare, la sezione Introduzione introduttiva della guida per gli sviluppatori di profili include collegamenti a argomenti correlati, una guida alla lettura delle chiamate API di esempio in questo documento e informazioni importanti sulle intestazioni richieste necessarie per eseguire correttamente chiamate a qualsiasi API della piattaforma Experience.

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 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 POST \
  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 valore "next" fornito.
jobType
Tipo di processo da creare. In questo caso, restituirà sempre "DELETE".
status
Stato della richiesta di eliminazione. I valori possibili sono "NEW", "PROCESSING", "COMPLETED", "ERROR".
metriche
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 impiegato per completare la richiesta ("timeTakenInSec").

Creare una richiesta di eliminazione

L'avvio di una nuova richiesta di eliminazione viene eseguito tramite una richiesta 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 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.
Quando si tenta di eliminare un dataset abilitato per il profilo utilizzando l'interfaccia utente della piattaforma Experience, il dataset viene disattivato per l'inserimento ma non verrà 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
ID del set di dati, 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.
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 è quello di ripetere il 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 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: {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. Lo "stato" della richiesta al momento della creazione è "NUOVO" fino all’inizio dell’elaborazione. Il "batchId" nella risposta deve corrispondere al "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, inclusi dettagli come il suo stato, potete eseguire una richiesta di ricerca (GET) all' /system/jobs endpoint e includere l'ID della richiesta di eliminazione nel percorso.
Formato API
GET /system/jobs/{DELETE_REQUEST_ID}

Parametro
Descrizione
(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 restituirà sempre "DELETE".
status
Stato della richiesta di eliminazione. Valori possibili: "NEW", "PROCESSING", "COMPLETED", "ERROR".
metriche
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 impiegato per completare la richiesta ("timeTakenInSec").
Una volta che lo stato della richiesta di eliminazione è "COMPLETATO", puoi 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 ai dati.

Rimozione di una richiesta di eliminazione

Experience Platform consente di eliminare una richiesta precedente, che può essere utile per diversi 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 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. Potete confermare che la richiesta è stata eliminata eseguendo una richiesta 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 conosci i passaggi necessari per eliminare set di dati e batch dallo store Profilo all’interno di Experience Platform, puoi eliminare in modo sicuro i dati che sono stati aggiunti erroneamente o che la tua 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 complementari all’eliminazione di un set di dati dallo store Profilo.

Eliminazione di un set di dati tramite l’interfaccia utente della piattaforma Experience

Quando si utilizza l'interfaccia utente di Experience Platform per eliminare un set di dati abilitato per il profilo, si apre una finestra di dialogo in cui si chiede: "Eliminare il set di dati dal lago di dati esperienza? Utilizzate l'API 'profile systems jobs' per eliminare questo set di dati dal servizio profili."
Facendo clic su Elimina nell'interfaccia utente, il set di dati viene disattivato per l'inserimento, ma NON viene eliminato automaticamente il set di dati nel backend. Per eliminare definitivamente il set di dati, è necessario creare manualmente una richiesta di eliminazione tramite i passaggi descritti in questa guida per creare una richiesta di eliminazione.
L'immagine seguente mostra l'avviso quando si tenta di eliminare un dataset abilitato per il profilo utilizzando l'interfaccia utente.
Per ulteriori informazioni sull'utilizzo dei set di dati, consultare la panoramica dei set di dati.