Guia da API de acesso a dados

A API de acesso a dados oferece suporte ao Adobe Experience Platform, fornecendo aos usuários uma interface RESTful focada na capacidade de descoberta e acessibilidade de conjuntos de dados assimilados no Experience Platform.

Acesso aos dados no Experience Platform

Referência da especificação da API

A documentação de referência da API do Swagger pode ser encontrada here.

Terminologia

Uma descrição de alguns termos comumente usados em todo este documento.

Termo Descrição
Conjunto de dados Uma coleção de dados que inclui esquema e campos.
Em lote Um conjunto de dados coletados durante um período de tempo e processados juntos como uma única unidade.

Recuperar a lista de arquivos em um lote

Usando um identificador em lote (batchID), a API de Acesso a Dados pode recuperar uma lista de arquivos pertencentes a esse lote específico.

Formato da API

GET /batches/{BATCH_ID}/files
Propriedade Descrição
{BATCH_ID} A ID do lote especificado.

Solicitação

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: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Resposta

{
  "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
  }
}

O "data" A matriz contém uma lista de todos os arquivos dentro do lote especificado. Cada arquivo retornado tem sua própria ID exclusiva ({FILE_ID}) contido na variável "dataSetFileId" campo. Essa ID exclusiva pode ser usada para acessar ou baixar o arquivo.

Propriedade Descrição
data.dataSetFileId A ID de arquivo para cada arquivo no lote especificado.
data._links.self.href O url para acessar o arquivo.

Acessar e baixar arquivos em um lote

Ao usar um identificador de arquivo ({FILE_ID}), a API de acesso a dados pode ser usada para acessar detalhes específicos de um arquivo, incluindo seu nome, tamanho em bytes e um link para download.

A resposta conterá uma matriz de dados. Dependendo de o arquivo apontado pela ID ser um arquivo individual ou um diretório, a matriz de dados retornada pode conter uma única entrada ou uma lista de arquivos pertencentes a esse diretório. Cada elemento de arquivo incluirá os detalhes do arquivo.

Formato da API

GET /files/{FILE_ID}
Propriedade Descrição
{FILE_ID} Igual a "dataSetFileId", a ID do arquivo a ser acessado.

Solicitação

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: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Resposta de arquivo único

{
  "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
  }
}
Propriedade Descrição
data.name Nome do arquivo (por exemplo, profiles.csv).
data.length Tamanho do arquivo (em bytes).
data._links.self.href O URL para baixar o arquivo.

Resposta do diretório

{
  "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
  }
}

Quando um diretório é retornado, ele contém uma matriz de todos os arquivos dentro do diretório.

Propriedade Descrição
data.name Nome do arquivo (por exemplo, profiles.csv).
data._links.self.href O URL para baixar o arquivo.

Acessar o conteúdo de um arquivo

O Data Access A API também pode ser usada para acessar o conteúdo de um arquivo. Isso pode ser usado para baixar o conteúdo para uma fonte externa.

Formato da API

GET /files/{dataSetFileId}?path={FILE_NAME}
Propriedade Descrição
{FILE_NAME} O nome do arquivo que você está tentando acessar.

Solicitação

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: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'
Propriedade Descrição
{FILE_ID} A ID do arquivo em um conjunto de dados.
{FILE_NAME} O nome completo do arquivo (por exemplo, profiles.csv).

Resposta

Contents of the file

Amostras de código adicionais

Para amostras adicionais, consulte o tutorial de acesso a dados.

Assinar eventos de assimilação de dados

Platform disponibiliza eventos específicos de alto valor para assinatura por meio do Console do desenvolvedor do Adobe. Por exemplo, você pode assinar eventos de assimilação de dados para ser notificado de possíveis atrasos e falhas. Veja o tutorial em assinatura de notificações de assimilação de dados para obter mais informações.

Nesta página