本文件包含 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 服務:使用者資料政策。