Extremo de trabajos de privacidad

Este documento explica cómo trabajar con trabajos de privacidad mediante llamadas a la API. En concreto, cubre el uso del extremo /job en la API Privacy Service. Antes de leer esta guía, consulte la guía de introducción para obtener información importante que necesita conocer para realizar correctamente llamadas a la API, incluidos los encabezados obligatorios y cómo leer llamadas de API de ejemplo.

Enumerar todos los trabajos list

Puede ver una lista de todos los trabajos de privacidad disponibles en su organización realizando una solicitud de GET al extremo /jobs.

Formato de API

Este formato de solicitud usa un parámetro de consulta regulation en el extremo /jobs, por lo que comienza con un signo de interrogación (?) como se muestra a continuación. Al enumerar recursos, la API de Privacy Service devuelve hasta 1000 trabajos y pagina la respuesta. Use otros parámetros de consulta (page, size y filtros de fecha) para filtrar la respuesta. Puede separar varios parámetros mediante el símbolo et (&).

GET /jobs?regulation={REGULATION}
GET /jobs?regulation={REGULATION}&page={PAGE}
GET /jobs?regulation={REGULATION}&size={SIZE}
GET /jobs?regulation={REGULATION}&page={PAGE}&size={SIZE}
GET /jobs?regulation={REGULATION}&fromDate={FROMDATE}&toDate={TODATE}&status={STATUS}

Solicitud

La siguiente solicitud recupera una lista paginada de todos los trabajos de una organización, a partir de la tercera página con un tamaño 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}'

Respuesta

Una respuesta correcta devuelve una lista de trabajos, y cada trabajo contiene detalles como su jobId. En este ejemplo, la respuesta contendría una lista de 50 trabajos, a partir de la tercera página de resultados.

Acceso a páginas subsiguientes

Para obtener el siguiente conjunto de resultados en una respuesta paginada, debe realizar otra llamada de API al mismo extremo y aumentar el parámetro de consulta page en 1.

Creación de un trabajo de privacidad create-job

Antes de crear una nueva solicitud de trabajo, primero debe recopilar información de identificación de los interesados a cuyos datos desea acceder, eliminar o excluir de la venta. Una vez que tenga los datos requeridos, deben proporcionarse en la carga de una solicitud de POST al extremo /jobs.

La API Privacy Service admite dos tipos de solicitudes de trabajo para datos personales:

Creación de un trabajo de acceso o eliminación access-delete

Esta sección muestra cómo realizar una solicitud de trabajo de acceso o eliminación mediante la API.

Formato de API

POST /jobs

Solicitud

La siguiente solicitud crea una nueva solicitud de trabajo, configurada por los atributos proporcionados en la carga útil como se describe a continuación.

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",
    "mergePolicyId": 124,
    "regulation": "ccpa"
}'

Respuesta

Una respuesta correcta devuelve los detalles de los trabajos recién creados.

{
    "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
}

Una vez que haya enviado correctamente la solicitud de trabajo, puede continuar con el siguiente paso de comprobar el estado del trabajo.

Comprobar el estado de un trabajo check-status

Puede recuperar información sobre un trabajo específico, como su estado de procesamiento actual, incluyendo el jobId de ese trabajo en la ruta de una solicitud de GET al extremo /jobs.

Formato de API

GET /jobs/{JOB_ID}

Solicitud

La siguiente solicitud recupera los detalles del trabajo cuyo jobId se ha proporcionado en la ruta de solicitud.

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}'

Respuesta

Una respuesta correcta devuelve los detalles del trabajo especificado.

{
    "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"
}

Categorías de estado del trabajo status-categories

En la tabla siguiente se enumeran las diferentes categorías de estado de trabajo posibles y su significado correspondiente:

Pasos siguientes

Ahora sabe cómo crear y supervisar trabajos de privacidad mediante la API Privacy Service. Para obtener información sobre cómo realizar las mismas tareas con la interfaz de usuario, vea la descripción general de la interfaz de usuario del Privacy Service.