Ponto de extremidade de tarefas de privacidade

Este documento aborda como trabalhar com tarefas de privacidade usando chamadas de API. Especificamente, abrange a utilização da variável /job endpoint no Privacy Service API. Antes de ler este guia, consulte guia de introdução para obter informações importantes que você precisa saber para fazer chamadas para a API com sucesso, incluindo cabeçalhos necessários e como ler chamadas de API de exemplo.

Listar todas as tarefas

Você pode exibir uma lista de todos os trabalhos de privacidade disponíveis em sua organização, fazendo uma solicitação do GET para a /jobs endpoint .

Formato da API

Esse formato de solicitação usa um regulation parâmetro de consulta no /jobs endpoint, portanto, começa com um ponto de interrogação (?) conforme mostrado abaixo. A resposta é paginada, permitindo usar outros parâmetros de consulta (page e size) para filtrar a resposta. Você pode separar vários parâmetros usando o sinal gráfico (&).

GET /jobs?regulation={REGULATION}
GET /jobs?regulation={REGULATION}&page={PAGE}
GET /jobs?regulation={REGULATION}&size={SIZE}
GET /jobs?regulation={REGULATION}&page={PAGE}&size={SIZE}

Solicitação

A solicitação a seguir recupera uma lista paginada de todas as tarefas em uma Organização IMS, começando na terceira página com um tamanho de página de 50.

curl -X GET \
  https://platform.adobe.io/data/core/privacy/jobs?regulation=gdpr&page=2&size=50 \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}'

Resposta

Uma resposta bem-sucedida retorna uma lista de tarefas, com cada tarefa contendo detalhes como jobId. Neste exemplo, a resposta conteria uma lista de 50 trabalhos, começando na terceira página de resultados.

Acessar páginas subsequentes

Para obter o próximo conjunto de resultados em uma resposta paginada, você deve fazer outra chamada de API para o mesmo endpoint enquanto aumenta o valor de page parâmetro de consulta por 1.

Criar um trabalho de privacidade

Antes de criar uma nova solicitação de cargo, você deve primeiro coletar informações de identificação sobre os titulares de dados cujos dados deseja acessar, excluir ou recusar a venda. Depois de ter os dados necessários, eles devem ser fornecidos na carga de uma solicitação do POST para a variável /jobs endpoint .

O Privacy Service A API suporta dois tipos de solicitações de trabalho para dados pessoais:

• Acessar e/ou excluir: Acesse (leia) ou exclua dados pessoais.
• Recusar venda: Marcar dados pessoais como não vendidos.

Criar um trabalho de acesso/exclusão

Esta seção demonstra como fazer uma solicitação de acesso/exclusão de trabalho usando a API.

Formato da API

POST /jobs

Solicitação

A solicitação a seguir cria uma nova solicitação de trabalho, configurada pelos atributos fornecidos na carga, conforme descrito abaixo.

curl -X POST \
  https://platform.adobe.io/data/core/privacy/jobs \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -d '{
    "companyContexts": [
      {
        "namespace": "imsOrgID",
        "value": "{ORG_ID}"
      }
    ],
    "users": [
      {
        "key": "DavidSmith",
        "action": ["access"],
        "userIDs": [
          {
            "namespace": "email",
            "value": "dsmith@acme.com",
            "type": "standard"
          },
          {
            "namespace": "ECID",
            "type": "standard",
            "value":  "443636576799758681021090721276",
            "isDeletedClientSide": false
          }
        ]
      },
      {
        "key": "user12345",
        "action": ["access","delete"],
        "userIDs": [
          {
            "namespace": "email",
            "value": "ajones@acme.com",
            "type": "standard"
          },
          {
            "namespace": "loyaltyAccount",
            "value": "12AD45FE30R29",
            "type": "integrationCode"
          }
        ]
      }
    ],
    "include": ["Analytics", "AudienceManager","profileService"],
    "expandIds": false,
    "priority": "normal",
    "analyticsDeleteMethod": "anonymize",
    "mergePolicyId": 124,
    "regulation": "ccpa"
}'

Resposta

Uma resposta bem-sucedida retorna os detalhes dos trabalhos recém-criados.

