Guía de API de acceso a datos

La API de acceso a datos admite Adobe Experience Platform al proporcionar a los usuarios una interfaz RESTful centrada en la capacidad de detección y accesibilidad de conjuntos de datos ingestados dentro de Experience Platform.

Acceso a datos en el Experience Platform

Referencia de especificación de API

La documentación de referencia de la API Swagger se encuentra aquí.

Terminología

Descripción de algunos términos de uso común en este documento.

Término Descripción
Conjunto de datos Recopilación de datos que incluye esquemas y campos.
Lote Conjunto de datos recopilados durante un período de tiempo y procesados juntos como una sola unidad.

Recuperar lista de archivos dentro de un lote

Mediante el uso de un identificador de lote (batchID), la API de acceso a datos puede recuperar una lista de archivos pertenecientes a ese lote en particular.

Formato de API

GET /batches/{BATCH_ID}/files
Propiedad Descripción
{BATCH_ID} El ID del lote especificado.

Solicitud

curl -X GET https://platform.adobe.io/data/foundation/export/batches/{BATCH_ID}/files \
  -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

{
  "data": [
    {
      "dataSetFileId": "{FILE_ID_1}",
      "dataSetViewId": "string",
      "version": "1.0.0",
      "created": "string",
      "updated": "string",
      "isValid": true,
      "_links": {
        "self": {
          "href": "https://platform.adobe.io/data/foundation/export/files/{FILE_ID_1}"
        }
      }
    },
    {
      "dataSetFileId": "{FILE_ID_2}",
      "dataSetViewId": "string",
      "version": "1.0.0",
      "created": "string",
      "updated": "string",
      "isValid": true,
      "_links": {
        "self": {
          "href": "https://platform.adobe.io/data/foundation/export/files/{FILE_ID_2}"
        }
      }
    },
  ],
  "_page": {
    "limit": 100,
    "count": 1
  }
}

La matriz "data" contiene una lista de todos los archivos dentro del lote especificado. Cada archivo devuelto tiene su propio ID único ({FILE_ID}) incluido en el campo "dataSetFileId". Este ID único se puede utilizar para acceder al archivo o descargarlo.

Propiedad Descripción
data.dataSetFileId El ID de archivo de cada archivo del lote especificado.
data._links.self.href La dirección URL para acceder al archivo.

Acceso y descarga de archivos dentro de un lote

Mediante el uso de un identificador de archivo ({FILE_ID}), la API de acceso a datos puede utilizarse para acceder a detalles específicos de un archivo, como su nombre, tamaño en bytes y un vínculo para descargar.

La respuesta contendrá una matriz de datos. Dependiendo de si el archivo señalado por el ID es un archivo individual o un directorio, la matriz de datos devuelta puede contener una sola entrada o una lista de archivos pertenecientes a ese directorio. Cada elemento de archivo incluirá los detalles del archivo.

Formato de API

GET /files/{FILE_ID}
Propiedad Descripción
{FILE_ID} Igual a "dataSetFileId", el ID del archivo al que se va a acceder.

Solicitud

curl -X GET https://platform.adobe.io/data/foundation/export/files/{FILE_ID} \
  -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 de un solo archivo

{
  "data": [
    {
      "name": "{FILE_NAME}",
      "length": "{LENGTH}",
      "_links": {
        "self": {
          "href": "https://platform.adobe.io/data/foundation/export/files/{FILE_ID}?path={FILE_NAME}"
        }
      }
    }
  ],
  "_page": {
    "limit": 100,
    "count": 1
  }
}
Propiedad Descripción
data.name Nombre del archivo (por ejemplo, profiles.csv).
data.length Tamaño del archivo (en bytes).
data._links.self.href La URL para descargar el archivo.

Respuesta de directorio

{
  "data": [
    {
      "dataSetFileId": "{FILE_ID_1}",
      "dataSetViewId": "string",
      "version": "1.0.0",
      "created": "string",
      "updated": "string",
      "isValid": true,
      "_links": {
        "self": {
          "href": "https://platform.adobe.io/data/foundation/export/files/{FILE_ID_1}"
        }
      }
    },
    {
      "dataSetFileId": "{FILE_ID_2}",
      "dataSetViewId": "string",
      "version": "1.0.0",
      "created": "string",
      "updated": "string",
      "isValid": true,
      "_links": {
        "self": {
          "href": "https://platform.adobe.io/data/foundation/export/files/{FILE_ID_2}"
        }
      }
    }
  ],
  "_page": {
    "limit": 100,
    "count": 2
  }
}

Cuando se devuelve un directorio, contiene una matriz de todos los archivos dentro del directorio.

Propiedad Descripción
data.name Nombre del archivo (por ejemplo, profiles.csv).
data._links.self.href La URL para descargar el archivo.

Acceso al contenido de un archivo

La API Data Access también se puede utilizar para acceder al contenido de un archivo. Esto se puede utilizar para descargar el contenido a una fuente externa.

Formato de API

GET /files/{dataSetFileId}?path={FILE_NAME}
Propiedad Descripción
{FILE_NAME} Nombre del archivo al que está intentando acceder.

Solicitud

curl -X GET https://platform.adobe.io/data/foundation/export/files/{FILE_ID}?path={FILE_NAME} \
  -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}'
Propiedad Descripción
{FILE_ID} ID del archivo dentro de un conjunto de datos.
{FILE_NAME} El nombre completo del archivo (por ejemplo, profiles.csv).

Respuesta

Contents of the file

Ejemplos de código adicionales

Para obtener más ejemplos, consulte el tutorial de acceso a datos.

Suscripción a eventos de ingesta de datos

Platform permite la suscripción de eventos específicos de alto valor mediante Adobe Developer Console. Por ejemplo, puede suscribirse a los eventos de ingesta de datos para recibir notificaciones de posibles retrasos y errores. Consulte el tutorial sobre suscripción a las notificaciones de ingesta de datos para obtener más información.

En esta página

Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now