このサービスは、スクリプト トリガーとスクリプトの公開へのアクセスを提供します。
クラス
| 名前 | 概要 |
|---|---|
Auth | トリガーされた関数を介して Apps Script が実行できる承認済みサービスのカテゴリを識別する列挙型。 |
Authorization | スクリプトの必要なスコープに対する承認をユーザーが付与しているかどうかを確認するオブジェクト。 |
Authorization | スクリプトの承認ステータスを示す列挙型。 |
Calendar | カレンダー トリガーのビルダー。 |
Clock | クロック トリガーのビルダー。 |
Document | ドキュメント トリガーのビルダー。 |
Event | トリガーされたイベントのタイプを示す列挙型。 |
Form | フォームトリガーのビルダー。 |
Installation | 現在のユーザーのアドオンとしてスクリプトがインストールされた方法を示す列挙型。 |
Script | スクリプトの公開とトリガーにアクセスして操作します。 |
Service | スクリプトの公開にアクセスして操作します。 |
Spreadsheet | スプレッドシート トリガーのビルダー。 |
State | スクリプトがコールバック API(OAuth フローなど)で使用できる状態トークンを作成できるようにします。 |
Trigger | スクリプト トリガー。 |
Trigger | スクリプト トリガーの汎用ビルダー。 |
Trigger | トリガーを起動するイベントのソースを示す列挙型。 |
Auth Mode
プロパティ
| プロパティ | タイプ | 説明 |
|---|---|---|
NONE | Enum | 認証が必要なサービスへのアクセスを許可しないモード。 |
CUSTOM_FUNCTION | Enum | カスタム スプレッドシート関数で使用するために、サービスの限定されたサブセットへのアクセスを許可するモード。 |
LIMITED | Enum | サービスの限定されたサブセットへのアクセスを許可するモード。 |
FULL | Enum | 認可が必要なすべてのサービスへのアクセスを許可するモード。 |
Authorization Info
メソッド
| メソッド | 戻り値の型 | 概要 |
|---|---|---|
get | Authorization | ユーザーが 1 つ以上のサービス(Script など)を使用するためにこのスクリプトを承認する必要があるかどうかを示す値を取得します。 |
get | String|null | スクリプトへのアクセス権の付与に使用できる認証 URL を取得します。 |
get | String[]|null | スクリプトの承認済みスコープのリストを取得します。 |
Authorization Status
プロパティ
| プロパティ | タイプ | 説明 |
|---|---|---|
REQUIRED | Enum | ユーザーは、1 つ以上のサービスを使用するためにこのスクリプトを承認する必要があります。 |
NOT_REQUIRED | Enum | ユーザーは、このスクリプトが現在必要とするすべての認証を付与しています。 |
Calendar Trigger Builder
メソッド
| メソッド | 戻り値の型 | 概要 |
|---|---|---|
create() | Trigger | トリガーを作成して返します。 |
on | Calendar | カレンダー エントリが作成、更新、削除されたときにトリガーされるトリガーを指定します。 |
Clock Trigger Builder
メソッド
| メソッド | 戻り値の型 | 概要 |
|---|---|---|
after(durationMilliseconds) | Clock | トリガーが実行されるまでの現在時刻からの最小期間(ミリ秒単位)を指定します。 |
at(date) | Clock | トリガーが実行されるタイミングを指定します。 |
at | Clock | トリガーが指定された日付に起動することを指定します。デフォルトでは、午前 0 時の前後 15 分です。 |
at | Clock | トリガーが実行されるトリガーの時間を指定します。 |
create() | Trigger | トリガーを作成します。 |
every | Clock | トリガーを n 日ごとに実行するように指定します。 |
every | Clock | トリガーを n 時間ごとに実行するように指定します。 |
every | Clock | トリガーを n 分ごとに実行するように指定します。 |
every | Clock | トリガーを n 週間ごとに実行するように指定します。 |
in | Clock | トリガーが実行される指定された日付/時刻のタイムゾーンを指定します。 |
near | Clock | トリガーが実行される時刻(±15 分)を指定します。 |
on | Clock | トリガーが実行される月の日付を指定します。 |
on | Clock | トリガーが実行される曜日を指定します。 |
Document Trigger Builder
メソッド
| メソッド | 戻り値の型 | 概要 |
|---|---|---|
create() | Trigger | 新しいトリガーを作成して返します。 |
on | Document | ドキュメントが開かれたときに起動するトリガーを指定します。 |
Event Type
プロパティ
| プロパティ | タイプ | 説明 |
|---|---|---|
CLOCK | Enum | 時間ベースのイベントが特定の時間に達すると、トリガーが 1 回起動します。 |
ON_OPEN | Enum | ユーザーが Google ドキュメント、スプレッドシート、フォームのファイルを開くと、トリガーが 1 回実行されます。 |
ON_EDIT | Enum | ユーザーが Google スプレッドシート ファイルを編集すると(たとえば、セルに新しい値を入力すると、変更ではなく編集としてカウントされます)、トリガーが 1 回起動します。 |
ON_FORM_SUBMIT | Enum | ユーザーが Google フォームに回答すると、トリガーが 1 回実行されます。 |
ON_CHANGE | Enum | トリガーは、ユーザーが Google スプレッドシート ファイルを変更したときに(たとえば、行を追加したとき。これは編集ではなく変更としてカウントされます)、1 回だけ起動します。 |
ON_EVENT_UPDATED | Enum | トリガーは、指定された Google カレンダーでイベントが作成、更新、削除されると 1 回だけ起動します。 |
Form Trigger Builder
メソッド
| メソッド | 戻り値の型 | 概要 |
|---|---|---|
create() | Trigger | 新しいトリガーを作成して返します。 |
on | Form | フォームに回答が送信されたときにトリガーされるトリガーを指定します。 |
on | Form | フォームの編集ビューが開いたときに起動するトリガーを指定します。 |
Installation Source
プロパティ
| プロパティ | タイプ | 説明 |
|---|---|---|
APPS_MARKETPLACE_DOMAIN_ADD_ON | Enum | アドオンがユーザーのドメインの管理者によってインストールされた。 |
NONE | Enum | スクリプトがアドオンとして実行されていません。 |
WEB_STORE_ADD_ON | Enum | ユーザーが Chrome ウェブストアからアドオンをインストールしました。 |
Script App
プロパティ
| プロパティ | タイプ | 説明 |
|---|---|---|
Auth | Auth | トリガーされた関数を介して Apps Script が実行できる承認済みサービスのカテゴリを識別する列挙型。 |
Authorization | Authorization | スクリプトの承認ステータスを示す列挙型。 |
Event | Event | トリガーされたイベントのタイプを示す列挙型。 |
Installation | Installation | スクリプトがアドオンとしてユーザーにインストールされた方法を示す列挙型。 |
Trigger | Trigger | トリガーを起動するイベントのソースを示す列挙型。 |
Week | Weekday | 曜日を表す列挙型。 |
メソッド
| メソッド | 戻り値の型 | 概要 |
|---|---|---|
delete | void | 指定されたトリガーを削除して、実行されないようにします。 |
get | Authorization | ユーザーがすべてのスクリプト要件に対する承認を付与しているかどうかを確認するオブジェクトを取得します。 |
get | Authorization | リクエストされたスコープに対する承認をユーザーが付与しているかどうかを確認するオブジェクトを取得します。 |
get | String|null | openid スコープが付与されている場合、有効なユーザーの Open |
get | Installation | スクリプトが現在のユーザーのアドオンとしてインストールされた方法を示す列挙型の値を返します(たとえば、ユーザーが Chrome ウェブストアから個人でインストールしたか、ドメイン管理者がすべてのユーザーにインストールしたかなど)。 |
get | String | 有効なユーザーの OAuth 2.0 アクセス トークンを取得します。 |
get | Trigger[] | 現在のプロジェクトと現在のユーザーに関連付けられているインストール可能なトリガーをすべて取得します。 |
get | String | スクリプト プロジェクトの一意の ID を取得します。 |
get | Service | スクリプトをウェブアプリとして公開する制御に使用されるオブジェクトを取得します。 |
get | Trigger[] | このユーザーが所有する、指定されたドキュメント内のこのスクリプトまたはアドオンのインストール可能なトリガーをすべて取得します。 |
get | Trigger[] | このユーザーが所有する、指定されたフォームのインストール可能なトリガーを、このスクリプトまたはアドオンに対してのみ取得します。 |
get | Trigger[] | このユーザーが所有する、指定されたスプレッドシートのインストール可能なすべてのトリガーを、このスクリプトまたはアドオンに対してのみ取得します。 |
invalidate | void | 有効なユーザーが現在のスクリプトを実行する権限を無効にします。 |
new | State | コールバック API(OAuth フローなど)で使用できる状態トークンのビルダーを作成します。 |
new | Trigger | インストール可能なトリガーを作成するプロセスを開始します。このトリガーが起動すると、指定された関数が呼び出されます。 |
require | void | ユーザーがスクリプトでリクエストされたすべてのスコープに同意しているかどうかを検証します。 |
require | void | ユーザーがリクエストされたスコープへの同意を付与しているかどうかを検証します。 |
Service
メソッド
| メソッド | 戻り値の型 | 概要 |
|---|---|---|
get | String | ウェブアプリがデプロイされている場合はその URL を返し、それ以外の場合は null を返します。 |
is | Boolean | スクリプトがウェブアプリとしてアクセス可能な場合は true を返します。 |
Spreadsheet Trigger Builder
メソッド
| メソッド | 戻り値の型 | 概要 |
|---|---|---|
create() | Trigger | トリガーを作成して返します。 |
on | Spreadsheet | スプレッドシートのコンテンツまたは構造が変更されたときに起動するトリガーを指定します。 |
on | Spreadsheet | スプレッドシートが編集されたときに起動するトリガーを指定します。 |
on | Spreadsheet | スプレッドシートにフォームが送信されたときにトリガーされるトリガーを指定します。 |
on | Spreadsheet | スプレッドシートが開かれたときにトリガーされるトリガーを指定します。 |
State Token Builder
メソッド
| メソッド | 戻り値の型 | 概要 |
|---|---|---|
create | String | 状態トークンの暗号化された文字列表現を構築します。 |
with | State | トークンに引数を追加します。 |
with | State | コールバック関数を設定します。 |
with | State | トークンが有効な期間(秒単位)を設定します。 |
Trigger
メソッド
| メソッド | 戻り値の型 | 概要 |
|---|---|---|
get | Event | トリガーが配信されるイベントタイプを返します。 |
get | String | トリガーが起動したときに呼び出される関数を返します。 |
get | Trigger | トリガーを起動するイベントのソースを返します。 |
get | String | ソースに固有の ID を返します。 |
get | String | トリガーを区別するために使用できる一意の識別子を返します。 |
Trigger Builder
メソッド
| メソッド | 戻り値の型 | 概要 |
|---|---|---|
for | Document | 指定されたドキュメントに関連付けられた Document を作成して返します。 |
for | Document | 指定された ID のドキュメントに関連付けられた Document を作成して返します。 |
for | Form | 指定されたフォームに関連付けられた Form を作成して返します。 |
for | Form | 指定された ID のフォームに関連付けられた Form を作成して返します。 |
for | Spreadsheet | 指定されたスプレッドシートに関連付けられた Spreadsheet を作成して返します。 |
for | Spreadsheet | 指定された ID のスプレッドシートに関連付けられた Spreadsheet を作成して返します。 |
for | Calendar | カレンダー トリガーを作成するためのビルダーを返します。 |
time | Clock | 時間ベースのトリガーをビルドするための Clock を作成して返します。 |
Trigger Source
プロパティ
| プロパティ | タイプ | 説明 |
|---|---|---|
SPREADSHEETS | Enum | Google スプレッドシートでトリガーが起動します。 |
CLOCK | Enum | 時間ドリブン イベントにより、トリガーが起動します。 |
FORMS | Enum | Google フォームによってトリガーが起動します。 |
DOCUMENTS | Enum | Google ドキュメントでトリガーが配信されます。 |
CALENDAR | Enum | Google カレンダーがトリガーを配信します。 |