本文包含 Gmail API 專屬的授權和驗證資訊。閱讀本文前,請務必參閱「瞭解驗證和授權」一文,瞭解 Google Workspace 的一般驗證和授權資訊。
設定 OAuth 2.0 授權
設定 OAuth 同意畫面並選擇範圍,即可定義要向使用者和應用程式審查人員顯示哪些資訊,並註冊應用程式,以便日後發布。
Gmail API 範圍
如要定義授予應用程式的存取權層級,您必須識別並宣告授權範圍。授權範圍是 OAuth 2.0 URI 字串,其中包含 Google Workspace 應用程式名稱、應用程式存取的資料類型,以及存取層級。「範圍」是指應用程式要求處理 Google Workspace 資料的權限,包括使用者的 Google 帳戶資料。
安裝應用程式時,系統會要求使用者驗證應用程式使用的範圍。一般來說,您應盡可能選擇最狹隘的範圍,並避免要求應用程式不需要的範圍。使用者更願意授予明確說明的有限範圍存取權。
Gmail API 支援下列範圍:
範圍代碼 | 說明 | 用量 |
---|---|---|
https://www.googleapis.com/auth/gmail.addons.current.action.compose |
在你使用外掛程式時管理草稿及傳送電子郵件。 | 非機密 |
https://www.googleapis.com/auth/gmail.addons.current.message.action |
在您使用外掛程式時查看您的電子郵件。 | 非機密 |
https://www.googleapis.com/auth/gmail.addons.current.message.metadata |
在外掛程式執行時,查看電子郵件中繼資料。 | 敏感內容 |
https://www.googleapis.com/auth/gmail.addons.current.message.readonly |
在外掛程式執行期間查看電子郵件。 | 敏感內容 |
https://www.googleapis.com/auth/gmail.labels |
僅限建立、讀取、更新及刪除標籤。 | 非機密 |
https://www.googleapis.com/auth/gmail.send |
僅傳送訊息。沒有讀取或修改信箱的權限。 | 敏感內容 |
https://www.googleapis.com/auth/gmail.readonly |
讀取所有資源及其中繼資料,但不執行寫入作業。 | 受限制 |
https://www.googleapis.com/auth/gmail.compose |
建立、讀取、更新及刪除草稿。傳送訊息和草稿。 | 受限制 |
https://www.googleapis.com/auth/gmail.insert |
僅插入及匯入訊息。 | 受限制 |
https://www.googleapis.com/auth/gmail.modify |
所有讀取/寫入作業,除了立即永久刪除會話和訊息 (略過垃圾桶) 的作業。 | 受限制 |
https://www.googleapis.com/auth/gmail.metadata |
讀取資源中繼資料,包括標籤、記錄記錄和電子郵件標頭,但不包括郵件內文或附件。 | 受限制 |
https://www.googleapis.com/auth/gmail.settings.basic |
管理基本郵件設定。 | 受限制 |
https://www.googleapis.com/auth/gmail.settings.sharing |
管理機密郵件設定,包括轉寄規則和別名。 注意:受此範圍保護的作業僅限於行政用途。只有使用全網域委派權限的服務帳戶的 Google Workspace 客戶才能使用這些功能。 |
受限制 |
https://mail.google.com/ |
對帳戶的收件匣擁有完整存取權,包括永久刪除會話和訊息。只有在應用程式需要立即永久刪除會話和訊息,且不經過「垃圾桶」時,才應要求此權限範圍;所有其他動作都可以使用較不嚴格的權限範圍執行。 | 受限制 |
上表中的「用途」欄會根據下列定義,指出每個範圍的敏感度:
非敏感資料:這些範圍提供最小範圍的授權存取權,且只需要基本應用程式驗證。如要進一步瞭解這項規定,請參閱「驗證準備程序步驟」。
機密:這些範圍允許存取 Google 使用者資料,且需要進行機密範圍驗證程序。如需這項規定的相關資訊,請參閱《Google API 服務:使用者資料政策》。這些權限範圍不需要安全性評估。
受限制:這些範圍可廣泛存取 Google 使用者資料,且需要您完成受限制範圍驗證程序。如需這項規定的相關資訊,請參閱「Google API 服務:使用者資料政策」和「特定 API 範圍的附加規定」。如果您在伺服器上儲存 (或傳輸) 受限制範圍的資料,就必須接受安全性評估。
如要進一步瞭解在您要求存取使用者資料時,如何使用及存取 Gmail API,請參閱 Gmail API 服務使用者資料和開發人員政策。
如果您的應用程式需要存取任何其他 Google API,您也可以新增這些範圍。如要進一步瞭解 Google API 範圍,請參閱「使用 OAuth 2.0 存取 Google API」。
OAuth 驗證
如要使用特定的敏感 OAuth 範圍,應用程式可能需要通過 Google 的 OAuth 驗證程序。請參閱 OAuth 驗證常見問題,瞭解應用程式何時應通過驗證,以及需要哪種驗證。另請參閱 Google API 服務:使用者資料政策。