正在連結 API

簡介

透過 Linking API,您可以設定並透過網址將使用者直接轉送至 Looker Studio 報表,介面穩定可靠。使用者點選連結 API URL 後,即可快速查看及操作資料,享受簡化的體驗。

本文說明連結 API 網址的必要格式和可用參數。

用途和優點

您可以使用 Linking API 為顧客提供預先設定的報表,方便他們查看及操作資料。Linking API 的主要優點如下:

  • 為顧客提供一鍵建立報表的體驗
    • 資料設定會顯示在網址中,因此使用者不必為資料設定報表。
    • 使用者只要按一下滑鼠,就能儲存報表,並隨時重新查看。
  • 大規模建立報表。連結 API 可減少複製或建立新報表所需的時間。
  • 啟用產品整合功能。穩定版介面可讓您將 Looker Studio 整合至產品工作流程。

運作方式

以下說明開發人員和使用者如何與連結 API 互動。

Linking API 開發人員工作流程

開發人員準備範本報表、資料來源,並設定 Linking API 網址格式。開發人員的一般工作流程如下:

  1. 決定要使用空白報表、Looker Studio 提供的預設報表範本,還是建立做為範本的 Looker Studio 報表。包括設定範本資料來源。
  2. 根據特定用途設定 Linking API 網址格式。如適用,請指定報表範本和其他參數,包括報表名稱、資料來源名稱和資料來源設定。
  3. 使用連結 API 網址將使用者導向報表。

Linking API 使用者體驗

使用者點選連結 API 網址後,如果開發人員已正確設定,系統會將使用者導向 Looker Studio 報表,讓他們查看及操作有權存取的資料。一般使用者體驗可能如下:

  1. 使用者在瀏覽器中造訪已整合 Linking API 的服務。
  2. 行動號召會邀請使用者點選連結,在 Looker Studio 中查看資料。
  3. 使用者點選連結後,會前往 Looker Studio 報表。報表會載入,使用者可以查看及操作資料。
  4. 使用者點按「編輯及共用」,報表就會儲存到他們的 Looker Studio 帳戶。
  5. 使用者現在可以完全存取及控管自己的報表副本。 他們隨時可以查看、編輯及分享。

需求條件

如要確保連結 API 網址運作正常,請務必符合下列條件:

  1. 做為範本的報表。如未提供,則可使用空白報表或 Looker Studio 提供的預設報表。
  2. 連結 API 網址的使用者至少必須具備範本報表的檢視權限。視報表使用的資料來源類型,以及透過 Linking API 提供的設定而定,使用者可能也需要資料來源的檢視權限。詳情請參閱「範本權限」。
  3. 每個資料來源的「連接器類型」必須支援透過 Linking API 設定。如需支援的連結器清單,請參閱連結器參考資料
  4. 連結 API 網址的使用者必須有權存取連結 API 網址中設定的資料。如果使用者無法存取基礎資料,任何依附的報表元件都會顯示錯誤。

網址參數

連結 API 網址必須採用下列格式:

https://lookerstudio.google.com/reporting/create?parameters

這個網址通常會在網頁瀏覽器中使用,一般是使用者點選連結或重新導向至該網址時使用。您也可以使用這項功能嵌入報表

範例網址

以下是 Linking 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

有些網址參數是必要參數,有些則是自選參數。以下是定義連結 API 網址時使用的參數清單:

控制參數

透過連結 API 網址查看報表時,控制參數會決定報表的狀態。

參數名稱 說明
c.reportId
(選用步驟) 範本報表 ID。Looker Studio 會開啟並設定指定的報表。如要瞭解如何找出 ID,請參閱「檢舉 ID」。如未指定,系統會使用空白報表或預設報表範本,詳情請參閱「使用空白或預設報表」。
c.pageId
(選用步驟) 要在報表中載入的初始頁面 ID。如未指定,則預設為報表的第一頁。
c.mode
(選用步驟) 初始報表模式。請選擇 view edit。如果沒有指定,則預設值為 view
c.explain
(選用步驟) 資訊/偵錯對話方塊的顯示狀態。設為 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

