使用流服务API更新目标数据流

本教程介绍了更新目标数据流的步骤。 了解如何使用启用或禁用数据流、更新其基本信息或者添加和删除受众和属性 Flow Service API. 有关使用Experience PlatformUI编辑目标数据流的信息,请阅读 编辑激活流程.

快速入门 get-started

本教程要求您拥有有效的流ID。 如果您没有有效的流ID,请从 目标目录 并遵循概述的步骤 连接到目标激活数据 ,然后再尝试本教程。

NOTE
术语 流量数据流 在本教程中可互换使用。 在本教程的上下文中,具有相同含义。

本教程还要求您实际了解Adobe Experience Platform的以下组件:

  • 目标: Destinations 是预先构建的与目标平台的集成,允许从Adobe Experience Platform无缝激活数据。 您可以使用目标激活已知和未知的数据,用于跨渠道营销活动、电子邮件宣传、定向广告和许多其他用例。
  • 沙盒:Experience Platform提供了可将单个Platform实例划分为多个单独的虚拟环境的虚拟沙箱,以帮助开发和改进数字体验应用程序。

以下部分提供在使用成功更新数据流时需要了解的其他信息 Flow Service API。

正在读取示例 API 调用 reading-sample-api-calls

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

收集所需标头的值 gather-values-for-required-headers

要调用Platform API,您必须先完成 身份验证教程. 完成身份验证教程将为所有Experience PlatformAPI调用中的每个所需标头提供值,如下所示:

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {ORG_ID}

Experience Platform中的所有资源,包括属于 Flow Service隔离到特定的虚拟沙盒。 所有对Platform API的请求都需要一个标头,用于指定将在其中执行操作的沙盒的名称:

  • x-sandbox-name: {SANDBOX_NAME}
NOTE
如果 x-sandbox-name 未指定标头,请求解析在 prod 沙盒。

所有包含有效负载(POST、PUT、PATCH)的请求都需要额外的媒体类型标头:

  • Content-Type: application/json

查找数据流详细信息 look-up-dataflow-details

更新目标数据流的第一步是使用流ID检索数据流详细信息。 您可以通过对以下对象发出GET请求,查看现有数据流的当前详细信息: /flows 端点。

API格式

GET /flows/{FLOW_ID}
参数
描述
{FLOW_ID}
唯一 id 要检索的目标数据流的值。

请求

以下请求可检索有关您的流量ID的信息。

curl -X GET \
    'https://platform.adobe.io/data/foundation/flowservice/flows/226fb2e1-db69-4760-b67e-9e671e05abfc' \
    -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}'

响应

成功响应将返回数据流的当前详细信息,包括其版本、唯一标识符(id),以及其他相关信息。

