マニフェストの構造

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

マニフェストのサブストラクチャは、別々のページで定義されています。

マニフェスト

マニフェスト構成の最上位。

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": {
          "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)

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