DocumentaciónExperience PlatformGuía de ingesta de datos

Guía para desarrolladores de ingesta por lotes

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Creado para:

  • Desarrollador

Este documento proporciona una guía completa para usar extremos de API de ingesta por lotes en Adobe Experience Platform. Para obtener una descripción general de las API de ingesta por lotes, incluidos los requisitos previos y las prácticas recomendadas, lea la descripción general de la API de ingesta por lotes.

En el apéndice de este documento se proporciona información sobre los datos de formato que se utilizarán para la ingesta, incluidos los archivos de datos CSV y JSON de ejemplo.

Introducción

Los extremos de API utilizados en esta guía forman parte de la API de ingesta por lotes. La ingesta por lotes se proporciona a través de una API RESTful, donde puede realizar operaciones básicas de CRUD con los tipos de objetos admitidos.

Antes de continuar, revise la descripción general de la API de ingesta por lotes y la guía de introducción.

Ingesta de archivos JSON

NOTE
Los siguientes pasos son aplicables a archivos pequeños (256 MB o menos). Si supera el tiempo de espera de una puerta de enlace o solicita errores de tamaño de cuerpo, debe cambiar a una carga de archivo grande.

Crear lote

En primer lugar, debe crear un lote, con JSON como formato de entrada. Al crear el lote, deberá proporcionar un ID de conjunto de datos. También deberá asegurarse de que todos los archivos cargados como parte del lote se ajusten al esquema XDM vinculado al conjunto de datos proporcionado.

NOTE
Los ejemplos siguientes son para JSON de una sola línea. Para ingerir JSON multilínea, se deberá establecer el indicador isMultiLineJson. Para obtener más información, lea la guía de solución de problemas de ingesta por lotes.

Formato de API

POST /batches

Solicitud

curl -X POST https://platform.adobe.io/data/foundation/import/batches \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
          "datasetId": "{DATASET_ID}",
           "inputFormat": {
                "format": "json"
           }
      }'
Parámetro
Descripción
{DATASET_ID}
ID del conjunto de datos de referencia.

Respuesta

{
    "id": "{BATCH_ID}",
    "imsOrg": "{ORG_ID}",
    "updated": 0,
    "status": "loading",
    "created": 0,
    "relatedObjects": [
        {
            "type": "dataSet",
            "id": "{DATASET_ID}"
        }
    ],
    "version": "1.0.0",
    "tags": {},
    "createdUser": "{USER_ID}",
    "updatedUser": "{USER_ID}"
}
Parámetro
Descripción
{BATCH_ID}
El ID del lote recién creado.
{DATASET_ID}
El ID del conjunto de datos al que se hace referencia.

Cargar archivos

Ahora que ha creado un lote, puede utilizar el ID de lote de la respuesta de creación de lotes para cargar archivos en el lote. Puede cargar varios archivos en el lote.

NOTE
Consulte la sección del apéndice para ver un ejemplo de un archivo de datos JSON con formato correcto.

Formato de API

PUT /batches/{BATCH_ID}/datasets/{DATASET_ID}/files/{FILE_NAME}
Parámetro
Descripción
{BATCH_ID}
El ID del lote al que desea cargar.
{DATASET_ID}
ID del conjunto de datos de referencia del lote.
{FILE_NAME}
El nombre del archivo que desea cargar. Asegúrese de utilizar un nombre de archivo único para que no entre en conflicto con otro archivo para el lote de archivos que se envía.

Solicitud

NOTE
La API admite la carga de una sola parte. Asegúrese de que content-type es application/octet-stream.
curl -X PUT https://platform.adobe.io/data/foundation/import/batches/{BATCH_ID}/datasets/{DATASET_ID}/files/{FILE_NAME}.json \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'content-type: application/octet-stream' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  --data-binary "@{FILE_PATH_AND_NAME}.json"
Parámetro
Descripción
{FILE_PATH_AND_NAME}
Ruta de acceso completa y nombre del archivo que intenta cargar. Esta ruta de acceso es la ruta de acceso del archivo local, como acme/customers/campaigns/summer.json.

Respuesta

200 OK

Completar lote