報表參數

報表參數會覆寫報表屬性。

參數名稱 說明
r.reportName
(選用步驟) 設定報表名稱。如未指定,預設為範本報表名稱。
r.measurementId

(選用步驟) 將 Google Analytics 評估 ID 設為評估報表使用情況。請使用半形逗號分隔多個 ID。

如果未指定 r.measurementIdr.keepMeasurementIdGoogle Analytics 評估 ID 報表設定預設為未設定。如果同時設定 r.measurementIdr.keepMeasurementId,系統會優先採用 r.keepMeasurementId 設定 ID。

r.keepMeasurementId

(選用步驟) 設為 true,即可使用範本報表「Google Analytics 評估 ID」。如未指定,則預設值為 false

如果未指定 r.measurementIdr.keepMeasurementIdGoogle Analytics 評估 ID 報表設定預設為未設定。如果同時設定 r.measurementIdr.keepMeasurementId,系統會優先採用 r.keepMeasurementId 設定 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,請參閱「資料來源別名」。

資料來源參數

所有連結器類型都有下列參數:

名稱 說明
ds.alias.datasourceName

(選用步驟) 設定資料來源名稱。

如果未指定 ds.datasourceNameds.keepDatasourceName,資料來源名稱會預設採用命名慣例,包含連接器類型和建立時間 (例如「samples - 12/12/21, 10:53 PM」)。如果設定 ds.datasourceNameds.keepDatasourceName,系統會優先使用 ds.datasourceName 設定資料來源名稱。

ds.alias.keepDatasourceName

(選用步驟) 如要使用範本資料來源名稱,請將這個值設為 true。如果沒有指定,則預設值為 false

如果未指定 ds.datasourceNameds.keepDatasourceName,資料來源名稱會預設採用命名慣例,包含連接器類型和建立時間 (例如「samples - 12/12/21, 10:53 PM」)。如果設定 ds.datasourceNameds.keepDatasourceName,系統會優先使用 ds.datasourceName 設定資料來源名稱。

ds.alias.connector
選用。

資料來源的連接器類型。如要進一步瞭解支援的連結器類型,請參閱連結器參考資料

如果設定此參數,則必須在連結 API 網址中指定連接器類型的所有必要 連接器參數,且範本資料來源設定會完全遭到取代。

如未指定,則可在 Linking API 網址中指定零或多個連接器類型的 連接器參數。範本資料來源設定會用於指定 Linking API 網址中未提供的任何參數。如要進一步瞭解如何判斷範本資料來源的連接器類型,請參閱「連接器類型」。

如要進一步瞭解 ds.connector 參數如何影響範本資料來源設定是否會完全取代,或是用於更新未指定的參數,請參閱「取代與更新」。

ds.alias.refreshFields
選用。

設為 true,即可使用透過 Linking API 指定的資料來源設定,重新整理資料來源欄位,並使用新的欄位選項更新報表元件。切換連接器類型時,或連接器類型因設定變更而產生不同欄位時 (例如 BigQuery 資料來源的欄位通常會因資料表設定而異),通常會指定 true

設為 false,讓資料來源欄位維持範本報表中的狀態。如果新資料設定產生的欄位完全相同,且您希望保留對範本資料來源所做的任何欄位變更,通常會指定 false

如未指定,預設值會因連接器類型而異。如要覆寫預設行為,請參閱連接器參考資料,瞭解連接器專屬的預設值。

使用 refreshFields 時,請注意下列事項:
  • 如果 refreshFields 設為 false,且透過 Linking API 指定的資料來源設定產生與範本報表所用不同的欄位,使用者可能會看到受影響元件的設定錯誤。
  • 如果將 refreshFields 設為 true,範本資料來源中的欄位變更 (例如名稱、類型、匯總等) 不會套用至新資料來源。將 refreshFields 設為 false,以保留範本資料來源的欄位設定。
  • 範本資料來源中定義的 計算欄位 參數一律會複製到新建立的資料來源,且不受 refreshFields 值影響。
