Extremo de trabajos del sistema de perfiles (solicitudes de eliminación)

Adobe Experience Platform le permite introducir datos de varias fuentes y crear perfiles sólidos para clientes individuales. Los datos introducidos en Platform se almacenan en Data Lake y, si los conjuntos de datos se han habilitado para Perfil, también se almacenan en el almacén de datos Real-time Customer Profile. En ocasiones puede ser necesario eliminar un conjunto de datos o lote del almacén de perfiles para eliminar datos que ya no son necesarios o que se agregaron por error. Esto requiere el uso de la API Real-time Customer Profile para crear un trabajo del sistema Profile, o delete request, que también se puede modificar, supervisar o eliminar si es necesario.

NOTA

Si está intentando eliminar conjuntos de datos o lotes del Data Lake, visite la información general del Servicio de catálogo para obtener más información.

Primeros pasos

El extremo de API utilizado en esta guía forma parte de Real-time Customer Profile API. Antes de continuar, consulte la guía de introducción para ver los vínculos a la documentación relacionada, una guía para leer las llamadas de API de ejemplo en este documento e información importante sobre los encabezados necesarios que se necesitan para realizar llamadas correctamente a cualquier API de Experience Platform.

Ver solicitudes de eliminación

Una solicitud de eliminación es un proceso asincrónico de larga duración, lo que significa que su organización puede estar ejecutando varias solicitudes de eliminación a la vez. Para ver todas las solicitudes de eliminación que su organización está ejecutando actualmente, puede realizar una solicitud de GET al extremo /system/jobs .

También puede utilizar parámetros de consulta opcionales para filtrar la lista de solicitudes de eliminación devueltas en la respuesta. Para utilizar varios parámetros, separe cada parámetro con un símbolo & (&).

Formato de API

GET /system/jobs
GET /system/jobs?{QUERY_PARAMETERS}
Parámetro Descripción
start Desplazar la página de resultados devueltos, según la hora de creación de la solicitud. Ejemplo: start=4
limit Limite el número de resultados devueltos. Ejemplo: limit=10
page Devolver una página específica de resultados, según la hora de creación de la solicitud. Ejemplo: page=2
sort Ordene los resultados por un campo específico en orden ascendente (asc) o descendente (desc). El parámetro de ordenación no funciona cuando se devuelven varias páginas de resultados. Ejemplo: sort=batchId:asc

Solicitud

curl -X GET \
  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}' \

Respuesta

La respuesta incluye una matriz "secundario" con un objeto para cada solicitud de eliminación que contiene los detalles de esa solicitud.

{
  "_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
    }
  ]
}
Propiedad Descripción
_page.count Número total de solicitudes. Esta respuesta se ha truncado para el espacio.
_page.next Si existe una página adicional de resultados, vea la siguiente página de resultados reemplazando el valor ID en una solicitud de consulta por el valor "next" proporcionado.
jobType Tipo de trabajo que se está creando. En este caso, siempre devolverá "DELETE".
status Estado de la solicitud de eliminación. Los valores posibles son "NEW", "PROCESSING", "COMPLETED", "ERROR".
metrics Un objeto que incluye el número de registros que se han procesado ("recordsProcessed") y el tiempo en segundos que se ha procesado la solicitud o el tiempo que tardó en completarse ("timeTakenInSec").

Crear una solicitud de eliminación

El inicio de una nueva solicitud de eliminación se realiza mediante una solicitud de POST al extremo /systems/jobs , donde el ID del conjunto de datos o lote que se va a eliminar se proporciona en el cuerpo de la solicitud.

Eliminación de un conjunto de datos

Para eliminar un conjunto de datos del almacén de perfiles, el ID del conjunto de datos debe incluirse en el cuerpo de la solicitud del POST. Esta acción eliminará TODOS los datos de un conjunto de datos determinado. Experience Platform permite eliminar conjuntos de datos en función de esquemas de registros y series temporales.

Formato de API

POST /system/jobs

Solicitud

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"
      }'
Propiedad Descripción
dataSetId (Obligatorio) El ID del conjunto de datos que desea eliminar.

Respuesta

Una respuesta correcta devuelve los detalles de la solicitud de eliminación recién creada, incluido un ID único, generado por el sistema y de solo lectura para la solicitud. Se puede utilizar para buscar la solicitud y comprobar su estado. El status de la solicitud en el momento de la creación es "NEW" hasta que comienza el procesamiento. El dataSetId en la respuesta debe coincidir con el dataSetId enviado en la solicitud.

{
    "id": "3f225e7e-ac8c-4904-b1d5-0ce79e03c2ec",
    "imsOrgId": "{IMS_ORG}",
    "dataSetId": "5c802d3cd83fc114b741c4b5",
    "jobType": "DELETE",
    "status": "NEW",
    "createEpoch": 1559025404,
    "updateEpoch": 1559025406
}
Propiedad Descripción
id ID único, generado por el sistema y de solo lectura de la solicitud de eliminación.
dataSetId El ID del conjunto de datos, tal como se especifica en la solicitud del POST.

Eliminar un lote

Para eliminar un lote, el ID de lote debe incluirse en el cuerpo de la solicitud del POST. Tenga en cuenta que no puede eliminar lotes para conjuntos de datos basados en esquemas de registros. Solo se pueden eliminar lotes para conjuntos de datos basados en esquemas de series temporales.

NOTA

