Información general sobre la API de ingesta por lotes

La API de ingesta de datos de Adobe Experience Platform le permite introducir datos en Platform como archivos por lotes. Los datos que se introducen pueden ser datos de perfil de un archivo plano (como un archivo de parquet) o datos que se ajustan a un esquema conocido del registro Experience Data Model (XDM).

La referencia de la API de ingesta de datos proporciona información adicional sobre estas llamadas a la API.

El diagrama siguiente describe el proceso de ingesta por lotes:

Primeros pasos

Los extremos de API utilizados en esta guía forman parte de la API de ingesta de datos. 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.

Data Ingestion requisitos previos

  • Los datos que se van a cargar deben estar en los formatos Parquet o JSON.
  • Un conjunto de datos creado en Catalog services.
  • El contenido del archivo de parquet debe coincidir con un subconjunto del esquema del conjunto de datos que se está cargando en.
  • Tenga su token de acceso único después de la autenticación.

Prácticas recomendadas sobre la ingesta por lotes

  • El tamaño recomendado del lote está entre 256 MB y 100 GB.
  • Cada lote debe contener como máximo 1500 archivos.

Restricciones de ingesta por lotes

La ingesta de datos por lotes tiene algunas restricciones:

  • Número máximo de archivos por lote: 1500
  • Tamaño máximo del lote: 100 GB
  • Número máximo de propiedades o campos por fila: 10000
  • Número máximo de lotes por minuto, por usuario: 138
NOTA

Para cargar un archivo de más de 512 MB, el archivo deberá dividirse en trozos más pequeños. Las instrucciones para cargar un archivo grande se encuentran en la sección large file upload of this document.

Tipos

Al ingerir datos, es importante comprender cómo funcionan los esquemas Experience Data Model (XDM). Para obtener más información sobre cómo se asignan los tipos de campo XDM a diferentes formatos, lea la Guía para desarrolladores del Registro de Esquemas.

Hay cierta flexibilidad a la hora de introducir datos: si un tipo no coincide con lo que hay en el esquema de destino, los datos se convertirán al tipo de destino expresado. Si no puede, fallará el lote con un TypeCompatibilityException.

Por ejemplo, ni JSON ni CSV tienen un tipo date o date-time. Como resultado, estos valores se expresan utilizando cadenas con formato ISO 8061 ("2018-07-10T15:05:59.000-08:00") o Tiempo Unix formateado en milisegundos (15312639 59000) y se convierten en el momento de la ingesta al tipo XDM de destino.

La tabla siguiente muestra las conversiones admitidas al introducir datos.

Entrante (fila) frente a Target (col.) Cadena Byte Corto Número entero Largo Duplicada Fecha Date-Time Objeto Mapa
Cadena X X X X X X X X
Byte X X X X X X
Corto X X X X X X
Número entero X X X X X X
Largo X X X X X X X X
Duplicada X X X X X X
Fecha X
Date-Time X
Objeto X X
Mapa X X
NOTA

Los booleanos y las matrices no se pueden convertir a otros tipos.

Uso de la API

La API Data Ingestion permite introducir datos como lotes (una unidad de datos que consta de uno o más archivos que se van a introducir como una sola unidad) en Experience Platform en tres pasos básicos:

  1. Cree un nuevo lote.
  2. Cargue archivos a un conjunto de datos especificado que coincida con el esquema XDM de los datos.
  3. Indica el final del lote.

Crear un lote

Para poder agregar datos a un conjunto de datos, estos deben vincularse a un lote que luego se cargará en un conjunto de datos especificado.

POST /batches

Solicitud

curl -X POST "https://platform.adobe.io/data/foundation/import/batches" \
  -H "Content-Type: application/json" \
  -H "x-gw-ims-org-id: {IMS_ORG}" \
  -H "x-sandbox-name: {SANDBOX_NAME}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key : {API_KEY}"
  -d '{ 
          "datasetId": "{DATASET_ID}" 
      }'
Propiedad Descripción
datasetId El ID del conjunto de datos en el que se cargarán los archivos.

Respuesta

{
    "id": "{BATCH_ID}",
    "imsOrg": "{IMS_ORG}",
    "updated": 0,
    "status": "loading",
    "created": 0,
    "relatedObjects": [
        {
            "type": "dataSet",
            "id": "{DATASET_ID}"
        }
    ],
    "version": "1.0.0",
    "tags": {},
    "createdUser": "{USER_ID}",
    "updatedUser": "{USER_ID}"
}
Propiedad Descripción
id El ID del lote que se acaba de crear (se utiliza en solicitudes posteriores).
relatedObjects.id El ID del conjunto de datos en el que se cargarán los archivos.