ds.alias.connectorParameters
必填連接器類型的資料來源設定。如要瞭解如何找出用來建立資料來源的連接器,請參閱「連接器類型」。如要瞭解各連接器類型可用的資料來源參數,請參閱連接器參考資料

取代與更新 - 資料來源設定

設定資料來源參數時,連結 API 網址中是否包含 ds.connector 參數,會分別表示要取代更新範本資料來源設定。

下表詳細說明 ds.connector 參數如何影響範本資料來源設定,決定是否要完全取代設定,或是用來更新未指定的參數:

是否已設定 ds.connector 預期設定和行為 常見用途
取代。系統會使用連結 API 網址中指定的資料來源參數,完全取代範本資料來源設定。您必須為連接器類型指定所有必要參數。請參閱「設定 ds.connector 時的必要參數」。
  • 變更資料來源的連接器類型時,舉例來說,如果您在範本報表中設定了 BigQuery 資料來源,但想透過 Linking API 設定 Google 試算表資料來源,這需要完整定義新的連接器設定。
  • 想確保資料來源的設定。 取代設定可避免系統從範本資料來源使用任何不明值。
更新。範本資料來源設定會用於指定連結 API 網址中未提供的任何參數。除非另有說明,否則連接器類型的所有連接器參數皆為選用。

這項功能可簡化連結 API 網址,如果您熟悉範本資料來源設定,且只想覆寫部分參數,一般建議使用這項功能。
  • 您只想提供與範本資料來源不同的參數值,並接受依賴範本資料來源取得任何未指定的連結器參數。舉例來說,只變更 BigQuery 資料來源設定的帳單專案 ID,並將所有其他參數套用範本設定。

設定 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

建立與新增

有時,在多份報表中使用同一個資料來源會很有幫助,因為這樣一來,資料來源的更新就會一併影響所有報表。使用 Linking API 建立報表時,請確保符合下列所有條件,即可從範本報表重新新增資料來源:

  1. 資料來源可重複使用 (請參閱嵌入與可重複使用的資料來源)
  2. 網址未依別名參照資料來源
  3. 網址未使用萬用字元別名 (請參閱「資料來源別名萬用字元」)

使用 Linking API 建立新的資料來源時,系統會使用點選網址的使用者憑證。也就是說,使用者必須能存取基礎資料,否則連線將無法運作。將資料來源重新新增至新產生的報表,即可保留憑證,讓使用者繼續存取新報表中的資料。

資料來源別名萬用字元

如要將 Linking API 參數套用至多個資料來源,可以使用萬用字元別名 ds.* 取代資料來源別名。

這項功能可移除網址中重複的參數。舉例來說,假設您有一個範本,其中附加了三個 BigQuery 資料來源,而且您想替換每個來源中的 projectIddatasetId,但保留 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

提供給 Linking API 的參數 (未使用 ds.* 萬用字元) 優先於使用該萬用字元的參數。在上述範例中,您可以新增特定資料來源別名,覆寫萬用字元的值。

  https://lookerstudio.google.com/reporting/create?
  c.reportId=7890
  &ds.*.projectId=client-project
  &ds.*.datasetId=client-dataset
  &ds.ds1.datasetId=client-dataset

一般來說,參數優先順序如下:

  1. 具有特定別名 (ds.ds1.datasetId) 的參數
  2. 使用萬用字元 (ds.*.datasetId) 提供的參數
  3. 如果未提供 ds.connector,則為從範本資料來源衍生的值 (請參閱「取代與更新」)
  4. 參數的預設值 (如為選用)。

連接器參考資料

連結 API 支援下列連結器和設定。系統會提供每個連結器的可用資料來源參數清單。

BigQuery

BigQuery 連接器支援兩種查詢類型:TABLE 查詢 (您提供要查詢的資料表 ID) 和 CUSTOM_QUERY 查詢 (您提供要查詢資料表的 SQL 陳述式)。

