文档Experience Platform源连接器指南

使用流服务API为Mailchimp Campaign创建数据流

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • 主题：

创建对象：

  • undefined

以下教程将指导您完成使用Flow Service API创建源连接和数据流以将Mailchimp Campaign数据引入Platform的步骤。

先决条件

在使用OAuth 2刷新代码将Mailchimp连接到Adobe Experience Platform之前，必须首先检索MailChimp.的访问令牌。有关查找访问令牌的详细说明，请参阅Mailchimp OAuth 2指南。

创建基本连接 base-connection

在检索Mailchimp身份验证凭据后，您现在可以开始创建数据流以将Mailchimp Campaign数据引入平台。 创建数据流的第一步是创建基本连接。

基本连接会保留您的源和平台之间的信息，包括源的身份验证凭据、连接的当前状态以及唯一的基本连接ID。 基本连接ID允许您浏览和浏览源中的文件，并标识要摄取的特定项目，包括有关其数据类型和格式的信息。

Mailchimp支持基本身份验证和OAuth 2刷新代码。 有关如何使用任一身份验证类型进行身份验证的指导，请参阅以下示例。

使用基本身份验证创建Mailchimp基本连接

要使用基本身份验证创建Mailchimp基本连接，请向Flow Service API的/connections端点发出POST请求，同时为您的authorizationTestUrl、username和password提供凭据。

API格式

POST /connections

请求

以下请求为Mailchimp创建基本连接：

curl -X POST \
  'https://platform.adobe.io/data/foundation/flowservice/connections' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'
  -d '{
      "name": "Mailchimp base connection with basic authentication",
      "description": "Mailchimp Campaign base connection with basic authentication",
      "connectionSpec": {
          "id": "c8ce8c8c-37fb-4162-9fbf-c2f181e04a7a",
          "version": "1.0"
      },
      "auth": {
          "specName": "Basic Authentication",
          "params": {
              "authorizationTestUrl": "https://login.mailchimp.com/oauth2/metadata",
              "username": "{USERNAME}",
              "password": "{PASSWORD}"
          }
      }
  }'
属性
描述
name
基础连接的名称。 确保基本连接的名称是描述性的，因为您可以使用此名称查找有关基本连接的信息。
description
（可选）可包含的资产，用于提供有关基本连接的更多信息。
connectionSpec.id
源的连接规范ID。 在您的源通过Flow Service API注册和批准后，可以检索此ID。
auth.specName
您用来将源连接到Platform的身份验证类型。
auth.params.authorizationTestUrl
（可选）创建基本连接时，授权测试URL用于验证凭据。 如果未提供，则会在源连接创建步骤中自动检查凭据。
auth.params.username
与您的Mailchimp帐户对应的用户名。 这是基本身份验证所必需的。
auth.params.password
与您的Mailchimp帐户对应的密码。 这是基本身份验证所必需的。

响应

成功的响应返回新创建的基本连接，包括其唯一连接标识符(id)。 在下一步中浏览源的文件结构和内容时，需要此ID。

{
    "id": "9601747c-6874-4c02-bb00-5732a8c43086",
    "etag": "\"3702dabc-0000-0200-0000-615b5b5a0000\""
}

使用OAuth 2刷新代码创建Mailchimp基本连接

要使用OAuth 2刷新代码创建Mailchimp基本连接，请在为您的authorizationTestUrl和accessToken提供凭据时向/connections端点发出POST请求。

API格式

POST /connections

请求

以下请求为Mailchimp创建基本连接：

curl -X POST \
  'https://platform.adobe.io/data/foundation/flowservice/connections' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'
  -d '{
      "name": "Mailchimp base connection with OAuth 2 refresh code",
      "description": "Mailchimp Campaign base connection with OAuth 2 refresh code",
      "connectionSpec": {
          "id": "c8ce8c8c-37fb-4162-9fbf-c2f181e04a7a",
          "version": "1.0"
      },
      "auth": {
          "specName": "oAuth2RefreshCode",
          "params": {
              "authorizationTestUrl": "https://login.mailchimp.com/oauth2/metadata",
              "accessToken": "{ACCESS_TOKEN}"
          }
      }
  }'
属性
描述
name
基础连接的名称。 确保基本连接的名称是描述性的，因为您可以使用此名称查找有关基本连接的信息。
description
（可选）可包含的资产，用于提供有关基本连接的更多信息。
connectionSpec.id
源的连接规范ID。 使用Flow Service API注册源后，可以检索此ID。
auth.specName
用于向Platform验证源的身份验证类型。
auth.params.authorizationTestUrl
（可选）授权测试URL用于在创建基本连接时验证凭据。 如果未提供，则会在源连接创建步骤中自动检查凭据。
auth.params.accessToken
用于对源进行身份验证的相应访问令牌。 基于OAuth的身份验证需要此项。

