Explore suas pastas de armazenamento na nuvem usando o Flow Service API

Última atualização em 2023-11-04
  • Tópicos
  • Sources
    Exibir mais informações sobre este tópico
  • Criado para:
  • Developer

Este tutorial fornece etapas sobre como explorar e visualizar a estrutura e o conteúdo do seu armazenamento em nuvem usando o Flow Service API.

OBSERVAÇÃO

Para explorar seu armazenamento na nuvem, você já deve ter uma ID de conexão básica válida para uma fonte de armazenamento na nuvem. Se você não tiver essa ID, consulte a visão geral das origens para obter uma lista de fontes de armazenamento na nuvem com as quais você pode criar uma conexão básica.

Introdução

Este manual necessita de uma compreensão funcional dos seguintes componentes da Adobe Experience Platform:

  • Origens: Experience Platform O permite que os dados sejam assimilados de várias fontes e, ao mesmo tempo, fornece a capacidade de estruturar, rotular e aprimorar os dados recebidos usando o Platform serviços.
  • Sandboxes: Experience Platform O fornece sandboxes virtuais que particionam uma única Platform em ambientes virtuais separados para ajudar a desenvolver aplicativos de experiência digital.

Uso de APIs da plataforma

Para obter informações sobre como fazer chamadas para APIs da Platform com êxito, consulte o manual em introdução às APIs da Platform.

Explore suas pastas de armazenamento na nuvem

Você pode recuperar informações sobre a estrutura das pastas de armazenamento na nuvem fazendo uma solicitação GET ao Flow Service ao fornecer a ID de conexão básica da sua origem.

Ao executar solicitações do GET para explorar seu 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:
  • folder: Explorar um diretório específico
  • root: Explore o diretório raiz.
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 sua fonte de armazenamento na 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 as path propriedade do arquivo que você 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
    }
]

Inspect a estrutura de um arquivo

Para inspecionar a estrutura do arquivo de dados do armazenamento na nuvem, execute uma solicitação GET enquanto fornece o caminho e o tipo do arquivo como um parâmetro de consulta.

É possível inspecionar a estrutura de um arquivo de dados da fonte de armazenamento na nuvem executando uma solicitação GET enquanto fornece o caminho e o tipo do arquivo. Você também pode inspecionar diferentes tipos de arquivos, como CSV, TSV ou JSON compactado e arquivos delimitados, especificando seus tipos de arquivos 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&fileType=delimited&encoding=ISO-8859-1;
Parâmetro Descrição
{BASE_CONNECTION_ID} A ID de conexão do conector de origem de armazenamento na nuvem.
{FILE_PATH} O caminho para o arquivo que você deseja inspecionar.
{FILE_TYPE} O tipo do arquivo. Os tipos de arquivos compatíveis incluem:
  • DELIMITADO: valor separado por delimitadores. Os arquivos DSV devem ser separados por vírgulas.
  • JSON: notação de objeto JavaScript. Os arquivos JSON devem ser compatíveis com XDM
  • PARQUET: Apache Parquet. Os arquivos Parquet devem ser compatíveis com XDM.
{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"
    }
]

Uso de parâmetros de consulta

A variável Flow Service API O é compatível com o uso de parâmetros de consulta para visualizar e inspecionar diferentes tipos de arquivos.

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 será padronizado como vírgula (,).
compressionType Um parâmetro de consulta necessário para visualizar um arquivo JSON ou delimitado compactado. Os arquivos compactados compatíveis são:
  • bzip2
  • gzip
  • deflate
  • zipDeflate
  • tarGzip
  • tar
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. Nota: A variável encoding O parâmetro só está disponível ao assimilar arquivos CSV delimitados. Outros tipos de arquivo serão assimilados com a codificação padrão, UTF-8.

Próximas etapas

Seguindo este tutorial, você explorou seu sistema de armazenamento em nuvem, encontrou o caminho do arquivo que deseja trazer para Platforme visualizou sua estrutura. Você pode usar essas informações no próximo tutorial para coletar dados do seu armazenamento na nuvem e trazê-los para a Platform.

Nesta página