Show Menu
TEMAS×

Trabajos del sistema de Perfil (Eliminar solicitudes)

Adobe Experience Platform le permite ingestar datos de varias fuentes y crear perfiles sólidos para clientes individuales. Los datos ingeridos en Platform se almacenan en Data Lake y en el almacén de datos de Perfil del cliente en tiempo real. 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 de Perfil del cliente en tiempo real para crear un trabajo del sistema de Perfil, también conocido como "solicitud de eliminación", que también se puede modificar, supervisar o eliminar si es necesario.
Si está intentando eliminar conjuntos de datos o lotes del lago de datos, consulte la información general del servicio de catálogos para obtener instrucciones.

Primeros pasos

Los extremos de API que se utilizan en esta guía forman parte de la API de Perfil del cliente en tiempo real. Antes de continuar, consulte la guía para desarrolladores de la API de Perfil del cliente en tiempo real. En particular, la sección de introducción de la guía para desarrolladores de Perfil incluye vínculos a temas relacionados, una guía para leer las llamadas de API de muestra en este documento e información importante sobre los encabezados necesarios que son necesarios para realizar llamadas con éxito a cualquier API de plataforma de experiencia.

Solicitudes de eliminación de Vistas

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 realizar la vista de todas las solicitudes de eliminación que su organización está ejecutando actualmente, puede realizar una solicitud GET al extremo del /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 API
GET /system/jobs
GET /system/jobs?{QUERY_PARAMETERS}

Parámetro
Descripción
start
Desplaza 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
Ordenar 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 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}' \

Respuesta
La respuesta incluye una matriz "secundarios" 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, reemplace el valor de ID en una solicitud de búsqueda por el valor "siguiente" proporcionado para la vista de la siguiente página de resultados.
jobType
Tipo de trabajo que se va a crear. En este caso, siempre devolverá "ELIMINAR".
status
Estado de la solicitud de eliminación. Los valores posibles son "NEW", "PROCESSING", "COMPLETED", "ERROR".
métricas
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 a través de una solicitud POST al extremo, donde el ID del conjunto de datos o lote que se va a eliminar se proporciona en el cuerpo de la solicitud. /systems/jobs

Eliminar un conjunto de datos

Para eliminar un conjunto de datos, el ID del conjunto de datos debe incluirse en el cuerpo de la solicitud POST. Esta acción eliminará TODOS los datos de un conjunto de datos determinado. La plataforma de experiencia le permite eliminar conjuntos de datos basados en esquemas de registros y series temporales.
Cuando se intenta eliminar un conjunto de datos habilitado para Perfil mediante la interfaz de usuario de la plataforma de experiencia, el conjunto de datos se deshabilita para la ingestión, pero no se elimina hasta que se crea una solicitud de eliminación mediante la API. Para obtener más información, consulte el apéndice de este documento.
Formato 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
(Requerido) 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. La solicitud status en el momento de la creación es "NEW" hasta que comienza el procesamiento. El dataSetId contenido de 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 única, generada por el sistema y de solo lectura de la solicitud de eliminación.
dataSetId
ID del conjunto de datos, tal como se especifica en la solicitud POST.

Eliminar un lote

Para eliminar un lote, el ID de lote debe incluirse en el cuerpo de la solicitud POST. Tenga en cuenta que no puede eliminar lotes para conjuntos de datos en función de esquemas de registros. Solo se pueden eliminar los lotes de conjuntos de datos basados en esquemas de series temporales.
El motivo por el que no se pueden eliminar lotes para conjuntos de datos basados en esquemas de registros es porque los lotes de conjuntos de datos de tipo de 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 ingestar 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 comportamientos de datos XDM en la descripción general del sistema XDM.
Formato 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
(Requerido) 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 "estado" de la solicitud en el momento de la creación es "NUEVO" hasta que comienza el procesamiento. El "batchId" de la respuesta debe coincidir con el "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 única, generada por el sistema y de solo lectura de la solicitud de eliminación.
batchId
ID del lote, tal como se especifica en la solicitud POST.
Si intenta iniciar una solicitud de eliminación para un lote de conjuntos de datos de registro, se producirá un error de 400 niveles, similar al siguiente:
{
    "requestId": "bc4eb29f-63a8-4653-9133-71238884bb81",
    "errors": {
        "400": [
            {
                "code": "500",
                "message": "Batch can only be specified for EE type 'a294e36d382649dab2cc6ad64a41b674'"
            }
        ]
    }
}

Vista de una solicitud de eliminación específica

Para realizar la vista de una solicitud de eliminación específica, incluyendo detalles como su estado, puede realizar una solicitud de búsqueda (GET) al extremo e incluir el ID de la solicitud de eliminación en la ruta de acceso. /system/jobs
Formato API
GET /system/jobs/{DELETE_REQUEST_ID}

Parámetro
Descripción
(Requerido) El ID de la solicitud de eliminación que desea vista.
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 debe coincidir con el ID enviado en la ruta de la 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á "ELIMINAR".
status
Estado de la solicitud de eliminación. Valores posibles: "NUEVO", "PROCESAMIENTO", "COMPLETADO", "ERROR".
métricas
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 "COMPLETADO", puede confirmar que los datos se han eliminado intentando 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

La plataforma de experiencias 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 ELIMINACIÓN al extremo e incluir el ID de la solicitud de eliminación que desea eliminar en la ruta de la solicitud. /system/jobs
Formato API
DELETE /system/jobs/{DELETE_REQUEST_ID}

Parámetro
Descripción
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 Estado HTTP 200 (Aceptar) y un cuerpo de respuesta vacío. Puede confirmar que la solicitud se eliminó realizando una solicitud GET para vista de la solicitud de eliminación por su ID. Esto debe devolver un estado HTTP 404 (no encontrado), que indica que se eliminó la solicitud de eliminación.

Pasos siguientes

Ahora que conoce los pasos necesarios para eliminar conjuntos de datos y lotes del almacén de Perfiles dentro de la plataforma de experiencia, puede eliminar de forma segura los datos que se han agregado por error 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 datos que esté seguro de que no necesita ahora y que no los necesitará en el futuro.

Apéndice

La siguiente información complementa el acto de eliminar un conjunto de datos del almacén de Perfiles.

Eliminación de un conjunto de datos mediante la interfaz de usuario de la plataforma de experiencia

Al utilizar la interfaz de usuario de la plataforma de experiencia para eliminar un conjunto de datos habilitado para Perfil, se abre un cuadro de diálogo en el que se pregunta: "¿Realmente desea eliminar este conjunto de datos del lago de datos de experiencia? Utilice la API de 'trabajos de sistemas de perfil' para eliminar este conjunto de datos del servicio de Perfil."
Al hacer clic en Eliminar en la interfaz de usuario, se deshabilita el conjunto de datos para su inserción, pero NO se elimina automáticamente el conjunto de datos en el servidor. Para eliminar permanentemente el conjunto de datos, se debe crear una solicitud de eliminación manualmente siguiendo los pasos de esta guía para crear una solicitud de eliminación.
La siguiente imagen muestra la advertencia al intentar eliminar un conjunto de datos con Perfil habilitado mediante la interfaz de usuario.
Para obtener más información sobre cómo trabajar con conjuntos de datos, lea la información general de los conjuntos de datos.