使用浏览云存储文件夹 Flow Service API

本教程提供了有关如何使用来浏览和预览云存储的结构和内容的步骤。 Flow Service API。

注意

要浏览云存储，您必须已经拥有云存储源的有效基本连接ID。 如果您没有此ID，请查看 源概述 以获取可创建基本连接的云存储源列表。

快速入门

本指南要求您对Adobe Experience Platform的以下组件有一定的了解：

  • 源： Experience Platform 允许从各种源摄取数据，同时让您能够使用以下方式构建、标记和增强传入数据： Platform 服务。
  • 沙盒： Experience Platform 提供对单个进行分区的虚拟沙盒 Platform 将实例安装到单独的虚拟环境中，以帮助开发和改进数字体验应用程序。

使用平台API

有关如何成功调用Platform API的信息，请参阅 Platform API快速入门.

浏览您的云存储文件夹

您可以通过向以下网站发出GET请求，检索有关云存储文件夹结构的信息： Flow Service 提供源的基本连接ID时的API。

执行GET请求以浏览云存储时，您必须包含下表列出的查询参数：

参数 描述
objectType 您希望浏览的对象类型。 将此值设置为：
  • folder：浏览特定目录
  • root：浏览根目录。
object 只有在查看特定目录时才需要此参数。 其值表示您希望浏览的目录的路径。

API格式

GET /connections/{BASE_CONNECTION_ID}/explore?objectType=root
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=folder&object={PATH}
参数 描述
{BASE_CONNECTION_ID} 云存储源的基本连接ID。
{PATH} 目录的路径。

请求

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}'

响应

成功的响应会返回在查询的目录中找到的文件和文件夹数组。 请注意 path 要上载的文件的属性，因为需要在下一步中提供该属性以检查其结构。

[
    {
        "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文件的结构

要检查云存储中的数据文件结构，请在提供文件路径并键入作为查询参数的同时，执行GET请求。

您可以在提供文件路径和类型的同时执行GET请求，以检查云存储源中数据文件的结构。 您还可以通过指定查询参数中的文件类型来检查不同的文件类型（如CSV、TSV或压缩JSON和分隔文件）。

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;
参数 描述
{BASE_CONNECTION_ID} 云存储源连接器的连接ID。
{FILE_PATH} 要检查的文件的路径。
{FILE_TYPE} 文件的类型。 支持的文件类型包括：
  • 已分隔：以分隔符分隔的值。 DSV文件必须以逗号分隔。
  • JSON：JavaScript对象表示法。 JSON文件必须与XDM兼容
  • PARQUET：Apache Parquet。 Parquet文件必须符合XDM标准。
{QUERY_PARAMS} 可用于筛选结果的可选查询参数。 请参阅以下部分： 查询参数 了解更多信息。

请求

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}'

响应

成功的响应将返回查询文件的结构，包括表名和数据类型。

[
    {
        "name": "Id",
        "type": "String"
    },
    {
        "name": "FirstName",
        "type": "String"
    },
    {
        "name": "LastName",
        "type": "String"
    },
    {
        "name": "Email",
        "type": "String"
    },
    {
        "name": "Phone",
        "type": "String"
    }
]

使用查询参数

此 Flow Service API 支持使用查询参数预览和检查不同的文件类型。

参数 描述
columnDelimiter 指定为列分隔符以检查CSV或TSV文件的单个字符值。 如果未提供参数，则值默认为逗号 (,).
compressionType 预览压缩的分隔或JSON文件所需的查询参数。 支持的压缩文件包括：
  • bzip2
  • gzip
  • deflate
  • zipDeflate
  • tarGzip
  • tar
encoding 定义在渲染预览时使用的编码类型。 支持的编码类型包括： UTF-8 和 ISO-8859-1. 注释：此 encoding 参数仅在摄取分隔的CSV文件时可用。 其他文件类型将使用默认编码摄取。 UTF-8.

后续步骤

通过完成本教程，您已探索云存储系统，找到要引入的文件的路径 Platform，并查看其结构。 您可以在下一教程中使用此信息来 从云存储中收集数据并将其引入平台.

在此页面上