Script Service

Скрипт

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

Классы

Имя	Краткое описание
Auth Mode	Перечисление, определяющее, какие категории авторизованных служб Apps Script может выполнять с помощью триггерной функции.
Authorization Info	Объект, который проверяет, предоставил ли пользователь авторизацию для необходимых областей действия скрипта.
Authorization Status	Перечисление, обозначающее статус авторизации сценария.
Calendar Trigger Builder	Конструктор триггеров календаря.
Clock Trigger Builder	Конструктор триггеров для часов.
Document Trigger Builder	Конструктор триггеров документов.
Event Type	Перечисление, обозначающее тип инициируемого события.
Form Trigger Builder	Конструктор триггеров форм.
Installation Source	Перечисление, указывающее, как сценарий был установлен в качестве дополнения для текущего пользователя.
Script App	Доступ к публикации скриптов и триггерам и управление ими.
Service	Доступ и управление публикацией сценариев.
Spreadsheet Trigger Builder	Построитель триггеров электронных таблиц.
State Token Builder	Позволяет сценариям создавать токены состояния, которые можно использовать в API обратного вызова (например, в потоках OAuth).
Trigger	Триггер сценария.
Trigger Builder	Универсальный конструктор триггеров сценариев.
Trigger Source	Перечисление, обозначающее источник события, вызывающего срабатывание триггера.

Auth Mode

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

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

Authorization Info

Методы

Метод	Тип возврата	Краткое описание
get Authorization Status()	Authorization Status	Получает значение, указывающее, необходимо ли пользователю авторизовать этот сценарий для использования одной или нескольких служб (например, Script App.AuthorizationStatus.REQUIRED ).
get Authorization Url()	String	Получает URL-адрес авторизации, который можно использовать для предоставления доступа к сценарию.
get Authorized Scopes()	String[]	Получает список авторизованных областей для сценария.

Authorization Status

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

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

Calendar Trigger Builder

Методы

Метод	Тип возврата	Краткое описание
create()	Trigger	Создает триггер и возвращает его.
on Event Updated()	Calendar Trigger Builder	Указывает триггер, который срабатывает при создании, обновлении или удалении записи календаря.

Clock Trigger Builder

Методы

Метод	Тип возврата	Краткое описание
after(durationMilliseconds)	Clock Trigger Builder	Указывает минимальную продолжительность (в миллисекундах) после текущего времени срабатывания триггера.
at(date)	Clock Trigger Builder	Указывает, когда срабатывает триггер.
at Date(year, month, day)	Clock Trigger Builder	Указывает, что триггер срабатывает в указанную дату, по умолчанию около полуночи (+/- 15 минут).
at Hour(hour)	Clock Trigger Builder	Указывает час, в который срабатывает триггер.
create()	Trigger	Создает триггер.
every Days(n)	Clock Trigger Builder	Указывает запускать триггер каждые n дней.
every Hours(n)	Clock Trigger Builder	Указывает запускать триггер каждые n часов.
every Minutes(n)	Clock Trigger Builder	Указывает запуск триггера каждые n минут.
every Weeks(n)	Clock Trigger Builder	Указывает запуск триггера каждые n недель.
in Timezone(timezone)	Clock Trigger Builder	Указывает часовой пояс для указанных дат/времени при запуске триггера.
near Minute(minute)	Clock Trigger Builder	Указывает минуту срабатывания триггера (плюс-минус 15 минут).
on Month Day(day)	Clock Trigger Builder	Указывает дату в месяце запуска триггера.
on Week Day(day)	Clock Trigger Builder	Указывает день недели, в который запускается триггер.

Document Trigger Builder

Методы

Метод	Тип возврата	Краткое описание
create()	Trigger	Создает и возвращает новый триггер.
on Open()	Document Trigger Builder	Указывает триггер, который сработает при открытии документа.

Event Type

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

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

Form Trigger Builder

Методы

Метод	Тип возврата	Краткое описание
create()	Trigger	Создает и возвращает новый триггер.
on Form Submit()	Form Trigger Builder	Указывает триггер, который сработает при отправке ответа в форму.
on Open()	Form Trigger Builder	Указывает триггер, который сработает при открытии представления редактирования формы.

Installation Source

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

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

Script App

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

Свойство	Тип	Описание
Auth Mode	Auth Mode	Перечисление, определяющее, какие категории авторизованных служб Apps Script может выполнять с помощью триггерной функции.
Authorization Status	Authorization Status	Перечисление, обозначающее статус авторизации сценария.
Event Type	Event Type	Перечисление, обозначающее тип инициируемого события.
Installation Source	Installation Source	Перечисление, обозначающее, как скрипт был установлен пользователю в качестве дополнения.
Trigger Source	Trigger Source	Перечисление, обозначающее источник события, вызывающего срабатывание триггера.
Week Day	Weekday	Перечисление, представляющее дни недели.

