Documentação Experience Platform Guia do Serviço de privacidade

Endpoint de conteúdo

Última atualização: 27 de janeiro de 2025

Tópicos:

Criado para:

Desenvolvedor

Use o ponto de extremidade /content para recuperar com segurança as informações de acesso (as informações que um titular de privacidade pode solicitar para acessar com direito) de seus clientes. A URL de download fornecida na resposta a uma solicitação do GET /jobs/{JOB_ID} aponta para um ponto de extremidade de serviço da Adobe. Você pode fazer uma solicitação GET a /jobs/:JOB_ID/content para retornar os dados do cliente no formato JSON. Esse método de acesso implementa várias camadas de autenticação e controle de acesso para melhorar a segurança.

Antes de usar este guia, consulte o guia de introdução para obter informações sobre os cabeçalhos de autenticação necessários apresentados na chamada de API de exemplo abaixo.

TIP

Se você não souber a ID do trabalho para as informações de acesso necessárias, faça uma chamada para o ponto de extremidade /jobs e use parâmetros de consulta adicionais para filtrar os resultados. Uma lista completa dos parâmetros de consulta disponíveis pode ser encontrada no manual de ponto de extremidade de trabalhos de privacidade.

Recuperar informações do trabalho de privacidade

Para recuperar informações sobre um trabalho específico, como seu status de processamento atual, inclua o jobId desse trabalho no caminho de uma solicitação GET para o ponto de extremidade /jobs.

Formato da API

GET /jobs/{JOB_ID}

Solicitação

A solicitação a seguir recupera os detalhes do trabalho cujo jobId é fornecido no caminho da solicitação.

curl -X GET \
  https://platform.adobe.io/data/core/privacy/jobs/dbe3a6a6-f8e6-11ee-a365-8d1d6df81cc5 \
  -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 do trabalho especificado.

NOTE

Os trabalhos de privacidade devem ter o status complete para conter downloadUrl.

{
    "jobId":"dbe3a6a6-f8e6-11ee-a365-8d1d6df81cc5",
    "requestId":"17129380910360540RX-753",
    "userKey":"1234",
    "action":"access",
    "status":"complete",
    "submittedBy":"jsnow@adobe.com",
    "createdDate":"04/12/2024 04:08 PM GMT",
    "lastModifiedDate":"04/12/2024 04:08 PM GMT",
    "userIds":[{
        "namespace":"ECID",
        "value":"1234",
        "type":"standard",
        "namespaceId":4,
        "isDeletedClientSide":false
        }],
    "productResponses":[{
        "product":"Identity",
        "retryCount":0,
        "processedDate":"04/12/2024 04:08 PM GMT",
        "productStatusResponse":{"status":"submitted"
        }}],
    "downloadUrl":"https://platform.adobe.io/data/core/privacy/jobs/dbe3a6a6-f8e6-11ee-a365-8d1d6df81cc5/content",
    "regulation":"gdpr"
}

Propriedade

Descrição

jobId

Um identificador exclusivo para o trabalho de privacidade.

requestId

Um identificador exclusivo para a solicitação específica feita ao Privacy Service.

userKey

userKey é o valor key fornecido ao enviar a solicitação de privacidade. O valor key é a sua oportunidade de fornecer um identificador para o titular dos dados que faz sentido para você. Normalmente, é um identificador exclusivo que seu sistema criou para rastrear esse titular de dados. DICA: Você pode listar todos os trabalhos de privacidade ativos e comparar seu key com cada trabalho.

action

O tipo de ação solicitada. Os valores aceitos são access e delete.

status

O status atual do trabalho de privacidade.

submittedBy

O endereço de email da pessoa que enviou o trabalho de privacidade.

createdDate

A data e hora em que o trabalho de privacidade foi criado.

lastModifiedDate

A data e a hora em que o trabalho de privacidade foi modificado pela última vez.

userIds

Uma matriz que contém identificadores de usuário e informações relacionadas.

userIds.namespace

O namespace usado para o identificador do usuário.

userIds.value

O valor real do identificador do usuário.

userIds.type

O tipo de identificador (por exemplo, standard ou custom).

userIds.namespaceId

Um identificador para o namespace usado para categorizar e gerenciar identidades de usuário.

userIds.isDeletedClientSide

Um booliano que indica se o identificador foi excluído no lado do cliente.

productResponses

Uma matriz que contém respostas de diferentes produtos ou serviços relacionados ao trabalho de privacidade.

productResponses.product

O nome do produto ou serviço usado para adquirir informações sobre o titular dos dados.

productResponses.retryCount

O número de vezes que a solicitação foi repetida.

productResponses.processedDate

A data e a hora em que a resposta do produto foi processada.

productResponses.productStatusResponse

Um objeto que contém o status da resposta do produto.

productResponses.productStatusResponse.status

O status da resposta do produto.

downloadURL

Esse atributo fornece um endpoint, que está disponível para chamada por 60 dias após a conclusão da tarefa. O status do trabalho deve ser complete e o action deve ser access. Caso contrário, esse campo estará ausente.

regulation

A estrutura regulatória sob a qual a solicitação de privacidade está sendo processada, como gdpr, ccpa, lgpd_bra, pdpa_tha e assim por diante.

Recuperar informações de acesso do cliente

Para obter as "informações de acesso" produzidas em resposta à consulta do titular dos dados, faça uma solicitação GET ao ponto de extremidade /jobs/{JOB_ID}/content. A resposta é um arquivo zip (*.zip) que contém uma pasta com subpastas para cada produto que contém dados sobre o titular dos dados.

TIP

Você precisa de uma ID de tarefa específica para fazer esta solicitação. Se você precisar recuperar a ID de trabalho específica, primeiro faça uma solicitação GET para o ponto de extremidade /jobs e use parâmetros de consulta adicionais para filtrar os resultados. Informações detalhadas incluindo os parâmetros de consulta permitidos podem ser encontradas no manual de ponto de extremidade de trabalhos de privacidade.

Formato da API

GET /jobs/{JOB_ID}/content

Solicitação

A solicitação a seguir retorna "informações de acesso" para a ID do trabalho fornecida na solicitação.

curl -X GET \
  https://platform.adobe.io/data/core/privacy/jobs/32d429b1-f7f4-11ee-a365-574bcf5a525d/content \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'Accept: application/json`

Resposta

A resposta é um arquivo zip (*.zip). Normalmente, as informações são retornadas no formato JSON, embora isso não possa ser garantido. Os dados extraídos podem ser retornados em qualquer formato.

recommendation-more-help