Show Menu
TÓPICOS×

Trabalhos do sistema do Perfil (Excluir solicitações)

A plataforma Adobe Experience permite que você ingira dados de várias fontes e crie perfis robustos para clientes individuais. Os dados ingeridos na plataforma são armazenados no Data Lake e no armazenamento de dados em tempo real do Perfil do cliente. Ocasionalmente, pode ser necessário excluir um conjunto de dados ou lote do repositório de Perfis para remover dados que não são mais necessários ou que foram adicionados por erro. Isso requer o uso da API Perfil do cliente em tempo real para criar um trabalho do sistema do Perfil, também conhecido como "solicitação de exclusão", que também pode ser modificado, monitorado ou removido, se necessário.
Se você estiver tentando excluir conjuntos de dados ou lotes do Data Lake, visite a visão geral do Serviço de Catálogo para obter instruções.

Introdução

Os pontos de extremidade da API usados neste guia fazem parte da API do Perfil do cliente em tempo real. Antes de continuar, consulte o guia do desenvolvedor da API do Perfil do cliente em tempo real. Em particular, a seção de introdução do guia do desenvolvedor do Perfil inclui links para tópicos relacionados, um guia para ler as chamadas de API de amostra neste documento e informações importantes sobre os cabeçalhos necessários que são necessários para fazer chamadas com êxito para quaisquer APIs da plataforma de experiência.

Visualização de solicitações de exclusão

Uma solicitação de exclusão é um processo assíncrono de longa duração, o que significa que sua organização pode estar executando várias solicitações de exclusão ao mesmo tempo. Para visualização de todas as solicitações de exclusão que sua organização está executando no momento, é possível executar uma solicitação GET para o /system/jobs endpoint.
Você também pode usar parâmetros de query opcionais para filtrar a lista de solicitações de exclusão retornadas na resposta. Para usar vários parâmetros, separe cada parâmetro usando um E comercial (&).
Formato da API
GET /system/jobs
GET /system/jobs?{QUERY_PARAMETERS}

Parâmetro
Descrição
start
Deslocar a página de resultados retornados, de acordo com a hora de criação da solicitação. Exemplo: start=4
limit
Limite o número de resultados retornados. Exemplo: limit=10
page
Retorna uma página específica de resultados, de acordo com a hora de criação da solicitação. Exemplo: page=2
sort
Classifique os resultados por um campo específico em ordem crescente ( asc ) ou decrescente ( desc ). O parâmetro de classificação não funciona ao retornar várias páginas de resultados. Exemplo: sort=batchId:asc
Solicitação
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}' \

Resposta
A resposta inclui uma matriz "filhos" com um objeto para cada solicitação de exclusão que contém os detalhes dessa solicitação.
{
  "_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
    }
  ]
}

Propriedade
Descrição
_page.count
O número total de solicitações. Essa resposta foi truncada para espaço.
_page.next
Se existir uma página adicional de resultados, visualização a próxima página de resultados substituindo o valor da ID em uma solicitação de pesquisa pelo valor "próximo" fornecido.
jobType
O tipo de trabalho que está sendo criado. Nesse caso, sempre retornará "EXCLUIR".
status
O status da solicitação de exclusão. Os valores possíveis são "NOVO", "PROCESSAMENTO", "CONCLUÍDO", "ERRO".
métricas
Um objeto que inclui o número de registros que foram processados ("recordsProcessed") e o tempo em segundos que a solicitação está sendo processada, ou o tempo que a solicitação levou para ser concluída ("timeTakenInSec").

Criar uma solicitação de exclusão

A inicialização de uma nova solicitação de exclusão é feita por meio de uma solicitação POST para o /systems/jobs ponto de extremidade, onde a ID do conjunto de dados ou lote a ser excluído é fornecida no corpo da solicitação.

Excluir um conjunto de dados

Para excluir um conjunto de dados, a ID do conjunto de dados deve ser incluída no corpo da solicitação POST. Esta ação excluirá TODOS os dados de um dado conjunto de dados. A Plataforma de experiência permite que você exclua conjuntos de dados com base em schemas de registro e de série de tempo.
Ao tentar excluir um conjunto de dados habilitado para Perfis usando a interface do usuário da plataforma de experiência, o conjunto de dados é desabilitado para inclusão, mas não será excluído até que uma solicitação de exclusão seja criada usando a API. Para obter mais informações, consulte o apêndice a este documento.
Formato da API
POST /system/jobs

