UI屬性

UI屬性會定義Adobe在Adobe Experience Platform使用者介面中應針對目的地卡片顯示的視覺元素,例如標誌、檔案頁面的連結、目的地說明及其類別和型別。

若要瞭解此元件在何處適合使用Destination SDK建立的整合,請參閱組態選項檔案中的圖表,或檢視下列目的地組態概觀頁面:

透過Destination SDK建立目的地時,uiAttributes區段會定義目的地卡片的下列視覺屬性:

  • 目的地目錄中目的地檔案頁面的URL。
  • Platform UI中顯示您目的地的類別。
  • 您目的地的資料匯出頻率。
  • 目的地連線型別,例如Amazon S3、Azure Blob等。
  • 您託管要在目的地目錄卡片中顯示之圖示的URL。

您可以透過/authoring/destinations端點設定UI屬性。 請參閱下列API參考頁面,以取得詳細的API呼叫範例,您可在此範例設定本頁面中顯示的元件。

本文說明可用於目的地的所有受支援UI屬性,並顯示客戶將在Experience PlatformUI中看到的內容。

UI熒幕擷圖顯示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是字串引數,參考目的地支援的資料匯出型別。 針對以API為基礎的整合設定為Streaming,或當您匯出檔案至目的地時設定為Batch

使用者可以在每個目的地連線的​ 資料流執行 ​頁面中看到頻率型別。

UI影像顯示UI中的頻率型別位置。

isBeta isbeta

如果您透過Destination SDK建立的目的地可供有限數量的客戶使用,您可能會想要將目的地目錄中的目的地卡片標示為測試版。

若要這麼做,您可以使用目的地設定之UI屬性區段中的isBeta: "true"引數,以適當地標示目的地卡片。

UI影像顯示標示為Beta的目的地卡片。

icon icon

您可以新增標誌圖示至您的目的地,如下圖所示。

顯示圖示位置的UI影像。

若要新增標誌至您的目的地卡片,您必須在提交目的地以供檢閱時,與Adobe團隊共用想要的影像。

後續步驟 next-steps

閱讀本文後,您應該更加瞭解您可以為目的地設定哪些UI屬性,以及使用者將在Platform UI中的何處看到這些屬性。

若要深入瞭解其他目的地元件,請參閱下列文章:

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