本文包含 Google Workspace Events API 專屬的授權和驗證資訊。閱讀本文前，請務必先參閱「瞭解驗證和授權」，瞭解 Google Workspace 的一般驗證和授權資訊。
設定 OAuth 2.0 授權
設定 OAuth 同意畫面並選擇範圍，定義要向使用者和應用程式審查人員顯示的資訊，並註冊應用程式，以便日後發布。
Google Workspace Events API 範圍
如要定義應用程式的存取層級，您必須找出並宣告授權範圍。授權範圍是 OAuth 2.0 URI 字串，其中包含 Google Workspace 應用程式名稱、存取的資料類型，以及存取層級。範圍是指應用程式要求使用 Google Workspace 資料，包括使用者的 Google 帳戶資料。
使用者安裝應用程式時，系統會要求他們驗證應用程式使用的範圍。一般來說，您應盡可能選擇最精確的範圍，並避免要求應用程式不需要的範圍。使用者較願意授予有限且明確說明的範圍存取權。
Google Workspace Events API 使用支援訂閱的 Google Workspace 應用程式範圍。如果應用程式已使用訂閱項目所需的範圍，則不需新增範圍，即可使用 Google Workspace Events API。如果確實要新增範圍，請選擇最不敏感的範圍，但仍可讓應用程式正常運作。如要進一步瞭解範圍類別，請參閱「範圍類別」。
下表列出 Google Workspace Events API 支援的範圍：
| 範圍代碼 | 說明 | 用量 | ||
|---|---|---|---|---|
| Google Chat | ||||
https://www.googleapis.com/auth/chat.bot |
允許 Chat 擴充應用程式查看即時通訊及傳送訊息。可存取 Chat 擴充應用程式的所有功能。 | 非機密 | ||
https://www.googleapis.com/auth/chat.memberships |
查看、新增及移除 Chat 對話的成員。 | 敏感 |
||
https://www.googleapis.com/auth/chat.memberships.readonly |
查看 Chat 對話的成員。 | 敏感 |
||
https://www.googleapis.com/auth/chat.app.memberships |
以 Chat 擴充應用程式的身分，查看、新增、更新及移除 Chat 對話和聊天室的成員 需要管理員核准。 |
敏感 |
||
https://www.googleapis.com/auth/chat.app.memberships.readonly |
以 Chat 應用程式的身分，查看 Google Chat 對話和聊天室的成員。 需要管理員核准。 |
敏感 |
||
https://www.googleapis.com/auth/chat.spaces |
在 Chat 中建立對話和聊天室，以及查看或更新中繼資料 (包括記錄設定)。 | 敏感內容 | ||
https://www.googleapis.com/auth/chat.spaces.readonly |
在 Chat 中查看即時通訊和聊天室。 | 敏感 |
||
https://www.googleapis.com/auth/chat.app.spaces |
以 Chat 擴充應用程式的身分，在 Chat 中建立對話和聊天室，以及查看或更新中繼資料 (包括記錄設定) 需要管理員核准。 |
敏感 |
||
https://www.googleapis.com/auth/chat.app.spaces.readonly |
以 Chat 應用程式的身分，查看 Google Chat 中的中繼資料 (包括記錄設定)。 需要管理員核准。 |
敏感 |
||
https://www.googleapis.com/auth/chat.messages.reactions |
在 Chat 中查看、新增和刪除訊息回應。 | 敏感 |
||
https://www.googleapis.com/auth/chat.messages.reactions.readonly |
在 Chat 中查看訊息的回應。 | 敏感 |
||
https://www.googleapis.com/auth/chat.messages |
查看、撰寫、傳送、更新及刪除訊息，以及新增、查看和刪除訊息的回應。 | 受限制 | ||
https://www.googleapis.com/auth/chat.messages.readonly |
在 Chat 中查看訊息和回應。 | 受限 |
||
https://www.googleapis.com/auth/chat.app.messages.readonly |
以 Chat 擴充應用程式的身分，查看 Chat 中的訊息和回應。 需要管理員核准。 |
受限 |
||
https://www.googleapis.com/auth/chat.users.readstate |
查看及更新 Chat 中的使用者已讀狀態。 | 敏感 |
||
https://www.googleapis.com/auth/chat.users.readstate.readonly |
查看 Chat 使用者的訊息讀取狀態。 | 敏感 |
||
https://www.googleapis.com/auth/chat.users.availability |
在 Chat 中查看及變更有空與否狀態。 | 敏感 |
||
https://www.googleapis.com/auth/chat.users.availability.readonly |
在 Chat 中查看有空與否狀態。 | 敏感 |
||
https://www.googleapis.com/auth/chat.app.all.spaces.readonly |
查看整個 Google Workspace 組織中，所有 Google Chat 聊天室和對話的中繼資料，即使 Chat 擴充應用程式不是成員也一樣。 這個範圍僅支援客戶訂閱。 必須獲得管理員核准。 |
受限制 | ||
https://www.googleapis.com/auth/chat.app.all.memberships.readonly |
查看整個 Google Workspace 組織中，所有 Google Chat 聊天室和對話的成員，即使 Chat 擴充應用程式不是成員也一樣。 這個範圍僅支援客戶訂閱。 必須獲得管理員核准。 |
受限制 | ||
https://www.googleapis.com/auth/chat.app.all.messages.readonly |
查看整個 Google Workspace 組織中的所有訊息和回應，即使 Chat 擴充應用程式不是聊天室或對話的成員也一樣。 這個範圍僅支援客戶訂閱。 必須獲得管理員核准。 |
受限制 | ||
https://www.googleapis.com/auth/chat.app.all.users.readstate.readonly |
查看整個 Google Workspace 組織中，所有聊天室和對話的使用者上次已讀時間，即使 Chat 擴充應用程式不是成員也一樣。 這個範圍僅支援客戶訂閱。 必須獲得管理員核准。 |
受限制 | ||
| Google 雲端硬碟 | ||||
https://www.googleapis.com/auth/drive.file |
建立新的雲端硬碟檔案，或修改您透過應用程式開啟的現有檔案，或使用者在使用 Google Picker API 或應用程式的檔案選擇器時，與應用程式共用的檔案。 | 非機密 | ||
https://www.googleapis.com/auth/drive |
查看及管理所有雲端硬碟檔案。 | 受限制 | ||
https://www.googleapis.com/auth/drive.readonly |
查看及下載所有雲端硬碟檔案。 | 受限制 | ||
https://www.googleapis.com/auth/drive.metadata |
查看及管理雲端硬碟中檔案的中繼資料。 | 受限制 | ||
https://www.googleapis.com/auth/drive.metadata.readonly |
查看雲端硬碟檔案的中繼資料。 | 受限制 | ||
| Google Meet | ||||
https://www.googleapis.com/auth/meetings.space.created |
允許應用程式建立、修改及讀取應用程式所建立會議空間的中繼資料。 | 敏感 |
||
https://www.googleapis.com/auth/meetings.space.readonly |
允許應用程式讀取使用者有權存取的任何會議空間中繼資料。 | 敏感 |
||
上表的「用途」欄會指出各個範圍的敏感度：
非機密：這類範圍提供的授權存取權範圍最小，只需進行基本的應用程式驗證。如要瞭解這項規定，請參閱「驗證規定」。
機密：這類範圍可讓應用程式存取使用者授權的特定 Google 使用者資料，您必須完成額外的應用程式驗證程序。如要瞭解這項規定，請參閱「敏感和受限制範圍規定」。
受限制：這類範圍可廣泛存取 Google 使用者資料，您必須完成受限制範圍驗證程序。如要瞭解這項規定，請參閱「Google API 服務：使用者資料政策」和「特定 API 範圍的其他規定」。如果您將受限範圍資料儲存在伺服器上 (或傳輸)，則必須接受安全性評估。
如果應用程式需要存取其他 Google API，您也可以新增這些範圍。如要進一步瞭解 Google API 範圍，請參閱「使用 OAuth 2.0 存取 Google API」。
如要進一步瞭解特定 OAuth 2.0 範圍，請參閱「Google API 適用的 OAuth 2.0 範圍」。
OAuth 驗證
使用特定 OAuth 範圍時，應用程式可能需要通過 OAuth 應用程式驗證說明中心。請參閱 OAuth 應用程式常見問題，判斷應用程式何時應進行驗證，以及需要哪種驗證。另請參閱《雲端硬碟服務條款》。
必要的驗證類型
本節說明 Google Workspace Events API 各方法需要或支援的驗證類型，以及支援的範圍。
如要訂閱 Chat 事件，Google Workspace Events API 支援使用者和應用程式驗證，可呼叫部分方法。如果 API 方法同時支援這兩種憑證，呼叫中使用的憑證類型會影響傳回的結果。舉例來說，如果您透過使用者驗證呼叫 subscriptions.list 方法，API 會傳回已驗證使用者可存取的訂閱項目清單。如果使用應用程式驗證，API 會傳回應用程式可存取的訂閱項目清單。如要進一步瞭解 Chat 驗證類型，請參閱「驗證及授權 Chat 擴充應用程式和 Chat API 要求」。
下表列出各個 Google Workspace Events API 方法需要或支援的驗證範圍和類型：
| 方法 | 需要或支援使用者驗證 | 支援應用程式驗證 (僅限 Chat 擴充應用程式) | 支援的授權範圍 | |
|---|---|---|---|---|
| 建立訂閱項目 | — |
使用使用者驗證時，必須為每種事件類型提供支援的範圍：
使用應用程式驗證和管理員核准 (僅限 Google Chat 應用程式)，需要各事件類型支援的範圍：
|
||
| 訂閱 |
如果使用使用者驗證，這個方法需要至少支援一種訂閱事件類型的範圍。 使用應用程式驗證 (僅限 Chat 擴充應用程式)：
|
|||
| 列出訂閱項目 |
如果使用使用者驗證，這個方法需要至少支援一種訂閱事件類型的範圍。 使用應用程式驗證 (僅限 Chat 擴充應用程式)：
|
|||
| 更新訂閱項目 | — |
使用使用者驗證時，必須為每種事件類型提供支援的範圍：
使用應用程式驗證和管理員核准 (僅限 Google Chat 應用程式)，需要各事件類型支援的範圍：
|
||
| 重新啟用訂閱方案 | — |
使用使用者驗證時，必須為每種事件類型提供支援的範圍：
使用應用程式驗證和管理員核准 (僅限 Chat 擴充應用程式)，需要各事件類型支援的範圍：
|
||
| 刪除訂閱項目 |
如果使用使用者驗證，這個方法需要至少支援一種訂閱事件類型的範圍。 使用應用程式驗證 (僅限 Chat 擴充應用程式)：
|
|||
各事件類型的範圍
使用使用者驗證機制呼叫 Google Workspace Events API 時，您必須指定一或多個與訂閱項目事件類型相對應的範圍。
下表列出各事件類型支援的授權範圍：
| 事件 | 事件類型 | 支援的授權範圍 | ||||||
|---|---|---|---|---|---|---|---|---|
| Chat | ||||||||
| 訊息已發布或更新。 |
|
使用「使用者驗證」：
|
||||||
| 新增或刪除回應，或變更多個回應。 |
|
使用「使用者驗證」：
|
||||||
| 建立、更新或移除成員資格，或變更多個成員資格。 |
|
使用「使用者驗證」：
|
||||||
| 聊天室已更新或刪除。 |
|
使用「使用者驗證」：
|
||||||
| 使用者的聊天室讀取狀態或討論串讀取狀態更新。 |
|
使用「使用者驗證」：
|
||||||
| 供應情形已更新。 |
|
使用「使用者驗證」：
|
||||||
| 雲端硬碟 | ||||||||
| 檔案建立、變更、移動、刪除、重新命名、移至垃圾桶或從垃圾桶移除。 |
|
|
||||||
| 檔案的存取權提案已建立或解決。 |
|
|
||||||
| 檔案的核准狀態變更為取消、完成、建立、重設、審查者變更或審查者回覆。 |
|
|
||||||
| 在檔案中建立、刪除、編輯、重新開啟或解決註解。 |
|
|
||||||
| 在檔案中建立、刪除或編輯回覆。 |
|
|
||||||
| 檔案的權限遭到建立、刪除或編輯。 |
|
|
||||||
| Meet | ||||||||
| 會議開始或結束。 |
|
|
||||||
| 出席者加入或離開會議。 |
|
|
||||||
| 已產生錄製內容。 |
|
|
||||||
| 系統已生成轉錄稿。 |
|
|
||||||