{
   "items":[
      {
         "id":"226fb2e1-db69-4760-b67e-9e671e05abfc",
         "createdAt":"{CREATED_AT}",
         "updatedAt":"{UPDATED_BY}",
         "createdBy":"{CREATED_BY}",
         "updatedBy":"{UPDATED_BY}",
         "createdClient":"{CREATED_CLIENT}",
         "updatedClient":"{UPDATED_CLIENT}",
         "sandboxId":"{SANDBOX_ID}",
         "sandboxName":"prod",
         "imsOrgId":"{ORG_ID}",
         "name":"2021 winter campaign",
         "description":"ACME company holiday campaign for high fidelity customers",
         "flowSpec":{
            "id":"71471eba-b620-49e4-90fd-23f1fa0174d8",
            "version":"1.0"
         },
         "state":"enabled",
         "version":"\"8b0351ca-0000-0200-0000-61c4d6700000\"",
         "etag":"\"8b0351ca-0000-0200-0000-61c4d6700000\"",
         "sourceConnectionIds":[
            "5e45582a-5336-4ea1-9ec9-d0004a9f344a"
         ],
         "targetConnectionIds":[
            "8ce3dc63-3766-4220-9f61-51d2f8f14618"
         ],
         "inheritedAttributes":{
            "sourceConnections":[
               {
                  "id":"5e45582a-5336-4ea1-9ec9-d0004a9f344a",
                  "connectionSpec":{
                     "id":"8a9c3494-9708-43d7-ae3f-cda01e5030e1",
                     "version":"1.0"
                  },
                  "baseConnection":{
                     "id":"0a82f29f-b457-47f7-bb30-33856e2ae5aa",
                     "connectionSpec":{
                        "id":"8a9c3494-9708-43d7-ae3f-cda01e5030e1",
                        "version":"1.0"
                     }
                  },
                  "typeInfo":{
                     "type":"ProfileFragments",
                     "id":"ups"
                  }
               }
            ],
            "targetConnections":[
               {
                  "id":"8ce3dc63-3766-4220-9f61-51d2f8f14618",
                  "connectionSpec":{
                     "id":"0b23e41a-cb4a-4321-a78f-3b654f5d7d97",
                     "version":"1.0"
                  },
                  "baseConnection":{
                     "id":"7fbf542b-83ed-498f-8838-8fde0c4d4d69",
                     "connectionSpec":{
                        "id":"0b23e41a-cb4a-4321-a78f-3b654f5d7d97",
                        "version":"1.0"
                     }
                  }
               }
            ]
         },
         "transformations":[
            {
               "name":"GeneralTransform",
               "params":{
                  "profileSelectors":{
                     "selectors":[
                        {
                           "type":"JSON_PATH",
                           "value":{
                              "path":"Email",
                              "operator":"EXISTS",
                              "identity":{
                                 "namespace":"Email"
                              },
                              "mapping":{
                                 "sourceType":"text/x.schema-path",
                                 "source":"Email",
                                 "destination":"Email",
                                 "identity":false,
                                 "primaryIdentity":false,
                                 "functionVersion":0,
                                 "copyModeMapping":false,
                                 "sourceAttribute":"Email",
                                 "destinationXdmPath":"Email"
                              }
                           }
                        },
                        {
                           "type":"JSON_PATH",
                           "value":{
                              "path":"person.name.firstName",
                              "operator":"EXISTS",
                              "mapping":{
                                 "sourceType":"text/x.schema-path",
                                 "source":"person.name.firstName",
                                 "destination":"person.name.firstName",
                                 "identity":false,
                                 "primaryIdentity":false,
                                 "functionVersion":0,
                                 "copyModeMapping":false,
                                 "sourceAttribute":"person.name.firstName",
                                 "destinationXdmPath":"person.name.firstName"
                              }
                           }
                        },
                        {
                           "type":"JSON_PATH",
                           "value":{
                              "path":"person.name.lastName",
                              "operator":"EXISTS",
                              "mapping":{
                                 "sourceType":"text/x.schema-path",
                                 "source":"person.name.lastName",
                                 "destination":"person.name.lastName",
                                 "identity":false,
                                 "primaryIdentity":false,
                                 "functionVersion":0,
                                 "copyModeMapping":false,
                                 "sourceAttribute":"person.name.lastName",
                                 "destinationXdmPath":"person.name.lastName"
                              }
                           }
                        },
                        {
                           "type":"JSON_PATH",
                           "value":{
                              "path":"personalEmail.address",
                              "operator":"EXISTS",
                              "mapping":{
                                 "sourceType":"text/x.schema-path",
                                 "source":"personalEmail.address",
                                 "destination":"personalEmail.address",
                                 "identity":false,
                                 "primaryIdentity":false,
                                 "functionVersion":0,
                                 "copyModeMapping":false,
                                 "sourceAttribute":"personalEmail.address",
                                 "destinationXdmPath":"personalEmail.address"
                              }
                           }
                        },
                        {
                           "type":"JSON_PATH",
                           "value":{
                              "path":"segmentMembership.status",
                              "operator":"EXISTS",
                              "mapping":{
                                 "sourceType":"text/x.schema-path",
                                 "source":"segmentMembership.status",
                                 "destination":"segmentMembership.status",
                                 "identity":false,
                                 "primaryIdentity":false,
                                 "functionVersion":0,
                                 "copyModeMapping":false,
                                 "sourceAttribute":"segmentMembership.status",
                                 "destinationXdmPath":"segmentMembership.status"
                              }
                           }
                        }
                     ],
                     "mandatoryFields":[
                        "Email",
                        "person.name.firstName",
                        "person.name.lastName"
                     ],
                     "primaryFields":[
                        {
                           "identityNamespace":"Email",
                           "fieldType":"IDENTITY"
                        }
                     ]
                  },
                  "segmentSelectors":{
                     "selectors":[
                        {
                           "type":"PLATFORM_SEGMENT",
                           "value":{
                              "id":"9f7d37fd-7039-4454-94ef-2b0cd6c3206a",
                              "name":"Interested in Mountain Biking",
                              "filenameTemplate":"%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%",
                              "exportMode":"DAILY_FULL_EXPORT",
                              "schedule":{
                                 "frequency":"ONCE",
                                 "startDate":"2021-12-25",
                                 "startTime":"20:00"
                              },
                              "createTime":"1640289901",
                              "updateTime":"1640289901"
                           }
                        },
                        {
                           "type":"PLATFORM_SEGMENT",
                           "value":{
                              "id":"f52a3785-2e7c-40a7-8137-9be99af7794e",
                              "name":"Birth year 1970",
                              "filenameTemplate":"%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%",
                              "exportMode":"DAILY_FULL_EXPORT",
                              "schedule":{
                                 "frequency":"DAILY",
                                 "startDate":"2021-12-23",
                                 "endDate":"2021-12-31",
                                 "startTime":"20:00"
                              },
                              "createTime":"1640289901",
                              "updateTime":"1640289901"
                           }
                        },
                        {
                           "type":"PLATFORM_SEGMENT",
                           "value":{
                              "id":"6caa79b9-39e0-4c37-892b-5061cdca2377",
                              "name":"Account Leads",
                              "filenameTemplate":"%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%",
                              "exportMode":"FIRST_FULL_THEN_INCREMENTAL",
                              "schedule":{
                                 "frequency":"DAILY",
                                 "startDate":"2021-12-23",
                                 "endDate":"2021-12-31",
                                 "startTime":"20:00"
                              },
                              "createTime":"1640289901",
                              "updateTime":"1640289901"
                           }
                        },
                        {
                           "type":"PLATFORM_SEGMENT",
                           "value":{
                              "id":"4c41c318-9e8c-4a4f-b880-877cdd629fc7",
                              "name":"Batch export for autumn campaign",
                              "filenameTemplate":"%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%",
                              "exportMode":"FIRST_FULL_THEN_INCREMENTAL",
                              "schedule":{
                                 "frequency":"EVERY_6_HOURS",
                                 "startDate":"2022-01-05",
                                 "endDate":"2022-12-30",
                                 "startTime":"20:00"
                              },
                              "createTime":"1640289901",
                              "updateTime":"1640289901"
                           }
                        }
                     ]
                  }
               }
            }
         ]
      }
   ]

更新数据流名称和描述 update-dataflow

PATCH要更新数据流的名称和描述,请向 Flow Service API,同时提供您的流ID、版本以及要使用的新值。

IMPORTANT
If-Match 发出PATCH请求时需要标头。 此标头的值是要更新的数据流的唯一版本。 每次成功更新数据流时,etag值都会更新。

API格式

PATCH /flows/{FLOW_ID}

请求

以下请求将更新数据流的名称和描述。

curl -X PATCH \
    'https://platform.adobe.io/data/foundation/flowservice/flows/226fb2e1-db69-4760-b67e-9e671e05abfc' \
    -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}'
    -H 'If-Match: "1a0037e4-0000-0200-0000-602e06f60000"' \
    -d '[
            {
                "op": "replace",
                "path": "/name",
                "value": "2021/2022 winter campaign"
            },
            {
                "op": "replace",
                "path": "/description",
                "value": "ACME company holiday campaign for high fidelity customers and prospects"
            }
        ]'
