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 Docs вызывает срабатывание триггера.
CALENDAR Enum Календарь Google вызывает срабатывание триггера.