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|null Получает URL-адрес авторизации, который можно использовать для предоставления доступа к скрипту.
get Authorized Scopes() String[]|null Получает список разрешенных областей действия для скрипта.

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 Sheets (например, вводит новое значение в ячейку, что считается редактированием, а не изменением).
ON_FORM_SUBMIT Enum Триггер срабатывает, когда пользователь отвечает на форму Google.
ON_CHANGE Enum Триггер срабатывает, когда пользователь вносит изменения в файл Google Sheets (например, добавляет строку, что считается изменением, а не редактированием).
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|null Получает токен идентификации Open ID Connect для фактического пользователя, если предоставлена ​​область openid .
get Installation Source() Installation Source Возвращает значение перечисления, указывающее, как скрипт был установлен в качестве дополнения для текущего пользователя (например, установил ли пользователь его лично через Chrome Web Store или администратор домена установил его для всех пользователей).
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 связанный с документом, имеющим заданный ID.
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 Sheets приводит к срабатыванию триггера.
CLOCK Enum Событие, зависящее от времени, приводит к срабатыванию триггера.
FORMS Enum Использование Google Forms приводит к срабатыванию триггера.
DOCUMENTS Enum Срабатывание триггера происходит при использовании Google Docs.
CALENDAR Enum Срабатывание триггера происходит при помощи Google Календаря.