パラメータを使って、ユーザーから提供されたデータを操作できます。たとえば、レポートを使用しているユーザーからの入力を含む計算フィールドを作成したり、データソースで使用される SQL クエリに値を返したりすることが可能です。パラメータを使うと、よりインタラクティブなレポートを作成できるほか、レポート テンプレートを作成することも可能です。
この記事の内容:パラメータの仕組み
パラメータは、プログラミング言語の変数と同じように機能し、主に次の 3 つの用途で使用されます。
- 計算フィールドでパラメータを使用し、ユーザー入力に基づいて結果を表示できます。
- BigQuery データソースのカスタム SQL クエリにパラメータを返すことができます。
- コミュニティ コネクタにパラメータを返すことができます。
パラメータは、以下の場所からデータを取得できます。
- パラメータに定義されているデフォルト値。
- コンポーネント プロパティ パネル。
- レポートに配置されたコントロール。
- レポートへのリンク。
レポート エディタとデータソース エディタで、フィールドのリストの下にパラメータが表示されます。パラメータは紫色のフィールドで表示されます。
パラメータでレポートのデータを共有する仕組み
レポートやデータソースのエディタからは、パラメータによって制御されているすべてのデータにアクセスすることができます。
パラメータを使うと、デフォルト値とは異なるデータをレポート エディタからリクエストできます。データソースのパラメータを有効にする前に、パラメータ値を変更するとレポートのデータにどのような影響があるかを把握しておく必要があります。パラメータによっては、他の地域の天気のように比較的「安全な」データのみを返すものもありますが、まったく新しいデータセットのリクエストをユーザーに許可してしまう場合もあります。たとえば、ユーザーが口座番号パラメータや、データベース テーブルの名前をリクエストすると、共有する意図のなかったデータが返されたり、レポートの既存のグラフに対応していないスキーマが返されたりする恐れがあります。
パラメータを作成する
パラメータは以下の場所で作成できます。
データソース内
- データソースを編集します。
- 右上の [パラメータを追加] をクリックします。
または、レポートの編集中にコンポーネントを選択し、右下の [パラメータを追加] をクリックして、パラメータを作ることもできます。必ず目的のデータソースに基づいてコンポーネントを選択してください。 - パラメータのオプションとデフォルト値を設定します(下記をご覧ください)。
BigQuery コネクタ内
BigQuery コネクタのカスタム SQL クエリにパラメータを渡すことができます。BigQuery コネクタでは、レポートの開始日と終了日、および(情報がある場合は)ユーザーのメールアドレスを渡す複数の標準パラメータが定義されます。また、カスタム パラメータを渡すこともできます。詳細
パラメータとコミュニティ コネクタ
コミュニティ コネクタにはオーバーライド可能なパラメータを含めることができます。レポートの編集者は、こうしたパラメータを使ってデータソースのデフォルト値を変更できます。コミュニティ コネクタで作成したデータソースの接続を編集できる方は、レポートの編集者が変更してよいパラメータを指定することができます。
- データソースを編集します。
- 左上にある [接続を編集] をクリックします。
- 編集可能なパラメータが提供されている場合は、パラメータがページの下部に表示されます。コネクタでカスタム パラメータを定義できる場合は、ページに手順が表示されます。
- [<パラメータ名>がレポートで変更されることを許可します] チェックボックスを使って、レポート内でのパラメータの編集を許可(オン)または禁止(オフ)します。
- 右上の [再接続] をクリックします。
コミュニティ コネクタからデータソースを作成しても、そのコネクタ内のパラメータへの変更内容は自動的にデータソースに表示されません。パラメータの追加、削除、変更を確認するには、データソースを再接続する必要があります。
既存のパラメータを編集する
既存のパラメータの構成を変更するには:
- パラメータを含むデータソースを編集します。
- フィールド リストでパラメータを見つけます。
- パラメータ名の右側にある @ 記号をクリックします。
- 変更を加えたら、右下の [保存] をクリックします。
パラメータを構成する
これらのオプションを使用して、データソースのパラメータを構成します。BigQuery コネクタとコミュニティ コネクタのパラメータについては、上記の参照記事をご覧ください。
パラメータ名: レポートとデータソースでフィールドのリストに表示されます。また、この名前は計算フィールドのパラメータを参照するためにも使用されます。
パラメータ ID: デフォルトで設定されています。パラメータ ID は、Looker Studio でパラメータを識別するために内部的に使用され、レポートの閲覧者には表示されません。
データ型: パラメータではテキスト、数値、ブール値(true/false)の値を格納できます。
使用可能な値: ユーザーが入力できる値を指定します。
値のリストを指定するには、そのオプションを選択してから、表示名(省略可)と併せて許容値を入力します。[オプションを追加] をクリックすると、リストに項目を追加できます。
使用可能な値の範囲を指定するには、その範囲の最小値と最大値を入力します。
デフォルト値: パラメータの開始値を指定します。
パラメータ値を設定する
パラメータの値は、以下の方法で設定できます。
パラメータのデフォルト値を設定する
パラメータを作成する際には、デフォルト値を設定できます。デフォルト値を調整するには、上記の手順に沿ってパラメータを編集します。
コントロールを使ってユーザーからの入力を受け取る
ユーザーはコントロールを使用することで、レポートを操作することができます。ユーザー入力をパラメータに保存するには、そのパラメータをコントロールの [コントロール フィールド] プロパティに追加します。
- レポートを編集します。
- 上部の [コントロールを追加] をクリックします。
- 追加するコントロールの種類を選択します。
[プロパティ] パネルで、[設定] タブを選択します。
- パラメータを [コントロール フィールド] に追加します。
詳しくは、コントロールの詳細をご覧ください。
コンポーネントのデフォルトのパラメータ値をオーバーライドする
パラレポート内の個別のコンポーネントを編集することで、パラメータのデフォルト値をオーバーライドできます。
- レポートを編集します。
- パラメータを含むデータソースに基づいてコンポーネントを選択します。
- コンポーネントの [データ] タブの下部にあるデフォルトのパラメータ値を編集します。
レポート単位やページ単位でパラメータを編集することもできます。
- レポートを編集します。
- [ファイル] > [レポート設定] または [ページ] > [現在のページの設定] を選択します。
- パラメータ値を編集します。
パラメータの継承
パラメータは、フィルタ プロパティと同じ継承規則に従います。具体的には、優先順位の高いコンポーネントのパラメータによって、優先順位の低いコンポーネントのパラメータがオーバーライドされます。優先順位(昇順)は以下のとおりです。
- データソース(デフォルト)
- レポート
- ページ
- グループ
- 個別のグラフやコントロール
レポートへのリンクを使ってパラメータを変更する
レポートの URL を使ってパラメータを設定すると、プログラムで構成可能なレポートをデベロッパーや上級ユーザーが作成できるようになります。
Looker Studio のレポート パラメータとそれに対応する値は、URL エンコードされた JSON 文字列として渡され、「params」クエリ パラメータを使ってレポート URL に追加されます。
詳しくは、デベロッパー ガイドをご覧ください。
レポートの URL パラメータの管理
レポートのパラメータは、デフォルトで、レポート URL を使って編集することができません。
レポートのユーザーに変更を許可するパラメータを選択するには:
- レポートを編集します。
- [リソース] > [レポートの URL パラメータの管理] を選択します。
- [レポートの URL による設定を許可する] 列で、許可するパラメータのチェックボックスをオンにします。
このページには、各パラメータの URL パラメータも表示されます。エンコードされたパラメータ オブジェクトを作成する際には、パラメータ名ではなく、この名前を使用します。この名前は、編集(鉛筆)アイコンをクリックして編集できます。レポート内の URL パラメータはすべて一意である必要があります。
URL パラメータ名を編集しても、レポート内でのパラメータの使用方法には影響しません。
パラメータを使用する
作成したパラメータは、ディメンションや指標と同じように計算フィールドとレポート コンポーネントで使用できます。
計算フィールドでパラメータを使用する
パラメータは、ディメンションや指標と同じように計算フィールドで使用できます。
パラメータを含む計算フィールドの例
たとえば、ユーザーが前四半期の売り上げに乗数を入力できるようにして、予測売上額を可視化するとします。
まず、予測乗数を保持するためのパラメータを作成します。
- Looker Studio にログインします。
- データソースを編集します。
- 右上の [パラメータを追加] をクリックします。
- パラメータに名前を付けます(「予測乗数」など)。
- [データ型] を [数値] に設定します。
- わかりやすくするため、[使用可能な値] オプションは [任意値] に設定されたままにします。
その他のオプションを使用して、ユーザーが値のリストから選択できるようにしたり、入力できる値を特定の範囲に制限したりすることも可能です。 - [デフォルト値] を「1」に設定します。
- [保存] をクリックします。
- データソースのフィールドのリストに戻るには、左側の [すべてのフィールド] をクリックします。
次に、計算フィールドを作成します。
- 右上の [フィールドを追加] をクリックします。
- フィールドに名前を付けます(「パラメータを含む売上予測」など)。
- 数式内で、データソースの「売り上げ」フィールドに予測乗数パラメータを掛けます。たとえば、データソースに「収益」というフィールドがある場合は、以下のように入力します。
収益 * 予測乗数 - [保存] をクリックします。
次に、ユーザーの入力を収集するためのコントロールを追加します。
- レポートを編集または作成します。
- 必要に応じて、データソースをレポートに追加します。
- 上部の [コントロールを追加] をクリックします。
- [入力ボックス] コントロールを選択します。
[入力ボックス] コントロールを使うと、ユーザーはパラメータ値を直接入力でき、他の種類のコントロールでは、リストから選択したり、スライダーを使用したり、チェックボックスを使ってブール値を切り替えたりすることができます。 - 右側の [データ] プロパティで、前に作成した予測乗数パラメータを追加します。
最後に、パラメータ化された計算フィールドをグラフで表示します。
- 上部の [ グラフを追加] をクリックします。
- わかりやすくするため、[スコアカード] を選択します。
- 右側の [データ] プロパティで、指標として [パラメータを含む売上予測] 計算フィールドを追加します。
以下をお試しください。
- 右上の [表示] をクリックします。
- [予測乗数] コントロールに数値を入力し、Enter キーを押します。
- 入力した値にスコアカードの値が乗算され、その変化が表示されます。
ビジュアル表示でパラメータを使用する
パラメータは、ディメンションや指標と同じように、グラフに追加できます。数値パラメータを指標として使用する場合は、その値が集計されます。
レポートでのパラメータの表示と非表示を切り替える
データソースで作成したパラメータの表示と非表示を切り替えることができます。
- データソースを編集します。
- 目的のパラメータを見つけます。
- パラメータの右側にある オプションをクリックします。
- [表示](パラメータが現在非表示の場合)または [非表示](パラメータが現在表示されている場合)をクリックします。
パラメータを含むコンポーネントをコピーする
コンポーネントをコピーすると、プロパティ パネルでの設定に基づいて、そのパラメータ値がコピーされます。コンポーネントを編集することで、コピーのパラメータをオーバーライドできます。
無効なパラメータを修正する
コネクタでパラメータの設定が変更されると、これらのパラメータを使用するグラフが破損する場合があります。たとえば、コネクタのデベロッパーがパラメータ値を上書きする機能を削除した場合、レポートで入力した値では有効なデータが返されなくなります。この場合、その変更によって影響を受けるすべてのグラフでエラー メッセージが表示されます。
これを修正するには、now-invalid パラメータを含むコンポーネントを探します。次に、そのコンポーネントの [データ] プロパティの [パラメータ] で、[無効な値を修正] をクリックします。
パラメータは、個々のグラフに加えて、レポート、ページ、グループ単位で設定できるため、エラーを見つけて修正するには複数の場所を調べることが必要になる場合があります。