创建目标配置
本页举例说明了可用于创建自己的目标配置的API请求和有效负载,使用 /authoring/destinations
API端点。
有关可通过此端点配置的功能的详细说明,请参阅以下文章:
IMPORTANT
Destination SDK支持的所有参数名称和值包括 区分大小写. 为避免出现区分大小写错误,请完全按照文档中的说明使用参数名称和值。
目标配置API操作快速入门 get-started
在继续之前,请查看 快速入门指南 获取成功调用API所需了解的重要信息,包括如何获取所需的目标创作权限和所需的标头。
创建目标配置 create
您可以通过向以下对象发出POST请求来创建新的目标配置: /authoring/destinations
端点。
TIP
API端点:
platform.adobe.io/data/core/activation/authoring/destinations
API格式
POST /authoring/destinations
以下请求创建一个新的 Amazon S3 目标配置,由有效负载中提供的参数配置。 以下有效负载包含由接受的基于文件的目标的所有参数 /authoring/destinations
端点。
请注意,您不必将所有参数添加到API调用,并且负载可以根据您的API要求进行自定义。
请求
code language-shell |
---|
|
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 7-row-3 8-row-3 9-row-3 10-row-3 11-row-3 12-row-3 13-row-3 14-row-3 15-row-3 16-row-3 17-row-3 18-row-3 19-row-3 20-row-3 21-row-3 22-row-3 23-row-3 24-row-3 25-row-3 26-row-3 27-row-3 28-row-3 29-row-3 30-row-3 31-row-3 layout-auto | ||
---|---|---|
参数 | 类型 | 描述 |
name |
字符串 | 指示Experience Platform目录中目标的标题。 |
description |
字符串 | 提供Adobe将在目标卡的Experience Platform目标目录中使用的描述。 目标不超过4到5句。 {width="100" modal="regular"} |
status |
字符串 | 指示目标卡的生命周期状态。 接受的值包括 TEST , PUBLISHED 、和 DELETED . 使用 TEST 当您首次配置目标时。 |
customerAuthenticationConfigurations.authType |
字符串 | 指示用于向目标服务器验证Experience Platform客户的配置。 请参阅 客户身份验证配置 以了解有关支持的身份验证类型的详细信息。 |
customerDataFields.name |
字符串 | 为您即将介绍的自定义字段提供一个名称。 请参阅 客户数据字段 以了解有关这些设置的详细信息。 {width="100" modal="regular"} |
customerDataFields.type |
字符串 | 指示您即将引入的自定义字段的类型。 接受的值包括 string , object , integer .请参阅 客户数据字段 以了解有关这些设置的详细信息。 |
customerDataFields.title |
字符串 | 指示字段的名称,如客户在Experience Platform用户界面中所看到的。 请参阅 客户数据字段 以了解有关这些设置的详细信息。 |
customerDataFields.description |
字符串 | 提供自定义字段的描述。 请参阅 客户数据字段 以了解有关这些设置的详细信息。 |
customerDataFields.isRequired |
布尔值 | 指示目标设置工作流中是否需要此字段。 请参阅 客户数据字段 以了解有关这些设置的详细信息。 |
customerDataFields.enum |
字符串 | 将自定义字段呈现为下拉菜单,并列出用户可用的选项。 请参阅 客户数据字段 以了解有关这些设置的详细信息。 |
customerDataFields.default |
字符串 | 从定义默认值 enum 列表。 |
customerDataFields.pattern |
字符串 | 如果需要,为自定义字段实施模式。 使用正则表达式可强制实施模式。 例如,如果您的客户ID不包含数字或下划线,请输入 ^[A-Za-z]+$ 在此字段中。请参阅 客户数据字段 以了解有关这些设置的详细信息。 |
uiAttributes.documentationLink |
字符串 | 请参阅 目标目录 到你的目的地去。 使用 https://www.adobe.com/go/destinations-YOURDESTINATION-en ,其中 YOURDESTINATION 是目标的名称。 对于名为Moviestar的目标,您可以使用 https://www.adobe.com/go/destinations-moviestar-en . 请注意,只有在Adobe将您的目标设置为实时状态并发布文档后,此链接才有效。请参阅 UI属性 以了解有关这些设置的详细信息。 {width="100" modal="regular"} |
uiAttributes.category |
字符串 | 是指在Adobe Experience Platform中分配给目标的类别。 有关详细信息,请阅读 目标类别. 使用以下值之一: adobeSolutions, advertising, analytics, cdp, cloudStorage, crm, customerSuccess, database, dmp, ecommerce, email, emailMarketing, enrichment, livechat, marketingAutomation, mobile, personalization, protocols, social, streaming, subscriptions, surveys, tagManagers, voc, warehouses, payments .请参阅 UI属性 以了解有关这些设置的详细信息。 |
uiAttributes.connectionType |
字符串 |
连接的类型,具体取决于目标。 支持的值:
|
uiAttributes.frequency |
字符串 | 是指目标支持的数据导出类型。 设置为 Streaming 对于基于API的集成,或者 Batch 将文件导出到目标时。 |
identityNamespaces.externalId.acceptsAttributes |
布尔值 | 指示客户是否可以将标准配置文件属性映射到您配置的身份。 |
identityNamespaces.externalId.acceptsCustomNamespaces |
布尔值 | 指示客户是否可以映射属于的身份 自定义命名空间 到您正在配置的身份。 |
identityNamespaces.externalId.transformation |
字符串 | 未在示例配置中显示. 例如,用于 Platform 客户将纯电子邮件地址作为属性,并且您的平台仅接受经过哈希处理的电子邮件。 在这里,您可以提供需要应用的转换(例如,将电子邮件转换为小写,然后进行哈希处理)。 |
identityNamespaces.externalId.acceptedGlobalNamespaces |
- | 指示哪些 标准身份命名空间 (例如,IDFA)客户可以映射到您正在配置的身份。 当您使用 acceptedGlobalNamespaces ,您可以使用 "requiredTransformation":"sha256(lower($))" 更改为小写和散列电子邮件地址或电话号码。 |
destinationDelivery.authenticationRule |
字符串 |
指示方式 Platform 客户连接到您的目标。 接受的值包括
|
destinationDelivery.destinationServerId |
字符串 | 此 instanceId 的 目标服务器模板 用于此目标。 |
backfillHistoricalProfileData |
布尔值 | 控制将受众激活到目标时是否导出历史配置文件数据。 始终将此项设置为 true . |
segmentMappingConfig.mapUserInput |
布尔值 | 控制用户是否输入目标激活工作流中的受众映射ID。 |
segmentMappingConfig.mapExperiencePlatformSegmentId |
布尔值 | 控制目标激活工作流中的受众映射ID是否为Experience Platform受众ID。 |
segmentMappingConfig.mapExperiencePlatformSegmentName |
布尔值 | 控制目标激活工作流中的受众映射ID是否为Experience Platform受众名称。 |
segmentMappingConfig.audienceTemplateId |
布尔值 | 此 instanceId 的 受众元数据模板 用于此目标。 |
schemaConfig.profileFields |
数组 | 添加预定义时 profileFields 如上面的配置所示,用户可以选择将Experience Platform属性映射到目标端的预定义属性。 |
schemaConfig.profileRequired |
布尔值 | 使用 true 如果用户应能够将配置文件属性从Experience Platform映射到目标端的自定义属性,如上面的示例配置所示。 |
schemaConfig.segmentRequired |
布尔值 | 始终使用 segmentRequired:true . |
schemaConfig.identityRequired |
布尔值 | 使用 true 如果用户应该能够将身份命名空间从Experience Platform映射到所需的架构。 |
响应
成功的响应会返回HTTP状态200以及新创建的目标配置的详细信息。
API错误处理
Destination SDKAPI端点遵循常规Experience PlatformAPI错误消息原则。 请参阅 API状态代码 和 请求标头错误 ,位于平台疑难解答指南中。
后续步骤
阅读本文档后,您现在知道如何通过Destination SDK创建新的目标配置 /authoring/destinations
API端点。
要了解有关可使用此端点执行的操作的更多信息,请参阅以下文章:
要了解此端点在目标创作过程中的位置,请参阅以下文章:
recommendation-more-help
7f4d1967-bf93-4dba-9789-bb6b505339d6