属性
描述
op
操作调用,用于定义更新数据流所需的操作。 操作包括: addreplace、和 remove.
path
定义要更新的流部分。
value
要用于更新参数的新值。

响应

成功的响应将返回您的流ID和更新的电子标记。 您可以通过向以下网站发出GET请求来验证更新: Flow Service API,同时提供您的流ID。

{
    "id": "2edc08ac-4df5-4fe6-936f-81a19ce92f5c",
    "etag": "\"50014cc8-0000-0200-0000-6036eb720000\""
}

启用或禁用数据流 enable-disable-dataflow

启用后,数据流会将配置文件导出到目标。 数据流默认处于启用状态,但可以禁用以暂停配置文件导出。

您可以通过对以下对象发出POST请求,启用或禁用现有目标数据流: Flow Service API以及要更新流的提供状态。

API格式

POST /flows/{FLOW_ID}/action?op=enable or disable

请求

以下请求会将您的数据流状态更新为“已启用”。

curl -X POST \
    'https://platform.adobe.io/data/foundation/flowservice/flows/226fb2e1-db69-4760-b67e-9e671e05abfc/action?op=enable' \
    -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}'

以下请求会将您的数据流状态更新为已禁用。

curl -X POST \
    'https://platform.adobe.io/data/foundation/flowservice/flows/226fb2e1-db69-4760-b67e-9e671e05abfc/action?op=disable' \
    -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}'

