Script Service

Скрипт

Эта служба предоставляет доступ к триггерам скриптов и публикации скриптов.

Классы

Имя	Краткое описание
AuthMode	Перечисление, определяющее, какие категории авторизованных служб Apps Script может выполнять с помощью запускаемой функции.
AuthorizationInfo	Объект, используемый для определения необходимости авторизации этого скрипта для использования одной или нескольких служб, а также для предоставления URL-адреса диалогового окна авторизации.
AuthorizationStatus	Перечисление, обозначающее статус авторизации скрипта.
CalendarTriggerBuilder	Конструктор триггеров календаря.
ClockTriggerBuilder	Конструктор триггеров часов.
DocumentTriggerBuilder	Конструктор триггеров документов.
EventType	Перечисление, обозначающее тип инициированного события.
FormTriggerBuilder	Конструктор триггеров форм.
InstallationSource	Перечисление, указывающее, как скрипт был установлен в качестве надстройки для текущего пользователя.
ScriptApp	Доступ и управление публикацией сценариев и триггерами.
Service	Доступ и управление публикацией скриптов.
SpreadsheetTriggerBuilder	Конструктор триггеров электронных таблиц.
StateTokenBuilder	Позволяет сценариям создавать маркеры состояния, которые можно использовать в API-интерфейсах обратного вызова (например, в потоках OAuth).
Trigger	Триггер скрипта.
TriggerBuilder	Общий конструктор триггеров скриптов.
TriggerSource	Перечисление, обозначающее источник события, вызывающего срабатывание триггера.

AuthMode

Характеристики

Имущество	Тип	Описание
NONE	Enum	Режим, запрещающий доступ к каким-либо сервисам, требующим авторизации.
CUSTOM_FUNCTION	Enum	Режим, который позволяет получить доступ к ограниченному подмножеству сервисов для использования в пользовательских функциях электронных таблиц.
LIMITED	Enum	Режим, позволяющий получить доступ к ограниченному набору услуг.
FULL	Enum	Режим, открывающий доступ ко всем сервисам, требующим авторизации.

AuthorizationInfo

Методы

Метод	Тип возврата	Краткое описание
getAuthorizationStatus()	AuthorizationStatus	Получает значение, указывающее, нужно ли пользователю авторизовать этот скрипт для использования одной или нескольких служб (например, ScriptApp.AuthorizationStatus.REQUIRED ).
getAuthorizationUrl()	String	Получает URL-адрес авторизации, который можно использовать для предоставления доступа к сценарию.

AuthorizationStatus

Характеристики

Имущество	Тип	Описание
REQUIRED	Enum	Пользователю необходимо авторизовать этот сценарий для использования одной или нескольких служб.
NOT_REQUIRED	Enum	Пользователь предоставил этому сценарию всю необходимую авторизацию.

CalendarTriggerBuilder

Методы

Метод	Тип возврата	Краткое описание
create()	Trigger	Создает триггер и возвращает его.
onEventUpdated()	CalendarTriggerBuilder	Задает триггер, который срабатывает при создании, обновлении или удалении записи календаря.

ClockTriggerBuilder

Методы

Метод	Тип возврата	Краткое описание
after(durationMilliseconds)	ClockTriggerBuilder	Указывает минимальную продолжительность (в миллисекундах) после текущего времени запуска триггера.
at(date)	ClockTriggerBuilder	Указывает, когда срабатывает триггер.
atDate(year, month, day)	ClockTriggerBuilder	Указывает, что триггер срабатывает в указанную дату, по умолчанию около полуночи (+/- 15 минут).
atHour(hour)	ClockTriggerBuilder	Указывает час запуска триггера.
create()	Trigger	Создает триггер.
everyDays(n)	ClockTriggerBuilder	Указывает запускать триггер каждые n дней.
everyHours(n)	ClockTriggerBuilder	Указывает запускать триггер каждые n часов.
everyMinutes(n)	ClockTriggerBuilder	Задает запуск триггера каждые n минут.
everyWeeks(n)	ClockTriggerBuilder	Указывает запускать триггер каждые n недель.
inTimezone(timezone)	ClockTriggerBuilder	Указывает часовой пояс для указанных дат/времени запуска триггера.
nearMinute(minute)	ClockTriggerBuilder	Задает минуту запуска триггера (плюс-минус 15 минут).
onMonthDay(day)	ClockTriggerBuilder	Указывает дату в месяце запуска триггера.
onWeekDay(day)	ClockTriggerBuilder	Указывает день недели, в который запускается триггер.