响应

成功的响应返回新创建的基本连接，包括其唯一连接标识符(id)。 在下一步中浏览源的文件结构和内容时，需要此ID。

{
    "id": "9601747c-6874-4c02-bb00-5732a8c43086",
    "etag": "\"3702dabc-0000-0200-0000-615b5b5a0000\""
}

浏览您的源 explore

使用在上一步中生成的基本连接ID，可以通过执行GET请求来浏览文件和目录。 执行GET请求以浏览源的文件结构和内容时，必须包括下表列出的查询参数：

参数
描述
{BASE_CONNECTION_ID}
上一步中生成的基本连接ID。
{OBJECT_TYPE}
要浏览的对象的类型。 对于REST源，此值默认为rest。
{OBJECT}
您希望探索的对象。
{FILE_TYPE}
只有在查看特定目录时才需要此参数。 其值表示您希望浏览的目录的路径。
{PREVIEW}
一个布尔值，定义连接的内容是否支持预览。
{SOURCE_PARAMS}
campaign_id的base64编码字符串。
TIP
要检索{SOURCE_PARAMS}的已接受格式类型，必须在base64中编码整个campaignId字符串。 例如，在base64中编码的{"campaignId": "c66a200cda"}等于eyJjYW1wYWlnbklkIjoiYzY2YTIwMGNkYSJ9。

API格式

GET /connections/{BASE_CONNECTION_ID}/explore?objectType=rest&objectType={OBJECT_TYPE}&fileType={FILE_TYPE}&preview={PREVIEW}&sourceParams={SOURCE_PARAMS}

请求

curl -X GET \
  'https://platform.adobe.io/data/foundation/flowservice/connections/05c595e5-edc3-45c8-90bb-fcf556b57c4b/explore?objectType=rest&object=json&fileType=json&preview=true&sourceParams=eyJjYW1wYWlnbklkIjoiYzY2YTIwMGNkYSJ9' \
  -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}'

响应

成功的响应将返回查询文件的结构。

{
    "data": [
        {
            "emails": [
                {
                    "campaign_id": "c66a200cda",
                    "list_id": "10c097ca71",
                    "list_is_active": true,
                    "email_id": "cff65fb4c5f5828666ad846443720efd",
                    "email_address": "kendall2134@gmail.com",
                    "_links": [
                        {
                            "rel": "parent",
                            "href": "https://us6.api.mailchimp.com/3.0/reports/c66a200cda/email-activity",
                            "method": "GET",
                            "targetSchema": "https://us6.api.mailchimp.com/schema/3.0/Definitions/Reports/EmailActivity/CollectionResponse.json"
                        },
                        {
                            "rel": "self",
                            "href": "https://us6.api.mailchimp.com/3.0/reports/c66a200cda/email-activity/cff65fb4c5f5828666ad846443720efd",
                            "method": "GET",
                            "targetSchema": "https://us6.api.mailchimp.com/schema/3.0/Definitions/Reports/EmailActivity/Response.json"
                        },
                        {
                            "rel": "member",
                            "href": "https://us6.api.mailchimp.com/3.0/lists/10c097ca71/members/cff65fb4c5f5828666ad846443720efd",
                            "method": "GET",
                            "targetSchema": "https://us6.api.mailchimp.com/schema/3.0/Definitions/Lists/Members/Response.json"
                        }
                    ]
                },
                {
                    "campaign_id": "c66a200cda",
                    "list_id": "10c097ca71",
                    "list_is_active": true,
                    "email_id": "a16b82774b211afaf60902d1afd8abc5",
                    "email_address": "logan9935890967@gmail.com",
                    "_links": [
                        {
                            "rel": "parent",
                            "href": "https://us6.api.mailchimp.com/3.0/reports/c66a200cda/email-activity",
                            "method": "GET",
                            "targetSchema": "https://us6.api.mailchimp.com/schema/3.0/Definitions/Reports/EmailActivity/CollectionResponse.json"
                        },
                        {
                            "rel": "self",
                            "href": "https://us6.api.mailchimp.com/3.0/reports/c66a200cda/email-activity/a16b82774b211afaf60902d1afd8abc5",
                            "method": "GET",
                            "targetSchema": "https://us6.api.mailchimp.com/schema/3.0/Definitions/Reports/EmailActivity/Response.json"
                        },
                        {
                            "rel": "member",
                            "href": "https://us6.api.mailchimp.com/3.0/lists/10c097ca71/members/a16b82774b211afaf60902d1afd8abc5",
                            "method": "GET",
                            "targetSchema": "https://us6.api.mailchimp.com/schema/3.0/Definitions/Lists/Members/Response.json"
                        }
                    ]
                },
            ]
        }
    ]
}