Una vez que haya terminado de cargar todas las diferentes partes del archivo, deberá indicar que los datos se han cargado completamente y que el lote está listo para la promoción.

Formato de API

POST /batches/{BATCH_ID}?action=COMPLETE
Parámetro
Descripción
{BATCH_ID}
El ID del lote al que desea cargar.

Solicitud

curl -X POST "https://platform.adobe.io/data/foundation/import/batches/{BATCH_ID}?action=COMPLETE" \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Respuesta

200 OK

Ingesta de archivos de Parquet ingest-parquet-files

NOTE
Los siguientes pasos son aplicables a archivos pequeños (256 MB o menos). Si supera el tiempo de espera de una puerta de enlace o solicita errores de tamaño de cuerpo, deberá cambiar a una carga de archivo grande.

Crear lote

En primer lugar, deberá crear un lote, con Parquet como formato de entrada. Al crear el lote, deberá proporcionar un ID de conjunto de datos. También deberá asegurarse de que todos los archivos cargados como parte del lote se ajusten al esquema XDM vinculado al conjunto de datos proporcionado.

Solicitud

curl -X POST "https://platform.adobe.io/data/foundation/import/batches" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "Content-Type: application/json" \
  -H "x-gw-ims-org-id: {ORG_ID}" \
  -H "x-api-key: {API_KEY}" \
  -H "x-sandbox-name: {SANDBOX_NAME}"
  -d '{
          "datasetId": "{DATASET_ID}",
           "inputFormat": {
                "format": "parquet"
           }
      }'
Parámetro
Descripción
{DATASET_ID}
ID del conjunto de datos de referencia.

Respuesta

201 Created

{
    "id": "{BATCH_ID}",
    "imsOrg": "{ORG_ID}",
    "updated": 0,
    "status": "loading",
    "created": 0,
    "relatedObjects": [
        {
            "type": "dataSet",
            "id": "{DATASET_ID}"
        }
    ],
    "version": "1.0.0",
    "tags": {},
    "createdUser": "{USER_ID}",
    "updatedUser": "{USER_ID}"
}
Parámetro
Descripción
{BATCH_ID}
El ID del lote recién creado.
{DATASET_ID}
El ID del conjunto de datos al que se hace referencia.
{USER_ID}
El ID del usuario que creó el lote.

Cargar archivos

Ahora que ha creado un lote, puede usar batchId de antes para cargar los archivos en el lote. Puede cargar varios archivos en el lote.

Formato de API

PUT /batches/{BATCH_ID}/datasets/{DATASET_ID}/files/{FILE_NAME}
Parámetro
Descripción
{BATCH_ID}
El ID del lote al que desea cargar.
{DATASET_ID}
ID del conjunto de datos de referencia del lote.
{FILE_NAME}
El nombre del archivo que desea cargar. Asegúrese de utilizar un nombre de archivo único para que no entre en conflicto con otro archivo para el lote de archivos que se envía.

Solicitud

CAUTION
Esta API admite la carga de una sola parte. Asegúrese de que content-type es application/octet-stream.
curl -X PUT https://platform.adobe.io/data/foundation/import/batches/{BATCH_ID}/datasets/{DATASET_ID}/files/{FILE_NAME}.parquet \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/octet-stream' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  --data-binary "@{FILE_PATH_AND_NAME}.parquet"
Parámetro
Descripción
{FILE_PATH_AND_NAME}
Ruta de acceso completa y nombre del archivo que intenta cargar. Esta ruta de acceso es la ruta de acceso del archivo local, como acme/customers/campaigns/summer.parquet.

Respuesta

200 OK

Completar lote

Una vez que haya terminado de cargar todas las diferentes partes del archivo, deberá indicar que los datos se han cargado completamente y que el lote está listo para la promoción.

Formato de API

POST /batches/{BATCH_ID}?action=complete
Parámetro
Descripción
{BATCH_ID}
El identificador del lote que desea señalar está listo para su finalización.

Solicitud

curl -X POST https://platform.adobe.io/data/foundation/import/batches/{BATCH_ID}?action=COMPLETE \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Respuesta

200 OK

Ingesta de archivos grandes de Parquet

NOTE
En esta sección se explica cómo cargar archivos que superen los 256 MB. Los archivos grandes se cargan en fragmentos y luego se vinculan a través de una señal de API.

