使用Destination SDK配置流目标
概述 overview
本页介绍如何使用目标SDK🔗中的配置选项以及其他Destination SDK功能和API参考文档中的信息配置流目标。 步骤按以下顺序排列。
先决条件 prerequisites
在继续执行以下步骤之前，请阅读Destination SDK快速入门页面，了解有关获取使用Destination SDKAPI所必需的Adobe I/O身份验证凭据和其他先决条件的信息。 这假定您已完成伙伴关系和权限先决条件，并已准备好开始开发目标。
在Destination SDK中使用配置选项设置目标的步骤 steps
步骤1：创建服务器和模板配置 create-server-template-configuration
首先使用/destinations-server端点创建服务器和模板配置。
下面显示了一个配置示例。 请注意，在步骤3 创建转换模板中处理了requestBody.value参数中的消息转换模板。
POST platform.adobe.io/data/core/activation/authoring/destination-servers
{
"name":"Moviestar destination server",
"destinationServerType":"URL_BASED",
"urlBasedDestination":{
"url":{
"templatingStrategy":"PEBBLE_V1",
"value":"https://api.moviestar.com/data/{{customerData.region}}/items"
}
},
"httpTemplate":{
"httpMethod":"POST",
"requestBody":{
"templatingStrategy":"PEBBLE_V1",
"value":"insert after you create a template in step 3"
},
"contentType":"application/json"
}
}
步骤2：创建目标配置 create-destination-configuration
下面显示的是目标模板的示例配置，使用/destinations API端点创建。 有关详细信息，请参阅创建目标配置。
若要将步骤1中的服务器和模板配置连接到此目标配置，请在此处添加服务器和模板配置的实例ID作为destinationServerId。
identityNamespaces中添加至少一个目标身份，如下所示。 如果未配置目标标识，则用户将无法继续完成激活工作流的映射步骤。POST platform.adobe.io/data/core/activation/authoring/destinations
{
"name":"Moviestar",
"description":"Moviestar is a fictional destination, used for this example.",
"status":"TEST",
"customerAuthenticationConfigurations":[
{
"authType":"BEARER"
}
],
"customerDataFields":[
{
"name":"endpointsInstance",
"type":"string",
"title":"Select Endpoint",
"description":"Moviestar manages several instances across the globe for REST endpoints that our customers are provisioned for. Select your endpoint in the dropdown list.",
"isRequired":true,
"enum":[
"US",
"EU",
"APAC",
"NZ"
]
},
{
"name":"customerID",
"type":"string",
"title":"Moviestar Customer ID",
"description":"Your customer ID in the Moviestar destination (e.g. abcdef).",
"isRequired":true,
"pattern":""
}
],
"uiAttributes":{
"documentationLink":"http://www.adobe.com/go/destinations-moviestar-en",
"category":"mobile",
"connectionType":"Server-to-server",
"frequency":"Streaming"
},
"identityNamespaces":{
"external_id":{
"acceptsAttributes":true,
"acceptsCustomNamespaces":true
},
"another_id":{
"acceptsAttributes":true,
"acceptsCustomNamespaces":true
}
},
"audienceMetadataConfig":{
"mapExperiencePlatformSegmentName":false,
"mapExperiencePlatformSegmentId":false,
"mapUserInput":false,
"audienceTemplateId":"cbf90a70-96b4-437b-86be-522fbdaabe9c"
},
"aggregation":{
"aggregationType":"CONFIGURABLE_AGGREGATION",
"configurableAggregation":{
"aggregationPolicyId":null,
"aggregationKey":{
"includeSegmentId":true,
"includeSegmentStatus":true,
"includeIdentity":true,
"oneIdentityPerGroup":true,
"groups":null
},
"splitUserById":true,
"maxBatchAgeInSecs":2400,
"maxNumEventsInBatch":5000
}
},
"destinationDelivery":[
{
"authenticationRule":"CUSTOMER_AUTHENTICATION",
"destinationServerId":"9c77000a-4559-40ae-9119-a04324a3ecd4"
}
]
}
步骤3：创建消息转换模板 — 使用模板化语言指定消息输出格式 create-transformation-template
根据目标支持的负载，必须创建一个模板，将导出数据的格式从AdobeXDM格式转换为目标支持的格式。 请参阅使用模板语言进行标识、属性和受众成员资格转换部分中的模板示例，并使用由Adobe提供的模板创作工具。
创建适合您的消息转换模板后，将其添加到您在步骤1中创建的服务器和模板配置中。
{
"name":"Moviestar destination server",
"destinationServerType":"URL_BASED",
"urlBasedDestination":{
"url":{
"templatingStrategy":"PEBBLE_V1",
"value":"https://api.moviestar.com/data/{{customerData.region}}/items"
}
},
"httpTemplate":{
"requestBody":{
"templatingStrategy":"PEBBLE_V1",
"value":"{\n \"users\": [\n {% for profile in input.profiles %}\n {{profile|raw}}{% if not loop.last %},{% endif %}\n {% endfor %}\n ]\n}"
},
"contentType":"application/json"
}
}
步骤4：创建受众元数据配置 create-audience-metadata-configuration
对于某些目标，Destination SDK需要您将受众元数据配置配置为以编程方式创建、更新或删除目标中的受众。 有关何时需要设置此配置以及如何设置的信息，请参阅受众元数据管理。
如果使用受众元数据配置，则必须将其连接到在步骤2中创建的目标配置。 将受众元数据配置的实例ID作为audienceTemplateId添加到目标配置中。
{
"name":"Moviestar",
"description":"Moviestar is a fictional destination, used for this example.",
"status":"TEST",
"customerAuthenticationConfigurations":[
{
"authType":"BEARER"
}
],
"customerDataFields":[
{
"name":"endpointsInstance",
"type":"string",
"title":"Select Endpoint",
"description":"Moviestar manages several instances across the globe for REST endpoints that our customers are provisioned for. Select your endpoint in the dropdown list.",
"isRequired":true,
"enum":[
"US",
"EU",
"APAC",
"NZ"
]
},
{
"name":"customerID",
"type":"string",
"title":"Moviestar Customer ID",
"description":"Your customer ID in the Moviestar destination (e.g. abcdef).",
"isRequired":true,
"pattern":""
}
],
"uiAttributes":{
"documentationLink":"http://www.adobe.com/go/destinations-moviestar-en",
"category":"mobile",
"connectionType":"Server-to-server",
"frequency":"Streaming"
},
"identityNamespaces":{
"external_id":{
"acceptsAttributes":true,
"acceptsCustomNamespaces":true
},
"another_id":{
"acceptsAttributes":true,
"acceptsCustomNamespaces":true
}
},
"audienceMetadataConfig":{
"mapExperiencePlatformSegmentName":false,
"mapExperiencePlatformSegmentId":false,
"mapUserInput":false,
"audienceTemplateId":"cbf90a70-96b4-437b-86be-522fbdaabe9c"
},
"aggregation":{
"aggregationType":"CONFIGURABLE_AGGREGATION",
"configurableAggregation":{
"aggregationPolicyId":null,
"aggregationKey":{
"includeSegmentId":true,
"includeSegmentStatus":true,
"includeIdentity":true,
"oneIdentityPerGroup":true,
"groups":null
},
"splitUserById":true,
"maxBatchAgeInSecs":2400,
"maxNumEventsInBatch":5000
}
},
"destinationDelivery":[
{
"authenticationRule":"CUSTOMER_AUTHENTICATION",
"destinationServerId":"9c77000a-4559-40ae-9119-a04324a3ecd4"
}
]
}
步骤5：设置身份验证 set-up-authentication
根据您在上面的目标配置中指定"authenticationRule": "CUSTOMER_AUTHENTICATION"还是"authenticationRule": "PLATFORM_AUTHENTICATION"，可以使用/destination或/credentials端点为目标设置身份验证。
CUSTOMER_AUTHENTICATION是两个身份验证规则中比较常见的一个，如果您要求用户在设置连接和导出数据之前向您的目标提供某种形式的身份验证，则应该使用。如果您在目标配置中选择了"authenticationRule": "CUSTOMER_AUTHENTICATION"，并且目标支持OAuth 2身份验证方法，请阅读OAuth 2身份验证。
如果您选择了"authenticationRule": "PLATFORM_AUTHENTICATION"，则必须创建凭据配置。
步骤6：测试您的目标 test-destination
使用前面步骤中的配置端点设置目标后，您可以使用目标测试工具来测试Adobe Experience Platform与您的目标之间的集成。
在测试目标的过程中，您必须使用Experience PlatformUI创建区段，并将区段激活到目标。 有关如何在Experience Platform中创建受众的说明，请参阅以下两个资源：
步骤7：Publish您的目标 publish-destination
配置和测试目标后，使用目标发布API将配置提交给Adobe进行审核。
步骤8：记录您的目标 document-destination
如果您是创建产品化集成的独立软件供应商(ISV)或系统集成商(SI)，请使用自助文档流程在Experience Platform目标目录中为您的目标创建产品文档页面。
步骤9：提交目标以供Adobe审核 submit-for-review
最后，在Experience Platform目录中发布目标并对所有Experience Platform客户可见之前，您需要正式提交目标以供Adobe审查。 查找有关如何提交以供审阅在Destination SDK中创作的产品化目标的完整信息。