Script Service

スクリプト

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

クラス

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

AuthMode

プロパティ

プロパティ種類説明
NONEEnum承認が必要なサービスへのアクセスを許可しないモード。
CUSTOM_FUNCTIONEnumカスタム スプレッドシート関数で使用するために一部のサービスへのアクセスを許可するモード。
LIMITEDEnum一部のサービスへのアクセスを許可するモード。
FULLEnum承認を必要とするすべてのサービスへのアクセスを許可するモード。

AuthorizationInfo

Methods

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

AuthorizationStatus

プロパティ

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

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

プロパティ

プロパティ種類説明
CLOCKEnum時間ドリブン イベントが特定の時間に達すると、トリガーが配信されます。
ON_OPENEnumユーザーが Google ドキュメント、スプレッドシート、フォームのファイルを開くと、トリガーが発動します。
ON_EDITEnumトリガーは、ユーザーが Google スプレッドシートのファイルを編集すると(たとえば、セルに新しい値を入力すると、変更ではなく編集としてカウントされます)と配信されます。
ON_FORM_SUBMITEnumユーザーが Google フォームに回答すると、トリガーが発動します。
ON_CHANGEEnumトリガーは、ユーザーが Google スプレッドシート ファイルを変更すると(たとえば、行が追加された場合、編集ではなく変更としてカウントされます)と呼び出されます。
ON_EVENT_UPDATEDEnumトリガーは、指定した Google カレンダーで予定が作成、更新、削除されると配信されます。

FormTriggerBuilder

Methods

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

InstallationSource

プロパティ

プロパティ種類説明
APPS_MARKETPLACE_DOMAIN_ADD_ONEnumユーザーのドメインの管理者がアドオンをインストールしました。
NONEEnumスクリプトはアドオンとして実行されていません。
WEB_STORE_ADD_ONEnumユーザーが Chrome ウェブストアからアドオンをインストールしました。

ScriptApp

プロパティ

プロパティ種類説明
AuthModeAuthModeApps Script がトリガーされた関数を介して実行できる承認済みサービスのカテゴリを識別する列挙型。
AuthorizationStatusAuthorizationStatusスクリプトの承認ステータスを示す列挙型。
EventTypeEventTypeトリガーされたイベントの種類を示す列挙型。
InstallationSourceInstallationSourceスクリプトがアドオンとしてどのようにユーザーにインストールされたかを示す列挙型。
TriggerSourceTriggerSourceトリガーをトリガーするイベントのソースを示す列挙型。
WeekDayWeekday曜日を表す列挙型。

Methods

メソッド戻り値の型概要
deleteTrigger(trigger)void指定されたトリガーを削除して、実行しないようにします。
getAuthorizationInfo(authMode)AuthorizationInfoこのスクリプトが 1 つ以上のサービスを使用するのを承認する必要があるかどうかを判別し、承認ダイアログの URL を提供するために使用するオブジェクトを取得します。
getIdentityToken()Stringopenid スコープが付与されている場合、有効なユーザーの 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

プロパティ

プロパティ種類説明
SPREADSHEETSEnumGoogle スプレッドシートによってトリガーが配信されます。
CLOCKEnum時間ベースのイベントにより、トリガーが配信されます。
FORMSEnumこれにより、Google フォームによってトリガーが配信されます。
DOCUMENTSEnumGoogle ドキュメントによってトリガーが呼び出されます。
CALENDAREnumこれにより、Google カレンダーによってトリガーが配信されます。