批次配置 batch-configuration

使用Destination SDK中的批处理配置选项,允许用户自定义导出的文件名,并根据自己的偏好配置导出计划。

通过Destination SDK创建基于文件的目标时,可以配置默认的文件命名和导出计划,也可以为用户提供从Platform UI配置这些设置的选项。 例如,您可以配置行为,例如:

  • 在文件名中包括特定信息,例如受众ID、目标ID或自定义信息。
  • 允许用户从Platform UI自定义文件命名。
  • 将文件导出配置为在设定的时间间隔内进行。
  • 定义用户可以在Platform UI中看到的文件命名和导出计划自定义选项。

批量配置设置是基于文件的目标的目标配置的一部分。

要了解此组件在何处适合使用Destination SDK创建的集成,请参阅中的图表 配置选项 文档或参阅指南,了解如何 使用Destination SDK配置基于文件的目标.

您可以通过以下方式配置文件命名和导出计划设置 /authoring/destinations 端点。 有关详细的API调用示例,请参阅以下API参考页面,您可以在其中配置此页面中显示的组件。

本文介绍了可用于目标的所有受支持的批处理配置选项,并显示了客户将在Platform UI中看到的内容。

IMPORTANT
Destination SDK支持的所有参数名称和值包括 区分大小写. 为避免出现区分大小写错误,请完全按照文档中的说明使用参数名称和值。

支持的集成类型 supported-integration-types

有关哪些类型的集成支持此页面上描述的功能,请参阅下表。

集成类型
支持功能
实时(流)集成
基于文件(批处理)的集成

支持的参数 supported-parameters

您在此处设置的值显示在 计划受众导出 基于文件的目标激活工作流的步骤。

"batchConfig":{
   "allowMandatoryFieldSelection":true,
   "allowDedupeKeyFieldSelection":true,
   "defaultExportMode":"DAILY_FULL_EXPORT",
   "allowedExportMode":[
      "DAILY_FULL_EXPORT",
      "FIRST_FULL_THEN_INCREMENTAL"
   ],
   "allowedScheduleFrequency":[
      "DAILY",
      "EVERY_3_HOURS",
      "EVERY_6_HOURS",
      "EVERY_8_HOURS",
      "EVERY_12_HOURS",
      "ONCE"
   ],
   "defaultFrequency":"DAILY",
   "defaultStartTime":"00:00",
   "filenameConfig":{
         "allowedFilenameAppendOptions":[
            "SEGMENT_NAME",
            "DESTINATION_INSTANCE_ID",
            "DESTINATION_INSTANCE_NAME",
            "ORGANIZATION_NAME",
            "SANDBOX_NAME",
            "DATETIME",
            "CUSTOM_TEXT"
         ],
         "defaultFilenameAppendOptions":[
            "DATETIME"
         ],
         "defaultFilename":"%DESTINATION%_%SEGMENT_ID%"
      },
   "segmentGroupingEnabled": true
   }
参数
类型
描述
allowMandatoryFieldSelection
布尔值
设置为 true 允许客户指定哪些配置文件属性是必需的。 默认值为 false。请参阅 必需属性 以了解更多信息。
allowDedupeKeyFieldSelection
布尔值
设置为 true 允许客户指定重复数据删除键。 默认值为 false。请参阅 重复数据删除键 以了解更多信息。
defaultExportMode
枚举

定义默认文件导出模式。 支持的值:

  • DAILY_FULL_EXPORT
  • FIRST_FULL_THEN_INCREMENTAL

默认值为 DAILY_FULL_EXPORT。请参阅 批量激活文档 以了解有关文件导出计划的详细信息。

allowedExportModes
列表

定义客户可用的文件导出模式。 支持的值:

  • DAILY_FULL_EXPORT
  • FIRST_FULL_THEN_INCREMENTAL
allowedScheduleFrequency
列表

定义客户可用的文件导出频率。 支持的值:

  • ONCE
  • EVERY_3_HOURS
  • EVERY_6_HOURS
  • EVERY_8_HOURS
  • EVERY_12_HOURS
  • DAILY
defaultFrequency
枚举

定义默认文件导出频率。支持的值:

  • ONCE
  • EVERY_3_HOURS
  • EVERY_6_HOURS
  • EVERY_8_HOURS
  • EVERY_12_HOURS
  • DAILY

默认值为 DAILY

defaultStartTime
字符串
定义文件导出的默认开始时间。 使用24小时文件格式。 默认值为“00:00”。
filenameConfig.allowedFilenameAppendOptions
字符串

必需. 可供用户选择的可用文件名宏列表。 这会确定哪些项目已附加到导出的文件名(受众ID、组织名称、导出日期和时间等)。 设置时 defaultFilename中,请确保避免复制宏。