Crear lote

En primer lugar, deberá crear un lote, con Parquet como formato de entrada. Al crear el lote, deberá proporcionar un ID de conjunto de datos. También deberá asegurarse de que todos los archivos cargados como parte del lote se ajusten al esquema XDM vinculado al conjunto de datos proporcionado.

Formato de API

POST /batches

Solicitud

curl -X POST https://platform.adobe.io/data/foundation/import/batches \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'
  -d '{
          "datasetId": "{DATASET_ID}",
           "inputFormat": {
             "format": "parquet"
           }
      }'
Parámetro
Descripción
{DATASET_ID}
ID del conjunto de datos de referencia.

Respuesta

201 Created

{
    "id": "{BATCH_ID}",
    "imsOrg": "{ORG_ID}",
    "updated": 0,
    "status": "loading",
    "created": 0,
    "relatedObjects": [
        {
            "type": "dataSet",
            "id": "{DATASET_ID}"
        }
    ],
    "version": "1.0.0",
    "tags": {},
    "createdUser": "{USER_ID}",
    "updatedUser": "{USER_ID}"
}
Parámetro
Descripción
{BATCH_ID}
El ID del lote recién creado.
{DATASET_ID}
El ID del conjunto de datos al que se hace referencia.
{USER_ID}
El ID del usuario que creó el lote.

Inicializar archivo grande

Después de crear el lote, deberá inicializar el archivo grande antes de cargar los fragmentos en el lote.

Formato de API

POST /batches/{BATCH_ID}/datasets/{DATASET_ID}/files/{FILE_NAME}
Parámetro
Descripción
{BATCH_ID}
El ID del lote recién creado.
{DATASET_ID}
El ID del conjunto de datos al que se hace referencia.
{FILE_NAME}
Nombre del archivo que se va a inicializar.

Solicitud

curl -X POST https://platform.adobe.io/data/foundation/import/batches/{BATCH_ID}/datasets/{DATASET_ID}/files/{FILE_NAME}.parquet?action=INITIALIZE \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Respuesta

201 Created

Cargar fragmentos de archivo grandes

Ahora que se ha creado el archivo, se pueden cargar todos los fragmentos posteriores realizando solicitudes repetidas al PATCH, una para cada sección del archivo.

Formato de API

PATCH /batches/{BATCH_ID}/datasets/{DATASET_ID}/files/{FILE_NAME}
Parámetro
Descripción
{BATCH_ID}
El ID del lote al que desea cargar.
{DATASET_ID}
ID del conjunto de datos de referencia del lote.
{FILE_NAME}
El nombre del archivo que desea cargar. Asegúrese de utilizar un nombre de archivo único para que no entre en conflicto con otro archivo para el lote de archivos que se envía.

Solicitud

CAUTION
Esta API admite la carga de una sola parte. Asegúrese de que content-type es application/octet-stream.
curl -X PATCH https://platform.adobe.io/data/foundation/import/batches/{BATCH_ID}/datasets/{DATASET_ID}/files/{FILE_NAME}.parquet \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/octet-stream' \
  -H 'Content-Range: bytes {CONTENT_RANGE}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  --data-binary "@{FILE_PATH_AND_NAME}.parquet"
Parámetro
Descripción
{CONTENT_RANGE}
En enteros, el principio y el final del intervalo solicitado.
{FILE_PATH_AND_NAME}
Ruta de acceso completa y nombre del archivo que intenta cargar. Esta ruta de acceso es la ruta de acceso del archivo local, como acme/customers/campaigns/summer.json.

Respuesta

200 OK

Archivo grande completo

Ahora que ha creado un lote, puede usar batchId de antes para cargar los archivos en el lote. Puede cargar varios archivos en el lote.

Formato de API

POST /batches/{BATCH_ID}/datasets/{DATASET_ID}/files/{FILE_NAME}
Parámetro
Descripción
{BATCH_ID}
El ID del lote del que desea indicar la finalización.
{DATASET_ID}
ID del conjunto de datos de referencia del lote.
{FILE_NAME}
El nombre del archivo del que desea indicar la finalización.

Solicitud

