UI属性

UI属性定义Adobe应在Adobe Experience Platform用户界面中为目标卡显示的可视化元素,例如徽标、指向文档页面的链接、目标描述及其类别和类型。

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

时间 创建目标 通过Destination SDK, uiAttributes 部分定义目标卡的以下可视属性:

  • 您的目标文档页面的URL,位于 目标目录.
  • 您的目标将显示在Platform UI中的类别。
  • 目标的数据导出频率。
  • 目标连接类型,如Amazon S3、Azure Blob等。
  • 您托管要在目标目录信息卡中显示的图标的URL。

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

本文介绍了可用于目标的所有受支持的UI属性,并显示了客户将在Experience PlatformUI中看到的内容。

显示Experience Platform界面中UI属性的用户界面屏幕截图

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

支持的集成类型 supported-integration-types

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

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

支持的参数 supported-parameters

"uiAttributes":{
      "documentationLink":"http://www.adobe.com/go/YOURDESTINATION-en",
      "category":"cloudStorage",
      "connectionType":"S3",
      "frequency":"batch",
      "isBeta":"true"
   }

documentationLink 是一个字符串参数,它引用 目标目录 到你的目的地去。 Adobe Experience Platform中的每个产品化目标都必须具有相应的文档页面。 了解如何创建目标文档页面 到你的目的地去。 请注意,私有/自定义目标不需要此项。

使用以下格式: http://www.adobe.com/go/destinations-YOURDESTINATION-en,其中 YOURDESTINATION 是目标的名称。 对于名为Moviestar的目标,您可以使用 http://www.adobe.com/go/destinations-moviestar-en.

用户可以从UI中的目标目录页面查看和访问您的文档链接。 他们需要浏览到您的目标卡,然后选择 更多操作,然后 查看文档,如下图所示。

显示文档链接位置的UI图像。

NOTE
此链接仅在Adobe将您的目标设置为实时状态并发布文档后生效。

category category

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图像。

connectionType connection-type

connectionType 是一个字符串参数,它根据目标来引用连接的类型。 支持的值:

  • Server-to-server
  • Cloud storage
  • Azure Blob
  • Azure Data Lake Storage
  • S3
  • SFTP
  • DLZ

用户可以在以下位置查看目标连接类型: 浏览 目标工作区的选项卡。

显示UI中连接类型位置的UI图像。

frequency frequency

frequency 是一个字符串参数,引用您的目标支持的数据导出类型。 设置为 Streaming 对于基于API的集成,或者 Batch 将文件导出到目标时。

用户可以在以下位置查看频率类型: 数据流运行 每个目标连接的页面。

显示UI中频率类型位置的UI图像。

isBeta isbeta

如果通过Destination SDK创建的目标可供有限数量的客户使用,您可能需要将目标目录中的目标卡标记为测试版。

为此,您可以使用 isBeta: "true" 目标配置的UI属性部分中的参数,用于正确标记目标卡。

显示标记为Beta版的目标卡片的UI图像。

icon icon

您可以向目标添加徽标图标,如下图所示。

显示图标位置的UI图像。

Adobe要在目标卡中添加徽标,您需要在 提交目标以供审查.

后续步骤 next-steps

阅读本文后,您应该能够更好地了解可以为目标配置哪些UI属性,以及用户将在Platform UI中的何处看到这些属性。

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

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