このページは 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`

Methods

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

`AuthorizationStatus`

プロパティ

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

`CalendarTriggerBuilder`

Methods

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

`ClockTriggerBuilder`

Methods

メソッド	戻り値の型	概要
`after(durationMilliseconds)`	`ClockTriggerBuilder`	現在のトリガー実行時刻以降の最小期間（ミリ秒単位）を指定します。
`at(date)`	`ClockTriggerBuilder`	トリガーの実行タイミングを指定します。
`atDate(year, month, day)`	`ClockTriggerBuilder`	指定した日付にトリガーを起動するように指定します。デフォルトでは深夜 0 時前後（+/- 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`

Methods

メソッド	戻り値の型	概要
`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`

Methods

メソッド	戻り値の型	概要
`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`	曜日を表す列挙型。

Methods

メソッド	戻り値の型	概要
`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`

Methods

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

`SpreadsheetTriggerBuilder`

Methods

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

`StateTokenBuilder`

Methods

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

`Trigger`

Methods

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

`TriggerBuilder`

Methods

メソッド	戻り値の型	概要
`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 および関連会社の登録商標です。

最終更新日 2023-12-01 UTC。

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