curl -X POST https://platform.adobe.io/data/foundation/import/batches/{BATCH_ID}/datasets/{DATASET_ID}/files/{FILE_NAME}.parquet?action=COMPLETE \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Respuesta

201 Created

Completar lote

Una vez que haya terminado de cargar todas las diferentes partes del archivo, deberá indicar que los datos se han cargado completamente y que el lote está listo para la promoción.

Formato de API

POST /batches/{BATCH_ID}?action=COMPLETE
Parámetro
Descripción
{BATCH_ID}
Se ha completado el ID del lote que desea señalar.

Solicitud

curl -X POST https://platform.adobe.io/data/foundation/import/batches/{BATCH_ID}?action=COMPLETE \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Respuesta

200 OK

Ingesta de archivos CSV

Para introducir archivos CSV, deberá crear una clase, un esquema y un conjunto de datos que admita CSV. Para obtener información detallada sobre cómo crear la clase y el esquema necesarios, siga las instrucciones proporcionadas en el tutorial de creación de esquemas ad hoc.

NOTE
Los siguientes pasos son aplicables a archivos pequeños (256 MB o menos). Si supera el tiempo de espera de una puerta de enlace o solicita errores de tamaño de cuerpo, deberá cambiar a una carga de archivo grande.

Crear conjunto de datos

Después de seguir las instrucciones anteriores para crear la clase y el esquema necesarios, debe crear un conjunto de datos compatible con CSV.

Formato de API

POST /catalog/dataSets

Solicitud

curl -X POST https://platform.adobe.io/data/foundation/catalog/dataSets \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'
  -d '{
      "name": "{DATASET_NAME}",
      "schemaRef": {
          "id": "https://ns.adobe.com/{TENANT_ID}/schemas/{SCHEMA_ID}",
          "contentType": "application/vnd.adobe.xed+json;version=1"
      }
  }'
Parámetro
Descripción
{TENANT_ID}
Este ID se utiliza para garantizar que los recursos que crea tengan un espacio de nombres correcto y estén contenidos en su organización.
{SCHEMA_ID}
El ID del esquema que ha creado.

Crear lote

A continuación, debe crear un lote con CSV como formato de entrada. Al crear el lote, deberá proporcionar un ID de conjunto de datos. También deberá asegurarse de que todos los archivos cargados como parte del lote se ajusten al esquema vinculado al conjunto de datos proporcionado.

Formato de API

POST /batches

Solicitud

curl -X POST https://platform.adobe.io/data/foundation/import/batches \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'
  -d '{
            "datasetId": "{DATASET_ID}",
            "inputFormat": {
                "format": "csv"
            }
      }'
Parámetro
Descripción
{DATASET_ID}
ID del conjunto de datos de referencia.

Respuesta

201 Created

{
    "id": "{BATCH_ID}",
    "imsOrg": "{ORG_ID}",
    "updated": 0,
    "status": "loading",
    "created": 0,
    "relatedObjects": [
        {
            "type": "dataSet",
            "id": "{DATASET_ID}"
        }
    ],
    "version": "1.0.0",
    "tags": {},
    "createdUser": "{USER_ID}",
    "updatedUser": "{USER_ID}"
}
Parámetro
Descripción
{BATCH_ID}
El ID del lote recién creado.
{DATASET_ID}
El ID del conjunto de datos al que se hace referencia.
{USER_ID}
El ID del usuario que creó el lote.

Cargar archivos

Ahora que ha creado un lote, puede usar batchId de antes para cargar los archivos en el lote. Puede cargar varios archivos en el lote.

NOTE
Consulte la sección del apéndice para ver un ejemplo de un archivo de datos CSV con el formato correcto.

Formato de API

PUT /batches/{BATCH_ID}/datasets/{DATASET_ID}/files/{FILE_NAME}
Parámetro
Descripción
{BATCH_ID}
El ID del lote al que desea cargar.
{DATASET_ID}
ID del conjunto de datos de referencia del lote.
{FILE_NAME}
El nombre del archivo que desea cargar. Asegúrese de utilizar un nombre de archivo único para que no entre en conflicto con otro archivo para el lote de archivos que se envía.

Solicitud