响应

成功的响应将返回您的流ID和更新的电子标记。 您可以通过向以下网站发出GET请求来验证更新: Flow Service API,同时提供您的流ID。

{
    "id": "2edc08ac-4df5-4fe6-936f-81a19ce92f5c",
    "etag": "\"50014cc8-0000-0200-0000-6036eb720000\""
}

将受众添加到数据流 add-segment

PATCH要将受众添加到目标数据流,请对 Flow Service API,同时提供您的流ID、版本以及要添加的受众。

API格式

PATCH /flows/{FLOW_ID}

请求

以下请求会将新受众添加到现有目标数据流。

curl -X PATCH \
    'https://platform.adobe.io/data/foundation/flowservice/flows/226fb2e1-db69-4760-b67e-9e671e05abfc' \
    -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}'
    -H 'If-Match: "1a0037e4-0000-0200-0000-602e06f60000"' \
    -d '[
   {
      "op":"add",
      "path":"/transformations/0/params/segmentSelectors/selectors/-",
      "value":{
         "type":"PLATFORM_SEGMENT",
         "value":{
            "id":"2d79d0d8-724f-49fc-a09d-d1dec338c93c",
            "name":"Winter 2021/2022 campaign",
            "filenameTemplate":"%DESTINATION_NAME%_%SEGMENT_ID%_%SEGMENT_NAME%_%DATETIME(YYYYMMdd_HHmmss)%_custom-text",
            "exportMode":"DAILY_FULL_EXPORT",
            "schedule":{
               "startDate":"2022-01-05",
               "frequency":"DAILY",
               "triggerType": "AFTER_SEGMENT_EVAL",
               "endDate":"2022-03-10"
            }
         }
      }
   }
]'
属性
描述
op
操作调用,用于定义更新数据流所需的操作。 操作包括: addreplace、和 remove. 要将受众添加到数据流,请使用 add 操作。
path
定义要更新的流部分。 将受众添加到数据流时,请使用示例中指定的路径。
value
要用于更新参数的新值。
id
指定要添加到目标数据流的受众的ID。
name
(可选). 指定要添加到目标数据流的受众的名称。 请注意,此字段不是必填字段,您无需提供名称即可将受众成功添加到目标数据流。
filenameTemplate

对象 批处理目标 仅限。 只有在批量文件导出目标(如Amazon S3、SFTP或Azure Blob)中将受众添加到数据流时,才需要使用此字段。
此字段确定导出到目标的文件的文件名格式。
可以使用以下选项:

  • %DESTINATION_NAME%:必填项。 导出的文件包含目标名称。
  • %SEGMENT_ID%:必填项。 导出的文件包含导出受众的ID。
  • %SEGMENT_NAME%(可选). 导出的文件包含导出的受众的名称。
  • DATETIME(YYYYMMdd_HHmmss)%TIMESTAMP%(可选). 为文件选择这两个选项之一,以包括通过Experience Platform生成文件的时间。
  • custom-text(可选). 将此占位符替换为要在文件名末尾追加的任何自定义文本。

有关配置文件名的详细信息,请参阅 配置文件名 部分(在批量目标激活教程中)。

exportMode
对象 批处理目标 仅限。 只有在批量文件导出目标(如Amazon S3、SFTP或Azure Blob)中将受众添加到数据流时,才需要使用此字段。
必填。 选择 "DAILY_FULL_EXPORT""FIRST_FULL_THEN_INCREMENTAL". 有关这两个选项的更多信息,请参阅 导出完整文件导出增量文件 在batch destinations activation教程中。
startDate
选择受众应开始将用户档案导出到目标的日期。
frequency

对象 批处理目标 仅限。 只有在批量文件导出目标(如Amazon S3、SFTP或Azure Blob)中将受众添加到数据流时,才需要使用此字段。
必填。

  • 对于 "DAILY_FULL_EXPORT" 导出模式,您可以选择 ONCEDAILY.
  • 对于 "FIRST_FULL_THEN_INCREMENTAL" 导出模式,您可以选择 "DAILY""EVERY_3_HOURS""EVERY_6_HOURS""EVERY_8_HOURS""EVERY_12_HOURS".
