通过客户数据字段配置用户输入

上次更新: 2023-11-07
  • 创建对象:
  • Admin
    User

在Experience PlatformUI中连接到目标时,您可能需要用户提供特定的配置详细信息或选择您向他们提供的特定选项。 在Destination SDK中,这些选项称为客户数据字段。

要了解此组件在何处适合使用Destination SDK创建的集成,请参阅中的图表 配置选项 文档或参阅以下目标配置概述页面:

客户数据字段的用例

在需要用户将数据输入到Experience PlatformUI中的各种用例中使用客户数据字段。 例如,当用户需要提供以下内容时,请使用客户数据字段:

  • 云存储段名称和路径,用于基于文件的目标。
  • 客户数据字段接受的格式。
  • 用户可以选择的可用文件压缩类型。
  • 实时(流)集成的可用端点列表。

您可以通过以下方式配置客户数据字段 /authoring/destinations 端点。 有关详细的API调用示例,请参阅以下API参考页面,您可以在其中配置此页面中显示的组件。

本文介绍了可用于目标的所有受支持的客户数据字段配置类型,并显示了客户将在Experience PlatformUI中看到的内容。

重要

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

支持的集成类型

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

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

支持的参数

在创建自己的客户数据字段时,您可以使用下表中描述的参数来配置其行为。

参数 类型 必填/可选 描述
name 字符串 必需 为您即将介绍的自定义字段提供一个名称。 此名称在Platform UI中不可见,除非 title 字段为空或缺失。
type 字符串 必需 指示您即将引入的自定义字段的类型。 接受的值:
  • string
  • object
  • integer
title 字符串 可选 指示字段的名称,如客户在Platform UI中所看到的。 如果此字段为空或缺失,则UI从继承字段名称 name 值。
description 字符串 可选 提供自定义字段的描述。 此描述在Platform UI中不可见。
isRequired 布尔值 可选 指示是否要求用户在目标配置工作流中提供此字段的值。
pattern 字符串 可选 如果需要,为自定义字段实施模式。 使用正则表达式可强制实施模式。 例如,如果您的客户ID不包含数字或下划线,请输入 ^[A-Za-z]+$ 在此字段中。
enum 字符串 可选 将自定义字段呈现为下拉菜单,并列出用户可用的选项。
default 字符串 可选 从定义默认值 enum 列表。
hidden 布尔值 可选 指示客户数据字段是否显示在UI中。
unique 布尔值 可选 当您需要创建客户数据字段,且该字段的值在用户组织设置的所有目标数据流中必须是唯一的,请使用此参数。 例如,自定义个性化​中的集成别名字段必须是唯一的,这意味着到该目标的两个单独的数据流不能具有相同的该字段值。
readOnly 布尔值 可选 指示客户是否可以更改字段值。

在以下示例中, customerDataFields 部分定义了用户连接到目标时必须在Platform UI中输入的两个字段:

  • Account ID:目标平台的用户帐户ID。
  • Endpoint region:它们将连接到的API的区域端点。 此 enum 部分创建一个下拉菜单,其中的值定义可供用户选择。
"customerDataFields":[
   {
      "name":"accountID",
      "title":"User account ID",
      "description":"User account ID for the destination platform.",
      "type":"string",
      "isRequired":true
   },
   {
      "name":"region",
      "title":"API endpoint region",
      "description":"The API endpoint region that the user should connect to.",
      "type":"string",
      "isRequired":true,
      "enum":[
         "EU"
         "US",
      ],
      "readOnly":false,
      "hidden":false
   }
]

生成的UI体验如下图所示。

显示客户数据字段示例的Ui图像。

目标连接名称和描述

创建新目标时,Destination SDK会自动添加 名称描述 Platform UI中指向目标连接屏幕的字段。 如上面的示例所示, 名称描述 字段在UI中渲染,而不包含在客户数据字段配置中。

重要

如果添加 名称描述 客户数据字段配置中的字段,用户将在UI中看到重复字段。

订购客户数据字段

目标配置中添加客户数据字段的顺序反映在Platform UI中。

例如,以下配置将相应地反映在UI中,并按顺序显示各个选项 名称描述存储段名称文件夹路径文件类型压缩格式.