TABLE 查詢

type 設為 TABLE,且您提供要查詢的資料表 ID 時,適用下列參數。

參數名稱 說明
ds.alias.connector
(選用步驟) 將 bigQuery 設為 BigQuery 連接器

如果已設定,請使用提供的 BigQuery 設定取代資料來源。請參閱「取代與更新」。
ds.alias.type
必要** 查詢類型,請設為 TABLE
ds.alias.projectId
必要**:要查詢的資料表專案 ID。
ds.alias.datasetId
必要** 要查詢的資料表資料集 ID。
ds.alias.tableId
必要** 要查詢的資料表 ID。

日期分片資料表
查詢日期分片資料表時,系統支援 * (萬用字元)YYYYMMDD 後置字元。
如果資料表識別為 Google Analytics、Firebase Analytics 或 Firebase Crashlytics,系統會選取預設欄位範本,除非您指定範本。請參閱欄位範本表格的相關參數。
ds.alias.billingProjectId
(選用步驟) 用於計費的專案 ID。如未設定,系統會使用 projectId
ds.alias.isPartitioned
(選用步驟) 如果資料表已分區,且您想將分區資料欄做為日期範圍維度,請設為 true。這項功能僅適用於以時間為準的分區 (例如使用以時間為準的分區資料欄或 _PARTITIONTIME 虛擬資料欄),不適用於整數範圍分區資料表。如未指定,則預設值為 false。如要瞭解詳情,請參閱 分區資料表簡介
ds.alias.refreshFields
(選用步驟) 如未指定,則預設值為 true。詳情請參閱「refreshFields」。
Google Analytics、Firebase Analytics 和 Crashlytics 的欄位範本

如果是 Google Analytics、Firebase Analytics 或 Firebase Crashlytics 表格,則可使用其他參數設定欄位範本。如未指定,系統會選取預設範本。

名稱 說明
ds.alias.gaTemplateLevel
(選用步驟) 要使用的 Google Analytics 欄位範本。僅適用於查詢 Google Analytics 的 BigQuery 匯出資料表時。只能設為 ALLSESSIONHITS。如果是 Google Analytics 表格,如未指定,預設為 ALL
ds.alias.firebaseTemplateLevel
(選用步驟) 要使用的 Firebase Analytics 欄位範本。僅適用於查詢 Firebase Analytics 資料表時。只能設為 EVENTS。如果是 Firebase Analytics 資料表,如未指定,則預設值為 EVENTS
ds.alias.crashlyticsTemplateLevel
要使用的 Firebase Crashlytics 欄位範本。只能設為 DEFAULT。僅適用於查詢 Firebase Crashlytics 資料表的 BigQuery 匯出作業。如果是 Firebase Crashlytics 資料表,如未指定,則預設為 DEFAULT

自訂查詢

如果 type 設為 CUSTOM_QUERY,且您提供 SQL 陳述式來查詢資料表,則適用下列參數。

參數名稱 說明
ds.alias.connector
(選用步驟) 將 bigQuery 設為 BigQuery 連接器

如果已設定,請使用提供的 BigQuery 設定取代資料來源。請參閱「取代與更新」。
ds.alias.type
必要** 查詢類型,請設為 CUSTOM_QUERY
ds.alias.sql
必要**:要執行的 SQL 查詢。
ds.alias.billingProjectId
(選用步驟) 用於計費的專案 ID。如未設定,系統會使用 projectId。如果未設定 projectId,系統會使用所查詢資料表的專案。
ds.alias.sqlReplace

(選用步驟) 以半形逗號分隔的模式和取代字串清單,用於套用至 SQL 查詢。只有在模式相符時,系統才會套用字串取代功能。請使用半形逗號分隔模式和取代字串配對。例如 stringPattern1,replacementString1, stringPattern2,replacementString2

ds.alias.refreshFields
(選用步驟) 如未指定,則預設值為 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_*
  

使用 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
  

