Gmail API のスコープの選択

このドキュメントでは、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 Google Chat で下書きを管理し、メールを送信する できます。 機密でない
https://www.googleapis.com/auth/gmail.addons.current.message.action Google Chat でやり取りしたときのメール メッセージの表示 できます。 機密でない
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 Cloud Compute Engine メッセージを即時かつ完全に削除し、 ゴミ箱その他のアクションはすべて、制限の緩いスコープで実行できます。 制限付き

上の表の [使用状況] 列は、各スコープの機密性を示しています。 定義します。

Gmail API の使用とアクセスを規定する追加情報 ユーザーデータへのアクセス リクエストは、 Gmail API サービスのユーザーデータとデベロッパー ポリシー

アプリで他の Google API にアクセスする必要がある場合は、 適用できます。Google API のスコープについて詳しくは OAuth 2.0 を使用した Google API へのアクセス

OAuth の確認

機密性の高い特定の OAuth スコープを使用すると、 Google の OAuth 検証プロセスOAuth の確認に関するよくある質問を読む アプリの検証をいつ行うべきか、またどのような種類の 確認が必要です。関連ドキュメント: Google API サービス: ユーザーデータに関するポリシー