Solicitação
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"
      }'

Propriedade
Descrição
dataSetId
(Obrigatório) A ID do conjunto de dados que você deseja excluir.
Resposta
Uma resposta bem-sucedida retorna os detalhes da solicitação de exclusão recém-criada, incluindo uma ID exclusiva gerada pelo sistema e somente leitura para a solicitação. Isso pode ser usado para procurar a solicitação e verificar seu status. A solicitação status no momento da criação é feita "NEW" até que comece o processamento. A resposta dataSetId deve corresponder à dataSetId enviada na solicitação.
{
    "id": "3f225e7e-ac8c-4904-b1d5-0ce79e03c2ec",
    "imsOrgId": "{IMS_ORG}",
    "dataSetId": "5c802d3cd83fc114b741c4b5",
    "jobType": "DELETE",
    "status": "NEW",
    "createEpoch": 1559025404,
    "updateEpoch": 1559025406
}

Propriedade
Descrição
id
A ID exclusiva gerada pelo sistema e somente leitura da solicitação de exclusão.
dataSetId
A ID do conjunto de dados, conforme especificado na solicitação POST.

Excluir um lote

Para excluir um lote, a ID do lote deve ser incluída no corpo da solicitação POST. Lembre-se de que não é possível excluir lotes para conjuntos de dados com base em schemas de registro. Somente lotes para conjuntos de dados com base em schemas de séries de tempo podem ser excluídos.
O motivo pelo qual você não pode excluir lotes de conjuntos de dados com base em schemas de registro é porque os lotes de conjuntos de dados de tipo de registro substituem registros anteriores e, portanto, não podem ser "desfeitos" ou excluídos. A única maneira de remover o impacto de lotes errados para conjuntos de dados baseados em schemas de registro é assimilar o lote com os dados corretos para substituir os registros incorretos.
Para obter mais informações sobre o comportamento de registro e série de tempo, consulte a seção sobre comportamentos de dados XDM na visão geral do Sistema XDM.
Formato da API
POST /system/jobs

Solicitação
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"
      }'

Propriedade
Descrição
batchId
(Obrigatório) A ID do lote que você deseja excluir.
Resposta
Uma resposta bem-sucedida retorna os detalhes da solicitação de exclusão recém-criada, incluindo uma ID exclusiva gerada pelo sistema e somente leitura para a solicitação. Isso pode ser usado para procurar a solicitação e verificar seu status. O "status" da solicitação no momento da criação é "NOVO" até que o processamento seja iniciado. O "batchId" na resposta deve corresponder ao "batchId" enviado na solicitação.
{
    "id": "9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4",
    "imsOrgId": "{IMS_ORG}",
    "batchId": "8d075b5a178e48389126b9289dcfd0ac",
    "jobType": "DELETE",
    "status": "NEW",
    "createEpoch": 1559026131,
    "updateEpoch": 1559026132
}

Propriedade
Descrição
id
A ID exclusiva gerada pelo sistema e somente leitura da solicitação de exclusão.
batchId
A ID do lote, conforme especificado na solicitação POST.
Se você tentar iniciar uma solicitação de exclusão para um lote de conjuntos de dados de Registro, ocorrerá um erro de nível 400, semelhante ao seguinte:
{
    "requestId": "bc4eb29f-63a8-4653-9133-71238884bb81",
    "errors": {
        "400": [
            {
                "code": "500",
                "message": "Batch can only be specified for EE type 'a294e36d382649dab2cc6ad64a41b674'"
            }
        ]
    }
}

Visualização de uma solicitação de exclusão específica

Para visualização de uma solicitação de exclusão específica, incluindo detalhes como seu status, é possível executar uma solicitação de pesquisa (GET) para o /system/jobs ponto de extremidade e incluir a ID da solicitação de exclusão no caminho.
Formato da API
GET /system/jobs/{DELETE_REQUEST_ID}