Методы

Метод	Тип возврата	Краткое описание
delete Trigger(trigger)	void	Удаляет данный триггер, чтобы он больше не работал.
get Authorization Info(authMode)	Authorization Info	Получает объект, который проверяет, предоставил ли пользователь авторизацию для всех требований сценария.
get Authorization Info(authMode, oAuthScopes)	Authorization Info	Получает объект, который проверяет, предоставил ли пользователь авторизацию для запрошенных областей.
get Identity Token()	String	Получает токен удостоверения Open ID Connect для эффективного пользователя, если предоставлена ​​область openid .
get Installation Source()	Installation Source	Возвращает значение перечисления, указывающее, как скрипт был установлен в качестве надстройки для текущего пользователя (например, установил ли пользователь его лично через Интернет-магазин Chrome или администратор домена установил его для всех пользователей).
get OAuth Token()	String	Получает токен доступа OAuth 2.0 для эффективного пользователя.
get Project Triggers()	Trigger[]	Получает все устанавливаемые триггеры, связанные с текущим проектом и текущим пользователем.
get Script Id()	String	Получает уникальный идентификатор проекта сценария.
get Service()	Service	Получает объект, используемый для управления публикацией сценария в виде веб-приложения.
get User Triggers(document)	Trigger[]	Получает все устанавливаемые триггеры, принадлежащие этому пользователю в данном документе, только для этого скрипта или надстройки.
get User Triggers(form)	Trigger[]	Получает все устанавливаемые триггеры, принадлежащие этому пользователю, в заданной форме, только для этого скрипта или надстройки.
get User Triggers(spreadsheet)	Trigger[]	Получает все устанавливаемые триггеры, принадлежащие этому пользователю в данной электронной таблице, только для этого скрипта или надстройки.
invalidate Auth()	void	Делает недействительными полномочия эффективного пользователя для выполнения текущего сценария.
new State Token()	State Token Builder	Создает построитель для токена состояния, который можно использовать в API обратного вызова (например, в потоке OAuth).
new Trigger(functionName)	Trigger Builder	Начинает процесс создания устанавливаемого триггера, который при срабатывании вызывает заданную функцию.
require All Scopes(authMode)	void	Проверяет, предоставил ли пользователь согласие на все области, запрошенные сценарием.
require Scopes(authMode, oAuthScopes)	void	Проверяет, предоставил ли пользователь согласие на запрошенные области.

Service

Методы

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

Spreadsheet Trigger Builder

Методы

Метод	Тип возврата	Краткое описание
create()	Trigger	Создает триггер и возвращает его.
on Change()	Spreadsheet Trigger Builder	Указывает триггер, который сработает при изменении содержимого или структуры электронной таблицы.
on Edit()	Spreadsheet Trigger Builder	Указывает триггер, который сработает при редактировании электронной таблицы.
on Form Submit()	Spreadsheet Trigger Builder	Указывает триггер, который сработает, когда в электронную таблицу будет отправлена ​​форма.
on Open()	Spreadsheet Trigger Builder	Указывает триггер, который сработает при открытии электронной таблицы.

State Token Builder

Методы

Метод	Тип возврата	Краткое описание
create Token()	String	Создает зашифрованное строковое представление токена состояния.
with Argument(name, value)	State Token Builder	Добавляет аргумент к токену.
with Method(method)	State Token Builder	Устанавливает функцию обратного вызова.
with Timeout(seconds)	State Token Builder	Устанавливает продолжительность (в секундах), в течение которой токен действителен.

Trigger

Методы

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

Trigger Builder

Методы

Метод	Тип возврата	Краткое описание
for Document(document)	Document Trigger Builder	Создает и возвращает Document Trigger Builder привязанный к данному документу.
for Document(key)	Document Trigger Builder	Создает и возвращает Document Trigger Builder привязанный к документу с заданным идентификатором.
for Form(form)	Form Trigger Builder	Создает и возвращает Form Trigger Builder привязанный к данной форме.
for Form(key)	Form Trigger Builder	Создает и возвращает Form Trigger Builder привязанный к форме с заданным идентификатором.
for Spreadsheet(sheet)	Spreadsheet Trigger Builder	Создает и возвращает Spreadsheet Trigger Builder привязанный к данной электронной таблице.
for Spreadsheet(key)	Spreadsheet Trigger Builder	Создает и возвращает Spreadsheet Trigger Builder привязанный к электронной таблице с заданным идентификатором.
for User Calendar(emailId)	Calendar Trigger Builder	Возвращает конструктор для создания триггеров календаря.
time Based()	Clock Trigger Builder	Создает и возвращает Clock Trigger Builder для создания триггеров на основе времени.

Trigger Source

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

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