{
    "jobs": [
        {
            "jobId": "6fc09b53-c24f-4a6c-9ca2-c6076b0842b6",
            "customer": {
                "user": {
                    "key": "DavidSmith",
                    "action": [
                        "access"
                    ]
                }
            }
        },
        {
            "jobId": "6fc09b53-c24f-4a6c-9ca2-c6076be029f3",
            "customer": {
                "user": {
                    "key": "user12345",
                    "action": [
                        "access"
                    ]
                }
            }
        },
        {
            "jobId": "6fc09b53-c24f-4a6c-9ca2-c6076bd023j1",
            "customer": {
                "user": {
                    "key": "user12345",
                    "action": [
                        "delete"
                    ]
                }
            }
        }
    ],
    "requestStatus": 1,
    "totalRecords": 3
}

Depois de enviar a solicitação de trabalho com sucesso, você pode prosseguir para a próxima etapa de verificar o status da tarefa.

Verificar o status de um trabalho

Você pode recuperar informações sobre um trabalho específico, como seu status de processamento atual, incluindo o jobId no caminho de uma solicitação do GET para o /jobs endpoint .

Formato da API

GET /jobs/{JOB_ID}

Solicitação

A solicitação a seguir recupera os detalhes da tarefa cuja jobId é fornecido no caminho da solicitação.

curl -X GET \
  https://platform.adobe.io/data/core/privacy/jobs/6fc09b53-c24f-4a6c-9ca2-c6076b0842b6 \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}'

Resposta

Uma resposta bem-sucedida retorna os detalhes da tarefa especificada.

{
    "jobId": "6fc09b53-c24f-4a6c-9ca2-c6076b0842b6",
    "requestId": "15700479082313109RX-899",
    "userKey": "David Smith",
    "action": "access",
    "status": "complete",
    "submittedBy": "{ACCOUNT_ID}",
    "createdDate": "10/02/2019 08:25 PM GMT",
    "lastModifiedDate": "10/02/2019 08:25 PM GMT",
    "userIds": [
        {
            "namespace": "email",
            "value": "dsmith@acme.com",
            "type": "standard",
            "namespaceId": 6,
            "isDeletedClientSide": false
        },
        {
            "namespace": "ECID",
            "value": "1123A4D5690B32A",
            "type": "standard",
            "namespaceId": 4,
            "isDeletedClientSide": false
        }
    ],
    "productResponses": [
        {
            "product": "Analytics",
            "retryCount": 0,
            "processedDate": "10/02/2019 08:25 PM GMT",
            "productStatusResponse": {
                "status": "complete",
                "message": "Success",
                "responseMsgCode": "PRVCY-6000-200",
                "responseMsgDetail": "Finished successfully."
            }
        },
        {
            "product": "Profile",
            "retryCount": 0,
            "processedDate": "10/02/2019 08:25 PM GMT",
            "productStatusResponse": {
                "status": "complete",
                "message": "Success",
                "responseMsgCode": "PRVCY-6000-200",
                "responseMsgDetail": "Success dataSetIds = [5dbb87aad37beb18a96feb61], Failed dataSetIds = []"
            }
        },
        {
            "product": "AudienceManager",
            "retryCount": 0,
            "processedDate": "10/02/2019 08:25 PM GMT",
            "productStatusResponse": {
                "status": "complete",
                "message": "Success",
                "responseMsgCode": "PRVCY-6054-200",
                "responseMsgDetail": "PARTIALLY COMPLETED- Data not found for some requests, check results for more info.",
                "results": {
                  "processed": ["1123A4D5690B32A"],
                  "ignored": ["dsmith@acme.com"]
                }
            }
        }
    ],
    "downloadURL": "http://...",
    "regulation": "ccpa"
}

Categorias de status da tarefa

A tabela a seguir lista as diferentes categorias possíveis de status da tarefa e seu significado correspondente:

Próximas etapas

Agora você sabe como criar e monitorar tarefas de privacidade usando o Privacy Service API. Para obter informações sobre como executar as mesmas tarefas usando a interface do usuário, consulte o Visão geral da interface do usuário do Privacy Service.

Recursos do Business.Adobe.com

Digital Foundation Auto Text Summarization Responsive Forms Data Explorer General Data Protection Regulation People Based Marketing