"customerDataFields":[
{
   "name":"bucketName",
   "title":"Bucket name",
   "description":"Amazon S3 bucket name",
   "type":"string",
   "isRequired":true,
   "pattern":"(?=^.{3,63}$)(?!^(\\d+\\.)+\\d+$)(^(([a-z0-9]|[a-z0-9][a-z0-9\\-]*[a-z0-9])\\.)*([a-z0-9]|[a-z0-9][a-z0-9\\-]*[a-z0-9])$)",
   "readOnly":false,
   "hidden":false
},
{
   "name":"path",
   "title":"Folder path",
   "description":"Enter the path to your S3 bucket folder",
   "type":"string",
   "isRequired":true,
   "pattern":"^[0-9a-zA-Z\\/\\!\\-_\\.\\*\\''\\(\\)]*((\\%SEGMENT_(NAME|ID)\\%)?\\/?)+$",
   "readOnly":false,
   "hidden":false
},
{
   "name":"fileType",
   "title":"File Type",
   "description":"Select the exported file type.",
   "type":"string",
   "isRequired":true,
   "readOnly":false,
   "hidden":false,
   "enum":[
      "csv",
      "json",
      "parquet"
   ],
   "default":"csv"
},
{
   "name":"compression",
   "title":"Compression format",
   "description":"Select the desired file compression format.",
   "type":"string",
   "isRequired":true,
   "readOnly":false,
   "enum":[
      "SNAPPY",
      "GZIP",
      "DEFLATE",
      "NONE"
   ]
}
]

该图像显示了Experience PlatformUI中文件格式选项顺序。

分组客户数据字段

您可以在一个部分中对多个客户数据字段进行分组。 在UI中设置与目标之间的连接时,用户可以查看类似字段的可视化分组并从中受益。

为此,请使用 "type": "object" 创建组,并收集组中所需的客户数据字段 properties 对象,如下图所示,其中分组 CSV选项 高亮显示。

"customerDataFields":[
   {
      "name":"csvOptions",
      "title":"CSV Options",
      "description":"Select your CSV options",
      "type":"object",
      "properties":[
         {
            "name":"delimiter",
            "title":"Delimiter",
            "description":"Select your Delimiter",
            "type":"string",
            "isRequired":false,
            "default":",",
            "namedEnum":[
               {
                  "name":"Comma (,)",
                  "value":","
               },
               {
                  "name":"Tab (\\t)",
                  "value":"\t"
               }
            ],
            "readOnly":false,
            "hidden":false
         }
      ]
   }
]

该图像显示UI中分组的客户数据字段。

对于希望允许用户在多个选项之间进行选择的情况(例如,应使用哪个字符来分隔CSV文件中的字段),您可以向UI添加下拉字段。

要执行此操作,请使用 namedEnum 对象并配置 default 用户可以选择的选项的值。

"customerDataFields":[
   {
      "name":"csvOptions",
      "title":"CSV Options",
      "description":"Select your CSV options",
      "type":"object",
      "properties":[
         {
            "name":"delimiter",
            "title":"Delimiter",
            "description":"Select your Delimiter",
            "type":"string",
            "isRequired":false,
            "default":",",
            "namedEnum":[
               {
                  "name":"Comma (,)",
                  "value":","
               },
               {
                  "name":"Tab (\\t)",
                  "value":"\t"
               }
            ],
            "readOnly":false,
            "hidden":false
         }
      ]
   }
]

屏幕录制,显示使用上面显示的配置创建的下拉列表选择器示例。

为客户数据字段创建动态下拉选择器

对于要动态调用API并使用响应动态填充下拉菜单中的选项的情况,您可以使用动态下拉选择器。

动态下拉列表选择器与 常规下拉列表选择器 在UI中。 唯一的区别是这些值是从API动态检索的。

要创建动态下拉选择器,您必须配置两个组件:

步骤 1. 创建目标服务器 带有 responseFields 动态API调用的模板,如下所示。