Parâmetro
Descrição
(Obrigatório) A ID da solicitação de exclusão que você deseja visualização.
Solicitação
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}' \

Resposta
A resposta fornece os detalhes da solicitação de exclusão, incluindo seu status atualizado. A ID da solicitação de exclusão na resposta deve corresponder à ID enviada no caminho da solicitação.
{
    "id": "9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4",
    "imsOrgId": "{IMS_ORG}",
    "batchId": "8d075b5a178e48389126b9289dcfd0ac",
    "jobType": "DELETE",
    "status": "COMPLETED",
    "metrics": "{\"recordsProcessed\":5,\"timeTakenInSec\":1}",
    "createEpoch": 1559026134,
    "updateEpoch": 1559026137
}

Propriedades
Descrição
jobType
O tipo de trabalho que está sendo criado, nesse caso, ele sempre retornará "EXCLUIR".
status
O status da solicitação de exclusão. Valores possíveis: "NOVO", "PROCESSAMENTO", "CONCLUÍDO", "ERRO".
métricas
Uma matriz que inclui o número de registros que foram processados ("recordsProcessed") e o tempo em segundos que a solicitação está sendo processada, ou o tempo que a solicitação levou para ser concluída ("timeTakenInSec").
Quando o status da solicitação de exclusão for "CONCLUÍDA", você poderá confirmar que os dados foram excluídos tentando acessar os dados excluídos usando a API de acesso a dados. Para obter instruções sobre como usar a API de acesso a dados para acessar conjuntos de dados e lotes, consulte a documentação de acesso a dados.

Remover uma solicitação de exclusão

A Plataforma de experiência permite que você exclua uma solicitação anterior, que pode ser útil por vários motivos, incluindo se o trabalho de exclusão não foi concluído ou ficou preso na etapa de processamento. Para remover uma solicitação de exclusão, é possível executar uma solicitação DELETE para o /system/jobs ponto de extremidade e incluir a ID da solicitação de exclusão que você deseja remover para o caminho da solicitação.
Formato da API
DELETE /system/jobs/{DELETE_REQUEST_ID}

Parâmetro
Descrição
A ID da solicitação de exclusão que você deseja remover.
Solicitação
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}' \

Resposta
Uma solicitação de exclusão bem-sucedida retorna o Status HTTP 200 (OK) e um corpo de resposta vazio. Você pode confirmar que a solicitação foi excluída executando uma solicitação GET para visualização da solicitação de exclusão por sua ID. Isso deve retornar um Status HTTP 404 (Não encontrado), indicando que a solicitação de exclusão foi removida.

Próximas etapas

Agora que você sabe as etapas envolvidas na exclusão de conjuntos de dados e lotes da loja de Perfis na plataforma da experiência, é possível excluir com segurança os dados que foram adicionados erroneamente ou que sua organização não precisa mais. Lembre-se de que uma solicitação de exclusão não pode ser desfeita, portanto, você deve excluir apenas os dados de que está confiante que não precisa agora e que não serão necessários no futuro.

Apêndice

As informações a seguir são complementares ao ato de excluir um conjunto de dados do repositório de Perfis.

Excluir um conjunto de dados usando a interface do usuário da plataforma de experiência

Ao usar a interface do usuário da plataforma Experience para excluir um conjunto de dados que foi ativado para o Perfil, uma caixa de diálogo é aberta perguntando: "Tem certeza de que deseja excluir esse conjunto de dados do Experience Data Lake? Use a API 'jobs de sistemas de perfis' para excluir esse conjunto de dados do Serviço de Perfis."
Clicar em Excluir na interface do usuário desativa o conjunto de dados para ingestão, mas NÃO exclui automaticamente o conjunto de dados no backend. Para excluir permanentemente o conjunto de dados, uma solicitação de exclusão deve ser criada manualmente usando as etapas neste guia para criar uma solicitação de exclusão.
A imagem a seguir mostra o aviso ao tentar excluir um conjunto de dados habilitado para Perfis usando a interface do usuário.
Para obter mais informações sobre como trabalhar com conjuntos de dados, comece lendo a visão geral dos conjuntos de dados.