はじめに
Linking API は、ユーザーを設定し、URL を介して Looker Studio レポートに直接転送するための信頼性の高いインターフェースを提供します。Linking API の URL をフォローしているユーザーは、データをすばやく表示して操作できます。
このドキュメントでは、Linking API の URL の必要な形式と使用可能なパラメータについて説明します。
ユースケースとメリット
Linking API を使用すると、ユーザーがデータを表示して操作できるように、事前構成済みのレポートを提供できます。Linking API の主なメリットは次のとおりです。
- ワンクリックでレポートを作成できます。
- データ構成は URL で提供されるため、ユーザーがデータに合わせてレポートを構成する必要はありません。
- ユーザーはワンクリックでレポートを保存でき、いつでもレポートを再確認できます。
- レポートを大規模に作成できます。Linking API を使用すると、レポートの複製や新しい作成にかかる時間を短縮できます。
- プロダクト インテグレーションを有効化できます。安定版のインターフェースを使用すると、Looker Studio をプロダクト ワークフローに統合できます。
仕組み
ここでは、デベロッパーとユーザーが Linking API を使用する方法について説明します。
Linking API デベロッパー ワークフロー
デベロッパーがテンプレート レポートとデータソースを準備し、Linking API の URL をフォーマットします。デベロッパーの一般的なワークフローは次のとおりです。
- 空白のレポート（Looker Studio に用意されているデフォルトのレポート テンプレート）を使用するか、テンプレートとして機能する Looker Studio レポートを作成するかを決めます。これには、テンプレートのデータソースの設定も含まれます。
- 特定のユースケースに合わせて Linking API の URL の形式を設定できます。必要に応じて、レポート テンプレートとその他のパラメータ（レポート名、データソース名、データソース構成など）を指定します。
- Linking API の URL を使用して、ユーザーをレポートに誘導します。
Linking API のユーザー エクスペリエンス
ユーザーは Linking API の URL に移動します。デベロッパーによって正しく設定されていれば、ユーザーは Looker Studio レポートにリダイレクトされます。このレポートでは、アクセス権のあるデータを表示、操作できます。一般的なユーザー エクスペリエンスは次のとおりです。
- ユーザーがブラウザで、 Linking API が統合されたサービスにアクセスします。
- カスタム外部リンクは、Looker Studio でデータを表示するリンクをクリックするようユーザーに促します。
- ユーザーがリンクをクリックすると、Looker Studio レポートが表示されます。レポートが読み込まれ、ユーザーはデータを表示、操作できるようになります。
- ユーザーが [編集して共有] をクリックすると、レポートが Looker Studio アカウントに保存されます。
- これで、レポートの独自のコピーの完全アクセス権を得て、管理できるようになりました。 いつでもレポートのコピーを表示、編集、共有できます。
要件
Linking API の URL が想定どおりに機能するには、以下が必要です。
- テンプレートとして機能するレポート。指定されていない場合は、空白のレポートまたは Looker Studio のデフォルトのレポートを使用できます。
- Linking API の URL のユーザーには、少なくともテンプレート レポートの閲覧権限が必要です。レポートで使用されるデータソースの種類と Linking API で指定される設定によっては、データソースの閲覧権限が必要になる場合もあります。詳しくは、テンプレートの権限をご覧ください。
- 各データソースのコネクタタイプが、Linking API による構成をサポートしている必要があります。サポートされているコネクタの一覧については、コネクタ リファレンスをご覧ください。
- Linking API の URL のユーザーは、Linking API の URL で構成されているデータにアクセスできる必要があります。ユーザーが基になるデータへのアクセス権を持っていない場合は、依存するレポート コンポーネントにエラーが表示されます。
URL パラメータ
Linking API の URL は次の形式にする必要があります。
https://lookerstudio.google.com/reporting/create?parameters
URL は、ウェブブラウザのコンテキスト（通常はユーザーがリンクをクリックしたり URL にリダイレクトする）で使用することが想定されています。また、レポートの埋め込みにも使用できます。
URL の例
Linking API の URL の例を次に示します。レポート名が設定され、単一の BigQuery データソースが構成されています。
https://lookerstudio.google.com/reporting/create?
c.reportId=12345
&r.reportName=MyNewReport
&ds.ds0.connector=bigQuery
&ds.ds0.datasourceName=MyNewDataSource
&ds.ds0.projectId=project-1234
&ds.ds0.type=TABLE
&ds.ds0.datasetId=456
&ds.ds0.tableId=789
URL パラメータには、必須のものと省略可能なものがあります。Linking API の URL を定義するために使用されるパラメータのリストを以下に示します。
control パラメータ
コントロール パラメータは、Linking API の URL から表示されたレポートの状態を決定します。
| パラメータ名 | 説明 |
|---|---|
| （省略可）テンプレート レポート ID。Looker Studio が開き、指定したレポートが設定されます。ID の確認方法について詳しくは、レポート ID をご覧ください。指定しない場合、空白のレポートまたはデフォルトのレポート テンプレートが使用されます。詳細については、空白のレポートまたはデフォルトのレポートを使用するをご覧ください。 | |
| （省略可）レポートで読み込む最初のページの ID。指定しない場合のデフォルトは、レポートの最初のページ（ ）です。 | |
（省略可）初期レポートモード。
view または
edit のいずれか。指定しない場合のデフォルトは view です。 |
|
（省略可）情報/デバッグ ダイアログの表示。true に設定するとダイアログ ボタンが表示されます。指定しない場合のデフォルトは false です。詳細については、
構成に関する問題のトラブルシューティングをご覧ください。 |
例
https://lookerstudio.google.com/reporting/create?
c.reportId=12345
&c.pageId=g7u8s9
&c.mode=edit
&r.reportName=MyNewReport
&ds.ds0.datasourceName=MyNewDataSource
&ds.ds0.connector=bigQuery
&ds.ds0.projectId=project-1234
&ds.ds0.type=TABLE
&ds.ds0.datasetId=456
&ds.ds0.tableId=789
レポート パラメータ
レポート パラメータを使用すると、レポート プロパティをオーバーライドできます。
| パラメータ名 | 説明 |
|---|---|
| （省略可）レポート名を設定します。指定しない場合、デフォルトでテンプレート レポート名になります。 | |
|
（省略可）レポートの使用状況を測定するように、Google アナリティクスの測定 ID を設定します。複数の ID を区切るにはカンマを使用します。
|
|
|
（省略可）テンプレート レポートの Google アナリティクスの測定 ID を使用するには、
|
例
https://lookerstudio.google.com/reporting/create?
c.reportId=12345
&r.reportName=MyNewReport
&r.measurementId=G-XXXXXXXXXX
&ds.ds0.datasourceName=MyNewDataSource
&ds.ds0.connector=bigQuery
&ds.ds0.projectId=project-1234
&ds.ds0.type=TABLE
&ds.ds0.datasetId=456
&ds.ds0.tableId=789
データソース パラメータ
データソース パラメータを使用すると、データソースの構成と、テンプレート レポートでデータソースに対してアクセスするデータを定義できます。
alias は、既存のレポートのデータソースを参照するために使用されます。エイリアスを使用すると、テンプレート レポートとの間でデータソースが追加または削除されても、下位互換性が確保されます。
データソース alias を見つける方法について詳しくは、データソース エイリアスをご覧ください。
データソース パラメータ
次のパラメータは、すべてのコネクタタイプに共通です。
| 名前 | 説明 |
|---|---|
|
（省略可）データソースの名前を設定します。
|
|
|
（省略可）テンプレートのデータソース名を使用するには、
|
|
|
省略可。
データソースのコネクタの種類。サポートされているコネクタの種類の詳細については、コネクタ リファレンスをご覧ください。 設定した場合、そのコネクタの種類に必要なすべての コネクタ パラメータを Linking API の URL で指定する必要があり、テンプレートのデータソースの設定全体が置き換えられます。 指定しない場合は、Linking API URL でコネクタタイプ用の 0 個以上の コネクタ パラメータを指定できます。テンプレートのデータソース設定は、Linking API URL では提供されないパラメータを指定するために使用されます。テンプレート データソースのコネクタタイプを特定する方法について詳しくは、コネクタの種類をご覧ください。
|
|
|
省略可。
指定しない場合のデフォルトは、コネクタの種類によって異なります。デフォルトの動作をオーバーライドする場合は、コネクタ リファレンスでコネクタ固有のデフォルトを確認してください。 refreshFields を使用する際の考慮事項:
|
|
| 必須。コネクタタイプのデータソース構成。データソースの作成に使用されるコネクタを特定する方法について詳しくは、コネクタの種類をご覧ください。各コネクタタイプで使用可能なデータソース パラメータの詳細については、コネクタ リファレンスをご覧ください。 |
置き換えと更新 - データソースの構成
データソースのパラメータを設定する際、Linking API の URL に ds.connector パラメータの有無は、テンプレートのデータソース構成の置換または更新の意図があることを示します。
次の表は、ds.connector パラメータが、テンプレート データソースの構成全体を置き換えるか、または指定されていないパラメータの更新に使用されるかにどう影響するかを示しています。
ds.connector は設定されていますか？ |
想定される構成と動作 | 一般的な用途 |
|---|---|---|
| はい |
置換。Linking API の URL で指定されたデータソース パラメータを使用して、テンプレートのデータソースの設定全体が置き換えられます。コネクタタイプに必要なパラメータをすべて指定する必要があります。ds.connector が設定されている場合の必須パラメータをご覧ください。 |
|
| × | 更新。テンプレートのデータソース設定は、Linking API URL では提供されないパラメータを指定するために使用されます。特に明記されていない限り、コネクタタイプのすべてのコネクタ パラメータは省略可能です。 これにより Linking API の URL が簡素化されます。通常は、テンプレートのデータソース構成に精通していて、パラメータのサブセットのみをオーバーライドしたい場合におすすめします。 |
|
ds.connector が設定されている場合の必須パラメータ
データソースの ds.connector パラメータが指定されている場合は、必須として指定されたすべてのコネクタ パラメータをデータソースに指定する必要があります。データソースの ds.connector パラメータが指定されていない場合は、特に明記されていない限り、すべてのコネクタ パラメータ（必須と指定されている場合も含む）をオプションとして扱うことができます。
例
単一の BigQuery データソース（ds0）でレポートを構成し、データソースの構成全体を置き換えます。
https://lookerstudio.google.com/reporting/create?
c.reportId=12345
&r.reportName=MyNewReport
&ds.ds0.datasourceName=MyNewDataSource
&ds.ds0.connector=bigQuery
&ds.ds0.type=TABLE
&ds.ds0.projectId=bigquery-public-data
&ds.ds0.datasetId=samples
&ds.ds0.tableId=shakespeare
レポートに含まれているデータソースが 1 つのみの場合、データソースのエイリアスを省略できます。したがって、上記の URL は次のように簡略化できます。
https://lookerstudio.google.com/reporting/create?
c.reportId=12345
&r.reportName=MyNewReport
&ds.datasourceName=MyNewDataSource
&ds.connector=bigQuery
&ds.type=TABLE
&ds.projectId=bigquery-public-data
&ds.datasetId=samples
&ds.tableId=shakespeare
単一の BigQuery データソース（ds0）を使用してレポートを構成し、データソースの課金プロジェクト ID のみを更新します。
https://lookerstudio.google.com/reporting/create?
c.reportId=12345
&r.reportName=MyNewReport
&ds.ds0.billingProjectId=my-billing-project
BigQuery データソース（ds0）と Google アナリティクスのデータソース（ds1）の 2 つのデータソースを使用してレポートを構成します。BigQuery のデータソースの構成全体が置き換えられますが、Google アナリティクスの構成では、単一のパラメータが更新され、指定されていないコネクタ パラメータについては ds1 テンプレートのデータソースが使用されます。
https://lookerstudio.google.com/reporting/create?
c.reportId=7890
&r.reportName=MyNewReportWithMultipleDataSources
&ds.ds0.datasourceName=MyNewDataSource
&ds.ds0.connector=bigQuery
&ds.ds0.type=TABLE
&ds.ds0.projectId=bigquery-public-data
&ds.ds0.datasetId=samples
&ds.ds0.tableId=shakespeare
&ds.ds1.viewId=92320289
作成と追加
複数のレポートに同じデータソースを使用すると、データソースを更新するとすべてのレポートに一括して影響が生じる場合があります。Linking API を使用してレポートを作成する場合、次の条件をすべて満たしていれば、テンプレート レポートからデータソースを再度追加できます。
- データソースは再利用可能です（埋め込みデータソースと再利用可能なデータソースをご覧ください）。
- URL はエイリアスでデータソースを参照していません
- URL にワイルドカード エイリアスが使用されていない（データソースのエイリアス ワイルドカードをご覧ください）
Linking API で新しいデータソースが作成されると、URL をクリックしたユーザーの認証情報が使用されます。つまり、ユーザーは基盤となるデータにアクセスできなければ、接続は機能しません。新しく生成されたレポートにデータソースを再度追加することで、その認証情報を保持できるため、ユーザーは新しいレポートのデータに引き続きアクセスできます。
データソースのエイリアスのワイルドカード
Linking API パラメータを複数のデータソースに適用するには、データソースのエイリアスの代わりにワイルドカード エイリアス ds.* を使用します。
これは、URL から重複するパラメータを削除する場合に便利です。たとえば、3 つの BigQuery データソースがアタッチされたテンプレートがあり、projectId と datasetId をそれぞれ置き換えて tableId を維持する場合は、次のように記述します。
https://lookerstudio.google.com/reporting/create?
c.reportId=7890
&ds.ds1.projectId=client-project
&ds.ds1.datasetId=client-dataset
&ds.ds2.projectId=client-project
&ds.ds2.datasetId=client-dataset
&ds.ds3.projectId=client-project
&ds.ds3.datasetId=client-dataset
または、ds.* ワイルドカードを使用すると、次の同等の URL を使用できます。
https://lookerstudio.google.com/reporting/create?
c.reportId=7890
&ds.*.projectId=client-project
&ds.*.datasetId=client-dataset
ds.* ワイルドカードを使用していない Linking API に渡されるパラメータは、他のパラメータよりも優先されます。上記の例では、特定のデータソースのエイリアスを追加して、ワイルドカードの値をオーバーライドできます。
https://lookerstudio.google.com/reporting/create?
c.reportId=7890
&ds.*.projectId=client-project
&ds.*.datasetId=client-dataset
&ds.ds1.datasetId=client-dataset
より一般的には、パラメータの優先順位は次のようになります。
- 特定のエイリアス（
ds.ds1.datasetId）で指定されたパラメータ - ワイルドカード（
ds.*.datasetId）を使用して指定されたパラメータ - テンプレート データソースから派生した値（ds.connector が指定されていない場合）。（置換と更新を参照）
- パラメータのデフォルト値（オプションの場合）。
コネクタ リファレンス
Linking API は、次のコネクタと設定をサポートしています。コネクタごとに、使用可能なデータソース パラメータのリストが提供されます。
BigQuery
BigQuery コネクタは、クエリするテーブルのテーブル ID を指定する TABLE クエリと、テーブルをクエリする SQL ステートメントを指定する CUSTOM_QUERY の 2 種類のクエリをサポートしています。
TABLE クエリ
type が TABLE に設定され、クエリを実行するテーブルの ID を指定する場合は、次のパラメータを使用できます。
| パラメータ名 | 説明 |
|---|---|
（省略可）BigQuery コネクタの場合は、bigQuery に設定します。設定すると、データソースが指定された BigQuery 構成に置き換えられます。置換と更新をご覧ください。 |
|
必須** クエリのタイプ。TABLE に設定します。 |
|
| 必須** クエリ対象のテーブルのプロジェクト ID。 | |
| 必須** クエリ対象のテーブルのデータセット ID。 | |
| 必須** クエリするテーブルのテーブル ID。 日付シャーディングされたテーブル: 日付シャーディングされたテーブルをクエリする場合、 *（ワイルドカード文字）または YYYYMMDD の接尾辞がサポートされます。テーブルが Google アナリティクス、Firebase Analytics、Firebase Crashlytics として識別された場合は、指定されない限り、デフォルトのフィールド テンプレートが選択されます。fields テンプレートの表に関連するパラメータをご覧ください。 |
|
（省略可）課金に使用するプロジェクトの ID。設定しない場合は、projectId が使用されます。 |
|
（省略可）テーブルがパーティション分割されていて、パーティショニング列を期間ディメンションとして使用する場合は、true に設定します。これは、時間ベースのパーティショニング（時間ベースのパーティショニング列や _PARTITIONTIME 疑似列の使用など）にのみ適用され、整数範囲パーティション分割テーブルでは機能しません。指定しない場合のデフォルトは false です。詳細については、
パーティション分割テーブルの概要をご覧ください。 |
|
（省略可）指定しない場合のデフォルトは true です。詳しくは、refreshFields をご覧ください。 |
Google アナリティクス、Firebase 向け Google アナリティクス、Crashlytics のフィールド テンプレート
Google アナリティクス、Firebase アナリティクス、Firebase Crashlytics として識別されるテーブルには、フィールド テンプレートを設定するための追加のパラメータを使用できます。指定しない場合は、デフォルトのテンプレートが選択されます。
| 名前 | 説明 |
|---|---|
（省略可）使用する Google アナリティクス フィールド テンプレート。Google アナリティクス テーブルの BigQuery エクスポートがクエリされている場合にのみ適用されます。ALL、SESSION、HITS のいずれか。Google アナリティクスのテーブルでは、指定しない場合のデフォルトは ALL です。 |
|
（省略可）使用する Firebase Analytics フィールド テンプレート。Firebase Analytics テーブルの BigQuery エクスポートがクエリされている場合にのみ適用されます。EVENTS にのみ設定できます。Firebase アナリティクスのテーブルでは、指定しない場合のデフォルトは EVENTS です。 |
|
使用する Firebase Crashlytics フィールド テンプレート。DEFAULT にのみ設定できます。Firebase Crashlytics テーブルの BigQuery エクスポートをクエリしている場合にのみ適用されます。Firebase Crashlytics テーブルの場合、指定しない場合のデフォルトは DEFAULT です。 |
カスタムクエリ
type が CUSTOM_QUERY に設定され、テーブルをクエリする SQL ステートメントを指定する場合は、次のパラメータを使用できます。
| パラメータ名 | 説明 |
|---|---|
（省略可）BigQuery コネクタの場合は、bigQuery に設定します。設定すると、データソースが指定された BigQuery 構成に置き換えられます。置換と更新をご覧ください。 |
|
必須** クエリのタイプ。CUSTOM_QUERY に設定します。 |
|
| 必須** 実行する SQL クエリ。 | |
（省略可）課金に使用するプロジェクトの ID。設定しない場合は、projectId が使用されます。projectId が設定されていない場合、クエリされたテーブルのプロジェクトが使用されます。 |
|
|
（省略可）SQL クエリに適用するパターン文字列と置換文字列のカンマ区切りのリスト。文字列の置換は、パターンが一致した場合にのみ適用されます。パターンと置換文字列のペアを区切るには、カンマを使用します。たとえば、 |
|
（省略可）指定しない場合のデフォルトは true です。詳しくは、refreshFields をご覧ください。 |
例
クエリがテーブル ID で定義された TABLE タイプの構成:
https://lookerstudio.google.com/reporting/create?
c.reportId=123abc
&ds.ds0.connector=bigQuery
&ds.ds0.type=TABLE
&ds.ds0.projectId=bigquery-public-data
&ds.ds0.datasetId=samples
&ds.ds0.tableId=shakespeare
&ds.ds0.billingProjectId=myProject
ワイルドカード文字の接尾辞を使用して日付シャーディング テーブルをクエリするための TABLE タイプの構成。
https://lookerstudio.google.com/reporting/create?
c.reportId=123abc
&ds.ds0.connector=bigQuery
&ds.ds0.type=TABLE
&ds.ds0.projectId=price-data
&ds.ds0.datasetId=samples
&ds.ds0.tableId=stock_*
YYYYMMDD サフィックスを使用して日付シャーディング テーブルをクエリするための TABLE タイプの構成。
https://lookerstudio.google.com/reporting/create?
c.reportId=123abc
&ds.ds0.connector=bigQuery
&ds.ds0.type=TABLE
&ds.ds0.projectId=price-data
&ds.ds0.datasetId=samples
&ds.ds0.tableId=stock_YYYYMMDD
SESSION フィールド テンプレートを使用して、Google アナリティクス テーブルの BigQuery Export をクエリするための TABLE 型の設定。
https://lookerstudio.google.com/reporting/create?
c.reportId=123abc
&ds.ds0.connector=bigQuery
&ds.ds0.type=TABLE
&ds.ds0.projectId=my-gabq-project
&ds.ds0.datasetId=1234567
&ds.ds0.tableId=ga_sessions_YYYYMMDD
&ds.ds0.gaTemplateLevel=SESSION
取り込み時間パーティション分割テーブルをクエリし、パーティショニング列を期間ディメンションとして使用するための TABLE タイプの構成。
https://lookerstudio.google.com/reporting/create?
c.reportId=123abc
&ds.ds0.connector=bigQuery
&ds.ds0.type=TABLE
&ds.ds0.projectId=acme-co-logs
&ds.ds0.datasetId=logs
&ds.ds0.tableId=logs_table
&ds.ds0.isPartitioned=true
クエリが SQL ステートメントで定義された CUSTOM_QUERY タイプの構成。
https://lookerstudio.google.com/reporting/create?
c.reportId=123abc
&ds.ds0.connector=bigQuery
&ds.ds0.type=CUSTOM_QUERY
&ds.ds0.projectId=bigquery-public-data
&ds.ds0.sql=SELECT%20word%2C%20word_count%20FROM%20%60bigquery-public-data.samples.shakespeare%60
&ds.ds0.billingProjectId=myProject
CUSTOM_QUERY タイプの構成では、SQL ステートメントのみが更新され、残りの構成にはテンプレート データソースが使用されます。
https://lookerstudio.google.com/reporting/create?
c.reportId=123abc
&ds.ds0.sql=SELECT%20corpus%20FROM%20%60bigquery-public-data.samples.shakespeare%60
sqlReplace を使用してテンプレート データソースの SQL ステートメントを更新する CUSTOM_QUERY タイプの構成。
https://lookerstudio.google.com/reporting/create?
c.reportId=123abc
&ds.ds0.sqlReplace=bigquery-public-data,new-project,samples,new-dataset
# The following shows a template query before and after sqlReplace is applied.
#
# Template data source custom query:
# SELECT word, word_count FROM big-query-public-data.samples.shakespeare
# INNER JOIN
# SELECT word, word_count FROM big-query-public-data.samples.raleigh
#
# New data source custom query with sqlReplace applied:
# SELECT word, word_count FROM new-project.new-dataset.shakespeare
# INNER JOIN
# SELECT word, word_count FROM new-project.new-dataset.raleigh
Cloud Spanner
| パラメータ名 | 説明 |
|---|---|
（省略可）Cloud Spanner コネクタの場合は、cloudSpanner に設定します。設定すると、データソースが指定された Cloud Spanner 構成に置き換えられます。置換と更新をご覧ください。 |
|
| 必須** プロジェクト ID。 | |
| 必須** インスタンス ID。 | |
| 必須** データベース ID。 | |
| 必須** 実行する SQL クエリ。 | |
（省略可）指定しない場合のデフォルトは true です。詳しくは、refreshFields をご覧ください。 |
例
SQL ステートメントを使用した Cloud Spanner 構成:
https://lookerstudio.google.com/reporting/create?
c.reportId=456def
&ds.ds1.connector=cloudSpanner
&ds.ds1.projectId=myProject
&ds.ds1.instanceId=production
&ds.ds1.datasetId=transactions
&ds.ds1.sql=SELECT%20accountId%2C%20date%2C%20revenue%20FROM%20sales%3B
コミュニティ コネクタ
| パラメータ名 | 説明 |
|---|---|
（省略可）コミュニティ コネクタの場合は、community に設定します。設定すると、データソースが指定されたコミュニティ コネクタの設定に置き換えられます。置換と更新をご覧ください。 |
|
必須** コミュニティ コネクタ connectorId（deploymentId とも呼ばれます）。 | |
| （省略可）コミュニティ コネクタの コネクタ設定で定義されているコネクタ固有の追加パラメータ。 | |
（省略可）指定しない場合のデフォルトは true です。詳しくは、refreshFields をご覧ください。 |
例
state と city の設定パラメータを使用してコミュニティ コネクタに接続します。
https://lookerstudio.google.com/reporting/create?
c.reportId=161718pqr
&ds.ds5.connector=community
&ds.ds5.connectorId=AqwqXxQshl94nJa0E0-1MsZXQL0DfCsJIMWk7dnx
&ds.ds5.state=CA
&ds.ds5.city=Sacramento
Google アナリティクス
| パラメータ名 | 説明 |
|---|---|
（省略可）Google アナリティクス コネクタを使用する場合は、googleAnalytics に設定します。設定すると、データソースが指定された Google アナリティクス設定に置き換えられます。置換と更新をご覧ください。 |
|
| 必須** アカウント ID。 | |
| 必須** プロパティ ID。 | |
| ビュー ID。 ユニバーサル アナリティクス プロパティの場合は必須**。 Google アナリティクス 4 プロパティには設定しないでください。 |
|
（省略可）指定しない場合のデフォルトは false です。詳しくは、refreshFields をご覧ください。 |
例
ユニバーサル アナリティクス プロパティを使用する場合の Google アナリティクス構成:
https://lookerstudio.google.com/reporting/create?
c.reportId=789ghi
&ds.ds2.connector=googleAnalytics
&ds.ds2.accountId=54516992
&ds.ds2.propertyId=UA-54516992-1
&ds.ds2.viewId=92320289
Google アナリティクス 4 プロパティを使用する場合の Google アナリティクス構成:
https://lookerstudio.google.com/reporting/create?
c.reportId=789ghi
&ds.ds2.connector=googleAnalytics
&ds.ds2.accountId=54516992
&ds.ds2.propertyId=213025502
Google Cloud Storage
| パラメータ名 | 説明 |
|---|---|
（省略可）googleCloudStorage[Google Cloud Storage コネクタ] に設定します。設定すると、データソースが指定された Google Cloud Storage 構成に置き換えられます。置換と更新をご覧ください。 |
|
必須** パスのタイプ。単一のファイルを選択するには FILE を使用し、指定したパスのすべてのファイルを選択するには FOLDER を使用します。 |
|
必須** pathType が FILE の場合はファイルパス（例: MyBucket/MyData/MyFile.csv）、pathType が FOLDER の場合はフォルダパス（例: *MyBucket/MyData）。 |
|
（省略可）指定しない場合のデフォルトは true です。詳しくは、refreshFields をご覧ください。 |
例
単一ファイルを選択した場合の Google Cloud Storage 構成:
https://lookerstudio.google.com/reporting/create?
c.reportId=231908kpf
&ds.ds50.connector=googleCloudStorage
&ds.ds50.pathType=FILE
&ds.ds50.path=MyBucket%2FMyData%2FMyFile.csv
パス内のすべてのファイルを選択した場合の Google Cloud Storage 構成:
https://lookerstudio.google.com/reporting/create?
c.reportId=231908kpf
&ds.ds50.connector=googleCloudStorage
&ds.ds50.pathType=FOLDER
&ds.ds50.path=MyBucket%2FMyData
Google スプレッドシート
| パラメータ名 | 説明 |
|---|---|
（省略可）Google スプレッドシート コネクタを使用する場合は、googleSheets に設定します。設定すると、データソースが指定された Google スプレッドシートの構成に置き換えられます。置換と更新をご覧ください。 |
|
| 必須** スプレッドシートの ID。 | |
| 必須** ワークシート ID。 | |
（省略可）最初の行をヘッダーとして使用するには、true に設定します。指定しない場合のデフォルトは true です。列ヘッダーは一意である必要があります。ヘッダーが空の列は、データソースに追加されません。
|
|
（省略可）非表示のセルを含めるには true に設定します。
指定しない場合のデフォルトは true です。 |
|
（省略可）フィルタ処理されたセルを含めるには、true に設定します。
指定しない場合のデフォルトは true です。 |
|
| （省略可）範囲（例: A1:B52）。 | |
（省略可）指定しない場合のデフォルトは true です。詳しくは、refreshFields をご覧ください。 |
例
Google スプレッドシート構成:
https://lookerstudio.google.com/reporting/create?
c.reportId=101112jkl
&ds.ds3.connector=googleSheets
&ds.ds3.spreadsheetId=1Qs8BdfxZXALh6vX4zrE7ZyGnR3h5k
&ds.ds3.worksheetId=903806437
最初の行をヘッダーとして使用し、非表示のセルとフィルタ処理されたセルを含む Google スプレッドシート構成
https://lookerstudio.google.com/reporting/create?
c.reportId=101112jkl
&ds.ds3.connector=googleSheets
&ds.ds3.spreadsheetId=1Qs8BdfxZXALh6vX4zrE7ZyGnR3h5k
&ds.ds3.worksheetId=903806437
&ds.ds3.hasHeader=true
&ds.ds3.includeHiddenCells=true
&ds.ds3.includeFilteredCells=true
範囲（A1:D20）の Google スプレッドシート構成:
https://lookerstudio.google.com/reporting/create?
c.reportId=101112jkl
&ds.ds3.connector=googleSheets
&ds.ds3.spreadsheetId=1Qs8BdfxZXALh6vX4zrE7ZyGnR3h5k
&ds.ds3.worksheetId=903806437
&ds.ds3.range=A1%3AD20
Looker
| パラメータ名 | 説明 |
|---|---|
（省略可）
Looker コネクタの場合は、looker に設定します。設定すると、データソースが指定された Looker 構成に置き換えられます。置換と更新をご覧ください。 |
|
| 必須** Looker インスタンスの URL。 | |
| 必須** Looker モデル。 | |
| 必須** Looker Explore。 | |
（省略可）指定しない場合のデフォルトは false です。詳しくは、refreshFields をご覧ください。 |
例
Looker Explore に接続します。
https://lookerstudio.google.com/reporting/create?
c.reportId=161718pqr
&ds.ds5.connector=looker
&ds.ds5.instanceUrl=my.looker.com
&ds.ds5.model=thelook
&ds.ds5.explore=orders
Search Console
| パラメータ名 | 説明 |
|---|---|
（省略可）Search Console コネクタの場合は、searchConsole に設定します。設定すると、データソースが指定された Search Console 設定に置き換えられます。置換と更新をご覧ください。 |
|
必須** サイトの URL。ドメイン プロパティの場合は、接頭辞 sc-domain\: を付けます。 |
|
必須** テーブルタイプを設定します。SITE_IMPRESSION または URL_IMPRESSION のいずれかになります。 |
|
必須** 検索タイプを設定します。WEB、IMAGE、VIDEO、NEWS のいずれかになります。 |
|
（省略可）指定しない場合のデフォルトは false です。詳しくは、refreshFields をご覧ください。 |
例
URL プレフィックス プロパティを使用した場合の Search Console 構成:
https://lookerstudio.google.com/reporting/create?
c.reportId=161718pqr
&ds.ds5.connector=searchConsole
&ds.ds5.siteUrl=https%3A%2F%2Fwww.example.com%2Fwelcome
&ds.ds5.tableType=SITE_IMPRESSION
&ds.ds5.searchType=WEB
ドメイン プロパティを使用した場合の Search Console 構成:
https://lookerstudio.google.com/reporting/create?
c.reportId=161718pqr
ds.ds5.connector=searchConsole
&ds.ds5.siteUrl=sc-domain%3Aexample.com
&ds.ds5.tableType=SITE_IMPRESSION
&ds.ds5.searchType=WEB
テンプレートの権限
優れたユーザー エクスペリエンスを実現するには、テンプレート レポートと関連データソースのレポートのアクセス権限を正しく設定することが重要です。必要な権限は、レポート テンプレートで埋め込みデータソースと再利用可能なデータソースのどちらを使用しているか、また Linking API 設定がデータソース設定の置換または更新に設定されているかによって異なります。
次の表に、テンプレートのデータソースと Linking API の設定に基づいて、最適なユーザー エクスペリエンスを実現するために推奨されるデータソースへのアクセスを示します。
| データソースのタイプ | データソースのリンク API 設定 | データソースの権限に関する推奨事項 | 注 |
|---|---|---|---|
| Embedded | 次のように置き換えます。 | 該当なし - 閲覧権限はレポートから継承されます。 | テンプレート レポートの閲覧権限を持つユーザーは、埋め込まれているデータソースの閲覧権限も自動的に付与されます。 |
| Embedded | 更新 | 該当なし - 閲覧権限はレポートから継承されます。 | テンプレート レポートの閲覧権限を持つユーザーは、埋め込まれているデータソースの閲覧権限も自動的に付与されます。 |
| 再利用可能 | 次のように置き換えます。 | ユーザーに閲覧権限は必要ありません。 | データソースの設定全体が Linking API によって置き換えられるため、表示アクセス権は必要ありません。 |
| 再利用可能 | 更新 | ユーザーに閲覧権限が必要です。 | Linking API がテンプレート データソースから設定を読み取り、使用できるようにするには、データソースへの表示アクセス権が必要です。ユーザーに閲覧権限がない場合、レポートの読み込み時にエラーが発生します。 |
空白のレポートやデフォルトのレポートを使用する
空白のレポートまたはデフォルトのレポートを使用するには、Linking API を次のように設定します。
| レポートタイプ | reportId コントロール パラメータを設定する |
データソース（ |
注 |
|---|---|---|---|
| 空のレポート | × | × | |
| デフォルトのレポート | × | はい | デフォルトのレポートは Looker Studio から提供されます。 デフォルト レポートにはデータソースが 1 つ埋め込まれているため、デフォルト レポートのデータソース パラメータを指定するときに、データソース エイリアスを使用する必要はありません。 |
次の例は、空白のレポートまたはデフォルトのレポートを使用する Linking API の URL を示しています。
空のレポートからレポートの作成ワークフローを開始します。
https://lookerstudio.google.com/reporting/create
空白のレポートでレポート作成ワークフローを開始し、レポート名を設定します。
https://lookerstudio.google.com/reporting/create?r.reportName=MyNewReport
Google スプレッドシートのコネクタ設定でデフォルトのレポート テンプレートを使用します。
https://lookerstudio.google.com/reporting/create?
ds.connector=googleSheets
&ds.spreadsheetId=1Q-w7KeeJj1jk3wFcFm4NsPlppNscs0CtHf_EP9fsYOo
&ds.worksheetId=0
レポートを埋め込む
Linking API で作成されたレポートを埋め込むには、URL パラメータを設定して、/embed/ パスを指定します。Linking API の埋め込み URL は次の形式にする必要があります。
https://lookerstudio.google.com/embed/reporting/create?parameters
ID とエイリアスを検索する
レポート ID
レポート ID を確認するには:
- テンプレートとして使用するレポートを開きます。レポートの URL を検査します。
reporting/と/pageの間の部分がレポート ID です。たとえば、次の URL の場合は0B_U5RNpwhcE6SF85TENURnc4UjAがレポート ID です。
https://lookerstudio.google.com/reporting/0B_U5RNpwhcE6SF85TENURnc4UjA/page/1M
![Looker Studio レポートの URL が表示されているブラウザのアドレスバー。[レポート ID] がハイライト表示されています。](https://developers.google.com/static/looker-studio/integrate/images/reportId-parameter.png?hl=ja)
データソースのエイリアス
レポートには複数のデータソースを含めることができます。データソースは、そのエイリアスで参照される必要があります。
データソースのエイリアスを確認するには:
- レポートを編集します。
- ツールバーで [リソース] > [追加済みのデータソースの管理] を選択します。
- [エイリアス] 列で、各データソースのエイリアス情報を確認します。
エイリアス名を編集して、データソースが追加または削除されたときの下位互換性を確保できます。
![データソースのリソース管理ページにおけるデータソースのリスト。
[Alias] 列がハイライト表示されています。](https://developers.google.com/static/looker-studio/integrate/images/data-source-alias.png?hl=ja)
コネクタの種類
レポートには、それぞれコネクタを設定して作成されたデータソースを含めることができます。データソースの作成に使用されるコネクタの種類を確認するには:
- レポートを編集します。
- ツールバーで [リソース] > [追加済みのデータソースの管理] を選択します。
- [コネクタの種類] 列を調べて、データソースの作成に使用されたコネクタを確認します。
![データソースのリソース管理ページにおけるデータソースのリスト。
[コネクタの種類] 列がハイライト表示されています。](https://developers.google.com/static/looker-studio/integrate/images/data-source-connector.png?hl=ja)
ヒントとトラブルシューティング
問題が発生した場合は、潜在的な問題と一般的な構成ミスを特定するために以下の詳細を確認してください。
デバッグ ダイアログ
デバッグ ダイアログを使用して、Looker Studio によって解釈された Linking API の設定を確認します。API に関する問題のデバッグに役立ちます。
- Linking API の URL の解析中にエラーが発生した場合は、エラーの詳細を示すダイアログが自動的に表示されます。
- エラーが発生し、ダイアログが自動的に表示されない場合は、レポートの右上にある [情報] ボタンを探します。クリックすると、追加のデバッグ情報が表示されます。
- 使用できる情報ボタンがない場合は、Linking API URL の末尾に
&c.explain=trueパラメータを追加して、ボタンを有効にできます。
権限
データソース タイプと Linking API の設定に対して、適切なテンプレート権限が設定されていることを確認してください。詳しくは、テンプレートの権限をご覧ください。
更新と置換
データソース テンプレートからデータソース設定を更新する場合は、テンプレートのデータソース設定と Linking API の設定に互換性があることを確認します。新しい構成から生成されるフィールドが、レポート コンポーネントおよび構成と互換性があることを確認します。
更新または置換を行う場合、無効な構成が未定義の動作で設定されることがあります。詳しくは、置換と更新をご覧ください。
フィールドを更新
テンプレート データソースにフィールド名、型、集計を設定している場合、ds.refreshFields パラメータが false に設定されている場合のみ、これらの変更は Linking API の設定データソースに引き継がれます。
Linking API の URL の ds.refreshFields データソース パラメータを確認します。省略した場合は、各コネクタタイプのパラメータのデフォルト値が、ユースケースに適していることを確認します。
一般に、テンプレートのデータソースでフィールドを構成していて、Linking API を介した新しいデータソース構成で常にまったく同じフィールドが生成されることが確実な場合は、refreshFields を false に設定することをおすすめします。
たとえば、レポート テンプレートの作成中に、Looker Studio が特定のデータソース フィールドを Number タイプとして識別し、それを Year タイプに変更すると、このフィールド構成の変更はテンプレートのデータソースの一部になります。修正後のフィールドを使用するレポート テンプレート内のグラフには、Year が想定されます。グラフが時間ベースの場合は、これ以外の値が表示されないことがあります。Linking API を使用して、まったく同じフィールドを生成する新しいデータソース構成を提供する場合、refreshFields パラメータの値に応じて 2 つの結果があります。
trueに設定すると、テンプレート データソースのフィールド構成は引き継がれません。また、グラフが同じフィールド構成（Year タイプのフィールドが想定されているなど）に依存している場合、グラフの読み込みが失敗する可能性があります。falseに設定すると、テンプレート データソースのフィールド構成が新しいデータソースとレポートグラフに引き継がれ、同じ構成の同じフィールドを受け取り、正常に読み込まれます。
フィードバックとサポート
Issue Tracker を使用して、Linking API の問題を報告したり、フィードバックを提供したりできます。サポートの利用と質問に関する一般的なリソースについては、サポートをご覧ください。
変更履歴
2023-06-06
- Google アナリティクスの測定 ID レポート設定を指定するための
r.measurementIdおよびr.keepMeasurementIdレポート パラメータを追加しました。 - テンプレート データソース名の再利用を制御する
ds.keepDatasourceNameを追加しました。 - 「レポートの埋め込み」セクションを追加しました。
- BigQuery コネクタ
sqlReplaceを追加しました。パターンと置換文字列を指定して、テンプレート データソースの SQL クエリを更新できます。
2023-05-22
- Looker コネクタのサポートが追加されました。
- コミュニティ コネクタがサポートされるようになりました。
2022-11-21
- 空白のレポートを使用する機能が追加されました。空白のレポートまたはデフォルトのレポートを使用するをご覧ください。
- ヒントとトラブルシューティングに
refreshFieldsセクションを追加しました。
2022-11-14
- Google サーベイのサポート終了に伴い、サーベイ コネクタのリファレンスは削除されました。
2022-06-15
- ベータ版の終了
- Integration API の名前が Linking API に変更されました。
- Linking API はベータ版から正式版に移行しました。
- 特定のレポートページにリンクできるように、
pageIdコントロール パラメータを追加しました。 - 読み込み時にレポートの状態を [表示] モードまたは [編集] モードに設定するための
modeコントロール パラメータを追加しました。 - データソース構成の全体または一部更新が可能になりました。この動作は、
ds.connectorパラメータが設定されているかどうかによって決まります。詳しくは、置換と更新をご覧ください。 c.reportIdパラメータを使用してレポート テンプレートが指定されていない場合、デフォルト テンプレートが使用されるようになりました。ds.refreshFieldsデータソース パラメータを追加しました。これにより、データソース構成を読み込む際にデータソース フィールドを更新するかどうかを制御できます。- BigQuery コネクタ
typeがCUSTOM_QUERYに設定されている場合、projectIdは不要です。billingProjectIdが設定されていない場合、課金プロジェクトはprojectIdまたはクエリされたテーブルのプロジェクトにフォールバックします。- 日付パーティション分割テーブルのサポートを追加しました。パーティション フィールドを期間ディメンションとして使用するには、
isPartitionedパラメータをtrueに設定します。 - ワイルドカード文字または
YYYYMMDDテーブル サフィックスを使用して日付パーティション分割テーブルをクエリするためのサポートを追加しました。 - Google アナリティクス、Firebase アナリティクス、Crashlytics のテーブルに対するクエリの実行と、フィールド テンプレートの選択のサポートを追加しました。
- Google スプレッドシート
- ウェブ UI のデフォルトと整合する
hasHeaderのデフォルトはtrueです。 includeHiddenAndFilteredCellをincludeHiddenCellsとincludeFilteredCells。ウェブ UI のデフォルトと整合するように、どちらもデフォルトはtrueになりました。
- ウェブ UI のデフォルトと整合する
- Search Console コネクタ
propertyTypeパラメータの名前をsearchTypeに変更しました。
- サーベイ コネクタ
surveyIdで、単一のアンケート ID またはアンケート ID のカンマ区切りのリストが受け入れられるようになりました。
2021-12-16
- Integration API の初版リリース。
- 既存のレポートへのリンクとレポート名の設定がサポートされました。
- 複数のデータソースの構成と各データソース名の設定が可能になりました。
- 次のコネクタの種類がサポートされました: BigQuery、Cloud Spanner、Google アナリティクス、Google Cloud Storage、Google スプレッドシート、Google サーベイ、Search Console。