マニフェストの構造

このページでは、Apps Script プロジェクトのマニフェスト ファイルの JSON データ構造の最上位について説明します。マニフェストでは、Apps Script プロジェクトの機能または目的を定義します。

JSON 表現
{
  "addOns": {
    object (AddOns)
  },
  "chat": {},
  "dependencies": {
    object (Dependencies)
  },
  "exceptionLogging": string,
  "executionApi": {
    object (ExecutionApi)
  },
  "oauthScopes": [
    string
  ],
  "runtimeVersion": string,
  "sheets": {
    object (Sheets)
  },
  "timeZone": string,
  "urlFetchWhitelist": [
    string
  ],
  "webapp": {
    object (Webapp)
  }
}
フィールド
addOns

object (AddOns)

Google Workspace アドオンとしてデプロイされた場合のプロジェクトのリソース構成。

chat

object

Google Chat 用アプリとしてデプロイされた場合のプロジェクトの構成。Chat 用アプリの詳細を構成するには、Google Chat API を有効にする必要があります。詳細については、Google Chat API を構成するをご覧ください。

Apps Script は、スクリプト レベルで承認を処理します。承認が必要な Chat 用アプリは、ユーザーが Chat 用アプリを承認するまでアクションを実行できません。承認前にメッセージを投稿するには、マニフェストに addToSpaceFallbackMessage オブジェクトを追加します。Chat 用アプリに初期化ロジックが必要な場合は、onMessage アクションでこのロジックを複製する必要があることがあります。

次の例は、ユーザーが Chat スペースに Chat 用アプリを追加したときに、デフォルトのウェルカム メッセージで応答する Chat 用アプリを示しています。

        "chat": {
          "addToSpaceFallbackMessage": "Thank you for adding me!"
        }
        

dependencies

object (Dependencies)

スクリプト プロジェクトで使用できるように有効になっている 拡張サービスライブラリの構成。

exceptionLogging

string

例外がロギングされる場所。有効な設定は次のとおりです。

  • NONE は、例外がログに記録されないことを示します。
  • STACKDRIVER は、例外が Stackdriver に記録されることを示します。
executionApi

object (ExecutionApi)

スクリプト プロジェクトの API 実行可能構成。これは、プロジェクトが API 実行用にデプロイされている場合にのみ使用されます。

oauthScopes[]

string

スクリプト プロジェクトで使用される認可スコープの定義。

runtimeVersion

string

スクリプトが使用しているランタイム バージョン。このフィールドがマニフェストに存在しない場合、スクリプトはデフォルトのランタイム(STABLE)を使用します。このフィールドの有効なオプションは次のとおりです。

  • STABLE は、デフォルトのランタイム(現在は Rhino)を示します。
  • V8 は、V8 を搭載したランタイムを示します。
  • DEPRECATED_ES5 は Rhino ランタイムを示します。この値を設定すると、V8 への自動移行も防止されます。
sheets

object (Sheets)

スプレッドシート マクロを定義するリソース構成。

timeZone

string

使用可能な ZoneId 値(「America/Denver」など)のいずれかの スクリプト タイムゾーン

urlFetchWhitelist[]

string

HTTPS URL 接頭辞のリスト。存在する場合、取得された URL エンドポイントは、このリストのいずれかの接頭辞に一致する必要があります。このプロパティは、ユーザーデータの保護に役立ちます。このフィールドはテスト デプロイでは省略可能ですが、デプロイでは必須です。詳しくは、URL を許可リストに登録するをご覧ください。

webapp

object (Webapp)

スクリプト プロジェクトのウェブアプリ構成。プロジェクトがウェブアプリとしてデプロイされている場合にのみ使用されます。