イベント オブジェクト

シンプルなトリガーとインストール可能なトリガーを使用すると、特定のイベントが発生した場合に Google Apps Script が関数を自動的に実行できます。トリガーが起動すると、Apps Script は通常 e というイベント オブジェクトを引数として関数に渡します。イベント オブジェクトには、トリガーが起動したコンテキストに関する情報が含まれます。たとえば、次のサンプルコードは、イベント オブジェクトを使用して編集されたセルを特定する Google スプレッドシート スクリプトの簡単な onEdit(e) トリガーを示しています。

function onEdit(e){
  // Set a comment on the edited cell to indicate when it was changed.
  var range = e.range;
  range.setNote('Last modified: ' + new Date());
}

このページでは、さまざまなタイプのトリガーのイベント オブジェクトのフィールドについて説明します。

インストール可能なトリガーによって生成されたイベントには、イベントを生成したトリガーを識別する triggerUid が含まれます。これは、複数のインストール可能なトリガーがあるスクリプトに役立ちます。

Google スプレッドシートのイベント

Google スプレッドシート固有のさまざまなトリガーを使用すると、スクリプトでスプレッドシート内のユーザーのアクションに応答できます。

LIMITED

Spreadsheet

4034124084959907503

amin@example.com

FULL

INSERT_ROW

Spreadsheet

4034124084959907503

amin@example.com

LIMITED

1234

Range

Spreadsheet

4034124084959907503

amin@example.com

10

FULL

{
  'First Name': ['Jane'],
  'Timestamp': ['6/7/2015 20:54:13'],
  'Last Name': ['Doe']
}

Range

4034124084959907503

['2015/05/04 15:00', 'amin@example.com', 'Bob', '27', 'Bill',
'28', 'Susan', '25']

Google ドキュメントのイベント

トリガーを使用すると、ユーザーがドキュメントを開いたときに Docs が応答できるようになります。

LIMITED

Document

4034124084959907503

amin@example.com

Google スライドのイベント

トリガーを使用すると、ユーザーがプレゼンテーションを開いたときにスライドが応答できるようになります。

LIMITED

Presentation

amin@example.com

Google フォームのイベント

フォーム固有のトリガーを使用すると、ユーザーがフォームを編集したり、回答を送信したりしたときにスクリプトが応答できます。

LIMITED

Form

4034124084959907503

amin@example.com

* このイベントは、ユーザーが回答するためにフォームを開いたときではなく、編集者がフォームを開いて変更したときに発生します。

FULL

FormResponse

Form

4034124084959907503

Google カレンダーの予定

Google カレンダーのトリガーは、ユーザーのカレンダーの予定が更新（作成、編集、削除）されたときに起動します。

これらのトリガーは、どのイベントがどのように変更されたかを通知しません。代わりに、コードがカレンダーの最近の変更を取得するために増分同期オペレーションを実行する必要があることを示します。この手順の詳細については、Calendar API のリソースの同期ガイドをご覧ください。

Apps Script でカレンダーと同期するには、次の手順を行います。

1. スクリプト プロジェクトでカレンダーの拡張サービスを有効にします。このワークフローでは、組み込みのカレンダー サービスでは不十分です。
2. 同期するカレンダーを決定します。カレンダーごとに、Calendar の高度なサービスの Events.list() メソッドを使用して初回同期オペレーションを実行します。
3. 最初の同期では、そのカレンダーの nextSyncToken が返されます。このトークンは後で使用するために保存しておきます。
4. Apps Script の EventUpdated トリガーが起動してカレンダーの予定の変更が示されたら、保存された nextSyncToken を使用して、影響を受けたカレンダーの増分同期を行います。これは基本的に別の Events.list() リクエストですが、nextSyncToken を指定すると、レスポンスは前回の同期以降に変更されたイベントのみに制限されます。
5. 同期のレスポンスを調べて、更新されたイベントを把握し、コードで適切に対応します。たとえば、変更をログに記録する、スプレッドシートを更新する、メール通知を送信するなどのアクションを実行できます。
6. そのカレンダーに保存されている nextSyncToken を、増分同期リクエストから返されたものに更新します。これにより、次の同期オペレーションで最新の変更のみが返されるようになります。

同期トークンはサーバーによって無効化されることがあり、その結果 410 エラーが発生します。この場合、コードで完全同期を行い、そのカレンダーの保存済み同期データとトークンをすべて置き換える必要があります。

FULL

susan@example.com

4034124084959907503

Google Workspace アドオンのイベント

onInstall() トリガーは、ユーザーがアドオンをインストールすると自動的に実行されます。

FULL

Google Chat アプリのイベント

Google Chat のイベント オブジェクトについては、Google Chat アプリとのインタラクションを受信して応答するをご覧ください。

時間主導型イベント

時間主導型トリガー（クロック トリガーとも呼ばれます）を使用すると、特定の時間または定期的な間隔でスクリプトを実行できます。

FULL

31

7

23

59

12

59

UTC

4034124084959907503

52

2015