UI 属性

UI 属性は、Adobe Experience Platform ユーザーインターフェイスでAdobeが宛先カードに表示する必要がある視覚的な要素(ロゴ、ドキュメントページへのリンク、宛先の説明とそのカテゴリおよびタイプなど)を定義します。

このコンポーネントが Destination SDK で作成される統合のどこに適合するかを把握するには、設定オプションドキュメントの図を参照するか、以下の宛先設定の概要ページを参照してください。

Destination SDK を使用して宛先を作成する場合、uiAttributes セクションで宛先カードの以下のビジュアルプロパティを定義します。

  • 宛先カタログの宛先ドキュメントページの URL。
  • Platform UI で宛先が表示されるカテゴリ。
  • 宛先のデータ書き出し頻度。
  • 宛先接続タイプ(Amazon S3、Azure Blob など)。
  • 宛先カタログのカードに表示するアイコンをホストした URL。

/authoring/destinations エンドポイントを介して UI 属性を設定できます。このページに表示されるコンポーネントを設定できる、詳細な API 呼び出しの例については、以下の API リファレンスページを参照してください。

この記事では、宛先に使用できる、サポートされるすべての UI 属性を説明し、Experience Platform UI で顧客に何が表示されるかを示します。

Experience Platform インターフェイスの UI 属性を示す 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
このリンクは、アドビが宛先をライブに設定してドキュメントが公開された後でのみ機能します。

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

icon icon

以下の画像に示すように、宛先にロゴアイコンを追加できます。

アイコンの場所を示す UI 画像。

宛先カードにロゴを追加するには、 レビュー用に宛先を送信する際に、Adobeチームと目的の画像を共有する必要があります。

次の手順 next-steps

この記事を読むことで、宛先に設定できる UI 属性と、それが Platform UI で表示される場所について、理解を深めることができました。

その他の宛先コンポーネントについて詳しくは、以下の記事を参照してください。

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