このページは Cloud Translation API によって翻訳されました。

Script Service

このサービスは、スクリプトトリガーとスクリプトの公開にアクセスできるようにします。

クラス

名前	概要
`AuthMode`	トリガーされた関数で Apps Script が実行できる承認済みサービスのカテゴリを識別する列挙型。
`AuthorizationInfo`	1 つ以上のサービスを使用するためにユーザーがこのスクリプトを承認する必要があるかどうかを判断し、承認ダイアログの URL を提供するのに使用されるオブジェクト。
`AuthorizationStatus`	スクリプトの承認ステータスを示す列挙型。
`CalendarTriggerBuilder`	カレンダートリガーのビルダー。
`ClockTriggerBuilder`	時刻トリガーのビルダー。
`DocumentTriggerBuilder`	ドキュメントトリガーのビルダー。
`EventType`	トリガーされたイベントのタイプを示す列挙型。
`FormTriggerBuilder`	フォームトリガーのビルダー。
`InstallationSource`	スクリプトが現在のユーザーのアドオンとしてインストールされた方法を示す列挙型。
`ScriptApp`	スクリプトの公開とトリガーにアクセスして操作する。
`Service`	スクリプトの公開にアクセスして操作する。
`SpreadsheetTriggerBuilder`	スプレッドシートトリガーのビルダー。
`StateTokenBuilder`	スクリプトで、コールバック API（OAuth フローなど）で使用できる状態トークンを作成できるようにします。
`Trigger`	スクリプトトリガー。
`TriggerBuilder`	スクリプトトリガーの汎用ビルダー。
`TriggerSource`	トリガーをトリガーするイベントのソースを示す列挙型。

`AuthMode`

プロパティ

プロパティ	タイプ	説明
`NONE`	`Enum`	認可を必要とするサービスへのアクセスを許可しないモード。
`CUSTOM_FUNCTION`	`Enum`	カスタムスプレッドシート関数で使用するために、限定されたサービスのサブセットへのアクセスを許可するモード。
`LIMITED`	`Enum`	サービスの限定されたサブセットへのアクセスを許可するモード。
`FULL`	`Enum`	認可が必要なすべてのサービスへのアクセスを許可するモード。

`AuthorizationInfo`

メソッド

メソッド	戻り値の型	概要
`getAuthorizationStatus()`	`AuthorizationStatus`	1 つ以上のサービス（`ScriptApp.AuthorizationStatus.REQUIRED` など）を使用するようにこのスクリプトを承認する必要があるかどうかを示す値を取得します。
`getAuthorizationUrl()`	`String`	スクリプトへのアクセス権の付与に使用できる認証 URL を取得します。

`AuthorizationStatus`

プロパティ

プロパティ	タイプ	説明
`REQUIRED`	`Enum`	1 つ以上のサービスを使用できるように、このスクリプトを承認する必要があります。
`NOT_REQUIRED`	`Enum`	ユーザーが、このスクリプトに現在必要なすべての承認を付与している。

`CalendarTriggerBuilder`

メソッド

メソッド	戻り値の型	概要
`create()`	`Trigger`	トリガーを作成して返します。
`onEventUpdated()`	`CalendarTriggerBuilder`	カレンダーエントリが作成、更新、削除されたときにトリガーされるトリガーを指定します。

`ClockTriggerBuilder`

メソッド

メソッド	戻り値の型	概要
`after(durationMilliseconds)`	`ClockTriggerBuilder`	トリガーが実行されるまでの最小時間（ミリ秒単位）を指定します。
`at(date)`	`ClockTriggerBuilder`	トリガーの実行タイミングを指定します。
`atDate(year, month, day)`	`ClockTriggerBuilder`	指定した日にトリガーを発生させます。デフォルトでは深夜（± 15 分）に発生します。
`atHour(hour)`	`ClockTriggerBuilder`	トリガーが実行される時刻を指定します。
`create()`	`Trigger`	トリガーを作成します。
`everyDays(n)`	`ClockTriggerBuilder`	トリガーを `n` 日ごとに実行するように指定します。
`everyHours(n)`	`ClockTriggerBuilder`	トリガーを `n` 時間ごとに実行するように指定します。
`everyMinutes(n)`	`ClockTriggerBuilder`	トリガーを `n` 分ごとに実行するように指定します。
`everyWeeks(n)`	`ClockTriggerBuilder`	トリガーを `n` 週間ごとに実行するように指定します。
`inTimezone(timezone)`	`ClockTriggerBuilder`	トリガーが実行される日時で使用するタイムゾーンを指定します。
`nearMinute(minute)`	`ClockTriggerBuilder`	トリガーが実行される分（±15 分）を指定します。
`onMonthDay(day)`	`ClockTriggerBuilder`	トリガーが実行される月の日付を指定します。
`onWeekDay(day)`	`ClockTriggerBuilder`	トリガーが実行される曜日を指定します。

