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

Last update: Thu May 25 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

主题：
Sources

创建对象：

Developer

以下教程将指导您完成创建源连接和要引入的数据流的步骤 Mailchimp Campaign 使用将数据发送到平台 Flow Service API.

先决条件

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

创建基本连接 base-connection

一旦您恢复了 Mailchimp 身份验证凭据，您现在可以开始创建数据流以引入 Mailchimp Campaign 数据到Platform。创建数据流的第一步是创建基本连接。

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

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

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

创建 Mailchimp POST基本连接使用基本身份验证，向 /connections 端点 Flow Service API同时为提供凭据 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。在您的源通过注册和批准后，可以检索此ID Flow Service API。

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\""
}

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

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

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。使用注册源后，可以检索此ID Flow Service API。

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}

的base64编码字符串 campaign_id.

TIP

检索接受的格式类型 {SOURCE_PARAMS}，您必须编码整个 campaignId base64中的字符串。例如， {"campaignId": "c66a200cda"} 在base64中编码等于 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

您可以通过对以下对象发出POST请求来创建源连接： Flow Service API。源连接由连接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

的基本连接ID Mailchimp. 此ID是在前面的步骤中生成的。

connectionSpec.id

与源对应的连接规范ID。

data.format

的格式 Mailchimp 要摄取的数据。

params.campaignId

此 Mailchimp 营销活动ID标识特定的 Mailchimp campaign，然后允许您向列表/受众发送电子邮件。

响应

成功响应将返回唯一标识符(id)。此ID在后续步骤中是创建数据流所必需的。

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

创建目标XDM架构 target-schema

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

可以通过向以下对象执行POST请求来创建目标XDM架构架构注册表API.

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

创建目标数据集 target-dataset

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

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

创建目标连接 target-connection

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

现在，目标架构和目标数据集的连接规范ID均为唯一标识符 Data Lake. 使用这些标识符，您可以使用 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

与对应的连接规范ID Data Lake. 此固定ID为： c604ff05-7f1a-43c0-8e18-33bf874cb11c.

data.format

的格式 Mailchimp 要带到Platform的数据。

params.dataSetId

在上一步中检索的目标数据集ID。

响应

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

{
    "id": "9463fe9c-027d-4347-a423-894fcd105647",
    "etag": "\"b902e822-0000-0200-0000-615b5c370000\""
}

IMPORTANT

当前不支持数据准备功能 Mailchimp Campaign.

创建流 flow

实现以下目标的最后一步： Mailchimp 数据到Platform就是创建一个数据流。现在，您已准备以下必需值：

源连接ID
目标连接ID

数据流负责从源中计划和收集数据。您可以通过在有效负载中提供上述值时执行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监控源数据流.

更新您的数据流

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

更新您的帐户

PATCH通过向 Flow Service API，同时将基本连接ID作为查询参数提供。在提出PATCH请求时，您必须提供源帐户的唯一 etag 在 If-Match 标头。有关完整的API示例，请阅读以下指南：使用API更新源帐户.

删除数据流

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

删除您的帐户

向以下人员发出DELETE请求以删除您的帐户： Flow Service 提供要删除的帐户的基本连接ID时的API。有关完整的API示例，请阅读以下指南：使用API删除源帐户.

recommendation-more-help

337b99bb-92fb-42ae-b6b7-c7042161d089