description（Explore 用）

このページでは、Explore の一部である description パラメータについて説明します。

description は、フィールドの一部として使用することもできます。description (フィールドの場合) パラメータのドキュメントページを参照してください。

description はダッシュボードの一部として使用することもできます。詳しくは、ダッシュボード パラメータに関するドキュメント ページをご覧ください。

使用状況

Explore: explore_name{
description: "私が希望する内容"
}

階層 モデルファイル explore description

デフォルト値 なし 許可 文字列

定義

description を使用すると、Explore に関する情報を UI に追加できます。これにより、ユーザーはレポートを作成する際に追加の情報を取得できます。たとえば、次の description パラメータは、

explore: order_items {
  description: "Based on the individual items that comprise customer orders"
}

description が Explore に追加されている場合、ユーザーはフィールド ピッカーの上部にある Explore の名前の横にある情報アイコンにカーソルを合わせると、説明を確認できます。

ユーザーは、Explore のプルダウン リストで同じ情報アイコンを使用することもできます。

description を Explore に明示的に追加しない場合、説明は表示されません。

例

User という Explore に説明を追加します。

explore: user {
  description: "All customer users, staff users are excluded"
}