`DocumentTriggerBuilder`

メソッド

メソッド	戻り値の型	概要
`create()`	`Trigger`	新しいトリガーを作成して返します。
`onOpen()`	`DocumentTriggerBuilder`	ドキュメントが開かれたときにトリガーされるトリガーを指定します。

`EventType`

プロパティ

プロパティ	タイプ	説明
`CLOCK`	`Enum`	時間ベースのイベントが特定の時刻に達すると、トリガーが起動します。
`ON_OPEN`	`Enum`	ユーザーが Google ドキュメント、スプレッドシート、フォームのファイルを開くと、トリガーが実行されます。
`ON_EDIT`	`Enum`	トリガーは、ユーザーが Google スプレッドシートファイルを編集すると（たとえば、セルに新しい値を入力すると、変更ではなく編集としてカウントされます）トリガーがトリガーされます。
`ON_FORM_SUBMIT`	`Enum`	ユーザーが Google フォームに回答すると、トリガーが実行されます。
`ON_CHANGE`	`Enum`	トリガーは、ユーザーが Google スプレッドシートファイルを変更すると（たとえば、行を追加すると、これは編集ではなく変更としてカウントされます）トリガーが実行されます。
`ON_EVENT_UPDATED`	`Enum`	指定した Google カレンダーで予定が作成、更新、削除されると、トリガーが実行されます。

`FormTriggerBuilder`

メソッド

メソッド	戻り値の型	概要
`create()`	`Trigger`	新しいトリガーを作成して返します。
`onFormSubmit()`	`FormTriggerBuilder`	フォームに回答が送信されたときにトリガーされるトリガーを指定します。
`onOpen()`	`FormTriggerBuilder`	フォームの編集ビューが開かれたときにトリガーされるトリガーを指定します。

`InstallationSource`

プロパティ

プロパティ	タイプ	説明
`APPS_MARKETPLACE_DOMAIN_ADD_ON`	`Enum`	アドオンがユーザーのドメイン用に管理者によってインストールされている。
`NONE`	`Enum`	スクリプトがアドオンとして実行されていない。
`WEB_STORE_ADD_ON`	`Enum`	アドオンはユーザーが Chrome ウェブストアからインストールしたものです。

`ScriptApp`

プロパティ

プロパティ	タイプ	説明
`AuthMode`	`AuthMode`	トリガーされた関数で Apps Script が実行できる承認済みサービスのカテゴリを識別する列挙型。
`AuthorizationStatus`	`AuthorizationStatus`	スクリプトの承認ステータスを示す列挙型。
`EventType`	`EventType`	トリガーされたイベントのタイプを示す列挙型。
`InstallationSource`	`InstallationSource`	スクリプトがアドオンとしてユーザーにインストールされた方法を示す列挙型。
`TriggerSource`	`TriggerSource`	トリガーをトリガーするイベントのソースを示す列挙型。
`WeekDay`	`Weekday`	曜日を表す列挙型。

メソッド

メソッド	戻り値の型	概要
`deleteTrigger(trigger)`	`void`	指定したトリガーを削除して、トリガーが実行されないようにします。
`getAuthorizationInfo(authMode)`	`AuthorizationInfo`	1 つ以上のサービスを使用するためにユーザーがこのスクリプトを承認する必要があるかどうかを判断し、承認ダイアログの URL を提供するのに使用されるオブジェクトを取得します。
`getIdentityToken()`	`String`	`openid` スコープが付与されている場合、有効なユーザーの OpenID Connect ID トークンを取得します。
`getInstallationSource()`	`InstallationSource`	現在のユーザー用にスクリプトがアドオンとしてインストールされた方法（ユーザーが Chrome ウェブストアから個人的にインストールしたのか、ドメイン管理者がすべてのユーザーにインストールしたのかなど）を示す列挙型の値を返します。
`getOAuthToken()`	`String`	有効なユーザーの OAuth 2.0 アクセストークンを取得します。
`getProjectTriggers()`	`Trigger[]`	現在のプロジェクトと現在のユーザーに関連付けられている、インストール可能なすべてのトリガーを取得します。
`getScriptId()`	`String`	スクリプトプロジェクトの一意の ID を取得します。
`getService()`	`Service`	スクリプトをウェブアプリとして公開する際に使用するオブジェクトを取得します。
`getUserTriggers(document)`	`Trigger[]`	指定されたドキュメントで、このユーザーが所有する、このスクリプトまたはアドオンにのみインストール可能なトリガーをすべて取得します。
`getUserTriggers(form)`	`Trigger[]`	このユーザーが所有する、指定されたフォームのインストール可能なトリガーをすべて取得します（このスクリプトまたはアドオンに限ります）。
`getUserTriggers(spreadsheet)`	`Trigger[]`	指定されたスプレッドシートで、このユーザーが所有する、このスクリプトまたはアドオンにのみインストール可能なすべてのトリガーを取得します。
`invalidateAuth()`	`void`	有効なユーザーが現在のスクリプトを実行するための承認を無効にします。
`newStateToken()`	`StateTokenBuilder`	コールバック API（OAuth フローなど）で使用できる状態トークンのビルダーを作成します。
`newTrigger(functionName)`	`TriggerBuilder`	トリガーが発生したときに特定の関数を呼び出す、インストール可能なトリガーの作成プロセスを開始します。