DocumentTriggerBuilder

Методы

Метод	Тип возврата	Краткое описание
create()	Trigger	Создает и возвращает новый триггер.
onOpen()	DocumentTriggerBuilder	Задает триггер, который будет срабатывать при открытии документа.

EventType

Характеристики

Имущество	Тип	Описание
CLOCK	Enum	Триггер срабатывает, когда управляемое временем событие достигает определенного времени.
ON_OPEN	Enum	Триггер срабатывает, когда пользователь открывает файл Google Docs, Sheets или Forms.
ON_EDIT	Enum	Триггер срабатывает, когда пользователь редактирует файл Google Sheets (например, вводя новое значение в ячейку, что считается редактированием, а не изменением).
ON_FORM_SUBMIT	Enum	Триггер срабатывает, когда пользователь отвечает на форму Google.
ON_CHANGE	Enum	Триггер срабатывает, когда пользователь изменяет файл Google Таблиц (например, добавляя строку, которая считается изменением, а не редактированием).
ON_EVENT_UPDATED	Enum	Триггер срабатывает, когда событие создается, обновляется или удаляется в указанном Календаре Google.

FormTriggerBuilder

Методы

Метод	Тип возврата	Краткое описание
create()	Trigger	Создает и возвращает новый триггер.
onFormSubmit()	FormTriggerBuilder	Указывает триггер, который срабатывает при отправке ответа в форму.
onOpen()	FormTriggerBuilder	Указывает триггер, который будет срабатывать при открытии представления редактирования формы.

InstallationSource

Характеристики

Имущество	Тип	Описание
APPS_MARKETPLACE_DOMAIN_ADD_ON	Enum	Надстройка была установлена ​​администратором домена пользователя.
NONE	Enum	Скрипт не работает как надстройка.
WEB_STORE_ADD_ON	Enum	Надстройка была установлена ​​пользователем из Интернет-магазина Chrome.

ScriptApp

Характеристики

Имущество	Тип	Описание
AuthMode	AuthMode	Перечисление, определяющее, какие категории авторизованных служб Apps Script может выполнять с помощью запускаемой функции.
AuthorizationStatus	AuthorizationStatus	Перечисление, обозначающее статус авторизации скрипта.
EventType	EventType	Перечисление, обозначающее тип инициированного события.
InstallationSource	InstallationSource	Перечисление, обозначающее, как скрипт был установлен пользователю как надстройка.
TriggerSource	TriggerSource	Перечисление, обозначающее источник события, вызывающего срабатывание триггера.
WeekDay	Weekday	Перечисление, представляющее дни недели.

Методы