TABLE 類型設定,用於查詢 Google Analytics 的 BigQuery Export 資料表,並使用 SESSION 欄位範本:

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

參數名稱 說明
ds.alias.connector
(選用步驟) 將 Cloud Spanner 連接器設為 cloudSpanner

如果設定這個選項,系統會以提供的 Cloud Spanner 設定取代資料來源。請參閱「取代與更新」。
ds.alias.projectId
必填** 專案 ID。
ds.alias.instanceId
必要**:執行個體 ID。
ds.alias.databaseId
必要** 資料庫 ID。
ds.alias.sql
必要**:要執行的 SQL 查詢。
ds.alias.refreshFields
(選用步驟) 如果沒有指定,則預設值為 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

社群連接器

參數名稱 說明
ds.alias.connector
(選用步驟) 設為 community,適用於社群連接器

如果已設定,系統會以提供的社群連結器設定取代資料來源。請參閱「取代與更新」。
ds.alias.connectorId
必要** 社群連結器 connectorId (也稱為 deploymentId)。
ds.alias.parameters
(選用步驟) 其他連接器專屬參數,由社群連接器的 連接器設定定義。
ds.alias.refreshFields
(選用步驟) 如未指定,則預設值為 true。詳情請參閱「refreshFields」。

範例

使用 statecity 設定參數連線至社群連結器:

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

參數名稱 說明
ds.alias.connector
(選用步驟) 將 googleAnalytics 設為 Google Analytics 連接器

如果已設定,系統會以提供的 Google Analytics 設定取代資料來源。請參閱「取代與更新」。
ds.alias.accountId
必填** 帳戶 ID。
ds.alias.propertyId
必要** 資源 ID。
ds.alias.viewId
資料檢視 ID。
通用 Analytics 資源**為必填欄位。
請勿為 Google Analytics 4 資源設定此欄位。
ds.alias.refreshFields
(選用步驟) 如未指定,則預設值為 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

參數名稱 說明
ds.alias.connector
(選用步驟) 設為 googleCloudStorage Google Cloud Storage 連接器

如果已設定,系統會將資料來源替換為提供的 Google Cloud Storage 設定。請參閱「取代與更新」。
ds.alias.pathType
必要** 路徑類型。使用 FILE 選取單一檔案,或使用 FOLDER 選取指定路徑的所有檔案。
ds.alias.path
必要** 如果 pathTypeFILE,則為檔案路徑 (例如 MyBucket/MyData/MyFile.csv);如果 pathTypeFOLDER,則為資料夾路徑 (例如 *MyBucket/MyData)。
ds.alias.refreshFields
(選用步驟) 如果沒有指定,則預設值為 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 試算表

參數名稱 說明
ds.alias.connector
(選用步驟) 將 Google 試算表連接器設為 googleSheets

如果已設定,系統會以提供的 Google 試算表設定取代資料來源。請參閱「取代與更新」。
ds.alias.spreadsheetId
必填** 試算表 ID。
ds.alias.worksheetId
必要** 工作表 ID。
ds.alias.hasHeader
(選用步驟) 設為 true,將第一列做為標題。 如果沒有指定,則預設值為 true。欄標題不得重複。系統不會在資料來源中加入標題空白的欄。
ds.alias.includeHiddenCells
(選用步驟) 設為 true 即可包含隱藏的儲存格。 如果沒有指定,則預設值為 true
ds.alias.includeFilteredCell
(選用步驟) 設為 true 即可納入篩除的儲存格。 如果沒有指定,則預設值為 true
ds.alias.range
(選用步驟) 範圍,例如 A1:B52。
ds.alias.refreshFields
(選用步驟) 如未指定,則預設值為 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

Google 試算表設定,範圍為 (A1:D20):

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

參數名稱 說明
ds.alias.connector
(選用步驟) 將 Looker 連接器設為 looker