triggerType

对象 批处理目标 仅限。 只有在选择 "DAILY_FULL_EXPORT" 中的模式 frequency 选择器。
必填。

  • 选择 "AFTER_SEGMENT_EVAL" 使激活作业在每日Platform批量分段作业完成后立即运行。 这可确保在激活作业运行时,将最新的配置文件导出到您的目标。
  • 选择 "SCHEDULED" 使激活作业在固定时间运行。 这可确保每天在同一时间导出Experience Platform配置文件数据,但您导出的配置文件可能不是最新的,具体取决于批量分段作业是否在激活作业开始之前完成。 选择此选项时,您还必须添加 startTime 指示每日导出应在UTC时段的哪个时间发生。
endDate
对象 批处理目标 仅限。 只有在批量文件导出目标(如Amazon S3、SFTP或Azure Blob)中将受众添加到数据流时,才需要使用此字段。
选择时不适用 "exportMode":"DAILY_FULL_EXPORT""frequency":"ONCE".
设置受众成员停止导出到目标的日期。
startTime
对象 批处理目标 仅限。 只有在批量文件导出目标(如Amazon S3、SFTP或Azure Blob)中将受众添加到数据流时,才需要使用此字段。
必填。 选择应生成包含受众成员的文件并将其导出到目标的时间。

响应

成功的响应将返回您的流ID和更新的电子标记。 您可以通过向以下网站发出GET请求来验证更新: Flow Service API,同时提供您的流ID。

{
    "id": "2edc08ac-4df5-4fe6-936f-81a19ce92f5c",
    "etag": "\"50014cc8-0000-0200-0000-6036eb720000\""
}

从数据流中删除受众 remove-segment

要从现有目标数据流中删除受众,请对执行PATCH请求 Flow Service API,同时提供您的流ID、版本以及要删除的受众的索引选择器。 索引始于 0. 例如,下面的示例请求从数据流中删除第一和第二受众。

API格式

PATCH /flows/{FLOW_ID}

请求

以下请求从现有目标数据流中删除两个受众。

curl -X PATCH \
    'https://platform.adobe.io/data/foundation/flowservice/flows/226fb2e1-db69-4760-b67e-9e671e05abfc' \
    -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}'
    -H 'If-Match: "1a0037e4-0000-0200-0000-602e06f60000"' \
    -d '[
{
   "op":"remove",
   "path":"/transformations/0/params/segmentSelectors/selectors/0",
   "value":{
      "type":"PLATFORM_SEGMENT",
      "value":{
      }
   }
},
{
   "op":"remove",
   "path":"/transformations/0/params/segmentSelectors/selectors/1",
   "value":{
      "type":"PLATFORM_SEGMENT",
      "value":{
      }
   }
}
]'
属性
描述
op
操作调用,用于定义更新数据流所需的操作。 操作包括: addreplace、和 remove. 要从数据流中删除受众,请使用 remove 操作。
path
根据受众选择器的索引,指定应从目标数据流中删除哪些现有受众。 GET要检索数据流中受众的顺序,请对 /flows 端点并检查 transformations.segmentSelectors 属性。 要删除数据流中的第一个受众,请使用 "path":"/transformations/0/params/segmentSelectors/selectors/0".

响应

成功的响应将返回您的流ID和更新的电子标记。 您可以通过向以下网站发出GET请求来验证更新: Flow Service API,同时提供您的流ID。

{
    "id": "2edc08ac-4df5-4fe6-936f-81a19ce92f5c",
    "etag": "\"50014cc8-0000-0200-0000-6036eb720000\""
}

更新数据流中受众的组件 update-segment

您可以更新现有目标数据流中受众的组件。 例如,可以更改导出频率或编辑文件名模板。 PATCH为此,请向 Flow Service API,同时提供您的流ID、版本以及要更新的受众的索引选择器。 索引始于 0. 例如,下面的请求会更新数据流中的第九个受众。

API格式

PATCH /flows/{FLOW_ID}

请求

在现有的目标数据流中更新受众时,您应该首先执行GET操作以检索要更新的受众的详细信息。 然后,在有效负荷中提供所有受众信息,而不仅仅是要更新的字段。 在以下示例中,自定义文本会添加到文件名模板的末尾,导出计划频率会从6小时更新为12小时。