Метод	Тип возврата	Краткое описание
deleteTrigger(trigger)	void	Удаляет данный триггер, чтобы он больше не работал.
getAuthorizationInfo(authMode)	AuthorizationInfo	Получает объект, используемый для определения необходимости авторизации этого скрипта для использования одной или нескольких служб, а также для предоставления URL-адреса диалогового окна авторизации.
getIdentityToken()	String	Получает токен удостоверения OpenID Connect для действующего пользователя, если была предоставлена ​​область openid .
getInstallationSource()	InstallationSource	Возвращает значение перечисления, указывающее, как сценарий был установлен в качестве надстройки для текущего пользователя (например, установил ли его пользователь лично через Интернет-магазин Chrome или администратор домена установил его для всех пользователей).
getOAuthToken()	String	Получает маркер доступа OAuth 2.0 для действующего пользователя.
getProjectTriggers()	Trigger[]	Получает все устанавливаемые триггеры, связанные с текущим проектом и текущим пользователем.
getScriptId()	String	Получает уникальный идентификатор проекта скрипта.
getService()	Service	Получает объект, используемый для управления публикацией скрипта в виде веб-приложения.
getUserTriggers(document)	Trigger[]	Получает все устанавливаемые триггеры, принадлежащие этому пользователю в данном документе, только для этого скрипта или надстройки.
getUserTriggers(form)	Trigger[]	Получает все устанавливаемые триггеры, принадлежащие этому пользователю в заданной форме, только для этого скрипта или надстройки.
getUserTriggers(spreadsheet)	Trigger[]	Получает все устанавливаемые триггеры, принадлежащие этому пользователю в данной электронной таблице, только для этого скрипта или надстройки.
invalidateAuth()	void	Аннулирует авторизацию, которую действующий пользователь должен выполнить для выполнения текущего скрипта.
newStateToken()	StateTokenBuilder	Создает построитель для токена состояния, который можно использовать в API обратного вызова (например, в потоке OAuth).
newTrigger(functionName)	TriggerBuilder	Начинает процесс создания устанавливаемого триггера, который при срабатывании вызывает заданную функцию.

Service

Методы

Метод	Тип возврата	Краткое описание
getUrl()	String	Возвращает URL-адрес веб-приложения, если оно было развернуто; в противном случае возвращает null .
isEnabled()	Boolean	Возвращает true , если скрипт доступен как веб-приложение.

SpreadsheetTriggerBuilder

Методы

Метод	Тип возврата	Краткое описание
create()	Trigger	Создает триггер и возвращает его.
onChange()	SpreadsheetTriggerBuilder	Указывает триггер, который срабатывает при изменении содержимого или структуры электронной таблицы.
onEdit()	SpreadsheetTriggerBuilder	Указывает триггер, который будет срабатывать при редактировании электронной таблицы.
onFormSubmit()	SpreadsheetTriggerBuilder	Указывает триггер, который сработает, когда в электронную таблицу будет отправлена ​​форма.
onOpen()	SpreadsheetTriggerBuilder	Указывает триггер, который срабатывает при открытии электронной таблицы.

StateTokenBuilder

Методы

Метод	Тип возврата	Краткое описание
createToken()	String	Создает зашифрованное строковое представление токена состояния.
withArgument(name, value)	StateTokenBuilder	Добавляет аргумент к токену.
withMethod(method)	StateTokenBuilder	Устанавливает функцию обратного вызова.
withTimeout(seconds)	StateTokenBuilder	Устанавливает продолжительность (в секундах), в течение которой токен действителен.

Trigger

Методы

Метод	Тип возврата	Краткое описание
getEventType()	EventType	Возвращает тип события, при котором срабатывает триггер.
getHandlerFunction()	String	Возвращает функцию, которая будет вызываться при срабатывании триггера.
getTriggerSource()	TriggerSource	Возвращает источник событий, которые вызовут срабатывание триггера.
getTriggerSourceId()	String	Возвращает идентификатор, относящийся к источнику.
getUniqueId()	String	Возвращает уникальный идентификатор, который можно использовать для отличия триггеров друг от друга.

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 для создания триггеров на основе времени.

TriggerSource

Характеристики

Имущество	Тип	Описание
SPREADSHEETS	Enum	Google Таблицы вызывают срабатывание триггера.
CLOCK	Enum	Событие, управляемое временем, вызывает срабатывание триггера.
FORMS	Enum	Google Forms вызывает срабатывание триггера.
DOCUMENTS	Enum	Документы Google вызывают срабатывание триггера.
CALENDAR	Enum	Календарь Google вызывает срабатывание триггера.