このページでは、フィールドの一部である
descriptionパラメータについて説明します。
descriptionは、description（Explore 用）パラメータのドキュメント ページで説明されているように、Explore の一部としても使用できます。
descriptionは、ダッシュボード パラメータのドキュメント ページで説明されているように、ダッシュボードの一部としても使用できます。
用途
view: view_name {
dimension: field_name {
description: "description string"
}
}
|
階層
description |
使用可能なフィールドタイプ
ディメンション、ディメンショングループ、メジャー、フィルタ、パラメータ
許可
文字列
|
定義
任意のフィールドに説明を追加できます。BigQuery 接続の場合、データベースから LookML プロジェクトを生成すると、Looker によって BigQuery 列メタデータの説明（ある場合）からフィールドの説明が自動的に入力されます。
ユーザーはフィールドの説明を複数の場所で見ることができます。
たとえば、次の LookML で定義されたディメンションの場合:
dimension: id {
primary_key: yes
description: "Unique ID for the order"
type: string
sql: ${TABLE}.id ;;
ユーザーがフィールド ピッカーのフィールド名の右にある情報アイコンを選択すると、説明が表示されます。
また説明は、Explore、ダッシュボード、または Look にあるテーブルやテーブル チャート ビジュアリゼーションの列名にマウスオーバーした場合も表示されます。
description パラメータでの Liquid 変数の使用
フィールドの description パラメータで Liquid 変数を使用できます。これは、たとえば、ユーザー属性やクエリが実行される Explore に基づいて、フィールドの説明を Looker に表示する場合に便利です。
たとえば、クエリが実行される Explore に応じてフィールドの説明を変更する場合は、Liquid {% if %}{% else %} {% endif %} 構造内で Liquid 変数 _explore._name を使用できます。
dimension: user_id {
description:
"{% if _explore._name == 'order_items' %}
The user ID for the Order Items Explore
{% elsif _explore._name == 'inventory_items' %}
The user ID for the Inventory Items Explore
{% else %}
The user ID
{% endif %}"
}
この例では、Order Items Explore でクエリを実行すると、User ID ディメンションの説明は「The user ID for the Order Items Explore」になります。Inventory Items Explore では、説明は The user ID for the Inventory Items Explore になります。他の Explore では、説明「ユーザー ID」が表示されます。
別の例として、ユーザーの部門に応じて異なる説明を表示するとします。Department というユーザー属性を定義している場合は、Liquid {% if %} {% else %}{% endif %} 構造内で Liquid 変数 _user_attributes['name_of_attribute'] を使用して、Department ユーザー属性の値に応じて異なる説明を指定できます。
dimension: gross_margin {
description:
"{% if _user_attributes['department'] == 'Marketing' %}
The standard margin for a field
{% elsif _user_attributes['department'] == 'Sales' %}
The operating margin for a field
{% else %} The gross margin for a field {% endif %}"
type: number
value_format_name: usd
sql: ${sale_price} - ${inventory_items.cost} ;;
}
この例では、ユーザーがマーケティング チーム、セールスチーム、その他のチームのいずれに属しているかによって、[売上総利益] ディメンションに表示される説明が異なります。
description パラメータでは、_model._name、_view._name、_explore._name、_field._name、_user_attributes['name_of_attribute'] などの Liquid 変数を使用できます。LookML での Liquid パラメータの使用方法と、description パラメータで使用できる Liquid 変数については、Liquid 変数リファレンスのドキュメント ページをご覧ください。
知っておくべきこと
説明はディメンショングループごとに 1 回表示されます
ディメンショングループについては、Lookerはグループ全体に対して1回のみ説明を表示し、グループ内の各タイムフレームのディメンションに対しては表示しません。