Script Service

スクリプト

このサービスは、スクリプト トリガーとスクリプトの公開へのアクセスを提供します。

クラス

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

AuthMode

プロパティ

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

AuthorizationInfo

メソッド

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

AuthorizationStatus

プロパティ

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

CalendarTriggerBuilder

メソッド

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

ClockTriggerBuilder

メソッド

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

メソッド

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

EventType

プロパティ

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

FormTriggerBuilder

メソッド

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

InstallationSource

プロパティ

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

ScriptApp

プロパティ

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

メソッド

メソッド戻り値の型概要
deleteTrigger(trigger)void指定されたトリガーを削除して、実行されないようにします。
getAuthorizationInfo(authMode)AuthorizationInfoユーザーがすべてのスクリプト要件に対する承認を付与しているかどうかを確認するオブジェクトを取得します。
getAuthorizationInfo(authMode, oAuthScopes)AuthorizationInfoリクエストされたスコープに対する承認をユーザーが付与しているかどうかを確認するオブジェクトを取得します。
getIdentityToken()String|nullopenid スコープが付与されている場合、有効なユーザーの 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インストール可能なトリガーを作成するプロセスを開始します。このトリガーが起動すると、指定された関数が呼び出されます。
requireAllScopes(authMode)voidユーザーがスクリプトでリクエストされたすべてのスコープに同意しているかどうかを検証します。
requireScopes(authMode, oAuthScopes)voidユーザーがリクエストされたスコープへの同意を付与しているかどうかを検証します。

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

プロパティ

プロパティタイプ説明
SPREADSHEETSEnumGoogle スプレッドシートでトリガーが起動します。
CLOCKEnum時間ドリブン イベントにより、トリガーが起動します。
FORMSEnumGoogle フォームによってトリガーが起動します。
DOCUMENTSEnumGoogle ドキュメントでトリガーが配信されます。
CALENDAREnumGoogle カレンダーがトリガーを配信します。