创建源连接 source-connection

您可以通过向Flow Service API发出POST请求来创建源连接。 源连接由连接ID、源数据文件的路径以及连接规范ID组成。

要创建源连接，还必须为数据格式属性定义一个枚举值。

为基于文件的源使用以下枚举值：

数据格式
枚举值
已分隔
delimited
JSON
json
Parquet
parquet

对于所有基于表的源，将该值设置为tabular。

API格式

POST /sourceConnections

请求

以下请求为Mailchimp创建源连接：

curl -X POST \
  'https://platform.adobe.io/data/foundation/flowservice/sourceConnections' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'
  -d '{
      "name": "MailChimp source connection to ingest campaign ID",
      "description": "MailChimp Campaign source connection to ingest campaign ID",
      "baseConnectionId": "4cea039f-f1cc-4fa5-9136-db8dd4c7fbfa",
      "connectionSpec": {
          "id": "c8ce8c8c-37fb-4162-9fbf-c2f181e04a7a",
          "version": "1.0"
      },
      "data": {
          "format": "json"
      },
      "params": {
          "campaignId": "c66a200cda"
      }
  }'
属性
描述
name
源连接的名称。 请确保源连接的名称是描述性的，因为您可以使用此名称查找有关源连接的信息。
description
可包含的可选值，用于提供有关源连接的更多信息。
baseConnectionId
Mailchimp的基本连接ID。 此ID是在前面的步骤中生成的。
connectionSpec.id
与源对应的连接规范ID。
data.format
要摄取的Mailchimp数据的格式。
params.campaignId
Mailchimp营销活动ID标识特定的Mailchimp营销活动，然后允许您向列表/受众发送电子邮件。

响应

成功的响应返回新创建的源连接的唯一标识符(id)。 此ID是稍后步骤创建数据流所必需的。

{
    "id": "d6557bf1-7347-415f-964c-9316bd4cbf56",
    "etag": "\"e205c206-0000-0200-0000-615b5c070000\""
}

创建目标XDM架构 target-schema

为了在Platform中使用源数据，必须创建目标架构，以根据您的需求构建源数据。 然后，使用目标架构创建包含源数据的Platform数据集。

通过向架构注册表API执行POST请求，可以创建目标XDM架构。

有关如何创建目标XDM架构的详细步骤，请参阅有关使用API 创建架构的教程。

创建目标数据集 target-dataset

可以通过向目录服务API执行POST请求，在有效负载中提供目标架构的ID来创建目标数据集。

有关如何创建目标数据集的详细步骤，请参阅有关使用API创建数据集的教程。

创建目标连接 target-connection

目标连接表示与所摄取数据所登陆的目标之间的连接。 要创建目标连接，必须提供与Data Lake对应的固定连接规范ID。 此ID为： c604ff05-7f1a-43c0-8e18-33bf874cb11c。

您现在具有目标架构、目标数据集以及到Data Lake的连接规范ID的唯一标识符。 使用这些标识符，您可以使用Flow Service API创建目标连接，以指定将包含入站源数据的数据集。

API格式

POST /targetConnections

请求

以下请求为Mailchimp创建目标连接：

curl -X POST \
  'https://platform.adobe.io/data/foundation/flowservice/targetConnections' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'
  -d '{
      "name": "MailChimp target connection",
      "description": "MailChimp Campaign target connection",
      "connectionSpec": {
          "id": "c604ff05-7f1a-43c0-8e18-33bf874cb11c",
          "version": "1.0"
      },
      "data": {
          "format": "parquet_xdm",
          "schema": {
              "id": "https://ns.adobe.com/{TENANT_ID}/schemas/570630b91eb9d5cf5db0436756abb110d02912917a67da2d",
              "version": "application/vnd.adobe.xed-full+json;version=1"
          }
      },
      "params": {
          "dataSetId": "6155e3a9bd13651949515f14"
      }
  }'
属性
描述
name
目标连接的名称。 确保目标连接的名称是描述性的，因为您可以使用此名称查找有关目标连接的信息。
description
可包含的可选值，用于提供有关目标连接的更多信息。
connectionSpec.id
对应于Data Lake的连接规范ID。 此固定ID为： c604ff05-7f1a-43c0-8e18-33bf874cb11c。
data.format
要带到Platform的Mailchimp数据的格式。
params.dataSetId
在上一步中检索到的目标数据集ID。