curl -X PATCH \
    'https://platform.adobe.io/data/foundation/flowservice/flows/226fb2e1-db69-4760-b67e-9e671e05abfc' \
    -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}'
    -H 'If-Match: "1a0037e4-0000-0200-0000-602e06f60000"' \
    -d '[
   {
      "op":"replace",
      "path":"/transformations/0/params/segmentSelectors/selectors/8",
      "value":{
         "type":"PLATFORM_SEGMENT",
         "value":{
            "id":"4c41c318-9e8c-4a4f-b880-877cdd629fc7",
            "name":"Batch export for autumn campaign",
            "filenameTemplate":"%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%_custom-text",
            "exportMode":"FIRST_FULL_THEN_INCREMENTAL",
            "schedule":{
               "frequency":"EVERY_12_HOURS",
               "startDate":"2022-01-05",
               "endDate":"2022-01-30",
               "startTime":"20:00"
            },
            "createTime":"1640289901",
            "updateTime":"1640289901"
         }
      }
   }
]'

有关有效负载中属性的描述,请参阅部分 将受众添加到数据流.

响应

成功的响应将返回您的流ID和更新的电子标记。 您可以通过向以下网站发出GET请求来验证更新: Flow Service API,同时提供您的流ID。

{
    "id": "2edc08ac-4df5-4fe6-936f-81a19ce92f5c",
    "etag": "\"50014cc8-0000-0200-0000-6036eb720000\""
}

有关可在数据流中更新的受众组件的更多示例,请参阅以下示例。

在受众评估后将受众的导出模式从计划的更新为的 update-export-mode

单击以查看示例,其中受众导出从每天在指定时间激活更新为每天在Platform批量分段作业完成后激活。

每天的16:00 UTC导出受众。

code language-json
{
  "type": "PLATFORM_SEGMENT",
  "value": {
    "id": "b1e50e8e-a6e2-420d-99e8-a80deda2082f",
    "name": "12JAN22-AEP-NA-NTC-90D-MW",
    "filenameTemplate": "%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%",
    "exportMode": "DAILY_FULL_EXPORT"
    "schedule": {
      "frequency": "DAILY",
      "triggerType": "SCHEDULED",
      "startDate": "2022-01-13",
      "endDate": "2023-01-13",
      "startTime":"16:00"
    },
    "createTime": "1642041770",
    "updateTime": "1642615573"
  }
}

每日批量分段作业完成后,每天都会导出受众。

code language-json
{
  "type": "PLATFORM_SEGMENT",
  "value": {
    "id": "b1e50e8e-a6e2-420d-99e8-a80deda2082f",
    "name": "12JAN22-AEP-NA-NTC-90D-MW",
    "filenameTemplate": "%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%",
    "exportMode": "DAILY_FULL_EXPORT"
    "schedule": {
      "frequency": "DAILY",
      "triggerType": "AFTER_SEGMENT_EVAL",
      "startDate": "2022-01-13",
      "endDate": "2023-01-13"
    },
    "createTime": "1642041770",
    "updateTime": "1642615573"
  }
}

更新文件名模板以在文件名中包含其他字段 update-filename-template

单击以查看文件名模板的更新示例,该模板在文件名中包含其他字段

导出的文件包含目标名称和Experience Platform受众ID

code language-json
{
  "type": "PLATFORM_SEGMENT",
  "value": {
    "id": "b1e50e8e-a6e2-420d-99e8-a80deda2082f",
    "name": "12JAN22-AEP-NA-NTC-90D-MW",
    "filenameTemplate": "%DESTINATION_NAME%_%SEGMENT_ID%",
    "exportMode": "DAILY_FULL_EXPORT"
    "schedule": {
      "frequency": "DAILY",
      "triggerType": "SCHEDULED",
      "startDate": "2022-01-13",
      "endDate": "2023-01-13",
      "startTime":"16:00"
    },
    "createTime": "1642041770",
    "updateTime": "1642615573"
  }
}

导出的文件包含目标名称、Experience Platform受众ID、Experience Platform生成文件的日期和时间,以及在文件末尾附加的自定义文本。

