Class TriggerBuilder

ТриггерБилдер

Универсальный конструктор триггеров сценариев.

Методы

Метод Тип возврата Краткое описание
forDocument(document) DocumentTriggerBuilder Создает и возвращает DocumentTriggerBuilder привязанный к данному документу.
forDocument(key) DocumentTriggerBuilder Создает и возвращает DocumentTriggerBuilder , привязанный к документу с заданным идентификатором.
forForm(form) FormTriggerBuilder Создает и возвращает FormTriggerBuilder привязанный к данной форме.
forForm(key) FormTriggerBuilder Создает и возвращает FormTriggerBuilder привязанный к форме с заданным идентификатором.
forSpreadsheet(sheet) SpreadsheetTriggerBuilder Создает и возвращает SpreadsheetTriggerBuilder привязанный к данной электронной таблице.
forSpreadsheet(key) SpreadsheetTriggerBuilder Создает и возвращает SpreadsheetTriggerBuilder привязанный к электронной таблице с заданным идентификатором.
forUserCalendar(emailId) CalendarTriggerBuilder Возвращает конструктор для создания триггеров календаря.
timeBased() ClockTriggerBuilder Создает и возвращает ClockTriggerBuilder для создания триггеров на основе времени.

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

forDocument(document)

Создает и возвращает DocumentTriggerBuilder привязанный к данному документу. 

ScriptApp.newTrigger('myFunction')
  .forDocument(DocumentApp.getActiveDocument())
  .onOpen()
  .create();

Параметры

Имя Тип Описание
document Document документ

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

DocumentTriggerBuilder — новый DocumentTriggerBuilder

Авторизация

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

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

forDocument(key)

Создает и возвращает DocumentTriggerBuilder , привязанный к документу с заданным идентификатором. 

ScriptApp.newTrigger('myFunction')
  .forDocument('1234567890abcdefghijklmnopqrstuvwxyz')
  .onOpen()
  .create();

Параметры

Имя Тип Описание
key String идентификатор документа

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

DocumentTriggerBuilder — новый DocumentTriggerBuilder

Авторизация

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

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

forForm(form)

Создает и возвращает FormTriggerBuilder привязанный к данной форме. 

ScriptApp.newTrigger('myFunction')
  .forForm(FormApp.getActiveForm())
  .onFormSubmit()
  .create();

Параметры

Имя Тип Описание
form Form форма

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

FormTriggerBuilder — новый FormTriggerBuilder

Авторизация

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

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

forForm(key)

Создает и возвращает FormTriggerBuilder привязанный к форме с заданным идентификатором. 

ScriptApp.newTrigger('myFunction')
  .forForm('1234567890abcdefghijklmnopqrstuvwxyz')
  .onFormSubmit()
  .create();

Параметры

Имя Тип Описание
key String идентификатор формы

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

FormTriggerBuilder — новый FormTriggerBuilder

Авторизация

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

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

forSpreadsheet(sheet)

Создает и возвращает SpreadsheetTriggerBuilder привязанный к данной электронной таблице. 

ScriptApp.newTrigger('myFunction')
  .forSpreadsheet(SpreadsheetApp.getActive())
  .onEdit()
  .create();

Параметры

Имя Тип Описание
sheet Spreadsheet электронная таблица

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

SpreadsheetTriggerBuilder — новый SpreadsheetTriggerBuilder

Авторизация

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

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

forSpreadsheet(key)

Создает и возвращает SpreadsheetTriggerBuilder привязанный к электронной таблице с заданным идентификатором. 

ScriptApp.newTrigger('myFunction')
  .forSpreadsheet('1234567890abcdefghijklmnopqrstuvwxyz')
  .onEdit()
  .create();

Параметры

Имя Тип Описание
key String идентификатор таблицы

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

SpreadsheetTriggerBuilder — новый SpreadsheetTriggerBuilder

Авторизация

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

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

forUserCalendar(emailId)

Возвращает конструктор для создания триггеров календаря.

Параметры

Имя Тип Описание
emailId String Идентификатор электронной почты пользователя календаря, который отслеживает триггер.

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

CalendarTriggerBuilder — новый CalendarTriggerBuilder.

Авторизация

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

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.googleapis.com/auth/calendar.events
  • https://www.googleapis.com/auth/calendar.events.readonly
  • https://www.google.com/calendar/feeds

timeBased()

Создает и возвращает ClockTriggerBuilder для создания триггеров на основе времени. 

ScriptApp.newTrigger('myFunction')
  .timeBased()
  .atDate(2013, 10, 31)
  .create();

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

ClockTriggerBuilder — новый ClockTriggerBuilder

Авторизация

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

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