Guia da API de acesso a dados
A API de acesso a dados é compatível com o 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
A documentação de referência da API do Swagger pode ser encontrada aqui.
Terminologia terminology
A tabela fornece uma descrição de alguns termos comumente usados neste documento.
Recuperar lista de arquivos em um lote retrieve-list-of-files-in-a-batch
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
{BATCH_ID}
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 variável "data"
contém uma lista de todos os arquivos do lote especificado. Cada arquivo retornado tem seu próprio identificador exclusivo ({FILE_ID}
) contido na "dataSetFileId"
campo. Você pode usar esse identificador exclusivo para acessar ou baixar o arquivo.
data.dataSetFileId
data._links.self.href
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 o 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}
{FILE_ID}
"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
}
}
data.name
profiles.csv
).data.length
data._links.self.href
Resposta de 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.
data.name
profiles.csv
).data._links.self.href
Acessar o conteúdo de um arquivo access-file-contents
Você também pode usar a variável Data Access API para acessar o conteúdo de um arquivo. Você pode baixar o conteúdo para uma fonte externa.
Formato da API
GET /files/{dataSetFileId}?path={FILE_NAME}
{FILE_NAME}
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}'
{FILE_ID}
{FILE_NAME}
profiles.csv
).Resposta
Contents of the file
Amostras de código adicionais
Para obter amostras adicionais, consulte o tutorial sobre acesso a dados.
Assinar eventos de assimilação de dados subscribe-to-data-ingestion-events
É possível assinar eventos específicos de alto valor por meio da Console do Adobe Developer. Por exemplo, você pode assinar eventos de assimilação de dados para ser notificado de possíveis atrasos e falhas. Veja o tutorial sobre assinatura de notificações de assimilação de dados para obter mais informações.