`Service`

メソッド

メソッド	戻り値の型	概要
`getUrl()`	`String`	ウェブアプリがデプロイされている場合はその URL を返し、そうでない場合は `null` を返します。
`isEnabled()`	`Boolean`	スクリプトにウェブアプリとしてアクセスできる場合は `true` を返します。

`SpreadsheetTriggerBuilder`

メソッド

メソッド	戻り値の型	概要
`create()`	`Trigger`	トリガーを作成して返します。
`onChange()`	`SpreadsheetTriggerBuilder`	スプレッドシートの内容または構造が変更されたときにトリガーされるトリガーを指定します。
`onEdit()`	`SpreadsheetTriggerBuilder`	スプレッドシートが編集されたときにトリガーされるトリガーを指定します。
`onFormSubmit()`	`SpreadsheetTriggerBuilder`	スプレッドシートにフォームが送信されたときにトリガーされるトリガーを指定します。
`onOpen()`	`SpreadsheetTriggerBuilder`	スプレッドシートを開いたときに実行されるトリガーを指定します。

`StateTokenBuilder`

メソッド

メソッド	戻り値の型	概要
`createToken()`	`String`	状態トークンの暗号化された文字列表現を構築します。
`withArgument(name, value)`	`StateTokenBuilder`	トークンに引数を追加します。
`withMethod(method)`	`StateTokenBuilder`	コールバック関数を設定します。
`withTimeout(seconds)`	`StateTokenBuilder`	トークンが有効な期間（秒単位）を設定します。

`Trigger`

メソッド

メソッド	戻り値の型	概要
`getEventType()`	`EventType`	トリガーがトリガーされるイベントタイプを返します。
`getHandlerFunction()`	`String`	トリガーがトリガーされたときに呼び出される関数を返します。
`getTriggerSource()`	`TriggerSource`	トリガーをトリガーするイベントのソースを返します。
`getTriggerSourceId()`	`String`	ソースに固有の ID を返します。
`getUniqueId()`	`String`	トリガーを区別するために使用できる一意の識別子を返します。

`TriggerBuilder`

メソッド

メソッド	戻り値の型	概要
`forDocument(document)`	`DocumentTriggerBuilder`	指定されたドキュメントに関連付けられた `DocumentTriggerBuilder` を作成して返します。
`forDocument(key)`	`DocumentTriggerBuilder`	指定された ID のドキュメントに関連付けられた `DocumentTriggerBuilder` を作成して返します。
`forForm(form)`	`FormTriggerBuilder`	指定されたフォームに関連付けられた `FormTriggerBuilder` を作成して返します。
`forForm(key)`	`FormTriggerBuilder`	指定された ID のフォームに関連付けられた `FormTriggerBuilder` を作成して返します。
`forSpreadsheet(sheet)`	`SpreadsheetTriggerBuilder`	指定されたスプレッドシートに関連付けられた `SpreadsheetTriggerBuilder` を作成して返します。
`forSpreadsheet(key)`	`SpreadsheetTriggerBuilder`	指定された ID のスプレッドシートに関連付けられた `SpreadsheetTriggerBuilder` を作成して返します。
`forUserCalendar(emailId)`	`CalendarTriggerBuilder`	カレンダートリガーを作成するためのビルダーを返します。
`timeBased()`	`ClockTriggerBuilder`	時間ベースのトリガーを構築するための `ClockTriggerBuilder` を作成して返します。

`TriggerSource`

プロパティ

プロパティ	タイプ	説明
`SPREADSHEETS`	`Enum`	Google スプレッドシートがトリガーを起動します。
`CLOCK`	`Enum`	時間ベースのイベントによってトリガーが配信されます。
`FORMS`	`Enum`	Google フォームによってトリガーが配信されます。
`DOCUMENTS`	`Enum`	Google ドキュメントがトリガーを配信します。
`CALENDAR`	`Enum`	Google カレンダーがトリガーを配信します。

特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。

最終更新日 2024-12-03 UTC。

ブログ
Google Workspace Developers ブログを読む
スタックオーバーフロー
google-apps-script タグで質問する
コードサンプル
コードサンプルを確認するかコピーして、独自のコードを構築します
動画
Apps Script のチュートリアルを見る