インストール可能なトリガー

単純なトリガーと同様に、インストール可能なトリガーを使用すると、 Apps Script は、特定のイベントが発生したとき、 動作が発生すると予測されます。インストール可能なトリガーでは 柔軟性が高く、シンプルなトリガーから サービス 必要な authorization、 時間ドリブン（時計）を含む、いくつかの追加タイプのイベントを提供します プログラムで制御できます。シンプルなサービスと インストール可能なトリガーにより、Apps Script はトリガーされた 情報を含むイベント オブジェクト 詳細情報を確認できます。

注: アドオンでトリガーを使用する方法について詳しくは、 Google Workspace アドオンのトリガー。

制限事項

インストール可能なトリガーはシンプルなトリガーよりも柔軟性がありますが、いくつかの制限があります。

• ファイルが読み取り専用（表示またはコメント）モードで開かれた場合、実行されません。スタンドアロン スクリプトの場合、トリガーを適切に実行するには、ユーザーにスクリプト ファイルに対する少なくとも閲覧権限が必要です。

• スクリプトの実行や API リクエストによってトリガーが実行されることはありません。たとえば 通話中 FormResponse.submit() 新しいフォームの回答を送信しても、フォームの送信トリガーは実行されません。

  注: この制限の例外は Form.submitGrades() です。コードが onFormSubmit トリガーを使用し、Form.submitGrades() トリガーを呼び出す onFormSubmit 条件が発生し、無限ループに陥ります。発生しないようにするため、 無限ループに成績がすでに存在するかどうかを確認するコードを submitGrades() の呼び出し。

• インストール可能なトリガーは常に、作成者のアカウントで実行されます できます。たとえば、インストール可能な起動トリガーを作成すると、 相手がドキュメントを開いたとき（同僚に編集権限がある場合）は、 アカウントとして運用されますつまり、トリガーを作成し、 ドキュメントが開かれたときにメールを送信する場合、メールは常に ドキュメントを開いたアカウントとは限りません。ただし、アカウントごとにインストール可能なトリガーを作成すると、アカウントごとに 1 通のメールが発送されます。

• 2 つ目のアカウントからインストールされたトリガーを、そのアカウントが確認することはできません。 ただし 最初のアカウントではこれらのトリガーを 有効にできます

• インストール可能なトリガーは Apps Script トリガーの対象になります 割り当て上限が適用されます。

時間ドリブンのトリガー

時間駆動トリガー（クロック トリガー）は、Unix の cron ジョブに似ています。時間ドリブンのトリガーを使用すると スクリプトを特定の時刻または定期的な間隔で実行する 頻度は 1 分に 1 回、月 1 回といった頻度です。（ただし、 アドオン 時間ドリブンのトリガーを使用して 頻度は 1 時間に 1 回までです）。わずかに時間差がある可能性があります。 たとえば、午前 9 時のトリガーを繰り返し作成した場合、 Apps Script は午前 9 時から午前 10 時の間の時間を選択し、 曜日ごとに同じ時刻にチェックされるようにし、 トリガーが再度発生します

以下に、 Google Chat アプリ アプリは、アプリが配置されているすべてのスペースに 1 分ごとにメッセージを投稿します。

// Example app for Google Chat that demonstrates app-initiated messages
// by spamming the user every minute.
//
// This app makes use of the Apps Script OAuth2 library at:
//     https://github.com/googlesamples/apps-script-oauth2
//
// Follow the instructions there to add the library to your script.

// When added to a space, we store the space's ID in ScriptProperties.
function onAddToSpace(e) {
  PropertiesService.getScriptProperties()
      .setProperty(e.space.name, '');
  return {
    'text': 'Hi! I\'ll post a message here every minute. ' +
            'Please remove me after testing or I\'ll keep spamming you!'
  };
}

// When removed from a space, we remove the space's ID from ScriptProperties.
function onRemoveFromSpace(e) {
  PropertiesService.getScriptProperties()
      .deleteProperty(e.space.name);
}

