簡介
Links API 提供可靠的介面，讓使用者透過網址進行設定並直接轉送到 Looker Studio 報表。當使用者點選 Links API 網址時，即可享有簡化的體驗，方便他們快速查看資料並與其互動。
本文件將說明 Links API 網址的必要格式以及可用的參數。
應用實例和優點
Links API 可用來提供預先設定的報表，讓客戶能查看他們的資料並進行互動。Links API 的主要優點如下：
- 為客戶提供一鍵建立報表體驗。
- 網址中會提供資料設定，因此使用者不需要為自己的資料設定報表。
- 使用者只要按一下即可儲存報表，且能隨時重返報表。
- 大規模製作報表。Links API 可縮短複製或建立新報表所需的時間。
- 啟用產品整合功能。穩定介面可讓您將 Looker Studio 整合至產品工作流程。
運作方式
以下將說明開發人員和使用者如何與 Links API 互動。
連結 API 開發人員工作流程
開發人員準備範本報表、資料來源，並設定 Links API 網址的格式。開發人員的一般工作流程如下：
- 決定要使用空白報表、Looker Studio 提供的預設報表範本，或是建立要做為範本的 Looker Studio 報表。包括設定範本資料來源。
- 根據特定用途設定 Links API 網址格式。在適用情況下，請指定報表範本和其他參數，包括報表名稱、資料來源名稱和資料來源設定。
- 使用 Links API 網址來引導使用者前往報表。
Link API 使用者體驗
使用者追蹤 Links API 網址後，如果開發人員正確設定網址，就會導向 Looker Studio 報表，讓他們能查看自己有權存取的資料並進行互動。常見的使用者體驗可能如下：
- 使用者在瀏覽器中造訪已與 Links API 整合的服務。
- 行動號召可邀請使用者點選連結，查看自己在 Looker Studio 中的資料。
- 使用者點選連結，然後前往 Looker Studio 報表。系統會載入報表，而使用者可以查看自己的資料並進行互動。
- 使用者按一下「編輯並分享」，報表會儲存到其 Looker Studio 帳戶。
- 使用者現在可以完整存取並控管自己的報表副本。而且隨時可以查看、編輯及分享內容。
需求條件
為確保 Links API 網址正常運作，必須符合下列規定：
- 報表 (做為範本)如未提供，您可以使用 Looker Studio 提供的空白報表或預設報表。
- 連結 API 網址的使用者至少必須擁有範本報表的檢視權限。視報表使用的資料來源類型和透過 Links API 提供的設定而定，使用者可能需要資料來源的檢視權限。詳情請參閱「範本權限」一文。
- 每個資料來源的連接器類型都必須透過連結 API 支援設定。如需支援的連接器清單，請參閱連接器參考資料。
- Links API 網址的使用者必須具備 Linking API 網址設定資料的存取權限。如果使用者無法存取基礎資料，任何相依報表元件都會顯示錯誤。
網址參數
Links API 網址必須採用以下格式：
https://lookerstudio.google.com/reporting/create?parameters
該網址應用於網路瀏覽器中，通常用於使用者按下連結或重新導向至網址。也可用來嵌入報表。
範例網址
以下是 Links API 網址範例。已設定報表名稱，且設定一個 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
有些網址參數是必要參數，有些則是自選參數。以下是用於定義 Links API 網址的參數清單：
控制參數
透過 Links API 網址查看報表時，控制參數可決定報表的狀態。
| 參數名稱 | 說明 |
|---|---|
| (選填) 範本報表 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 Analytics (分析) 評估 ID 設為評估報表用量。請使用半形逗號分隔多個 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，請參閱「資料來源別名」。
資料來源參數
下列參數適用於所有連接器類型：
| 名稱 | 說明 |
|---|---|
|
(選填) 設定資料來源的名稱。 如果未指定 |
|
|
(選填) 如要使用範本資料來源名稱，請設為 如果未指定 |
|
|
選用。 資料來源的連接器類型。如要進一步瞭解支援的連接器類型，請參閱連接器參考資料。 如果設定了這個值，就必須在 Links API 網址中指定連接器類型的所有必要 連接器參數，而且範本資料來源設定會完全取代。 如果未指定，您可以在 Links API 網址中指定零或多個連接器類型的 連接器參數。範本資料來源設定會用來指定在 Links API 網址中提供的任何參數。如要進一步瞭解如何識別範本資料來源的連接器類型，請參閱「連接器類型」。 如要進一步瞭解 |
|
|
選用。 設為 設為 如果未指定，預設值會因連接器類型而異。如要覆寫預設行為，請參閱連接器參考資料瞭解連接器專屬預設值。 使用
refreshFields 的注意事項： |
|
| 必備。連接器類型的資料來源設定。如要進一步瞭解如何辨識用來建立資料來源的連接器，請參閱「連接器類型」。如要進一步瞭解各個連接器類型可用的資料來源參數，請參閱連接器參考資料。 |
取代與更新 - 資料來源設定
設定資料來源參數時，Link API 網址中 ds.connector 參數存在或省略，表示想要分別替換或更新範本資料來源設定。
下表詳細說明 ds.connector 參數如何影響範本資料來源設定的完整取代功能，還是用於更新未指定的參數：
是否已設定「ds.connector」？ |
預期的設定和行為 | 常見用途 |
|---|---|---|
| 是 |
取代：使用 Links API 網址中指定的資料來源參數，完全取代範本資料來源設定。您必須為連接器類型指定所有必要參數。請參閱「設定 ds.connector 時的必要參數」一節。 |
|
| 否 | 更新：範本資料來源設定會用來指定在 Links API 網址中提供的任何參數。除非另有說明，否則連接器類型的所有連接器參數均為選用參數。 此做法可簡化 Links API 網址。如果您已熟悉範本資料來源設定，而且只想覆寫一部分的參數，則通常建議使用此設定。 |
|
已設定 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
如果報表只有單一資料來源，則可省略資料來源別名。 上述網址可簡化為：
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 Analytics (分析) 資料來源 (ds1)。BigQuery 資料來源設定已完全取代，Google Analytics (分析) 設定會更新單一參數，並使用 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
建立與新增
在多個報表中擁有相同資料來源有時有幫助，因此資料來源的更新會同時影響所有報表。使用 Links API 建立報表時，您可以確認符合下列所有條件，藉此從範本報表中重新新增資料來源：
- 這個資料來源可重複使用 (請參閱內嵌與可重複使用的資料來源)
- 網址未依別名參照資料來源
- 網址並未使用萬用字元別名 (請參閱資料來源別名萬用字元一節)
透過 Links API 建立新的資料來源時，該來源會使用點選網址的使用者憑證。這表示使用者必須具備基礎資料的存取權，否則連線會無法運作。將資料來源重新加進新產生的報表，您可以保留其憑證，讓使用者能繼續在新報表中存取資料。
資料來源別名萬用字元
如要將 Links API 參數套用至多個資料來源，您可以使用萬用字元別名 ds.* 取代資料來源別名。
想要從網址中移除重複的參數時，這個功能就能派上用場。舉例來說，如果您的範本已附加三個 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.* 萬用字元，您可以使用以下對等網址：
https://lookerstudio.google.com/reporting/create?
c.reportId=7890
&ds.*.projectId=client-project
&ds.*.datasetId=client-dataset
如果提供給 Links API 的參數未使用 ds.* 萬用字元，系統會優先採用該參數。在上述範例中，您可以新增特定資料來源別名來覆寫萬用字元的值。
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，則會從範本資料來源衍生的值 (請參閱取代與更新一節)
- 參數的預設值 (選用)。
連接器參照
Links API 支援下列連接器和設定。系統會針對每個連接器，提供可用的資料來源參數清單。
BigQuery
BigQuery 連接器支援兩種查詢：TABLE 查詢，您可以在其中提供要查詢的資料表 ID 及 CUSTOM_QUERY (提供 SQL 陳述式以查詢資料表)。
TABLE 查詢
如果 type 設為 TABLE，且您提供要查詢的資料表 ID，就適用下列參數。
| 參數名稱 | 說明 |
|---|---|
(選填) 請將 BigQuery 連接器設為 bigQuery。如已設定，請將資料來源替換為提供的 BigQuery 設定。請參閱「取代與更新」一文。 |
|
必要** 查詢類型。請設為 TABLE。 |
|
| 必要** 要查詢的資料表的專案 ID。 | |
| 必要** 要查詢的資料表所屬的資料集 ID。 | |
| 必要** 要查詢的資料表 ID。 日期資料分割資料表： 查詢日期資料分割資料表時支援 * (萬用字元) 或 YYYYMMDD 後置字串。如果表格經識別為 Google Analytics (分析)、Firebase Analytics 或 Firebase Crashlytics，系統會選取預設欄位範本。請參閱欄位範本資料表的相關參數。 |
|
(選填) 用於計費的專案 ID。如未設定，系統會使用 projectId。 |
|
(選填) 如果資料表已分區，且您想使用分區資料欄做為日期範圍維度，請設為 true。這僅適用於時間分區 (例如使用以時間為準的分區資料欄或 _PARTITIONTIME 虛擬資料欄)，且不適用於整數範圍分區資料表。如未指定，則預設值為 false。詳情請參閱
分區資料表簡介一文。 |
|
(選填) 如未指定，則預設值為 true。詳情請參閱 refreshFields。 |
Google Analytics (分析)、Firebase Analytics 和 Crashlytics 的欄位範本
對於識別為 Google Analytics (分析)、Firebase Analytics 或 Firebase Crashlytics 的資料表，您可以使用其他參數設定欄位範本。如未指定，系統會選取預設範本。
| 名稱 | 說明 |
|---|---|
(選填) 要使用的 Google Analytics (分析) 欄位範本。僅適用於查詢 Google Analytics (分析) 資料表的 BigQuery Export 作業。必須為 ALL、SESSION 或 HITS 其中之一。以 Google Analytics (分析) 資料表來說，如果未指定，則預設為 ALL。 |
|
(選填) 要使用的 Firebase Analytics 欄位範本。僅適用於查詢 BigQuery Export for Firebase Analytics 資料表的情況。只能設為「EVENTS」。以 Firebase Analytics 資料表來說，如未指定，則預設為 EVENTS。 |
|
要使用的 Firebase Crashlytics 欄位範本。只能設為 DEFAULT。僅適用於正在查詢 BigQuery Export for Firebase Crashlytics 資料表的情況。如為 Firebase Crashlytics 資料表，如未指定，則預設為 DEFAULT。 |
自訂查詢
如果 type 設為 CUSTOM_QUERY，且您提供 SQL 陳述式查詢資料表，就可使用下列參數。
| 參數名稱 | 說明 |
|---|---|
(選填) 請將 BigQuery 連接器設為 bigQuery。如已設定，請將資料來源替換為提供的 BigQuery 設定。請參閱「取代與更新」一文。 |
|
必要** 查詢類型。請設為 CUSTOM_QUERY。 |
|
| 必要** 要執行的 SQL 查詢。 | |
(選填) 用於計費的專案 ID。如未設定，系統會使用 projectId。如未設定 projectId，系統會使用查詢資料表的專案。 |
|
|
(選填) 要套用至 SQL 查詢的模式和替代字串清單 (以半形逗號分隔)。只有在有模式相符時，系統才會套用字串替換項目。並使用半形逗號分隔模式和替代字串組合。例如 |
|
(選填) 如未指定，則預設值為 true。詳情請參閱 refreshFields。 |
例子
TABLE 類型設定，其中查詢是以資料表 ID 定義：
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_*
TABLE 類型設定，可使用 YYYYMMDD 後置字串查詢日期資料分割資料表：
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 欄位範本查詢 BigQuery Export 至 Google Analytics (分析) 資料表的 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
CUSTOM_QUERY 類型設定，使用 SQL 陳述式定義查詢：
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
CUSTOM_QUERY 類型設定，其中範本資料來源的 SQL 陳述式會使用 sqlReplace 更新：
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。如有設定，請以提供的社群連接器設定取代資料來源。請參閱取代與更新。 |
|
必要** 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 Analytics (分析)
| 參數名稱 | 說明 |
|---|---|
(選填) 請將 Google Analytics (分析) 連接器設為「googleAnalytics」。如已設定，請將資料來源替換為提供的 Google Analytics (分析) 設定。請參閱取代與更新。 |
|
| 必填** 帳戶 ID。 | |
| 必填** 物業 ID。 | |
| 資料檢視 ID。 通用 Analytics (分析) 資源的必填**。 請勿為 Google Analytics (分析) 4 資源設定。 |
|
(選填) 如未指定，則預設值為 false。詳情請參閱 refreshFields。 |
例子
通用 Analytics (分析) 資源的 Google Analytics (分析) 設定：
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 Analytics (分析) 4 資源的 Google Analytics (分析) 設定：
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)，則為 FOLDER 的檔案路徑 (例如 MyBucket/MyData/MyFile.csv)。pathType |
|
(選填) 如未指定，則預設值為 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 執行個體網址。 | |
| 必要**：Looker 模型。 | |
| 必要項目**：Looker 探索。 | |
(選填) 如未指定，則預設值為 false。詳情請參閱 refreshFields。 |
範例
連線至 Looker 探索：
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 設定。請參閱取代與更新。 |
|
必填** 網站網址。如為網域屬性，請在前置字串中加上 sc-domain\:。 |
|
必要**：設定資料表類型。可以是 SITE_IMPRESSION 或 URL_IMPRESSION。 |
|
必要**：設定搜尋類型。可以是 WEB、IMAGE、VIDEO 或 NEWS 其中之一。 |
|
(選填) 如未指定，則預設值為 false。詳情請參閱 refreshFields。 |
範例
網址前置字元資源的 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
範本權限
為確保使用者能獲得最佳體驗，請務必為範本報表和相關資料來源正確設定報表存取權限。所需權限取決於報表範本是否使用嵌入式與可重複使用的資料來源，以及 Links API 設定是否設為替換或更新資料來源設定。
下表根據範本資料來源和 Links API 設定，提供最佳使用者體驗的建議資料來源：
| 資料來源類型 | 正在連結資料來源的 API 設定 | 資料來源權限建議 | 附註 |
|---|---|---|---|
| 嵌入日期 | 替換 | 不適用 - 報表將沿用資料檢視存取權。 | 如果使用者俱備範本報表的檢視權限，就會自動具備所有內嵌資料來源的檢視權限。 |
| 嵌入日期 | 更新 | 不適用 - 報表將沿用資料檢視存取權。 | 如果使用者俱備範本報表的檢視權限，就會自動具備所有內嵌資料來源的檢視權限。 |
| 可重複使用 | 替換 | 使用者不需要查看權限。 | 系統會透過 Links API 全面取代資料來源設定，因此不需要查看資料檢視存取權。 |
| 可重複使用 | 更新 | 使用者需要檢視權限。 | 您必須具備資料來源的檢視權限，才能讓 Links API 讀取及使用範本資料來源的設定。如果使用者沒有檢視權限，載入報表時就會收到錯誤訊息。 |
使用空白或預設報表
如要使用空白報表或預設報表，請按照下列步驟設定 Links API：
| 報表類型 | 設定 reportId 控制項參數 |
設定資料來源 ( |
附註 |
|---|---|---|---|
| 空白報表 | 否 | 否 | |
| 預設報表 | 否 | 是 | 預設報表是由 Looker Studio 提供。 指定預設報表的資料來源參數時，不需要使用資料來源別名，因為預設報表只有一個嵌入的資料來源。 |
以下範例說明使用空白報表或預設報表的各種 Links API 網址。
使用空白報表啟動報表建立工作流程：
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
嵌入報表
如要嵌入使用 Links API 建立的報表，請設定網址參數並加入 /embed/ 路徑。Links API 嵌入網址必須採用以下格式：
https://lookerstudio.google.com/embed/reporting/create?parameters
尋找 ID 和別名
報表 ID
如何找出報表 ID：
- 開啟要做為範本的報表。然後檢查報表的網址。
reporting/和/page之間的部分是報表 ID。舉例來說，在下列網址中，0B_U5RNpwhcE6SF85TENURnc4UjA是報表 ID：
https://lookerstudio.google.com/reporting/0B_U5RNpwhcE6SF85TENURnc4UjA/page/1M
資料來源別名
一份報表可包含多個資料來源。資料來源應由其別名參照。
如何找出資料來源別名：
- 編輯報表。
- 在工具列中依序選取「資源」 >「管理已新增的資料來源」。
- 檢查「別名」欄，找出各個資料來源的別名資訊。
您可以編輯別名名稱，確保新增或移除資料來源時具備回溯相容性。
連接器類型
報表可以有多個「資料來源」，每個資料來源都是透過設定連接器建立。如何找出用來建立資料來源的連接器類型：
- 編輯報表。
- 在工具列中依序選取「資源」 >「管理已新增的資料來源」。
- 檢查「連接器類型」欄，找出用來建立資料來源的連接器。
訣竅與疑難排解
如果遇到問題，請查看以下詳細資料，找出潛在問題和常見錯誤設定。
偵錯對話方塊
使用偵錯對話方塊查看 Looker Studio 解讀的 Links API 設定。這項功能有助於對 API 問題進行偵錯。
- 如果在剖析 Links API 網址時發生錯誤，系統會自動顯示對話方塊，並提供錯誤詳情。
- 如果發生錯誤，且系統未自動顯示對話方塊，請查看報表右上方的資訊按鈕。按一下即可查看其他偵錯資訊。
- 如果沒有可用的資訊按鈕，您可以在任何 Links API 網址結尾加上
&c.explain=true參數來啟用按鈕。
權限
請確認您已針對資料來源類型和 Links API 設定設定正確的範本權限。詳情請參閱「範本權限」一文。
更新與取代
如要從資料來源範本更新資料來源設定，請檢查範本資料來源設定和 Links API 設定，確認兩者相容。確認新設定產生的欄位與報表元件和設定相容。
執行更新與取代作業時，您可以使用未定義的行為設定無效的設定。詳情請參閱「取代與更新」。
重新整理欄位
如果您為範本資料來源設定了欄位名稱、類型或匯總資料，那麼當 ds.refreshFields 參數設為 false 時，這些變更只會套用至 Linked API 設定的資料來源。
查看 Linking API 網址的 ds.refreshFields 資料來源參數。如果省略，請確認每種連接器類型的參數預設值皆符合您使用的情況。
一般來說，如果您已在範本資料來源中設定欄位，並確定透過 Links API 的新資料來源設定永遠都會產生完全相同的欄位，則建議將 refreshFields 設為 false。
舉例來說，如果在建立報表範本時，Looker Studio 會將特定資料來源欄位識別為 Number 類型，且您將欄位變更為 Year，則欄位設定變更現在屬於範本資料來源的一部分。報表範本中使用修正欄位的任何圖表都預期為「Year」，如果圖表是以時間為依據，則可能不會顯示。如果使用 Links API 來提供新資料來源設定，而該設定產生的欄位完全相同，則根據 refreshFields 參數值會產生兩種結果：
如果設為
true，系統「不會」沿用範本資料來源的欄位設定，而且如果圖表取決於相同欄位設定 (亦即會輸入 Year 類型的欄位)，則可能會無法載入。如果設為
false，範本資料來源的欄位設定將沿用至新的資料來源，報表圖表，則會接收具有相同設定並成功載入的相同欄位。
意見回饋和支援服務
請使用 Issue Tracker 回報 Links API 問題或提供意見回饋。如需取得說明及提出問題的一般資源，請參閱支援。
變更記錄
2023-06-06
- 新增了
r.measurementId和r.keepMeasurementId報表參數，以設定 Google Analytics (分析) 評估 ID 報表設定。 - 新增
ds.keepDatasourceName，以便控管範本資料來源名稱的重複使用情形。 - 新增嵌入報表部分。
- BigQuery 連接器
- 已新增
sqlReplace。可讓您指定模式和替換字串，以更新範本資料來源的 SQL 查詢。
- 已新增
2023-05-22
2022-11-21
2022-11-14
- 由於 Google 問卷調查停用，問卷調查連接器參考資料已遭移除。
2022-06-15
- 已通過 Beta 版測試
- Integration API 已重新命名為「Linking API」。
- Links API 已通過測試階段。
- 新增
pageId控制項參數，以允許連結至特定報表頁面。 - 新增
mode控制項參數，以便在載入時將報表狀態設為「檢視」或「編輯」模式。 - 資料來源設定現在可以全面取代或部分更新。這項行為取決於是否已設定
ds.connector參數。詳情請參閱「取代與更新」。 - 如果報表範本未提供透過
c.reportId參數提供，系統會使用預設範本。 - 新增了
ds.refreshFields資料來源參數。這可讓您控制在載入資料來源設定時，是否要重新整理資料來源欄位。 - BigQuery 連接器
- 如果
type設為CUSTOM_QUERY，則不需要projectId。 - 如未設定
billingProjectId，帳單專案就會改回使用projectId或查詢資料表的專案。 - 開始支援日期分區表格。將
isPartitioned參數設為true，即可使用分區欄位做為日期範圍維度。 - 新增使用萬用字元或
YYYYMMDD資料表後置字串查詢日期分區資料表的支援功能。 - 新增支援功能，可查詢 Google Analytics (分析)、Firebase Analytics 或 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 Analytics (分析)、Google Cloud Storage、Google 試算表、Google 問卷調查、Search Console。