Class Trigger

Курок

Триггер сценария.

Методы

Метод Тип возврата Краткое описание
get Event Type() Event Type Возвращает тип события, при котором срабатывает триггер.
get Handler Function() String Возвращает функцию, которая будет вызываться при срабатывании триггера.
get Trigger Source() Trigger Source Возвращает источник событий, которые вызовут срабатывание триггера.
get Trigger Source Id() String Возвращает идентификатор, определенный для источника.
get Unique Id() String Возвращает уникальный идентификатор, который можно использовать для отличия триггеров друг от друга.

Подробная документация

get Event Type()

Возвращает тип события, при котором срабатывает триггер.

const triggers = ScriptApp.getProjectTriggers();
for (let i = 0; i < triggers.length; i++) {
  if (triggers[i].getEventType() === ScriptApp.EventType.CLOCK) {
    // Some code here - other options are:
    // ScriptApp.EventType.ON_EDIT
    // ScriptApp.EventType.ON_FORM_SUBMIT
    // ScriptApp.EventType.ON_OPEN
  }
}

Возвращаться

Event Type — тип события, для которого это является триггером.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/script.scriptapp

get Handler Function()

Возвращает функцию, которая будет вызываться при срабатывании триггера.

// Create a trigger for the script.
ScriptApp.newTrigger('myFunction')
    .forSpreadsheet('id of my spreadsheet')
    .onEdit()
    .create();
Logger.log(ScriptApp.getProjectTriggers()[0]
               .getHandlerFunction());  // logs "myFunction"

Возвращаться

String — имя метода

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/script.scriptapp

get Trigger Source()

Возвращает источник событий, которые вызовут срабатывание триггера.

Например, триггер onEdit электронной таблицы вернет SPREADSHEETS, а триггер, основанный на времени, вернет CLOCK.

const triggers = ScriptApp.getProjectTriggers();
for (let i = 0; i < triggers.length; i++) {
  if (triggers[i].getTriggerSource() === ScriptApp.TriggerSource.CLOCK) {
    Logger.log(`${triggers[i].getUniqueId()} source is clock`);
  } else if (
      triggers[i].getTriggerSource() === ScriptApp.TriggerSource.SPREADSHEETS) {
    Logger.log(`${triggers[i].getUniqueId()} source is spreadsheets`);
  }
}

Возвращаться

Trigger Source — издатель, для которого это триггер.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/script.scriptapp

get Trigger Source Id()

Возвращает идентификатор, определенный для источника.

Например, если источником триггера является электронная таблица, это будет идентификатор электронной таблицы. Для событий часов это возвращает ноль.

Возвращаться

String — идентификатор сущности в издателе, для которого это триггер.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/script.scriptapp

get Unique Id()

Возвращает уникальный идентификатор, который можно использовать для отличия триггеров друг от друга.

Возвращаться

String — уникальный идентификатор триггера

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

  • https://www.googleapis.com/auth/script.scriptapp