スコープ

ユーザーは、自分のデータにアクセスするアドオンやその他のアプリ、またはユーザーに代わって動作するアプリを承認する必要があります。ユーザーが初めてアドオンを実行すると、 アドオン UI に承認フローを開始する承認プロンプトが表示されます。

このフローの中で、プロンプトはアプリケーションが要求するものをユーザーに伝えます。 できます。たとえば、アドオンがファイルに対する読み取り権限、 ユーザーのメール メッセージを作成したり、カレンダーで予定を作成したりできます。アドオンのスクリプト プロジェクトでは、これらの個々の権限を OAuth スコープとして定義しています。

マニフェストでスコープを宣言する URL 文字列を使用します。承認フロー中に、Apps Script はスコープの人間が判読できる説明をユーザーに提示します。たとえば、Google Workspace アドオンで「現在のメッセージの読み取り」スコープを使用する場合、マニフェストには https://www.googleapis.com/auth/gmail.addons.current.message.readonly と記述されます。イベント中 承認フローで、このスコープを持つアドオンがユーザーに アドオン: アドオンの実行中にメール メッセージを表示する。

スコープの表示

スクリプト プロジェクトで現在必要なスコープを確認する手順は次のとおりです。

1. スクリプト プロジェクトを開きます。
2. 左側の [概要] をクリックします。 info_outline。
3. [プロジェクトの OAuth スコープ] でスコープを確認します。

プロジェクト マニフェストで、スクリプト プロジェクトの現在のスコープを確認することもできます。 oauthScopes ただし、これらのスコープが明示的に設定されている場合に限ります。

明示的なスコープを設定する

Apps Script は、コードをスキャンして、必要な関数呼び出しを検出し、スクリプトに必要なスコープを自動的に決定します。ほとんどのスクリプトではこれで十分で、時間を節約できますが、公開済みのアドオンの場合は、スコープをより直接的に制御する必要があります。

たとえば、Apps Script では、デフォルトでアドオン スクリプト プロジェクトに非常に許容度の高いスコープ https://mail.google.com が付与されます。ユーザーがスクリプトを承認したとき このスコープでプロジェクトを作成すると、そのプロジェクトにユーザーの Gmail への あります。公開されているアドオンの場合、このスコープをよりより アドオンのニーズに応える限定セットであり、これ以上のものはありません。

スクリプト プロジェクトで使用するスコープは、 そのマニフェスト ファイルを実行します。マニフェスト フィールド oauthScopes は配列です。 スコープの総称です。プロジェクトのスコープを設定するには、次の手順を実施します。 次のとおりです。

1. アドオンで現在使用されているスコープを表示する。決定する 変更が必要になった場合です。
2. アドオンのマニフェスト ファイルを開きます。
3. 最上位の oauthScopes フィールドを見つけます。見つからない場合は 追加できます。

4. oauthScopes フィールドには文字列の配列を指定します。プロジェクトで使用するスコープを設定するには、この配列の内容を、使用するスコープに置き換えます。たとえば、Gmail を拡張する Google Workspace アドオンの場合、次のような場合があります。

   {
     ...
     "oauthScopes": [
       "https://www.googleapis.com/auth/gmail.addons.current.message.metadata",
       "https://www.googleapis.com/auth/userinfo.email"
     ],
     ...
   }
   

5. マニフェスト ファイルの変更を保存します。

OAuth の確認

機密性の高い特定の OAuth スコープを使用すると、 OAuth クライアントの確認 いくつかのステップがあります詳細については、次のガイドをご覧ください。

• Apps Script の OAuth クライアントの確認
• 未確認のアプリ
• OAuth の確認に関するよくある質問
• Google API サービス: ユーザーデータ ポリシー

制限付きスコープ

特定のスコープは制限されており、それに役立つ追加のルールが適用されます。 ユーザーデータを保護できます。公開しようとしている Gmail またはエディタのアドオンで 制限付きスコープを使用する場合、アドオンは指定されたすべての 制限することもできます。

公開を試みる前に、制限付きスコープの一覧を確認してください。アドオンでこれらの API を使用する場合は、公開前に特定の API スコープの追加要件に準拠する必要があります。

カレンダー スコープ

以下は、Google カレンダーを拡張する Google Workspace アドオンでよく使用されるスコープです。

ドライブのスコープ

以下は、Google ドライブを拡張する Google Workspace アドオンでよく使用されるスコープです。

Gmail アドオンのスコープ

Google Cloud 用に作成されたスコープがいくつかあり、 ユーザーの Gmail を保護する Google Workspace アドオン 分析できます必要なこと これらのスコープを明示的に追加する 他の依存関係とともに、アドオン マニフェストに 必要ありません。

以下は、Gmail を拡張する Google Workspace アドオンでよく使用されるスコープです。アドオンが Gmail を拡張する場合は、[必須] とラベル付けされているスコープを Google Workspace アドオン マニフェストに追加する必要があります。

また、アドオンの非常に広範な https://mail.google.com スコープを、アドオンに必要な操作のみを許可する、より狭いスコープのセットに置き換えてください。

アクセス トークン

ユーザーデータを保護するため、Google Chat で使用される Google Workspace アドオンのみの付与 ユーザーデータへのアクセスを一時的に許可できます。一時的なアクセスを有効にするには、 関数 GmailApp.setCurrentMessageAccessToken(accessToken) 引数としてアクセス トークンを使用します。アクセス トークンは、 アクション イベント オブジェクト。

以下は、アクセスを許可するアクセス トークンを設定する例です。 メッセージのメタデータ。この例に必要なスコープは https://www.googleapis.com/auth/gmail.addons.current.message.metadata のみです。

function readSender(e) {
  var accessToken = e.gmail.accessToken;
  var messageId = e.gmail.messageId;

  // The following function enables short-lived access to the current
  // message in Gmail. Access to other Gmail messages or data isn't
  // permitted.
  GmailApp.setCurrentMessageAccessToken(accessToken);
  var mailMessage = GmailApp.getMessageById(messageId);
  return mailMessage.getFrom();
}

エディタのスコープ

以下は、ドキュメント、スプレッドシート、スライドを拡張する Google Workspace アドオンでよく使用されるスコープです。

その他のスコープ

アドオンで他の Apps Script サービスを使用する場合は、追加のスコープが必要になることがあります。ほとんどの場合、これらのスコープを Apps Script が検出してマニフェストを自動的に更新できます。マニフェストのスコープリストを編集する際は、より適切な代替手段（より狭いスコープなど）に置き換える場合を除き、スコープを削除しないでください。

参考までに、この API でよく使用される Apps Script スコープのリストを Google Workspace アドオンと組み合わせることで、