Carga de archivos

Después de crear correctamente un nuevo lote para su carga, los archivos se pueden cargar en un conjunto de datos específico.

Puede cargar archivos mediante la API de carga de archivos pequeños. Sin embargo, si los archivos son demasiado grandes y se supera el límite de la puerta de enlace (como los tiempos de espera extendidos, las solicitudes de tamaño de cuerpo excedidos y otras restricciones), puede cambiar a la API de carga de archivos grandes. Esta API carga el archivo en fragmentos y vincula los datos mediante la llamada API de finalización de carga de archivos grandes.

NOTA

La ingesta por lotes se puede utilizar para actualizar los datos de forma incremental en el Almacenamiento de perfiles. Para obtener más información, consulte la sección sobre la actualización de un lote en la guía para desarrolladores sobre ingesta por lotes.

INFORMACIÓN

Los ejemplos siguientes utilizan el formato de archivo Apache Parquet. Puede encontrar un ejemplo que use el formato de archivo JSON en la guía para desarrolladores de ingesta por lotes.

Carga de archivo pequeño

Una vez creado un lote, los datos se pueden cargar en un conjunto de datos preexistente. El archivo que se está cargando debe coincidir con su esquema XDM al que se hace referencia.

PUT /batches/{BATCH_ID}/datasets/{DATASET_ID}/files/{FILE_NAME}
Propiedad Descripción
{BATCH_ID} El ID del lote.
{DATASET_ID} ID del conjunto de datos para cargar archivos.
{FILE_NAME} El nombre del archivo tal como se verá en el conjunto de datos.

Solicitud

curl -X PUT "https://platform.adobe.io/data/foundation/import/batches/{BATCH_ID}/datasets/{DATASET_ID}/files/{FILE_NAME}.parquet" \
  -H "content-type: application/octet-stream" \
  -H "x-gw-ims-org-id: {IMS_ORG}" \
  -H "x-sandbox-name: {SANDBOX_NAME}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key : {API_KEY}" \
  --data-binary "@{FILE_PATH_AND_NAME}.parquet"
Propiedad Descripción
{FILE_PATH_AND_NAME} Ruta y nombre de archivo del archivo que se va a cargar en el conjunto de datos.

Respuesta

#Status 200 OK, with empty response body

Carga de archivo grande: crear archivo

Para cargar un archivo grande, el archivo debe dividirse en fragmentos más pequeños y cargarse de uno en uno.

POST /batches/{BATCH_ID}/datasets/{DATASET_ID}/files/{FILE_NAME}?action=initialize
Propiedad Descripción
{BATCH_ID} El ID del lote.
{DATASET_ID} ID del conjunto de datos que incorpora los archivos.
{FILE_NAME} El nombre del archivo tal como se verá en el conjunto de datos.

Solicitud

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

Respuesta

#Status 201 CREATED, with empty response body

Carga de archivos grande: cargue las partes siguientes

Una vez creado el archivo, todos los fragmentos posteriores se pueden cargar realizando solicitudes de PATCH repetidas, una para cada sección del archivo.

PATCH /batches/{BATCH_ID}/datasets/{DATASET_ID}/files/{FILE_NAME}
Propiedad Descripción
{BATCH_ID} El ID del lote.
{DATASET_ID} El ID del conjunto de datos en el que se cargarán los archivos.
{FILE_NAME} Nombre del archivo tal como se verá en el conjunto de datos.

Solicitud

curl -X PATCH "https://platform.adobe.io/data/foundation/import/batches/{BATCH_ID}/datasets/{DATASET_ID}/files/part1=a/part2=b/{FILE_NAME}.parquet" \
  -H "content-type: application/octet-stream" \
  -H "x-gw-ims-org-id: {IMS_ORG}" \
  -H "x-sandbox-name: {SANDBOX_NAME}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-api-key: {API_KEY}" \
  -H "Content-Range: bytes {CONTENT_RANGE}" \
  --data-binary "@{FILE_PATH_AND_NAME}.parquet"
Propiedad Descripción
{FILE_PATH_AND_NAME} Ruta y nombre de archivo del archivo que se va a cargar en el conjunto de datos.

Respuesta

#Status 200 OK, with empty response

Finalización del lote de señales

Una vez cargados todos los archivos en el lote, se puede indicar que el lote ha finalizado. Al hacerlo, las entradas Catalog DataSetFile se crean para los archivos completados y se asocian al lote generado anteriormente. El lote Catalog se marca como correcto, lo que déclencheur los flujos descendentes para introducir los datos disponibles.

Solicitud