CAUTION
Esta API admite la carga de una sola parte. Asegúrese de que content-type es application/octet-stream.
curl -X PUT https://platform.adobe.io/data/foundation/import/batches/{BATCH_ID}/datasets/{DATASET_ID}/files/{FILE_NAME}.csv \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/octet-stream' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  --data-binary "@{FILE_PATH_AND_NAME}.csv"
Parámetro
Descripción
{FILE_PATH_AND_NAME}
Ruta de acceso completa y nombre del archivo que intenta cargar. Esta ruta de acceso es la ruta de acceso del archivo local, como acme/customers/campaigns/summer.csv.

Respuesta

200 OK

Completar lote

Una vez que haya terminado de cargar todas las diferentes partes del archivo, deberá indicar que los datos se han cargado completamente y que el lote está listo para la promoción.

Formato de API

POST /batches/{BATCH_ID}?action=COMPLETE

Solicitud

curl -X POST https://platform.adobe.io/data/foundation/import/batches/{BATCH_ID}?action=COMPLETE \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Respuesta

200 OK

Cancelar un lote

Mientras el lote se está procesando, aún se puede cancelar. Sin embargo, una vez finalizado un lote (como un estado correcto o fallido), el lote no se puede cancelar.

Formato de API

POST /batches/{BATCH_ID}?action=ABORT
Parámetro
Descripción
{BATCH_ID}
El ID del lote que desea cancelar.

Solicitud

curl -X POST https://platform.adobe.io/data/foundation/import/batches/{BATCH_ID}?action=ABORT \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Respuesta

200 OK

Eliminar un lote delete-a-batch

Se puede eliminar un lote realizando la siguiente solicitud de POST con el parámetro de consulta action=REVERT al ID del lote que desea eliminar. El lote está marcado como "inactivo", por lo que es apto para la recolección de basura. El lote se recopilará asincrónicamente, momento en el que se marcará como "eliminado".

Formato de API

POST /batches/{BATCH_ID}?action=REVERT
Parámetro
Descripción
{BATCH_ID}
El ID del lote que desea eliminar.

Solicitud

curl -X POST https://platform.adobe.io/data/foundation/import/batches/{BATCH_ID}?action=REVERT \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Respuesta

200 OK

Parche de un lote

En ocasiones puede ser necesario actualizar los datos en el almacén de perfiles de su organización. Por ejemplo, es posible que tenga que corregir registros o cambiar un valor de atributo. Adobe Experience Platform admite la actualización o el parche de datos del almacén de perfiles mediante una acción de actualización o "aplicación de parches a un lote".

NOTE
Estas actualizaciones solo se permiten en registros de perfil, no en eventos de experiencia.

Para aplicar parches a un lote, es necesario lo siguiente:

  • Conjunto de datos habilitado para actualizaciones de perfiles y atributos. Esto se realiza mediante etiquetas de conjuntos de datos y requiere que se agregue una etiqueta isUpsert:true específica a la matriz unifiedProfile. Para obtener detalles sobre los pasos que muestran cómo crear un conjunto de datos o configurar uno existente para su actualización, siga el tutorial de habilitar un conjunto de datos para actualizaciones de perfil.
  • Archivo de parquet que contiene los campos a los que se va a aplicar parches y los campos de identidad del perfil. El formato de datos para aplicar parches a un lote es similar al proceso normal de ingesta por lotes. La entrada requerida es un archivo de Parquet y, además de los campos que se van a actualizar, los datos cargados deben contener los campos de identidad para que coincidan con los datos en el almacén de perfiles.

Una vez que tenga un conjunto de datos habilitado para Perfil y actualización, y un archivo de Parquet que contenga los campos a los que desee aplicar parches, así como los campos de identidad necesarios, puede seguir los pasos de ingesta de archivos de Parquet para completar el parche mediante la ingesta por lotes.

Reproducción de un lote

Si desea reemplazar un lote ya introducido, puede hacerlo con "reproducción por lotes": esta acción equivale a eliminar el lote antiguo e ingerir uno nuevo en su lugar.

Crear lote

