Guia da API de acesso a dados
IMPORTANTA API de Acesso a Dados dá suporte ao Adobe Experience Platform, fornecendo aos usuários uma interface RESTful com foco na descoberta e acessibilidade de conjuntos de dados assimilados no Experience Platform.
Referência da especificação da API
Consulte a documentação de referência da OpenAPI do Data Access para exibir um formato padronizado e legível por máquina para facilitar a integração, o teste e a exploração.
Terminologia
A tabela fornece uma descrição de alguns termos comumente usados neste documento.
| Termo | Descrição |
|---|---|
| Conjunto de dados | Uma coleção de dados que inclui um esquema e campos. |
| Lote | Um conjunto de dados coletados por um período e processados juntos como uma única unidade. |
Recuperar lista de arquivos em um lote
Para recuperar uma lista de arquivos pertencentes a um lote específico, use o identificador de lote (batchID) com a API de acesso a dados.
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
}
}
A matriz "data" contém uma lista de todos os arquivos dentro do lote especificado. Cada arquivo retornado tem sua própria ID exclusiva ({FILE_ID}) contida no campo "dataSetFileId". Você pode usar esse identificador exclusivo para acessar ou baixar o arquivo.
| Propriedade | Descrição |
|---|---|
data.dataSetFileId | A ID de cada arquivo no lote especificado. |
data._links.self.href | O URL para acessar o arquivo. |
Acessar e baixar arquivos em um lote
Para acessar detalhes específicos de um arquivo, use um identificador de arquivo ({FILE_ID}) com a API de Acesso a Dados, incluindo seu nome, tamanho em bytes e um link para baixar.
A resposta contém 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 inclui 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 | O nome do arquivo (por exemplo, profiles.parquet). |
data.length | O 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 | O nome do arquivo (por exemplo, profiles.parquet). |
data._links.self.href | O URL para baixar o arquivo. |