UI 属性

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

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

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

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

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

この記事では、宛先に使用できるサポートされているすべてのUI属性について説明し、顧客がExperience Platform 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 の宛先カタログページからドキュメントリンクを確認および訪問できます。 次の画像に示すように、宛先カードを参照し、その他のアクション​を選択してから​ ドキュメントを表示 ​する必要があります。

Experience Platform 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

ユーザーは、次の画像に示すように、宛先カタログのフィルターパネルに宛先カテゴリのリストを表示できます。

Experience Platform UIの宛先カタログと、フィルターパネルに表示される宛先カテゴリのリスト。

connectionType connection-type

connectionType は、宛先に応じて接続のタイプを参照する文字列パラメーターです。 サポートされている値:

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

ユーザーは、宛先ワークスペースの「参照」タブで、宛先接続タイプを確認できます。

Experience Platform UIの宛先ワークスペースの「参照」タブに、宛先の接続タイプが表示されます。

frequency frequency

frequency は、宛先でサポートされているデータ書き出しのタイプを参照する文字列パラメーターです。 API ベースの統合の場合は Streaming に設定し、宛先にファイルを書き出す場合は Batch に設定する。

ユーザーは、各宛先接続の​データフロー実行 ページで頻度タイプを確認できます。

​ データフローは、Experience Platform UIで宛先接続のページを実行し、データ書き出しの頻度タイプを示します。

isBeta isbeta

Destination SDKで作成する宛先が限られた数のお客様で利用できる場合は、宛先カタログの宛先カードをベータ版としてマークすることができます。

これを行うには、宛先設定の UI 属性セクションで isBeta: "true" パラメーターを使用して、適切に宛先カードをマークできます。

Experience Platform UIのベータ版バッジが付いた宛先カタログ内の宛先カード。

icon icon

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

​ カスタムロゴアイコンを表示するExperience Platform UIの宛先カード。

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

次の手順 next-steps

宛先に設定できるUI属性と、Experience Platform UIでユーザーに表示される場所を理解できました。

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

recommendation-more-help
experience-platform-help-destinations