為 Google 設定 OAuth
預設情況下,Google Analytics (分析)、Google BigQuery 和 Google 試算表(Tableau 版本 2022.1 中已棄用)連接器會針對提供者為 Tableau Server 產生的 OAuth 權杖,以及相同站台上所有使用者共用的 OAuth 權杖,使用受管理的金鑰鏈。
您可以藉由為每個連接器設定 Tableau Server 的 OAuth 用戶端 ID 和密碼,將使用受管理的金鑰鏈的連接器轉換成使用已儲存的認證。
本主題會介紹如何使用已儲存認證針對 OAuth 設定 Google Analytics (分析)、Google BigQuery 和 Google 試算表連線。為每個 Tableau Server 執行個體完成這些步驟。
附註:Google 雲端硬碟連線預設使用已儲存的認證,並且從 Tableau 2022.3 開始,需要使用 OAuth 用戶端 ID 和 Google 密碼設定 Tableau Server。
有關受管理的金鑰鏈和已儲存認證的更多資訊,請參閱 OAuth 連線。
附註:
- 所有基於 Google 的連接器均需要受管理的金鑰鏈(預設)、全伺服器 OAuth 或特定於站台的 OAuth。
- 要為站台使用儲存的認證,必須首先設定全伺服器 OAuth。
- 無論是否設定了全站台 OAuth,都可以使用全伺服器 OAuth。
- 若使用特定於站台的 OAuth,則必須單獨設定每個站台。
- 要支援即時連線提示、編輯連線和 Web 製作,請將受管理的金鑰鏈轉換為儲存的認證以避免錯誤。
步驟摘要
請按照以下一般步驟設定 OAuth:
- 啟用 API 存取並透過 Google 建立存取權杖。
- 使用在步驟 1 中取得的資訊來設定 Tableau Server。
- (可選)設定特定於站台的 OAuth。
- 建立和編輯 Google 資料來源。
取得用戶端 ID 並啟用 Google API
附註:這些步驟反映編寫本文時 Google Cloud Platform 控制台中的設定。有關詳情,請參閱 Google 開發人員控制台說明中的對 Web 伺服器應用程式使用 OAuth 2.0(連結在新視窗開啟)。
登入到 Google Cloud Platform(連結在新視窗開啟),然後按一下 [Go to my console] 。
在下拉式功能表中選取一個專案,選取「建立專案」 。
在出現的新項目表單中,完成以下操作:
為項目提供一個有意義的名稱,以反映您將對其使用此專案的 Tableau Server 實例。
確定您是否要變更專案 ID。
附註:建立專案後,將無法變更專案 ID。欲深入了解,請按一下問號圖示。
開啟新專案,巡覽至 [API 和服務] > [Oauth 同意畫面],並選取使用者類型。
按一下「OAuth 同意螢幕」索引標籤,然後輸入一個有意義的名稱,這是為使用者顯示的「產品名稱」。
按一下認證,然後按一下建立認證索引標籤,然後按一下 OAuth 用戶端 ID。
在建立 OAuth 用戶端 ID 畫面上,填寫必填欄位。請按照以下步驟授權 Oauth 權杖:
選取 [Web Application] 。
輸入用戶端名稱。
對於授權的 JavaScript 出處,按一下新增 URI,然後使用 HTTP 或 HTTPs 輸入 Tableau Server 網域名稱。
對於授權的重新導向 URI,按一下新增 URI,並將範例文字取代為 Tableau Server 的網際網路位址,然後在其末尾新增以下文字:auth/add_oauth_token。例如:
https://your_server_url.com/auth/add_oauth_token
複製授權的重定向 URI,並將其粘貼到您可以從 Tableau Server 電腦存取的位置。
按一下 [Create] 。
複製 Google 返回的以下值,並將其粘貼到您可以從 Tableau Server 電腦存取的位置:
- 使用者端 ID
- 用戶端密碼
在 [API 和服務]中,驗證是否已啟用 [BigQuery API]、[Google 雲端硬碟 API](用於啟用 Google 試算表)或 [Analytics API]。若要啟用 API,請按一下頁首的 [ENABLE API] 。
附註:要在 Tableau Server 和 Google Analytics 4 之間建立連線,必須在 Google 主控台中同時啟用 Google Analytics Admin API 與 Google Analytics Data API。新增這些 API 可防止在此處理序中可能出現的任何潛在權限錯誤。
為 Tableau Server 設定 Google OAuth
使用您透過完成取得用戶端 ID 並啟用 Google API 中的步驟獲得的資訊,您可以設定您的 Tableau Server:
在 Tableau Server 電腦上,開啟 shell 並執行以下命令來指定存取權杖和 URI:
tsm configuration set -k oauth.google.client_id -v <your_client_ID>
tsm configuration set -k oauth.google.client_secret -v <your_client_secret>
tsm configuration set -k oauth.google.redirect_uri -v <your_authorized_redirect_URI>
tsm pending-changes apply
如果擱置組態需要重新啟動伺服器,
pending-changes apply
命令將顯示提示,讓您知道即將重新啟動。即使伺服器已停止,也會顯示提示,但在這種情況下不會重新啟動。您可以使用--ignore-prompt
選項隱藏提示,但這樣做不會改變重新啟動行為。如果變更不需要重新啟動,則不會出現提示即可套用變更。有關詳情,請參閱 tsm pending-changes apply。
為站台設定自訂 OAuth
可以為站台設定自訂 Google OAuth 用戶端。
考慮將自訂 OAuth 用戶端設定為 1) 如果是為伺服器設定,則覆寫 OAuth 用戶端;或 2) 啟用支援安全連線到需要唯一 OAuth 用戶端的資料。
設定自訂 OAuth 用戶端時,站台等級設定優先於任何伺服器端設定,並且預設情況下建立的所有新 OAuth 憑證都使用站台等級 OAuth 用戶端。無須重新啟動 Tableau Server 即可使設定生效。
重要提示:在設定自訂 OAuth 用戶端之前建立的現有 OAuth 憑證暫時可用,但伺服器管理員和使用者都必須更新其保存的憑證以幫助確保能不間斷存取資料。
1:準備 OAuth 用戶端 ID、用戶端密碼以及重新定向 URL
在設定自訂 OAuth 用戶端之前,需要以下列出的資訊。準備好這些資訊後,就可以為站台註冊自訂 Oauth 用戶端。
OAuth 用戶端 ID 和用戶端密碼:首先向資料提供者(連接器)註冊 OAuth 用戶端以檢索為 Tableau Server 產生的用戶端 ID 和密碼。
重新導向 URL:注意正確的重新導向 URL。您將在下方的步驟 2 註冊過程中需要它。
https://<伺服器名稱> .com/auth/add_oauth_token
例如,https://example.com/auth/add_oauth_token
2:註冊 OAuth 用戶端 ID 與用戶端密碼
按照下面描述的過程將自訂 OAuth 用戶端註冊到站台。
使用管理員認證登入 Tableau 伺服器站台,並轉到「設定」頁面。
在 OAuth 用戶端登錄檔下,按一下「新增 OAuth 用戶端」按鈕。
輸入所需資訊,包括上述步驟 1 中的資訊:
對於「連線類型」,請選取要設定其自訂 OAuth 用戶端的連接器。
若註冊多個 OAuth 用戶端,則需要 OAuth 執行個體 URL。否則,此為可選選項。
而「用戶端 ID」、「用戶端密碼」和「重新導向 URL」,請輸入在上述步驟 1 中準備的資訊。
按一下「新增 OAuth 用戶端」按鈕以完成註冊過程。
(可選)對所有支援的連接器重複步驟 3。
- 按一下「設定」頁面底部或頂部的「儲存」按鈕以儲存變更。
3:驗證和更新儲存的憑證
為幫助確保能不間斷存取資料,您(和您的站台使用者)必須刪除之前儲存的憑證並再次新增憑證,以使用站台的自訂 OAuth 用戶端。
巡覽至「我的帳戶設定」頁面。
在「儲存的資料來源憑證」下,執行以下動作:
按一下上述步驟 2 中設定的自訂 OAuth 用戶端連接器的現有已儲存憑證旁邊的「刪除」。
在連接器名稱旁邊,按一下「新增」並按照提示,1) 連線到在上述步驟 2 中設定的自訂 OAuth 用戶端,以及 2) 儲存最新的憑證。
4:通知使用者更新已儲存的認證
確保通知站台使用者更新他們為連接器儲存的憑證,該連接器的自訂 OAuth 用戶端即為上述步驟 2 中設定的。站台使用者可以使用更新儲存的認證中描述的過程來更新他們保存的憑證。
建立和編輯 Google 資料來源
接著,您必須將 Google 資料來源發佈到伺服器。例如,請參閱 Tableau Desktop 主題 Google BigQuery(連結在新視窗開啟)。
發佈資料來源之後,最後一步是編輯資料來源連線以使用您之前設定的內嵌式存取權杖。請參閱在 Tableau Server 上編輯連線。
管理存取權杖
針對 OAuth 設定伺服器之後,您可以允許使用者在其組態檔設定中管理其自己的存取權杖,或者您可以集中管理這些權杖。有關詳情,請參閱允許已儲存的存取權杖。
用於 OAuth 身份驗證的正向 Proxy
有關為 Tableau Server(僅限 Windows)設定具有 OAuth 身份驗證的正向 Proxy 的詳細資訊,請參見 Tableau 說明中的為 OAuth 身份驗證配置正向 Proxy。(連結在新視窗開啟)