En primer lugar, debe crear un lote, con JSON como formato de entrada. Al crear el lote, deberá proporcionar un ID de conjunto de datos. También deberá asegurarse de que todos los archivos cargados como parte del lote se ajusten al esquema XDM vinculado al conjunto de datos proporcionado. Además, deberá proporcionar los lotes antiguos como referencia en la sección de reproducción. En el ejemplo siguiente, está reproduciendo lotes con los identificadores batchIdA y batchIdB.

Formato de API

POST /batches

Solicitud

curl -X POST https://platform.adobe.io/data/foundation/import/batches \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'
  -d '{
          "datasetId": "{DATASET_ID}",
           "inputFormat": {
             "format": "json"
           },
            "replay": {
                "predecessors": ["${batchIdA}","${batchIdB}"],
                "reason": "replace"
             }
      }'
Parámetro
Descripción
{DATASET_ID}
ID del conjunto de datos de referencia.

Respuesta

201 Created

{
    "id": "{BATCH_ID}",
    "imsOrg": "{ORG_ID}",
    "updated": 0,
    "status": "loading",
    "created": 0,
    "relatedObjects": [
        {
            "type": "dataSet",
            "id": "{DATASET_ID}"
        }
    ],
    "replay": {
        "predecessors": [
            "batchIdA", "batchIdB"
        ],
        "reason": "replace"
    },
    "version": "1.0.0",
    "tags": {},
    "createdUser": "{USER_ID}",
    "updatedUser": "{USER_ID}"
}
Parámetro
Descripción
{BATCH_ID}
El ID del lote recién creado.
{DATASET_ID}
El ID del conjunto de datos al que se hace referencia.
{USER_ID}
El ID del usuario que creó el lote.

Cargar archivos

Ahora que ha creado un lote, puede usar batchId de antes para cargar los archivos en el lote. Puede cargar varios archivos en el lote.

Formato de API

PUT /batches/{BATCH_ID}/datasets/{DATASET_ID}/files/{FILE_NAME}
Parámetro
Descripción
{BATCH_ID}
El ID del lote al que desea cargar.
{DATASET_ID}
ID del conjunto de datos de referencia del lote.
{FILE_NAME}
El nombre del archivo que desea cargar. Asegúrese de utilizar un nombre de archivo único para que no entre en conflicto con otro archivo para el lote de archivos que se envía.

Solicitud

CAUTION
Esta API admite la carga de una sola parte. Asegúrese de que content-type es application/octet-stream. No utilice la opción curl -F, ya que el valor predeterminado es una solicitud de varias partes incompatible con la API.
curl -X PUT https://platform.adobe.io/data/foundation/import/batches/{BATCH_ID}/datasets/{DATASET_ID}/files/{FILE_NAME}.json \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/octet-stream' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  --data-binary "@{FILE_PATH_AND_NAME}.json"
Parámetro
Descripción
{FILE_PATH_AND_NAME}
Ruta de acceso completa y nombre del archivo que intenta cargar. Esta ruta de acceso es la ruta de acceso del archivo local, como acme/customers/campaigns/summer.json.

Respuesta

200 OK

Completar lote

Una vez que haya terminado de cargar todas las diferentes partes del archivo, deberá indicar que los datos se han cargado completamente y que el lote está listo para la promoción.

Formato de API

POST /batches/{BATCH_ID}?action=COMPLETE
Parámetro
Descripción
{BATCH_ID}
El ID del lote que desea completar.

Solicitud

curl -X POST https://platform.adobe.io/data/foundation/import/batches/{BATCH_ID}?action=COMPLETE \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Respuesta

200 OK

Apéndice

La siguiente sección contiene información adicional para la ingesta de datos en Experience Platform mediante la ingesta por lotes.

Transformación de datos para la ingesta por lotes

Para ingerir un archivo de datos en Experience Platform, la estructura jerárquica del archivo debe cumplir con el esquema Experience Data Model (XDM) asociado con el conjunto de datos que se está cargando en.

Encontrará información sobre cómo asignar un archivo CSV para cumplir con un esquema XDM en el documento transformaciones de muestra, junto con un ejemplo de archivo de datos JSON con formato correcto. Los archivos de ejemplo proporcionados en el documento se pueden encontrar aquí:

recommendation-more-help
2ee14710-6ba4-4feb-9f79-0aad73102a9a