更新受众模板

IMPORTANT
API端点platform.adobe.io/data/core/activation/authoring/audience-templates

此页面展示了可用于更新受众模板的API请求和有效负荷,使用 /authoring/audience-templates API端点。

有关可通过此端点配置的功能的详细说明,请参阅 受众元数据管理.

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

受众模板API操作快速入门 get-started

在继续之前,请查看 快速入门指南 获取成功调用API所需了解的重要信息,包括如何获取所需的目标创作权限和所需的标头。

更新受众模板 create

您可以更新 现有 创建受众模板 PUT 请求 /authoring/audience-templates 具有更新的有效负载的端点。

获取现有的受众模板及其对应的受众模板 {INSTANCE_ID},请参阅关于以下内容的文章: 检索受众模板.

API格式

PUT /authoring/audience-templates/{INSTANCE_ID}
参数
描述
{INSTANCE_ID}
要更新的受众模板的ID。 获取现有的受众模板及其对应的受众模板 {INSTANCE_ID},请参见 检索受众模板.

以下请求更新现有的受众元数据模板,该模板由有效负载中提供的参数配置。

请求
code language-shell
curl -X PUT https://platform.adobe.io/data/core/activation/authoring/audience-templates/{INSTANCE_ID} \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '
{
   "metadataTemplate":{
      "create":{
         "url":"https://api.moviestar.com/v1.0/{{customerData.accountId}}/customaudiences?fields=name,description,account_id&subtype=CUSTOM&name={{segment.name}}&customer_file_source={{segment.metadata.customer_file_source}}&access_token={{authData.accessToken}}",
         "httpMethod":"POST",
         "headers":[
            {
               "value":"application/x-www-form-urlencoded",
               "header":"Content-Type"
            }
         ],
         "responseFields":[
            {
               "value":"{{response.id}}",
               "name":"externalAudienceId"
            }
         ],
         "responseErrorFields":[
            {
               "value":"{{error.message}}",
               "name":"message"
            }
         ]
      },
      "update":{
         "url":"https://api.moviestar.com/v1.0/{{segment.alias}}?field=name,description,account_id&access_token={{authData.accessToken}}&customerAudienceId={{segment.alias}}&&name={{segment.name}}&description={{segment.description}}&customer_file_source={{segment.metadata.customer_file_source}}",
         "httpMethod":"POST",
         "headers":[
            {
               "value":"application/x-www-form-urlencoded",
               "header":"Content-Type"
            }
         ],
         "responseFields":[
            {
               "value":"{{response.id}}",
               "name":"externalAudienceId"
            }
         ],
         "responseErrorFields":[
            {
               "value":"{{error.message}}",
               "name":"message"
            }
         ]
      },
      "delete":{
         "url":"https://api.moviestar.com/v1.0/{{segment.alias}}?fields=name,description,account_id&access_token={{authData.accessToken}}&customerAudienceId={{segment.alias}}",
         "httpMethod":"DELETE",
         "headers":[
            {
               "value":"application/x-www-form-urlencoded",
               "header":"Content-Type"
            }
         ],
         "responseErrorFields":[
            {
               "value":"{{error.message}}",
               "name":"message"
            }
         ]
      },
      "validate":{
         "url":"https://api.moviestar.com/v1.0/permissions?access_token={{authData.accessToken}}",
         "httpMethod":"GET",
         "headers":[
            {
               "value":"application/x-www-form-urlencoded",
               "header":"Content-Type"
            }
         ],
         "responseFields":[
            {
               "value":"{{response.data[0].permission}}",
               "name":"Id"
            }
         ],
         "responseErrorFields":[
            {
               "value":"{{error.message}}",
               "name":"message"
            }
         ]
      }
   }
}'
响应
成功的响应返回HTTP状态200以及已更新受众模板的详细信息。

API错误处理

Destination SDKAPI端点遵循常规Experience PlatformAPI错误消息原则。 请参阅 API状态代码请求标头错误 ,位于平台疑难解答指南中。

后续步骤

阅读本文档后,您现在知道何时使用受众模板以及如何使用更新受众模板 /authoring/audience-templates API端点。 读取 如何使用Destination SDK配置目标 以了解此步骤在配置目标的过程中所处的位置。

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