本文說明 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 |
讓 Google Chat 應用程式查看即時通訊和傳送訊息。可存取 Chat 應用程式提供的所有功能。 | 非機密 | ||
https://www.googleapis.com/auth/chat.memberships |
查看、新增及移除 Google Chat 對話的成員。 | Sensitive |
||
https://www.googleapis.com/auth/chat.memberships.readonly |
查看 Google Chat 對話中的成員。 | Sensitive |
||
https://www.googleapis.com/auth/chat.spaces |
在 Google Chat 中建立對話和聊天室,以及查看或更新中繼資料 (包括記錄設定)。 | 敏感內容 | ||
https://www.googleapis.com/auth/chat.spaces.readonly |
在 Google Chat 中查看即時通訊和聊天室。 | Sensitive |
||
https://www.googleapis.com/auth/chat.messages.reaction 秒 |
在 Chat 中查看、新增及刪除訊息回應。 | Sensitive |
||
https://www.googleapis.com/auth/chat.messages.reactions.readonly |
在 Chat 中查看訊息回應。 | Sensitive |
||
https://www.googleapis.com/auth/chat.messages |
查看、撰寫、傳送、更新及刪除訊息,以及新增、查看和刪除訊息的回應。 | 受限制 | ||
https://www.googleapis.com/auth/chat.messages.readonly |
在 Google Chat 中查看訊息和回應。 | 受限制 |
||
Google Meet | ||||
https://www.googleapis.com/auth/meetings.space.created |
允許應用程式建立、修改及讀取應用程式建立的會議空間中繼資料。 | Sensitive |
||
https://www.googleapis.com/auth/meetings.space.readonly |
允許應用程式讀取使用者可存取的任何會議空間的中繼資料。 | Sensitive |
上表中的「用途」欄會根據下列定義,指出每個範圍的敏感度:
非敏感:這些範圍提供最小授權存取範圍,且只需要基本應用程式驗證。如要瞭解這項規定,請參閱「驗證前準備步驟」。
機密:這些範圍可提供存取特定 Google 使用者資料的權限,這些資料已由使用者授權給您的應用程式。您必須進行額外的應用程式驗證。如要瞭解這項規定,請參閱「要求敏感權限範圍的應用程式步驟」
受限制:這些範圍可提供對 Google 使用者資料的廣泛存取權,且需要您完成受限制範圍驗證程序。如需這項規定的相關資訊,請參閱「Google API 服務:使用者資料政策」和「特定 API 範圍的附加規定」。如果您在伺服器上儲存 (或傳輸) 受限制範圍的資料,就必須接受安全性評估。
如果應用程式需要存取其他 Google API,您也可以新增這些範圍。如要進一步瞭解 Google API 範圍,請參閱「使用 OAuth 2.0 存取 Google API」。
如要進一步瞭解特定 OAuth 2.0 範圍,請參閱「Google API 適用的 OAuth 2.0 範圍」。
OAuth 驗證
如要使用特定 OAuth 範圍,應用程式可能需要通過 Google 的 OAuth 驗證程序。請參閱 OAuth API 驗證常見問題,瞭解應用程式何時需要通過驗證,以及需要哪種驗證。另請參閱 Google 雲端硬碟附加服務條款。
必要驗證類型
本節說明需要或支援哪些類型的驗證,並提供 Google Workspace Events API 各個方法支援的範圍。
針對 Google Chat 事件的訂閱項目,Google Workspace Events API 支援使用者和應用程式驗證,以便呼叫部分方法。如果 API 方法支援兩種憑證,在呼叫中使用的憑證類型會影響傳回的結果。舉例來說,如果您使用使用者驗證功能呼叫 subscriptions.list()
方法,API 會傳回已驗證使用者可存取的訂閱項目清單。如果您使用應用程式驗證,API 會傳回 應用程式 可存取的訂閱項目清單。如要進一步瞭解 Chat 驗證類型,請參閱「驗證及授權 Chat 應用程式和 Google Chat API 要求」。
下表列出每個 Google Workspace Events API 方法所需或支援的驗證範圍和類型:
方法 | 需要或支援使用者驗證 | 支援應用程式驗證 (僅限 Google Chat 應用程式) | 支援的授權範圍 | |
---|---|---|---|---|
建立訂閱項目 | — |
需要每個事件類型的支援範圍:
|
||
取得訂閱 |
使用者驗證時,此方法需要訂閱範圍至少支援一種事件類型。 使用應用程式驗證 (僅限 Google Chat 應用程式):
|
|||
列出訂閱項目 |
使用者驗證時,此方法需要訂閱範圍至少支援一種事件類型。 使用應用程式驗證 (僅限 Google Chat 應用程式):
|
|||
更新訂閱 | — |
需要每個事件類型的支援範圍:
|
||
重新啟用訂閱方案 | — |
需要每個事件類型的支援範圍:
|
||
刪除訂閱項目 |
使用者驗證時,此方法需要訂閱範圍至少支援一種事件類型。 使用應用程式驗證 (僅限 Google Chat 應用程式):
|
依事件類型劃分範圍
使用使用者驗證功能呼叫 Google Workspace Events API 時,您必須指定一或多個範圍,以對應訂閱的事件類型。
下表列出各事件類型支援的授權範圍:
事件 | 事件類型 | 支援的授權範圍 | ||||||
---|---|---|---|---|---|---|---|---|
Google Chat | ||||||||
發布或更新訊息。 |
|
|
||||||
新增或刪除回應,或變更多個回應。 |
|
|
||||||
建立、更新或移除會員資格,或變更多個會員資格。 |
|
|
||||||
聊天室已更新或刪除。 |
|
|
||||||
Google Meet | ||||||||
會議開始或結束。 |
|
|
||||||
參與者加入或離開會議。 |
|
|
||||||
系統已產生錄音檔。 |
|
|
||||||
系統已產生轉錄稿。 |
|
|