Show Menu
主题×

使用Flow Service API探索营销自动化系统

Flow Service用于收集和集中Adobe Experience Platform内不同来源的客户数据。 该服务提供用户界面和RESTful API,所有支持的源都可从中连接。
本教程使用Flow Service API探索营销自动化系统。

入门指南

本指南需要对Adobe Experience Platform的以下组件有充分的了解:
  • 来源 :Experience Platform允许从各种来源摄取数据,同时使您能够使用平台服务来构建、标记和增强传入数据。
  • 沙箱 :Experience Platform提供虚拟沙箱,将单个Platform实例分为单独的虚拟环境,以帮助开发和发展数字体验应用程序。
以下各节提供您需要了解的其他信息,以便使用Flow Service API成功连接到营销自动化系统。

收集所需的凭据

本教程要求您与要从中获取数据的第三方营销自动化应用程序建立有效连接。 有效的连接涉及应用程序的连接规范ID和连接ID。 有关创建营销自动化连接和检索这些值的更多信息,请参阅将营销 自动化源连接到平台教程

读取示例API调用

本教程提供示例API调用,以演示如何设置请求的格式。 这些包括路径、必需的标题和格式正确的请求负载。 还提供API响应中返回的示例JSON。 有关示例API调用文档中使用的惯例的信息,请参阅Experience Platform疑难解答指南 中有关如何阅读示例API调用的部分

收集所需标题的值

要调用平台API,您必须首先完成身份验证 教程 。 完成身份验证教程后,将为所有Experience Platform API调用中的每个所需标头提供值,如下所示:
  • 授权:承载人 {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}
Experience Platform中的所有资源(包括属于Flow Service的资源)都与特定虚拟沙箱隔离。 对平台API的所有请求都需要一个标头,它指定操作将在以下位置进行的沙箱的名称:
  • x-sandbox-name: {SANDBOX_NAME}
所有包含有效负荷(POST、PUT、PATCH)的请求都需要额外的媒体类型标题:
  • 内容类型: application/json

浏览数据表

使用营销自动化系统的基本连接,您可以通过执行GET请求来浏览数据表。 使用以下调用查找要检查或收录到平台中的表的路径。
API格式
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=root

参数
描述
{BASE_CONNECTION_ID}
营销自动化系统的基本连接ID。
请求
curl -X GET \
    'http://platform.adobe.io/data/foundation/flowservice/connections/2fce94c1-9a93-4971-8e94-c19a93097129/explore?objectType=root' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {IMS_ORG}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'

响应
成功的响应是一系列从营销自动化系统到营销自动化系统的表。 查找要引入平台的表并记下其属性,因为您需要在下一 path 步中提供它以检查其结构。
[
    {
        "type": "table",
        "name": "Hubspot.All_Deals",
        "path": "Hubspot.All_Deals",
        "canPreview": true,
        "canFetchSchema": true
    },
    {
        "type": "table",
        "name": "Hubspot.Blog_Authors",
        "path": "Hubspot.Blog_Authors",
        "canPreview": true,
        "canFetchSchema": true
    },
    {
        "type": "table",
        "name": "Hubspot.Blog_Comments",
        "path": "Hubspot.Blog_Comments",
        "canPreview": true,
        "canFetchSchema": true
    },
    {
        "type": "table",
        "name": "Hubspot.Contacts",
        "path": "Hubspot.Contacts",
        "canPreview": true,
        "canFetchSchema": true
    },
]

检查表的结构

要从营销自动化系统检查表的结构,请在将表的路径指定为查询参数时执行GET请求。
API格式
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=table&object={TABLE_PATH}

参数
描述
{BASE_CONNECTION_ID}
营销自动化系统的连接ID。
{TABLE_PATH}
营销自动化系统中表的路径。
请求
curl -X GET \
    'http://platform.adobe.io/data/foundation/flowservice/connections/2fce94c1-9a93-4971-8e94-c19a93097129/explore?objectType=table&object=Hubspot.Contacts' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {IMS_ORG}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'

响应
成功的响应会返回表的结构。 有关每个表列的详细信息位于数组的元素 columns 中。
{
    "format": "flat",
    "schema": {
        "columns": [
            {
                "name": "Properties_Firstname_Value",
                "type": "string",
                "xdm": {
                    "type": "string"
                }
            },
            {
                "name": "Properties_Lastname_Value",
                "type": "string",
                "xdm": {
                    "type": "string"
                }
            },
            {
                "name": "Added_At",
                "type": "string",
                "meta:xdmType": "date-time",
                "xdm": {
                    "type": "string",
                    "format": "date-time"
                }
            },
            {
                "name": "Portal_Id",
                "type": "string",
                "xdm": {
                    "type": "string"
                }
            },
        ]
    }
}

后续步骤

通过本教程,您探索了营销自动化系统,找到了要引入平台的表的路径,并获取了有关其结构的信息。 您可以在下一个教程中使用此信息从 营销自动化系统收集数据并将其引入平台