响应

成功的响应返回新目标连接的唯一标识符(id)。 此ID在后续步骤中是必需的。

{
    "id": "9463fe9c-027d-4347-a423-894fcd105647",
    "etag": "\"b902e822-0000-0200-0000-615b5c370000\""
}
IMPORTANT
Mailchimp Campaign当前不支持数据准备功能。

创建流 flow

将Mailchimp数据引入Platform的最后一步是创建数据流。 现在，您已准备以下必需值：

数据流负责从源中计划和收集数据。 您可以通过在有效负载中提供上述值时执行POST请求来创建数据流。

要计划摄取，您必须先将开始时间值设置为纪元时间（以秒为单位）。 然后，必须将频率值设置为五个选项之一： once、minute、hour、day或week。 间隔值指定两次连续摄取之间的时间段，创建一次性摄取(once)不需要设置间隔。 对于所有其他频率，间隔值必须设置为等于或大于15。

API格式

POST /flows

请求

curl -X POST \
  'https://platform.adobe.io/data/foundation/flowservice/flows' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'
  -d '{
      "name": "MailChimp Campaign dataflow",
      "description": "MailChimp Campaign dataflow",
      "flowSpec": {
          "id": "6499120c-0b15-42dc-936e-847ea3c24d72",
          "version": "1.0"
      },
      "sourceConnectionIds": [
          "d6557bf1-7347-415f-964c-9316bd4cbf56"
      ],
      "targetConnectionIds": [
          "9463fe9c-027d-4347-a423-894fcd105647"
      ],
      "scheduleParams": {
          "startTime": "1632809759",
          "frequency": "minute",
          "interval": 15
      }
  }'
属性
描述
name
您的数据流的名称。 确保数据流的名称是描述性的，因为您可以使用此名称查找数据流上的信息。
description
（可选）可包含的属性，用于提供有关数据流的更多信息。
flowSpec.id
创建数据流所需的流规范ID。 此固定ID为： 6499120c-0b15-42dc-936e-847ea3c24d72。
flowSpec.version
流规范ID的相应版本。 此值默认为1.0。
sourceConnectionIds
在之前的步骤中生成的源连接ID。
targetConnectionIds
在之前的步骤中生成的目标连接ID。
scheduleParams.startTime
首次摄取数据时指定的开始时间。
scheduleParams.frequency
数据流收集数据的频率。 可接受的值包括： once、minute、hour、day或week。
scheduleParams.interval
间隔指定两次连续流运行之间的周期。 间隔的值应为非零整数。 当频率设置为once时不需要间隔，其他频率值应大于或等于15。

响应

成功的响应返回新创建的数据流的ID (id)。 您可以使用此ID监视、更新或删除数据流。

{
    "id": "be2d5249-eeaf-4a74-bdbd-b7bf62f7b2da",
    "etag": "\"7e010621-0000-0200-0000-615b5c9b0000\""
}

附录

以下部分提供了有关监视、更新和删除数据流的步骤的信息。

监测数据流

创建数据流后，您可以监视通过它摄取的数据，以查看有关流运行、完成状态和错误的信息。 有关完整的API示例，请阅读有关使用API监视源数据流的指南。

更新您的数据流

通过提供数据流的ID，向Flow Service API的/flows端点发出PATCH请求，更新数据流的详细信息，例如其名称和描述，以及其运行计划和关联的映射集。 发出PATCH请求时，必须在If-Match标头中提供数据流唯一的etag。 有关完整的API示例，请阅读有关使用API更新源数据流的指南。

更新您的帐户

在提供您的基本连接ID作为查询参数的同时，通过执行对Flow Service API的PATCH请求来更新源帐户的名称、描述和凭据。 发出PATCH请求时，必须在If-Match标头中提供源帐户的唯一etag。 有关完整的API示例，请阅读有关使用API更新源帐户的指南。

删除您的数据流

在查询参数中提供要删除的数据流的ID时，通过向Flow Service API执行DELETE请求来删除数据流。 有关完整的API示例，请阅读有关使用API删除数据流的指南。

删除您的帐户

在提供要删除的帐户的基本连接ID时，通过向Flow Service API执行DELETE请求来删除您的帐户。 有关完整的API示例，请阅读有关使用API🔗删除源帐户的指南。

recommendation-more-help
337b99bb-92fb-42ae-b6b7-c7042161d089