// Add a trigger that invokes this function every minute in the
// "Edit > Current Project's Triggers" menu. When it runs, it
// posts in each space the app was added to.
function onTrigger() {
  var spaceIds = PropertiesService.getScriptProperties()
      .getKeys();
  var message = { 'text': 'Hi! It\'s now ' + (new Date()) };
  for (var i = 0; i < spaceIds.length; ++i) {
    postMessage(spaceIds[i], message);
  }
}
var SCOPE = 'https://www.googleapis.com/auth/chat.bot';
// The values below are copied from the JSON file downloaded upon
// service account creation.
// For SERVICE_ACCOUNT_PRIVATE_KEY, remember to include the BEGIN and END lines
// of the private key
var SERVICE_ACCOUNT_PRIVATE_KEY = '...';
var SERVICE_ACCOUNT_EMAIL = '[e-mail]';

// Posts a message into the given space ID via the API, using
// service account authentication.
function postMessage(spaceId, message) {
  var service = OAuth2.createService('chat')
      .setTokenUrl('https://accounts.google.com/o/oauth2/token')
      .setPrivateKey(SERVICE_ACCOUNT_PRIVATE_KEY)
      .setClientId(SERVICE_ACCOUNT_EMAIL)
      .setPropertyStore(PropertiesService.getUserProperties())
      .setScope(SCOPE);
  if (!service.hasAccess()) {
    Logger.log('Authentication error: %s', service.getLastError());
    return;
  }
  var url = 'https://chat.googleapis.com/v1/' + spaceId + '/messages';
  UrlFetchApp.fetch(url, {
    method: 'post',
    headers: { 'Authorization': 'Bearer ' + service.getAccessToken() },
    contentType: 'application/json',
    payload: JSON.stringify(message),
  });
}

イベント ドリブン トリガー

インストール可能なイベント ドリブン トリガーは、概念的には 単純なトリガー onOpen() に似ていますが、追加のイベントに応答でき、 違います。

たとえば、Google スプレッドシート用にインストール可能なオープン トリガーは、単純な onOpen() トリガーと同様に、編集権限を持つユーザーがスプレッドシートを開くたびにアクティブになります。ただし、インストール可能なバージョンでは、 サービスを呼び出すには、 認証。インストール可能なバージョンは、編集権限を持つ別のユーザーがスプレッドシートを開いた場合でも、トリガーを作成したユーザーの承認で実行されます。

Google Workspace アプリケーションには、インストール可能なトリガーがいくつかあります。

• インストール可能な open トリガーは、ユーザーがスプレッドシートを開くと実行されます。 そのユーザーが編集権限を持つドキュメント、またはフォームです。
• インストール可能な edit トリガーは、ユーザーが 表示されます。
• インストール可能な変更トリガーは、ユーザーがスプレッドシート自体の構造を変更したときに実行されます（新しいシートの追加や列の削除など）。
• インストール可能なフォーム送信トリガーは、ユーザーがフォームに回答すると実行されます。 「form-submit」トリガーには、 1 つは Google フォーム用の フォームがスプレッドシートに送信される場合はスプレッドシート用です。
• インストール可能なカレンダーの予定トリガーは、ユーザーのカレンダーの予定が更新されたとき（作成、編集、削除）に実行されます。

インストール可能なトリガーは、スタンドアロン スクリプトとバインドされたスクリプトで使用できます。たとえば スタンドアロン スクリプトでは、サービス用のインストール可能なトリガーをプログラムで作成できます。 任意の Google スプレッドシート ファイルを TriggerBuilder.forSpreadsheet(key) スプレッドシートの ID を渡します。

トリガーを手動で管理する

スクリプト エディタでインストール可能なトリガーを手動で作成する手順は次のとおりです。 手順は次のとおりです。

1. Apps Script プロジェクトを開きます。
2. 左側の [トリガー] をクリックします。
3. 右下の [トリガーを追加] をクリックします。
4. 作成するトリガーのタイプを選択して構成します。
5. [保存] をクリックします。

トリガーをプログラムで管理する

スクリプト サービスを使用して、トリガーをプログラムで作成および削除することもできます。まず次の呼び出しを行います ScriptApp.newTrigger(functionName) このメソッドは、 TriggerBuilder。