{
   "name":"Server for dynamic dropdown",
   "destinationServerType":"URL_BASED",
   "urlBasedDestination":{
      "url":{
         "templatingStrategy":"PEBBLE_V1",
         "value":" <--YOUR-API-ENDPOINT-PATH--> "
      }
   },
   "httpTemplate":{
      "httpMethod":"GET",
      "headers":[
         {
            "header":"Authorization",
            "value":{
               "templatingStrategy":"PEBBLE_V1",
               "value":"My Bearer Token"
            }
         },
         {
            "header":"x-integration",
            "value":{
               "templatingStrategy":"PEBBLE_V1",
               "value":"{{customerData.integrationId}}"
            }
         },
         {
            "header":"Accept",
            "value":{
               "templatingStrategy":"NONE",
               "value":"application/json"
            }
         }
      ]
   },
   "responseFields":[
      {
         "templatingStrategy":"PEBBLE_V1",
         "value":"{% set list = [] %} {% for record in response.body %} {% set list = list|merge([{'name' : record.name, 'value' : record.id }]) %} {% endfor %}{{ {'list': list} | toJson | raw }}",
         "name":"list"
      }
   ]
}

步骤 2. 使用 dynamicEnum 对象,如下所示。 在以下示例中, User 下拉列表是使用动态服务器检索的。

"customerDataFields": [
  {
    "name": "integrationId",
    "title": "Integration ID",
    "type": "string",
    "isRequired": true
  },
  {
    "name": "userId",
    "title": "User",
    "type": "string",
    "isRequired": true,
    "dynamicEnum": {
      "queryParams": [
        "integrationId"
      ],
      "destinationServerId": "<~dynamic-field-server-id~>",
      "authenticationRule": "CUSTOMER_AUTHENTICATION",
      "value": "$.list",
      "responseFormat": "NAME_VALUE"
    }
  }
]

设置 destinationServerId 参数,指定您在步骤1中创建的目标服务器的ID。 您可以在的响应中看到目标服务器ID。 检索目标服务器配置 API调用。

创建条件客户数据字段

您可以创建条件客户数据字段,这些字段仅在用户选择特定选项时才会显示在激活工作流中。

例如,您可以创建条件文件格式选项,以使其仅在用户选择特定文件导出类型时显示。

以下配置将为CSV文件格式选项创建条件分组。 只有在用户选择CSV作为导出所需的文件类型时,才会显示CSV文件选项。

要将字段设置为条件字段,请使用 conditional 参数如下所示:

"conditional": {
   "field": "fileType",
   "operator": "EQUALS",
   "value": "CSV"
}

在更广泛的背景下,您可以看到 conditional 以下目标配置中使用的字段,以及 fileType 字符串和 csvOptions 在其中定义它的对象。

"customerDataFields":[
   {
      "name":"fileType",
      "title":"File Type",
      "description":"Select your file type",
      "type":"string",
      "isRequired":true,
      "enum":[
         "PARQUET",
         "CSV",
         "JSON"
      ],
      "readOnly":false,
      "hidden":false
   },
   {
      "name":"csvOptions",
      "title":"CSV Options",
      "description":"Select your CSV options",
      "type":"object",
      "conditional":{
         "field":"fileType",
         "operator":"EQUALS",
         "value":"CSV"
      },
      "properties":[
         {
            "name":"delimiter",
            "title":"Delimiter",
            "description":"Select your Delimiter",
            "type":"string",
            "isRequired":false,
            "default":",",
            "namedEnum":[
               {
                  "name":"Comma (,)",
                  "value":","
               },
               {
                  "name":"Tab (\\t)",
                  "value":"\t"
               }
            ],
            "readOnly":false,
            "hidden":false
         },
         {
            "name":"quote",
            "title":"Quote Character",
            "description":"Select your Quote character",
            "type":"string",
            "isRequired":false,
            "default":"",
            "namedEnum":[
               {
                  "name":"Double Quotes (\")",
                  "value":"\""
               },
               {
                  "name":"Null Character (\u0000)",
                  "value":"\u0000"
               }
            ],
            "readOnly":false,
            "hidden":false
         },
         {
            "name":"escape",
            "title":"Escape Character",
            "description":"Select your Escape character",
            "type":"string",
            "isRequired":false,
            "default":"\\",
            "namedEnum":[
               {
                  "name":"Back Slash (\\)",
                  "value":"\\"
               },
               {
                  "name":"Single Quote (')",
                  "value":"'"
               }
            ],
            "readOnly":false,
            "hidden":false
         },
         {
            "name":"emptyValue",
            "title":"Empty Value",
            "description":"Select the output value of blank fields",
            "type":"string",
            "isRequired":false,
            "default":"",
            "namedEnum":[
               {
                  "name":"Empty String",
                  "value":""
               },
               {
                  "name":"\"\"",
                  "value":"\"\""
               },
               {
                  "name":"null",
                  "value":"null"
               }
            ],
            "readOnly":false,
            "hidden":false
         },
         {
            "name":"nullValue",
            "title":"Null Value",
            "description":"Select the output value of 'null' fields",
            "type":"string",
            "isRequired":false,
            "default":"null",
            "namedEnum":[
               {
                  "name":"Empty String",
                  "value":""
               },
               {
                  "name":"\"\"",
                  "value":"\"\""
               },
               {
                  "name":"null",
                  "value":"null"
               }
            ],
            "readOnly":false,
            "hidden":false
         }
      ],
      "isRequired":false,
      "readOnly":false,
      "hidden":false
   }
]

