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 Возвращает уникальный идентификатор, который можно использовать для различения триггеров друг от друга.

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

getEventType()

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

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
  }
}

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

EventType — Тип события, для которого предназначен этот триггер.

Авторизация

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

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

getHandlerFunction()

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

// 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

getTriggerSource()

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

Например, триггер 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`);
  }
}

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

TriggerSource — издатель, для которого предназначен этот триггер.

Авторизация

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

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

getTriggerSourceId()

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

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

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

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

Авторизация

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

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

getUniqueId()

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

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

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

Авторизация

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

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