Este tutorial fornece etapas sobre como explorar e visualizar a estrutura e o conteúdo do armazenamento em nuvem usando o Flow Service API.
Para explorar o armazenamento na nuvem, você já deve ter uma ID de conexão base válida para uma fonte de armazenamento na nuvem. Se você não tiver essa ID, consulte a visão geral das fontes para obter uma lista de fontes de armazenamento em nuvem com as quais você pode criar uma conexão básica.
Este guia requer uma compreensão funcional dos seguintes componentes do Adobe Experience Platform:
Para obter informações sobre como fazer chamadas para APIs da plataforma com êxito, consulte o guia em introdução às APIs do Platform.
Você pode recuperar informações sobre a estrutura de suas pastas de armazenamento em nuvem fazendo uma solicitação do GET para o Flow Service API enquanto fornece a ID de conexão básica da sua fonte.
Ao executar solicitações do GET para explorar o armazenamento na nuvem, você deve incluir os parâmetros de consulta listados na tabela abaixo:
Parâmetro | Descrição |
---|---|
objectType |
O tipo de objeto que você deseja explorar. Defina esse valor como:
|
object |
Esse parâmetro é necessário somente ao visualizar um diretório específico. Seu valor representa o caminho do diretório que você deseja explorar. |
Formato da API
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=root
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=folder&object={PATH}
Parâmetro | Descrição |
---|---|
{BASE_CONNECTION_ID} |
A ID de conexão básica da fonte de armazenamento em nuvem. |
{PATH} |
O caminho de um diretório. |
Solicitação
curl -X GET \
'http://platform.adobe.io/data/foundation/flowservice/connections/dc3c0646-5e30-47be-a1ce-d162cb8f1f07/explore?objectType=folder&object=root' \
-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
Uma resposta bem-sucedida retorna uma matriz de arquivos e pastas encontrados no diretório consultado. Anote o path
propriedade do arquivo que deseja fazer upload, pois é necessário fornecê-lo na próxima etapa para inspecionar sua estrutura.
[
{
"type": "file",
"name": "account.csv",
"path": "/test-connectors/testFolder-fileIngestion/account.csv",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "file",
"name": "profileData.json",
"path": "/test-connectors/testFolder-fileIngestion/profileData.json",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "file",
"name": "sampleprofile--3.parquet",
"path": "/test-connectors/testFolder-fileIngestion/sampleprofile--3.parquet",
"canPreview": true,
"canFetchSchema": true
}
]
Para inspecionar a estrutura do arquivo de dados do armazenamento em nuvem, execute uma solicitação de GET enquanto fornece o caminho do arquivo e digite como parâmetro de consulta.
Você pode inspecionar a estrutura de um arquivo de dados da sua fonte de armazenamento em nuvem executando uma solicitação do GET enquanto fornece o caminho e o tipo do arquivo. Também é possível inspecionar diferentes tipos de arquivos, como CSV, TSV ou JSON compactado e arquivos delimitados, especificando seus tipos de arquivo como parte dos parâmetros de consulta.
Formato da API
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=file&object={FILE_PATH}&fileType={FILE_TYPE}&{QUERY_PARAMS}&preview=true
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=file&object={FILE_PATH}&preview=true&fileType=delimited&columnDelimiter=\t
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=file&object={FILE_PATH}&preview=true&fileType=delimited&compressionType=gzip;
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=FILE&object={FILE_PATH}&preview=true&ileType=delimited&encoding=ISO-8859-1;
Parâmetro | Descrição |
---|---|
{BASE_CONNECTION_ID} |
A ID de conexão do conector de origem de armazenamento da nuvem. |
{FILE_PATH} |
O caminho para o arquivo que você deseja inspecionar. |
{FILE_TYPE} |
O tipo do arquivo. Os tipos de arquivos suportados incluem:
|
{QUERY_PARAMS} |
Parâmetros de consulta opcionais que podem ser usados para filtrar resultados. Consulte a seção sobre parâmetros de consulta para obter mais informações. |
Solicitação
curl -X GET \
'http://platform.adobe.io/data/foundation/flowservice/connections/{BASE_CONNECTION_ID}/explore?objectType=file&object=/aep-bootcamp/Adobe%20Pets%20Customer%2020190801%20EXP.json&fileType=json&preview=true' \
-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
Uma resposta bem-sucedida retorna a estrutura do arquivo consultado, incluindo nomes de tabela e tipos de dados.
[
{
"name": "Id",
"type": "String"
},
{
"name": "FirstName",
"type": "String"
},
{
"name": "LastName",
"type": "String"
},
{
"name": "Email",
"type": "String"
},
{
"name": "Phone",
"type": "String"
}
]
O Flow Service API O suporta o uso de parâmetros de consulta para visualizar e inspecionar tipos de arquivos diferentes.
Parâmetro | Descrição |
---|---|
columnDelimiter |
O valor de caractere único especificado como delimitador de coluna para inspecionar arquivos CSV ou TSV. Se o parâmetro não for fornecido, o valor assumirá como padrão uma vírgula (,) . |
compressionType |
Um parâmetro de consulta obrigatório para a visualização de um arquivo compactado delimitado ou JSON. Os arquivos compactados compatíveis são:
|
encoding |
Define qual tipo de codificação usar ao renderizar a visualização. Os tipos de codificação compatíveis são: UTF-8 e ISO-8859-1 . Observação: O encoding só está disponível ao assimilar arquivos CSV delimitados. Outros tipos de arquivos serão assimilados com a codificação padrão, UTF-8 . |
Ao seguir este tutorial, você explorou seu sistema de armazenamento em nuvem e encontrou o caminho do arquivo que deseja trazer para Platforme visualizou sua estrutura. Você pode usar essas informações no próximo tutorial para colete dados do armazenamento em nuvem e traga-os para a Platform.