次の例は、2 つの時間ドリブン トリガーを作成する方法を示しています。 6 時間ごとにトリガーされるコンテナと、毎週月曜日の午前 9 時（ あります）。

triggers/triggers.gs

GitHub で表示

/**
 * Creates two time-driven triggers.
 * @see https://developers.google.com/apps-script/guides/triggers/installable#time-driven_triggers
 */
function createTimeDrivenTriggers() {
  // Trigger every 6 hours.
  ScriptApp.newTrigger('myFunction')
      .timeBased()
      .everyHours(6)
      .create();
  // Trigger every Monday at 09:00.
  ScriptApp.newTrigger('myFunction')
      .timeBased()
      .onWeekDay(ScriptApp.WeekDay.MONDAY)
      .atHour(9)
      .create();
}

次の例は、スプレッドシート用にインストール可能なオープン トリガーを作成する方法を示しています。なお、単純な onOpen() トリガーとは異なり、次のスクリプトは インストール可能なトリガーをスプレッドシートにバインドする必要はありません。作成 スクリプトから作成すると、このトリガーを SpreadsheetApp.getActive() への着信 SpreadsheetApp.openById(id)。

triggers/triggers.gs

GitHub で表示

/**
 * Creates a trigger for when a spreadsheet opens.
 * @see https://developers.google.com/apps-script/guides/triggers/installable
 */
function createSpreadsheetOpenTrigger() {
  const ss = SpreadsheetApp.getActive();
  ScriptApp.newTrigger('myFunction')
      .forSpreadsheet(ss)
      .onOpen()
      .create();
}

インストール可能な既存のトリガーをプログラムで変更するには、トリガーを削除する必要があります。 新規作成します。トリガーの ID を以前に保存している場合は、 その ID を引数として以下の関数に渡して削除します。

triggers/triggers.gs

GitHub で表示

/**
 * Deletes a trigger.
 * @param {string} triggerId The Trigger ID.
 * @see https://developers.google.com/apps-script/guides/triggers/installable
 */
function deleteTrigger(triggerId) {
  // Loop over all triggers.
  const allTriggers = ScriptApp.getProjectTriggers();
  for (let index = 0; index < allTriggers.length; index++) {
    // If the current trigger is the correct one, delete it.
    if (allTriggers[index].getUniqueId() === triggerId) {
      ScriptApp.deleteTrigger(allTriggers[index]);
      break;
    }
  }
}

トリガーのエラー

インストール可能なトリガーがトリガーされたものの、関数から例外がスローされた場合や、関数が正常に実行されなかった場合、画面にエラー メッセージは表示されません。結局、時間ドリブンのトリガーが実行されるか、 コンピュータの近くにいない場合もあります。

代わりに、Apps Script から次のようなメールが送信されます。

From: [e-mail]
Subject: Summary of failures for Google Apps Script
Your script has recently failed to finish successfully.
A summary of the failure(s) is shown below.

このメールには、トリガーを無効化または再構成するためのリンクが記載されています。もし スクリプト バインドされている Google スプレッドシート、ドキュメント、フォームの メールにはファイルへのリンクも記載されています。これらのリンクを使用すると、 トリガーを無効にするか、スクリプトを編集してバグを修正します。

注: 作成されたインストール可能なトリガー これらのメール通知をユーザーに送信することはありません。

Google アカウントに関連付けられているすべてのトリガーを確認し、 不要になったトリガーを無効にするには、次の手順を行います。

1. script.google.com にアクセスします。
2. 左側の [トリガー] をクリックします。

3. トリガーを削除するには、トリガーの右側にあるその他アイコン >トリガーを削除します。

   注: onOpen() などの単純なトリガーは、この操作では無効にできません。 page;代わりに、適切なスクリプトを編集して、削除するか名前を変更する必要があります。 onOpen() 関数。

アドオンのトリガー

マニフェスト トリガーは、インストール可能なトリガーの他にも、 できます。詳しくは Google Workspace アドオンのトリガー。