code language-json
{
  "type": "PLATFORM_SEGMENT",
  "value": {
    "id": "b1e50e8e-a6e2-420d-99e8-a80deda2082f",
    "name": "12JAN22-AEP-NA-NTC-90D-MW",
    "filenameTemplate": "%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%_%this is custom text%",
    "exportMode": "DAILY_FULL_EXPORT"
    "schedule": {
      "frequency": "DAILY",
      "triggerType": "SCHEDULED",
      "startDate": "2022-01-13",
      "endDate": "2023-01-13",
      "startTime":"16:00"
    },
    "createTime": "1642041770",
    "updateTime": "1642615573"
  }
}

向数据流添加配置文件属性 add-profile-attribute

要将配置文件属性添加到目标数据流,请向以下对象执行PATCH请求: Flow Service 流ID、版本以及要添加的用户档案属性时使用的API。

API格式

PATCH /flows/{FLOW_ID}

请求

以下请求将新的配置文件属性添加到现有目标数据流。

curl -X PATCH \
    'https://platform.adobe.io/data/foundation/flowservice/flows/226fb2e1-db69-4760-b67e-9e671e05abfc' \
    -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}'
    -H 'If-Match: "1a0037e4-0000-0200-0000-602e06f60000"' \
    -d '[
    {
    "op":"add",
    "path":"/transformations/0/params/profileSelectors/selectors/-",
    "value":{
        "type":"JSON_PATH",
        "value":{
            "path":"mobilePhone.status"
        }
    }
    }
]'
属性
描述
op
操作调用,用于定义更新数据流所需的操作。 操作包括: addreplace、和 remove. 要将配置文件属性添加到数据流,请使用 add 操作。
path
定义要更新的流部分。 将配置文件属性添加到数据流时,请使用示例中指定的路径。
value.path
要添加到数据流的配置文件属性的值。

响应

成功的响应将返回您的流ID和更新的电子标记。 您可以通过向以下网站发出GET请求来验证更新: Flow Service API,同时提供您的流ID。

{
    "id": "2edc08ac-4df5-4fe6-936f-81a19ce92f5c",
    "etag": "\"50014cc8-0000-0200-0000-6036eb720000\""
}

从数据流中删除配置文件属性 remove-profile-attribute

PATCH要从现有目标数据流中删除配置文件属性,请向 Flow Service API,同时提供您的流ID、版本以及要删除的配置文件属性的索引选择器。 索引始于 0. 例如,下面的示例请求从数据流中删除第五个配置文件属性。

API格式

PATCH /flows/{FLOW_ID}

请求

以下请求从现有目标数据流中删除配置文件属性。

curl -X PATCH \
    'https://platform.adobe.io/data/foundation/flowservice/flows/226fb2e1-db69-4760-b67e-9e671e05abfc' \
    -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}'
    -H 'If-Match: "1a0037e4-0000-0200-0000-602e06f60000"' \
    -d '[
    {
    "op":"remove",
    "path":"/transformations/0/params/profileSelectors/selectors/4",
    "value":{
        "type":"JSON_PATH",
        "value":{
            "path":"mobilePhone.status"
        }
    }
    }
]'
属性
描述
op
操作调用,用于定义更新数据流所需的操作。 操作包括: addreplace、和 remove. 要从数据流中删除受众,请使用 remove 操作。
path
根据受众选择器的索引,指定应从目标数据流中删除的现有配置文件属性。 GET要检索数据流中用户档案属性的顺序,请对 /flows 端点并检查 transformations.profileSelectors 属性。 要删除数据流中的第一个受众,请使用 "path":"transformations/0/params/segmentSelectors/selectors/0/".

响应

成功的响应将返回您的流ID和更新的电子标记。 您可以通过向以下网站发出GET请求来验证更新: Flow Service API,同时提供您的流ID。

{
    "id": "2edc08ac-4df5-4fe6-936f-81a19ce92f5c",
    "etag": "\"50014cc8-0000-0200-0000-6036eb720000\""
}

API错误处理 api-error-handling

本教程中的API端点遵循常规Experience PlatformAPI错误消息原则。 请参阅 API状态代码请求标头错误 有关解释错误响应的更多信息,请参阅平台故障排除指南。

后续步骤 next-steps

通过学习本教程,您已了解如何更新目标数据流的各种组件,例如,使用添加或删除受众或配置文件属性 Flow Service API。 欲知目标的更多信息,请参见 目标概述.

recommendation-more-help
7f4d1967-bf93-4dba-9789-bb6b505339d6