はじめに
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
パラメータには、必須パラメータと省略可能なパラメータがあります。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 で指定する必要があります。また、テンプレートのデータソース構成は完全に置き換えられます。 指定しない場合、コネクタ タイプの 0 個以上の コネクタ パラメータを Linking API URL で指定できます。テンプレートのデータソース構成は、Linking API の URL で指定されていないパラメータを指定するために使用されます。テンプレート データソースのコネクタの種類を特定する方法について詳しくは、コネクタの種類をご覧ください。
|
|
|
省略可。
Linking API で指定されたデータソース構成を使用して、データソースのフィールドを更新し、新しいフィールド選択でレポート コンポーネントを更新するには、 テンプレート レポートのデータソース フィールドを変更しない場合は、 指定しない場合、デフォルトはコネクタのタイプによって異なります。デフォルトの動作をオーバーライドする場合は、コネクタ固有のデフォルトについてコネクタ リファレンスを確認してください。 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 コネクタは、2 種類のクエリ（クエリするテーブルのテーブル ID を指定する TABLE クエリと、テーブルをクエリする SQL ステートメントを指定する CUSTOM_QUERY）をサポートしています。
TABLE クエリ
次のパラメータは、type が TABLE に設定され、クエリするテーブルの ID を指定した場合に適用されます。
| パラメータ名 | 説明 |
|---|---|
省略可。BigQuery コネクタの場合は、bigQuery に設定します。設定されている場合、指定された BigQuery 構成でデータソースを置き換えます。交換と更新を参照してください。 |
|
必須** クエリのタイプ。TABLE に設定します。 |
|
| 必須** クエリを実行するテーブルのプロジェクト ID。 | |
| 必須** クエリを実行するテーブルのデータセット ID。 | |
| 必須** クエリするテーブルのテーブル ID。 日付でシャーディングされたテーブル: 日付でシャーディングされたテーブルをクエリするときは、 *（ワイルドカード文字）または YYYYMMDD 接尾辞がサポートされます。テーブルが Google アナリティクス、Firebase アナリティクス、Firebase Crashlytics として識別された場合、指定されていない限り、デフォルトのフィールド テンプレートが選択されます。フィールド テンプレートの表に関連するパラメータをご覧ください。 |
|
省略可。請求に使用するプロジェクトの ID。設定しない場合、projectId が使用されます。 |
|
省略可。テーブルがパーティション分割されていて、パーティショニング列を期間ディメンションとして使用する場合は、true に設定します。これは、時間ベースのパーティショニング（時間ベースのパーティショニング列または _PARTITIONTIME 疑似列の使用など）にのみ適用され、整数範囲パーティション分割テーブルでは機能しません。指定しない場合のデフォルトは false です。詳細については、
パーティション分割テーブルの概要をご覧ください。 |
|
省略可。指定しない場合のデフォルトは true です。詳しくは、refreshFields をご覧ください。 |
Google アナリティクス、Firebase アナリティクス、Crashlytics のフィールド テンプレート
Google アナリティクス、Firebase アナリティクス、Firebase Crashlytics として識別されたテーブルでは、フィールド テンプレートを設定するための追加のパラメータを使用できます。指定しない場合は、デフォルトのテンプレートが選択されます。
| 名前 | 説明 |
|---|---|
省略可。使用する Google アナリティクスのフィールド テンプレート。Google アナリティクスの BigQuery Export テーブルがクエリされている場合にのみ適用されます。ALL、SESSION、HITS のいずれか。Google アナリティクス テーブルの場合、指定しない場合のデフォルトは ALL です。 |
|
省略可。使用する Firebase アナリティクス フィールド テンプレート。Firebase アナリティクス テーブルの BigQuery Export がクエリされている場合にのみ適用されます。EVENTS にのみ設定できます。Firebase アナリティクス テーブルの場合、指定しない場合のデフォルトは EVENTS です。 |
|
使用する Firebase Crashlytics フィールド テンプレート。DEFAULT にのみ設定できます。Firebase Crashlytics テーブルの BigQuery エクスポートがクエリされている場合にのみ適用されます。Firebase Crashlytics テーブルの場合、指定しない場合のデフォルトは DEFAULT です。 |
CUSTOM クエリ
次のパラメータは、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
SQL ステートメントのみが更新され、残りの構成にテンプレート データソースが使用される CUSTOM_QUERY タイプの構成。
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
| パラメータ名 | 説明 |
|---|---|
省略可。Google Cloud Storage コネクタの場合は googleCloudStorage に設定します。設定されている場合、データソースが指定された 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 の構成に基づいて、最適なユーザー エクスペリエンスを実現するためにおすすめのデータソース アクセスを示します。
| データソースのタイプ | データソースの Linking API 構成 | データソースの権限に関する推奨事項 | メモ |
|---|---|---|---|
| エンベディング | 次のように置き換えます。 | 該当なし - 閲覧権限はレポートから継承されます。 | ユーザーがテンプレート レポートの閲覧権限を持っている場合、埋め込みデータソースの閲覧権限も自動的に付与されます。 |
| エンベディング | 更新 | 該当なし - 閲覧権限はレポートから継承されます。 | ユーザーがテンプレート レポートの閲覧権限を持っている場合、埋め込みデータソースの閲覧権限も自動的に付与されます。 |
| 再利用可能 | 次のように置き換えます。 | ユーザーに閲覧権限は必要ありません。 | データソースの構成は 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?authuser=3&hl=ja)
データソースのエイリアス
レポートには複数のデータソースを含めることができます。データソースは、そのエイリアスで参照される必要があります。
データソースのエイリアスを確認するには:
- レポートを編集します。
- ツールバーで [リソース] > [追加済みのデータソースの管理] を選択します。
- [エイリアス] 列で、各データソースのエイリアス情報を確認します。
エイリアス名を編集して、データソースが追加または削除されたときの下位互換性を確保できます。
![データソースのリソース管理ページにおけるデータソースのリスト。
[Alias] 列がハイライト表示されています。](https://developers.google.com/static/looker-studio/integrate/images/data-source-alias.png?authuser=3&hl=ja)
コネクタの種類
レポートには、それぞれコネクタを設定して作成されたデータソースを含めることができます。データソースの作成に使用されるコネクタの種類を確認するには:
- レポートを編集します。
- ツールバーで [リソース] > [追加済みのデータソースの管理] を選択します。
- [コネクタの種類] 列を調べて、データソースの作成に使用されたコネクタを確認します。
![データソースのリソース管理ページにおけるデータソースのリスト。
[コネクタの種類] 列がハイライト表示されています。](https://developers.google.com/static/looker-studio/integrate/images/data-source-connector.png?authuser=3&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 が特定のデータソース フィールドを 数値型として識別し、それを 年型に変更した場合、このフィールド構成の変更はテンプレート データソースの一部になります。修正されたフィールドを使用するレポート テンプレート内のグラフでは、年が想定されます。グラフが時間ベースの場合、それ以外ではレンダリングされない可能性があります。Linking API を使用して、まったく同じフィールドを生成する新しいデータソース構成を指定した場合、refreshFields パラメータの値に応じて 2 つの結果が生じます。
trueに設定すると、テンプレート データソースのフィールド構成は引き継がれません。同じフィールド構成（年型のフィールドなど）に依存しているグラフは、読み込みに失敗する可能性があります。falseに設定すると、テンプレートのデータソースのフィールド構成が新しいデータソースに引き継がれ、レポートのグラフには同じ構成の同じフィールドが渡されて、正常に読み込まれます。
フィードバックとサポート
Linking API の問題を報告したり、フィードバックを提供したりする場合は、Issue Tracker を使用します。ヘルプの利用と質問に関する一般的なリソースについては、サポートをご覧ください。
変更履歴
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 スプレッドシート
hasHeaderのデフォルトはtrueで、ウェブ UI のデフォルトと一致しています。includeHiddenAndFilteredCellがincludeHiddenCellsに分割includeFilteredCells。どちらもデフォルトで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。