El motivo por el que no se pueden eliminar lotes de conjuntos de datos basados en esquemas de registros es porque los lotes de conjuntos de datos de tipo registro sobrescriben los registros anteriores y, por lo tanto, no se pueden "deshacer" ni eliminar. La única manera de eliminar el impacto de los lotes erróneos para conjuntos de datos basados en esquemas de registros es volver a introducir el lote con los datos correctos para sobrescribir los registros incorrectos.

Para obtener más información sobre el comportamiento de registros y series temporales, consulte la sección sobre los comportamientos de datos XDM en la XDM System información general.

Formato de API

POST /system/jobs

Solicitud

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"
      }'
Propiedad Descripción
batchId (Obligatorio) El ID del lote que desea eliminar.

Respuesta

Una respuesta correcta devuelve los detalles de la solicitud de eliminación recién creada, incluido un ID único, generado por el sistema y de solo lectura para la solicitud. Se puede utilizar para buscar la solicitud y comprobar su estado. El "status" de la solicitud en el momento de la creación es "NEW" hasta que comienza el procesamiento. El valor "batchId" de la respuesta debe coincidir con el valor "batchId" enviado en la solicitud.

{
    "id": "9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4",
    "imsOrgId": "{IMS_ORG}",
    "batchId": "8d075b5a178e48389126b9289dcfd0ac",
    "jobType": "DELETE",
    "status": "NEW",
    "createEpoch": 1559026131,
    "updateEpoch": 1559026132
}
Propiedad Descripción
id ID único, generado por el sistema y de solo lectura de la solicitud de eliminación.
batchId El ID del lote, tal como se especifica en la solicitud del POST.

Si intenta iniciar una solicitud de eliminación para un lote de conjuntos de datos de Record, se producirá un error de nivel 400, similar al siguiente:

{
    "requestId": "bc4eb29f-63a8-4653-9133-71238884bb81",
    "errors": {
        "400": [
            {
                "code": "500",
                "message": "Batch can only be specified for EE type 'a294e36d382649dab2cc6ad64a41b674'"
            }
        ]
    }
}

Ver una solicitud de eliminación específica

Para ver una solicitud de eliminación específica, incluidos detalles como su estado, puede realizar una solicitud de búsqueda (GET) al extremo /system/jobs e incluir el ID de la solicitud de eliminación en la ruta.

Formato de API

GET /system/jobs/{DELETE_REQUEST_ID}
Parámetro Descripción
{DELETE_REQUEST_ID} (Obligatorio) El ID de la solicitud de eliminación que desea ver.

Solicitud

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

Respuesta

La respuesta proporciona los detalles de la solicitud de eliminación, incluido su estado actualizado. El ID de la solicitud de eliminación en la respuesta (el valor "id") debe coincidir con el ID enviado en la ruta de solicitud.

{
    "id": "9c2018e2-cd04-46a4-b38e-89ef7b1fcdf4",
    "imsOrgId": "{IMS_ORG}",
    "batchId": "8d075b5a178e48389126b9289dcfd0ac",
    "jobType": "DELETE",
    "status": "COMPLETED",
    "metrics": "{\"recordsProcessed\":5,\"timeTakenInSec\":1}",
    "createEpoch": 1559026134,
    "updateEpoch": 1559026137
}
Propiedades Descripción
jobType El tipo de trabajo que se está creando, en este caso siempre devolverá "DELETE".
status Estado de la solicitud de eliminación. Valores posibles: "NEW", "PROCESSING", "COMPLETED", "ERROR".
metrics Matriz que incluye el número de registros que se han procesado ("recordsProcessed") y el tiempo en segundos que se ha procesado la solicitud o el tiempo que tardó en completarse ("timeTakenInSec").

Una vez que el estado de la solicitud de eliminación es "COMPLETED", puede confirmar que los datos se han eliminado al intentar acceder a los datos eliminados mediante la API de acceso a datos. Para obtener instrucciones sobre cómo utilizar la API de acceso a datos para acceder a conjuntos de datos y lotes, consulte la Documentación de acceso a datos.

Eliminar una solicitud de eliminación

Experience Platform permite eliminar una solicitud anterior, lo que puede resultar útil por varios motivos, incluido si el trabajo de eliminación no se completó o se quedó atascado en la fase de procesamiento. Para eliminar una solicitud de eliminación, puede realizar una solicitud de DELETE al extremo /system/jobs e incluir el ID de la solicitud de eliminación que desea eliminar en la ruta de solicitud.

Formato de API

DELETE /system/jobs/{DELETE_REQUEST_ID}
Parámetro Descripción
El ID de la solicitud de eliminación que desea eliminar.

Solicitud

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

Respuesta

Una solicitud de eliminación correcta devuelve el estado HTTP 200 (OK) y un cuerpo de respuesta vacío. Puede confirmar que la solicitud se eliminó realizando una solicitud de GET para ver la solicitud de eliminación por su ID. Debe devolver un estado HTTP 404 (no encontrado), que indica que se ha eliminado la solicitud de eliminación.

Pasos siguientes

Ahora que conoce los pasos involucrados en la eliminación de conjuntos de datos y lotes del Profile Store dentro de Experience Platform, puede eliminar de forma segura los datos que se han agregado erróneamente o que su organización ya no necesita. Tenga en cuenta que una solicitud de eliminación no se puede deshacer, por lo que solo debe eliminar los datos que esté seguro de que no necesita ahora y que no los necesitará en el futuro.

En esta página