POST /batches/{BATCH_ID}?action=COMPLETE
Propiedad Descripción
{BATCH_ID} El ID del lote que se cargará en el conjunto de datos.
curl -X POST "https://platform.adobe.io/data/foundation/import/batches/{BATCH_ID}?action=COMPLETE" \
-H "x-gw-ims-org-id: {IMS_ORG}" \
-H "x-sandbox-name: {SANDBOX_NAME}" \
-H "Authorization: Bearer {ACCESS_TOKEN}" \
-H "x-api-key : {API_KEY}"

Respuesta

#Status 200 OK, with empty response

Comprobar el estado del lote

Mientras esperan que los archivos se carguen en el lote, se puede comprobar el estado del lote para ver su progreso.

Formato de API

GET /batch/{BATCH_ID}
Propiedad Descripción
{BATCH_ID} El ID del lote que se está comprobando.

Solicitud

curl GET "https://platform.adobe.io/data/foundation/catalog/batch/{BATCH_ID}" \
  -H "Authorization: Bearer {ACCESS_TOKEN}" \
  -H "x-gw-ims-org-id: {IMS_ORG}" \
  -H "x-sandbox-name: {SANDBOX_NAME}" \
  -H "x-api-key: {API_KEY}"

Respuesta

{
    "{BATCH_ID}": {
        "imsOrg": "{IMS_ORG}",
        "created": 1494349962314,
        "createdClient": "MCDPCatalogService",
        "createdUser": "{USER_ID}",
        "updatedUser": "{USER_ID}",
        "updated": 1494349963467,
        "externalId": "{EXTERNAL_ID}",
        "status": "success",
        "errors": [
            {
                "code": "err-1494349963436"
            }
        ],
        "version": "1.0.3",
        "availableDates": {
            "startDate": 1337,
            "endDate": 4000
        },
        "relatedObjects": [
            {
                "type": "batch",
                "id": "foo_batch"
            },
            {
                "type": "connection",
                "id": "foo_connection"
            },
            {
                "type": "connector",
                "id": "foo_connector"
            },
            {
                "type": "dataSet",
                "id": "foo_dataSet"
            },
            {
                "type": "dataSetView",
                "id": "foo_dataSetView"
            },
            {
                "type": "dataSetFile",
                "id": "foo_dataSetFile"
            },
            {
                "type": "expressionBlock",
                "id": "foo_expressionBlock"
            },
            {
                "type": "service",
                "id": "foo_service"
            },
            {
                "type": "serviceDefinition",
                "id": "foo_serviceDefinition"
            }
        ],
        "metrics": {
            "foo": 1337
        },
        "tags": {
            "foo_bar": [
                "stuff"
            ],
            "bar_foo": [
                "woo",
                "baz"
            ],
            "foo/bar/foo-bar": [
                "weehaw",
                "wee:haw"
            ]
        },
        "inputFormat": {
            "format": "parquet",
            "delimiter": ".",
            "quote": "`",
            "escape": "\\",
            "nullMarker": "",
            "header": "true",
            "charset": "UTF-8"
        }
    }
}
Propiedad Descripción
{USER_ID} ID del usuario que creó o actualizó el lote.

El campo "status" es lo que muestra el estado actual del lote solicitado. Los lotes pueden tener uno de los siguientes estados:

Estados de ingesta por lotes

Estado Descripción
Abandonado El lote no se ha completado en el intervalo de tiempo esperado.
Anulado Se ha llamado a una operación de anulación explícitamente (a través de la API de ingesta de lotes) para el lote especificado. Una vez que el lote está en estado "Loaded", no se puede anular.
Activo El lote se ha promocionado correctamente y está disponible para el consumo descendente. Este estado se puede utilizar de forma intercambiable con "Success".
Eliminado Los datos del lote se han eliminado por completo.
Fallido Estado de terminal que resulta de una configuración incorrecta o de datos incorrectos. Los datos de un lote fallido no aparecerán. Este estado se puede utilizar de forma intercambiable con "Fallo".
Inactivo El lote se promocionó correctamente, pero se ha revertido o ha caducado. El lote ya no está disponible para el consumo descendente.
Cargado Los datos del lote se completan y el lote está listo para su promoción.
Carga Los datos de este lote se están cargando y el lote está no listo para su promoción.
Reintentando Se están procesando los datos de este lote. Sin embargo, debido a un error del sistema o transitorio, el lote falló, por lo que se está reintentando este lote.
Ensayo La fase de ensayo del proceso de promoción de un lote se ha completado y el trabajo de ingesta se ha ejecutado.
Ensayo Se están procesando los datos del lote.
Estancado Se están procesando los datos del lote. Sin embargo, la promoción por lotes se ha estancado después de varios reintentos.

En esta página