description（フィールド）

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

description は、Explore の一部として使用することもできます（description（Explore 用）パラメータのドキュメント ページを参照）。

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

使用状況

ビュー: view_name {
dimension: field_name {
description: "description string"
}
}
階層
view
フィールド タイプ
description
使用可能なフィールドタイプ
ディメンション、ディメンション グループ、メジャー、フィルタ、パラメータ

許可
文字列

定義

どのフィールドにも説明を追加できます。BigQuery 接続の場合、データベースから LookML プロジェクトを生成すると、BigQuery の列メタデータから説明があれば、Looker によってフィールドの説明が自動入力されます。

ユーザーは、フィールドの説明を複数の場所で確認できます。

たとえば、次の LookML で定義されたディメンションの場合、

dimension: id {
  primary_key: yes
  description: "Unique ID for the order"
  type: string
  sql: ${TABLE}.id ;;

ユーザーがフィールドピッカーのフィールド名の右にある情報アイコンを選択すると、説明が表示されます。

また説明は、Explore、ダッシュボード、Lookにあるテーブルまたはテーブルチャートのビジュアリゼーションの列名にマウスオーバーした場合も表示されます。

description パラメータで Liquid 変数を使用する

フィールドの description パラメータで Liquid 変数を使用できます。これは、たとえば、ユーザー属性に基づいて、またはクエリが実行された Explore に基づいて、フィールドに関する異なる説明を表示したい場合に役立ちます。

たとえば、クエリが実行される Explore に応じてフィールドの説明を変えたい場合は、Liquid の {% dynamic if %} {% dynamic else %} {% dynamic endif %} 構造内で Liquid 変数 _explore._name を使用できます。


dimension: user_id {
  description:
   "{% dynamic 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
    {% dynamic else %}
      The user ID
    {% dynamic endif %}"
}

この例では、Order Items Explore でクエリが実行されると、User ID ディメンションの説明は Order Items Explore のユーザー ID になります。Inventory Items Explore では、説明は User ID of the Inventory Items Explore になります。他の Explore では、説明にユーザー ID が表示されます。

別の例として、部門ごとに異なるユーザーに異なる説明を表示する場合、Department というユーザー属性を定義している場合は、Liquid {% dynamic if %} {% dynamic else %} {% dynamic endif %} 構造内で Liquid 変数 _user_attributes['name_of_attribute'] を使用して、Department ユーザー属性の値に応じて異なる説明を指定できます。


dimension: gross_margin {
  description:
   "{% dynamic if _user_attributes['department'] == 'Marketing' %}
      The standard margin for a field
    {% elsif _user_attributes['department'] == 'Sales' %}
      The operating margin for a field
    {% dynamic else %} The gross margin for a field {% dynamic 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回のみ説明を表示し、グループ内の各タイムフレームのディメンションに対しては表示しません。