如果設定這個選項,系統會以提供的 Looker 設定取代資料來源。請參閱「取代與更新」。
ds.alias.instanceUrl
必要**:Looker 執行個體網址。
ds.alias.model
必填** Looker 模型。
ds.alias.explore
必要** Looker 探索。
ds.alias.refreshFields
(選用步驟) 如未指定,則預設值為 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

參數名稱 說明
ds.alias.connector
(選用步驟) 將「Search Console 連接器」設為 searchConsole

如果設定這個選項,系統會使用提供的 Search Console 設定取代資料來源。請參閱「取代與更新」。
ds.alias.siteUrl
必填** 網站網址。如果是網域資源,請加上 sc-domain\: 前置字元。
ds.alias.tableType
必要** 設定資料表類型。可以是 SITE_IMPRESSIONURL_IMPRESSION
ds.alias.searchType
必要** 設定搜尋類型。可以是 WEBIMAGEVIDEONEWS
ds.alias.refreshFields
(選用步驟) 如未指定,則預設值為 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

範本權限

為確保使用者享有最佳體驗,請務必為範本報表和相關聯的資料來源正確設定報表存取權限。所需權限取決於報表範本是使用內嵌或可重複使用的資料來源,以及連結 API 設定是取代或更新資料來源設定。

下表根據範本資料來源和 Linking API 設定,提供建議的資料來源存取權,確保使用者獲得最佳體驗:

資料來源類型 連結資料來源的 API 設定 資料來源權限建議 附註
內嵌 取代 不適用 - 檢視權限會沿用報表的權限。 如果使用者有權查看範本報表,系統就會自動授予他們內嵌資料來源的查看權。
內嵌 更新 不適用 - 檢視權限會沿用報表的權限。 如果使用者有權查看範本報表,系統就會自動授予他們內嵌資料來源的查看權。
可重複使用 取代 使用者不需要檢視權限。 由於資料來源設定會透過 Linking API 完全取代,因此不需要檢視存取權。
可重複使用 更新 使用者必須具備檢視權。 您必須擁有資料來源的檢視權限,Linking API 才能讀取及使用範本資料來源的設定。如果使用者沒有檢視權限,載入報表時會收到錯誤訊息。

使用空白或預設報表

如要使用空白報表或預設報表,請按照下列方式設定 Linking API:

報告類型 設定 reportId 控制參數 設定資料來源 (ds) 參數。 附註
空白報表
預設報表

預設報表由 Looker Studio 提供。

為預設報表指定資料來源參數時,不需要使用資料來源別名,因為預設報表只有一個嵌入資料來源。

以下範例顯示各種 Linking 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

嵌入報表

如要嵌入使用 Linking API 建立的報表,請設定網址參數,並加入 /embed/ 路徑。連結 API 嵌入網址必須採用下列格式:

https://lookerstudio.google.com/embed/reporting/create?parameters

找出 ID 和別名

報表 ID

如要找出報表 ID,請按照下列步驟操作:

  1. 開啟要設為範本的報表。檢查報表的網址。reporting//page 之間的內容是報表 ID。舉例來說,在下列網址中,0B_U5RNpwhcE6SF85TENURnc4UjA 是報表 ID:
https://lookerstudio.google.com/reporting/0B_U5RNpwhcE6SF85TENURnc4UjA/page/1M
瀏覽器網址列顯示 Looker Studio 報表的網址。
            報表 ID 會醒目顯示。
在報表網址中找出報表 ID。

資料來源別名

報表可以有多個資料來源。資料來源應以別名參照。

如要找出資料來源別名,請按照下列步驟操作:

  1. 編輯報表。
  2. 依序選取工具列中的「資源」 >「管理已新增的資料來源」
  3. 檢查「別名」欄,找出每個資料來源的別名資訊。

您可以編輯別名,確保新增或移除資料來源時,系統能向後相容。

資料來源資源管理頁面中的資料來源清單。
            「別名」欄位會醒目顯示。
在「資料來源」管理頁面中找出資料來源別名。

連接器類型

