本文包含 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 對話的成員。 | 敏感 |
||
https://www.googleapis.com/auth/chat.memberships.readonly |
查看 Google Chat 對話中的成員。 | 敏感 |
||
https://www.googleapis.com/auth/chat.spaces |
在 Google Chat 中建立對話和聊天室,以及查看或更新中繼資料 (包括記錄設定)。 | 敏感內容 | ||
https://www.googleapis.com/auth/chat.spaces.readonly |
在 Google Chat 中查看即時通訊和聊天室。 | 敏感 |
||
https://www.googleapis.com/auth/chat.messages.reaction 秒 |
在 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 |
在 Google 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 雲端硬碟服務條款》。
必要驗證類型
本節說明必要或支援的驗證類型,並提供 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 雲端硬碟 | ||||||||
檔案的建立、變更、移動、刪除、移至垃圾桶或從垃圾桶移除。 |
|
|
||||||
在檔案上建立或解決存取提案。 |
|
|
||||||
Google Meet | ||||||||
電話會議開始或結束。 |
|
|
||||||
參與者加入或退出電話會議。 |
|
|
||||||
系統已生成錄音檔。 |
|
|
||||||
系統已生成轉錄稿。 |
|
|