透過 OAuth 進行驗證的快速入門導覽課程

如要向 Gemini API 驗證,最簡單的方法是設定 API 金鑰,詳情請參閱 Gemini API 入門指南。如要使用更嚴格的存取權控管機制,請改用 OAuth。本指南將協助您設定 OAuth 驗證。

本指南會使用簡化的驗證方法,適用於測試環境。在正式環境中,建議您先瞭解驗證和授權,再選擇適合應用程式的存取憑證

目標

  • 設定 OAuth 的雲端專案
  • 設定應用程式預設憑證
  • 在程式中管理憑證,而非使用 gcloud auth

必要條件

如要執行這項快速入門導覽課程,您需要:

設定雲端專案

如要完成本快速入門導覽課程,請先設定雲端專案。

1. 啟用 API

使用 Google API 前,請先在 Google Cloud 專案中啟用這些 API。

  • 在 Google Cloud 控制台中啟用 Google Generative Language API。

    啟用 API

2. 設定 OAuth 同意畫面

接著設定專案的 OAuth 同意畫面,並將自己新增為測試使用者。如果已為 Cloud 專案完成這個步驟,請跳至下一節。

  1. 前往 Google Cloud 控制台,依序選取「選單」 >「Google Auth platform」 >「Overview」

    前往 Google Auth 平台

  2. 填寫專案設定表單,並在「目標對象」部分將使用者類型設為「外部」

  3. 填妥表單的其餘部分,接受使用者資料政策條款,然後按一下「建立」

  4. 目前可以略過新增範圍,然後按一下「儲存並繼續」。日後為 Google Workspace 機構以外的環境建立應用程式時,您必須新增並驗證應用程式所需的授權範圍。

  5. 新增測試使用者:

    1. 前往 Google Auth Platform 的目標對象頁面
    2. 在「測試使用者」下方,按一下「新增使用者」
    3. 輸入您的電子郵件地址和任何其他授權測試使用者,然後按一下「儲存」

3. 授權電腦應用程式的憑證

如要以使用者身分驗證,並存取應用程式中的使用者資料,您需要建立一或多個 OAuth 2.0 用戶端 ID。Google 的 OAuth 伺服器會使用用戶端 ID 來識別個別應用程式。如果您的應用程式在多個平台上執行,則必須為每個平台分別建立用戶端 ID。

  1. 在 Google Cloud 控制台中,依序前往「選單」 >「Google Auth platform」 >「Clients」

    前往「憑證」

  2. 按一下「Create Client」(建立用戶端)

  3. 依序點選「Application type」(應用程式類型) >「Desktop app」(電腦版應用程式)

  4. 在「Name」(名稱) 欄位中,輸入憑證名稱。這個名稱只會顯示在 Google Cloud 控制台中。

  5. 按一下「建立」,系統會顯示「已建立 OAuth 用戶端」畫面,其中包含新的用戶端 ID 和用戶端密鑰。

  6. 按一下「確定」。新建立的憑證會顯示在「OAuth 2.0 Client IDs」(OAuth 2.0 用戶端 ID) 下方。

  7. 按一下下載按鈕儲存 JSON 檔案。並儲存為 client_secret_<identifier>.json,然後重新命名為 client_secret.json,並移至工作目錄。

設定應用程式預設憑證

如要將 client_secret.json 檔案轉換為可用的憑證,請將檔案位置傳遞至 gcloud auth application-default login 指令的 --client-id-file 引數。

gcloud auth application-default login \
    --client-id-file=client_secret.json \
    --scopes='https://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/generative-language.retriever'

本教學課程中簡化的專案設定會觸發「Google 尚未驗證這個應用程式」對話方塊。這是正常現象,請選擇「繼續」

這會將產生的權杖放在已知位置,以便 gcloud 或用戶端程式庫存取。