一份報表可以有多個「資料來源」,每個資料來源都是透過設定連結器建立。如要找出用來建立資料來源的連接器類型,請按照下列步驟操作:

  1. 編輯報表。
  2. 依序選取工具列中的「資源」 >「管理已新增的資料來源」
  3. 檢查「連接器類型」欄,找出用於建立資料來源的連接器。
資料來源資源管理頁面中的資料來源清單。
            「連接器類型」欄會醒目標示。
在「資料來源」管理頁面中,找出資料來源連接器類型。

訣竅與疑難排解

如果遇到問題,請參閱下方詳細資料,找出潛在問題和常見設定錯誤。

偵錯對話方塊

使用偵錯對話方塊,查看 Looker Studio 解讀的連結 API 設定。這有助於偵錯 API 問題。

  • 剖析 Linking API 網址時發生錯誤,系統會自動顯示對話方塊,提供錯誤詳細資料。
  • 如果發生錯誤,但系統未自動顯示對話方塊,請在報表右上角尋找資訊按鈕。按一下即可查看其他偵錯資訊。
    資訊按鈕,可瞭解報表的建立方式。
  • 如果沒有資訊按鈕,請在任何連結 API 網址結尾附加 &c.explain=true 參數,即可啟用按鈕。

權限

請確認您已為資料來源類型和連結 API 設定正確的範本權限。詳情請參閱「範本權限」。

更新與取代

如要從資料來源範本更新資料來源設定,請檢查範本資料來源設定和 Linking API 設定是否相容。確認新設定產生的欄位與報表元件和設定相容。

執行更新與更換作業時,可能會設定無效的設定,導致行為未定義。詳情請參閱「取代與更新」。

重新整理欄位

如果您已為範本資料來源設定欄位名稱、類型或匯總,只有在 ds.refreshFields 參數設為 false 時,這些變更才會轉移至 Linking API 設定的資料來源。

檢查連結 API 網址的 ds.refreshFields 資料來源參數。如果省略,請確認每個連接器類型的參數預設值是否符合您的用途。

一般來說,如果您已在範本資料來源中設定欄位,並確定透過 Linking API 建立的新資料來源設定一律會產生完全相同的欄位,建議將 refreshFields 設為 false

舉例來說,如果 Looker Studio 在建立報表範本時,將特定資料來源欄位識別為「數字」類型,而您將其變更為「年份」類型,這項欄位設定變更就會成為範本資料來源的一部分。報表範本中所有使用修正欄位的圖表都會預期有「年份」,如果圖表是以時間為準,否則可能無法顯示。如果使用 Linking API 提供新的資料來源設定,但產生的欄位完全相同,則會根據 refreshFields 參數的值,出現下列兩種結果:

  • 如果設為 true,範本資料來源的欄位設定不會沿用,且圖表可能會無法載入 (如果圖表依賴相同的欄位設定,也就是預期會出現「年」類型的欄位)。

  • 如果設為 false,範本資料來源的欄位設定會沿用至新資料來源,報表圖表也會收到相同欄位和設定,並順利載入。

意見回饋和支援服務

如要回報 Linking API 問題或提供意見回饋,請使用 Issue Tracker。如需取得協助和提出問題的一般資源,請參閱「支援」。

變更記錄

2023-06-06

  • 新增 r.measurementIdr.keepMeasurementId 報表參數,以設定 Google Analytics 評估 ID 報表設定。
  • 新增 ds.keepDatasourceName,可控制範本資料來源名稱的重複使用情形。
  • 新增「嵌入報表」一節。
  • BigQuery 連接器
    • 新增「sqlReplace。可指定模式和取代字串,以更新範本資料來源的 SQL 查詢。

2023-05-22

2022-11-21

  • 新增使用空白報表的功能。請參閱「使用空白或預設報表
  • 在「訣竅與疑難排解」一節中新增 refreshFields 部分。

2022-11-14

2022-06-15

  • 測試階段結束
    • 整合 API 已重新命名為連結 API
    • 連結 API 已通過 Beta 版測試階段。
  • 新增 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。