文档Experience Platform目标指南

创建受众模板

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • 主题：

创建对象：

  • undefined
  • undefined
IMPORTANT
API终结点： platform.adobe.io/data/core/activation/authoring/audience-templates

对于使用Destination SDK创建的某些目标，您需要创建受众元数据配置，以便以编程方式在目标中创建、更新或删除受众元数据。 此页面显示如何使用/authoring/audience-templates API端点创建配置。

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

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

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

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

创建受众模板 create

您可以通过向/authoring/audience-templates端点发出POST请求来创建新的受众模板。

API格式

POST /authoring/audience-templates
请求

以下请求创建新的受众模板，该模板由有效负载中提供的参数配置。 以下有效负载包含/authoring/audience-templates终结点接受的所有参数。 请注意，您无需在调用中添加所有参数，并且可根据您的API要求自定义模板。

code language-shell 
curl -X POST https://platform.adobe.io/data/core/activation/authoring/audience-templates \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '
{
   "metadataTemplate":{
      "name":"string",
      "create":{
         "url":"string",
         "httpMethod":"string",
         "headers":[
            {
               "header":"string",
               "value":"string"
            }
         ],
         "requestBody":{

         },
         "responseFields":[
            {
               "name":"string",
               "value":"string"
            }
         ],
         "responseErrorFields":[
            {
               "name":"string",
               "value":"string"
            }
         ]
      },
      "update":{
         "url":"string",
         "httpMethod":"string",
         "headers":[
            {
               "header":"string",
               "value":"string"
            }
         ],
         "requestBody":{

         },
         "responseFields":[
            {
               "name":"string",
               "value":"string"
            }
         ],
         "responseErrorFields":[
            {
               "name":"string",
               "value":"string"
            }
         ]
      },
      "delete":{
         "url":"string",
         "httpMethod":"string",
         "headers":[
            {
               "header":"string",
               "value":"string"
            }
         ],
         "requestBody":{

         },
         "responseFields":[
            {
               "name":"string",
               "value":"string"
            }
         ],
         "responseErrorFields":[
            {
               "name":"string",
               "value":"string"
            }
         ]
      },
      "validate":{
         "url":"string",
         "httpMethod":"string",
         "headers":[
            {
               "header":"string",
               "value":"string"
            }
         ],
         "requestBody":{

         },
         "responseFields":[
            {
               "name":"string",
               "value":"string"
            }
         ],
         "responseErrorFields":[
            {
               "name":"string",
               "value":"string"
            }
         ]
      },
      "notify":{
         "url":"string",
         "httpMethod":"string",
         "headers":[
            {
               "header":"string",
               "value":"string"
            }
         ],
         "requestBody":{

         },
         "responseFields":[
            {
               "name":"string",
               "value":"string"
            }
         ],
         "responseErrorFields":[
            {
               "name":"string",
               "value":"string"
            }
         ]
      }
   },
   "validations":[
      {
         "field":"string",
         "regex":"string"
      }
   ]
}'
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 layout-auto
属性 类型 描述
name 字符串 目标的受众元数据模板的名称。 此名称将出现在Experience Platform用户界面中任何特定于合作伙伴的错误消息中，随后是从metadataTemplate.create.errorSchemaMap解析的错误消息。
url 字符串 API的URL和端点，用于在您的平台上创建、更新、删除或验证受众。 两个行业示例为：https://adsapi.snapchat.com/v1/adaccounts/{{customerData.accountId}}/segments和https://api.linkedin.com/v2/dmpSegments/{{segment.alias}}。
httpMethod 字符串 在您的端点上使用的方法，用于以编程方式创建、更新、删除或验证目标中的受众。 例如： POST，PUT，DELETE
headers.header 字符串 指定应添加到API调用的任何HTTP标头。 例如："Content-Type"
headers.value 字符串 指定应添加到API调用中的HTTP标头值。 例如："application/x-www-form-urlencoded"
requestBody 字符串 指定应发送到API的消息正文的内容。 应添加到requestBody对象的参数取决于API接受的字段。 有关示例，请参阅受众元数据功能文档中的第一个模板示例。
responseFields.name 字符串 指定API在调用时返回的任何响应字段。 有关示例，请参阅受众元数据功能文档中的模板示例。
responseFields.value 字符串 指定API在调用时返回的任何响应字段的值。
responseErrorFields.name 字符串 指定API在调用时返回的任何响应字段。 有关示例，请参阅受众元数据功能文档中的模板示例。
responseErrorFields.value 字符串 解析从目标返回API调用响应时返回的任何错误消息。 这些错误消息将在Experience Platform用户界面中向用户显示。
validations.field 字符串 指示在对目标进行API调用之前是否应对任何字段运行验证。 例如，您可以使用{{validations.accountId}}来验证用户的帐户ID。
validations.regex 字符串 指示字段的结构应如何才能通过验证。
响应
成功的响应返回HTTP状态200以及新创建的受众模板的详细信息。

API错误处理

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

后续步骤

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

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