支持的值:

  • DESTINATION
  • SEGMENT_ID
  • SEGMENT_NAME
  • DESTINATION_INSTANCE_ID
  • DESTINATION_INSTANCE_NAME
  • ORGANIZATION_NAME
  • SANDBOX_NAME
  • DATETIME
  • CUSTOM_TEXT

无论定义宏的顺序如何,Experience PlatformUI将始终按此处显示的顺序显示它们。

如果 defaultFilename 为空,则 allowedFilenameAppendOptions 列表必须至少包含一个宏。

filenameConfig.defaultFilenameAppendOptions
字符串
必需. 预先选定的默认文件名宏,用户可以取消选中该宏。

此列表中的宏是中定义的宏的子集 allowedFilenameAppendOptions.
filenameConfig.defaultFilename
字符串
可选. 为导出的文件定义默认文件名宏。 用户无法覆盖这些内容。

由定义的任何宏 allowedFilenameAppendOptions 将附加在 defaultFilename 宏。

如果 defaultFilename 为空,则必须在中至少定义一个宏 allowedFilenameAppendOptions.
segmentGroupingEnabled
布尔值

根据受众,定义激活的受众是应导出到单个文件还是多个文件中 合并策略. 支持的值:

  • true:为每个合并策略导出一个文件。
  • false:每个受众导出一个文件,而不考虑合并策略。 这是默认行为。 完全忽略此参数也可以获得相同的结果。

文件名配置 file-name-configuration

使用文件名配置宏定义导出的文件名应包含的内容。 下表中的宏描述了在UI中找到的元素 文件名配置 屏幕。

TIP
作为最佳实践,您应始终包含 SEGMENT_ID 宏在导出的文件名中。 区段ID是唯一的,因此将它们包含在文件名中是确保文件名唯一的最佳方法。
UI标签
描述
示例
DESTINATION
目标
UI中的目标名称。
Amazon S3
SEGMENT_ID
区段ID
平台生成的唯一受众ID
ce5c5482-2813-4a80-99bc-57113f6acde2
SEGMENT_NAME
区段名称
用户定义的受众名称
VIP订阅者
DESTINATION_INSTANCE_ID
目标Id
目标实例的平台生成的唯一ID
7b891e5f-025a-4f0d-9e73-1919e71da3b0
DESTINATION_INSTANCE_NAME
目标名称
用户定义的目标实例名称。
我的2022年广告目标
ORGANIZATION_NAME
组织名称
Adobe Experience Platform中的客户组织的名称。
我的组织名称
SANDBOX_NAME
沙盒名称
客户使用的沙盒的名称。
prod
DATETIME / TIMESTAMP
日期和时间

DATETIMETIMESTAMP 这两种方法都定义生成文件的时间,但采用不同的格式。

  • DATETIME 使用以下格式:YYYYMMDD_HHMMSS。
  • TIMESTAMP 使用10位数Unix格式。

DATETIMETIMESTAMP 是互斥的,不能同时使用。

  • DATETIME: 20220509_210543
  • TIMESTAMP: 1652131584
CUSTOM_TEXT
自定文本
要包含在文件名中的用户定义的自定义文本。 不能用于 defaultFilename.
My_Custom_Text
TIMESTAMP
日期和时间
生成文件时间的10位数时间戳,采用Unix格式。
1652131584
MERGE_POLICY_ID
合并策略ID
的ID 合并策略 用于生成导出的受众。 当您根据合并策略在文件中分组导出的受众时,使用此宏。 将此宏与 segmentGroupingEnabled:true.
e8591fdb-2873-4b12-b63e-15275b1c1439
MERGE_POLICY_NAME
合并策略名称
的名称 合并策略 用于生成导出的受众。 当您根据合并策略在文件中分组导出的受众时,使用此宏。 将此宏与 segmentGroupingEnabled:true.
我的自定义合并策略

文件名配置示例

以下配置示例显示了API调用中使用的配置与UI中显示的选项之间的对应关系。

"filenameConfig":{
   "allowedFilenameAppendOptions":[
      "CUSTOM_TEXT",
      "SEGMENT_ID",
      "DATETIME"
   ],
   "defaultFilenameAppendOptions":[
      "SEGMENT_ID",
      "DATETIME"
   ],
   "defaultFilename": "%DESTINATION%"
}

显示具有预选宏的文件名配置屏幕的用户界面图像

后续步骤 next-steps

阅读本文后,您应该更好地了解如何为基于文件的目标配置文件命名和导出计划。

要了解有关其他目标组件的更多信息,请参阅以下文章:

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