在下方,您可以根据上述配置查看生成的UI屏幕。 当用户选择文件类型CSV时,UI中会显示引用CSV文件类型的其他文件格式选项。

显示CSV文件的条件文件格式选项的屏幕录制。

访问模板化的客户数据字段

当您的目标需要用户输入时,您必须向用户提供一系列客户数据字段,用户可以通过Platform UI填写这些字段。 然后,您必须配置目标服务器,以从客户数据字段中正确读取用户输入。 这可以通过模板化字段完成。

模板化字段使用格式 {{customerData.fieldName}},其中 fieldName 是从中读取信息的客户数据字段的名称。 所有模板化的客户数据字段前面都有 customerData. 并括在双大括号内 {{ }}.

例如,我们来考虑以下Amazon S3目标配置:

"customerDataFields":[
   {
      "name":"bucketName",
      "title":"Enter the name of your Amazon S3 bucket",
      "description":"Amazon S3 bucket name",
      "type":"string",
      "isRequired":true,
      "pattern":"(?=^.{3,63}$)(?!^(\\d+\\.)+\\d+$)(^(([a-z0-9]|[a-z0-9][a-z0-9\\-]*[a-z0-9])\\.)*([a-z0-9]|[a-z0-9][a-z0-9\\-]*[a-z0-9])$)",
      "readOnly":false,
      "hidden":false
   },
   {
      "name":"path",
      "title":"Enter the path to your S3 bucket folder",
      "description":"Enter the path to your S3 bucket folder",
      "type":"string",
      "isRequired":true,
      "pattern":"^[0-9a-zA-Z\\/\\!\\-_\\.\\*\\''\\(\\)]*((\\%SEGMENT_(NAME|ID)\\%)?\\/?)+$",
      "readOnly":false,
      "hidden":false
   }
]

此配置会提示用户输入他们的 Amazon S3 将存储段名称和文件夹路径放置到各自的客户数据字段中。

要使Experience Platform正确连接到 Amazon S3,则必须将目标服务器配置为从这两个客户数据字段中读取值,如下所示:

 "fileBasedS3Destination":{
      "bucketName":{
         "templatingStrategy":"PEBBLE_V1",
         "value":"{{customerData.bucketName}}"
      },
      "path":{
         "templatingStrategy":"PEBBLE_V1",
         "value":"{{customerData.path}}"
      }
   }

模板化值 {{customerData.bucketName}}{{customerData.path}} 读取用户提供的值,以便Experience Platform能够成功连接到目标平台。

有关如何配置目标服务器以读取模板化字段的更多信息,请参阅以下文档: 硬编码字段与模板化字段.

后续步骤

阅读本文后,您应该更好地了解如何允许用户在Experience PlatformUI中通过客户数据字段输入信息。 您现在还知道如何为您的用例选择正确的客户数据字段,以及在Platform UI中配置、排序和分组客户数据字段。

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

在此页面上