Base Service

База

Этот сервис предоставляет доступ к информации о пользователях, такой как адреса электронной почты и имена пользователей. Он также управляет журналами сценариев и диалоговыми окнами в приложениях Google Workspace.

Классы

Имя Краткое описание
Blob Объект обмена данными для служб Apps Script.
Blob Source Интерфейс для объектов, которые могут экспортировать свои данные в виде объекта типа Blob .
Browser Этот класс предоставляет доступ к диалоговым окнам, специфичным для Google Таблиц.
Button Перечисление, представляющее собой заранее определенные локализованные кнопки диалогового окна, возвращаемые alert окном или Prompt Response.getSelectedButton() , указывающее, на какую кнопку в диалоговом окне нажал пользователь.
Button Set Перечисление, представляющее собой заранее определенные локализованные наборы из одной или нескольких кнопок диалогового окна, которые можно добавить в alert или prompt .
Color Type Типы цветов
Logger Этот класс позволяет разработчику записывать данные в журнал выполнения и в Google Cloud Logging , если скрипт связан со стандартным облачным проектом .
Menu Пользовательское меню в экземпляре пользовательского интерфейса приложения Google.
Mime Type Перечисление, предоставляющее доступ к объявлениям MIME-типов без явного указания типов строк.
Month Перечисление, представляющее месяцы года.
Prompt Response Ответ на диалоговое окно prompt отображаемое в пользовательском интерфейсе приложения Google.
Rgb Color Цвет, определяемый каналами красного, зеленого и синего цветов.
Session Класс Session предоставляет доступ к информации о сессии, такой как адрес электронной почты пользователя (в некоторых случаях) и языковые настройки.
Ui Пример пользовательского интерфейса для приложения Google, позволяющий скрипту добавлять такие функции, как меню, диалоги и боковые панели.
User Изображение пользователя, подходящее для написания скриптов.
Weekday Перечисление, представляющее дни недели.
console Этот класс позволяет разработчику записывать данные в журнал выполнения и в Google Cloud Logging , если скрипт связан со стандартным облачным проектом .

Blob

Методы

Метод Тип возвращаемого значения Краткое описание
copy Blob() Blob Возвращает копию этого объекта.
get As(contentType) Blob Возвращает данные, содержащиеся в этом объекте, в виде двоичных данных (blob), преобразованных в указанный тип содержимого.
get Bytes() Byte[] Получает данные, хранящиеся в этом блоке.
get Content Type() String Получает тип содержимого байтов в этом блоке данных.
get Data As String() String Получает данные этого объекта в виде строки с кодировкой UTF-8.
get Data As String(charset) String Получает данные этого объекта в виде строки с указанной кодировкой.
get Name() String Получает имя этого объекта.
is Google Type() Boolean Возвращает значение, указывающее, является ли данный объект файлом Google Workspace (Sheets, Docs и т. д.).
set Bytes(data) Blob Задает параметры данных, хранящихся в этом блоке.
set Content Type(contentType) Blob Задает тип содержимого байтов в этом блоке.
set Content Type From Extension() Blob Устанавливает тип содержимого байтов в этом блоке данных на основе расширения файла.
set Data From String(string) Blob Задает данные для этого объекта типа BLOB из строки с кодировкой UTF-8.
set Data From String(string, charset) Blob Задает данные для этого объекта типа BLOB из строки с указанной кодировкой.
set Name(name) Blob Задает имя этого объекта.

Blob Source

Методы

Метод Тип возвращаемого значения Краткое описание
get As(contentType) Blob Возвращает данные, содержащиеся в этом объекте, в виде двоичных данных (blob), преобразованных в указанный тип содержимого.
get Blob() Blob Возвращает данные, содержащиеся в этом объекте, в виде двоичных данных (blob).

Browser

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

Свойство Тип Описание
Buttons Button Set

Методы

Метод Тип возвращаемого значения Краткое описание
input Box(prompt) String|null Открывает в браузере пользователя диалоговое окно с текстовым полем ввода.
input Box(prompt, buttons) String|null Открывает в браузере пользователя диалоговое окно с текстовым полем ввода.
input Box(title, prompt, buttons) String|null Открывает в браузере пользователя диалоговое окно с текстовым полем ввода.
msg Box(prompt) String|null Отображает в браузере пользователя диалоговое окно с указанным сообщением и кнопкой «ОК».
msg Box(prompt, buttons) String|null Отображает в браузере пользователя диалоговое окно с заданным сообщением и указанными кнопками.
msg Box(title, prompt, buttons) String|null Отображает в браузере пользователя диалоговое окно с заданным заголовком, сообщением и указанными кнопками.

Button

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

Свойство Тип Описание
CLOSE Enum Стандартная кнопка закрытия, отображаемая в заголовке каждого диалогового окна.
OK Enum Кнопка «ОК», указывающая на необходимость продолжения операции.
CANCEL Enum Кнопка «Отмена», указывающая на то, что операция не должна быть продолжена.
YES Enum Кнопка «Да», указывающая на положительный ответ на вопрос.
NO Enum Кнопка «Нет» указывает на отрицательный ответ на вопрос.

Button Set

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

Свойство Тип Описание
OK Enum Единственная кнопка «ОК», указывающая на информационное сообщение, которое можно только закрыть.
OK_CANCEL Enum Кнопки «ОК» и «Отмена», позволяющие пользователю либо продолжить, либо остановить операцию.
YES_NO Enum Кнопка «Да» и кнопка «Нет», позволяющие пользователю ответить на вопрос «да» или «нет».
YES_NO_CANCEL Enum Кнопка «Да», кнопка «Нет» и кнопка «Отмена», позволяющие пользователю либо ответить на вопрос «да/нет», либо остановить операцию.

Color Type

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

Свойство Тип Описание
UNSUPPORTED Enum Тип цвета, который не поддерживается.
RGB Enum Цвет, определяемый каналами красного, зеленого и синего цветов.
THEME Enum Цвет, указывающий на элемент в цветовой схеме темы.

Logger

Методы

Метод Тип возвращаемого значения Краткое описание
clear() void Очищает журнал.
get Log() String Возвращает полный список сообщений из текущего журнала.
log(data) Logger Записывает данные в журнал.
log(format, values) Logger Выводит отформатированную строку в консоль логирования, используя предоставленный формат и значения.

Методы

Метод Тип возвращаемого значения Краткое описание
add Item(caption, functionName) Menu Добавляет пункт в меню.
add Separator() Menu Добавляет визуальный разделитель в меню.
add Sub Menu(menu) Menu Добавляет подменю в основное меню.
add To Ui() void Вставляет меню в экземпляр пользовательского интерфейса редактора.

Mime Type

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

Свойство Тип Описание
GOOGLE_APPS_SCRIPT Enum Представление MIME-типа для проекта Google Apps Script.
GOOGLE_DRAWINGS Enum Представление MIME-типа для файла Google Drawings.
GOOGLE_DOCS Enum Представление MIME-типа для файла Google Docs.
GOOGLE_FORMS Enum Представление MIME-типа для файла Google Forms.
GOOGLE_SHEETS Enum Представление MIME-типа для файла Google Таблиц.
GOOGLE_SITES Enum Представление MIME-типа для файла Google Sites.
GOOGLE_SLIDES Enum Представление MIME-типа для файла Google Slides.
FOLDER Enum Представление MIME-типа для папки Google Диска.
SHORTCUT Enum Представление MIME-типа для ярлыка Google Диска.
BMP Enum Представление MIME-типа для файла изображения в формате BMP (обычно .bmp).
GIF Enum Представление MIME-типа для файла изображения GIF (обычно .gif).
JPEG Enum Представление MIME-типа для файла изображения JPEG (обычно .jpg).
PNG Enum Представление MIME-типа для файла изображения в формате PNG (обычно .png).
SVG Enum Представление MIME-типа для файла изображения SVG (обычно .svg).
PDF Enum Представление MIME-типа для PDF-файла (обычно .pdf).
CSS Enum Представление MIME-типа для текстового CSS-файла (обычно .css).
CSV Enum Представление MIME-типа для текстового CSV-файла (обычно .csv).
HTML Enum Представление MIME-типа для текстового HTML-файла (обычно .html).
JAVASCRIPT Enum Представление MIME-типа для текстового файла JavaScript (обычно .js).
PLAIN_TEXT Enum Представление MIME-типа для обычного текстового файла (обычно с расширением .txt).
RTF Enum Представление MIME-типа для текстового файла с расширенными возможностями форматирования (обычно .rtf).
OPENDOCUMENT_GRAPHICS Enum Представление MIME-типа для графического файла OpenDocument (обычно .odg).
OPENDOCUMENT_PRESENTATION Enum Представление MIME-типа для файла презентации OpenDocument (обычно .odp).
OPENDOCUMENT_SPREADSHEET Enum Представление MIME-типа для файла электронной таблицы OpenDocument (обычно .ods).
OPENDOCUMENT_TEXT Enum Представление MIME-типа для файла текстового редактора OpenDocument (обычно .odt).
MICROSOFT_EXCEL Enum Представление MIME-типа для файла электронной таблицы Microsoft Excel (обычно .xlsx).
MICROSOFT_EXCEL_LEGACY Enum Представление MIME-типа для устаревшего файла Microsoft Excel (обычно .xls).
MICROSOFT_POWERPOINT Enum Представление MIME-типа для файла презентации Microsoft PowerPoint (обычно .pptx).
MICROSOFT_POWERPOINT_LEGACY Enum Представление MIME-типа для устаревшего файла Microsoft PowerPoint (обычно .ppt).
MICROSOFT_WORD Enum Представление MIME-типа для файла документа Microsoft Word (обычно .docx).
MICROSOFT_WORD_LEGACY Enum Представление MIME-типа для устаревшего файла Microsoft Word (обычно .doc).
ZIP Enum Представление MIME-типа для ZIP-архива (обычно .zip).

Month

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

Свойство Тип Описание
JANUARY Enum Январь (месяц 1).
FEBRUARY Enum Февраль (месяц 2).
MARCH Enum Март (3-й месяц).
APRIL Enum Апрель (4-й месяц).
MAY Enum Май (5-й месяц).
JUNE Enum Июнь (месяц 6).
JULY Enum Июль (7-й месяц).
AUGUST Enum Август (8-й месяц).
SEPTEMBER Enum Сентябрь (9-й месяц).
OCTOBER Enum Октябрь (10-й месяц).
NOVEMBER Enum Ноябрь (11-й месяц).
DECEMBER Enum Декабрь (12-й месяц).

Prompt Response

Методы

Метод Тип возвращаемого значения Краткое описание
get Response Text() String Получает текст, который пользователь ввел в поле ввода диалогового окна.
get Selected Button() Button Получает кнопку, на которую пользователь нажал, чтобы закрыть диалоговое окно.

Rgb Color

Методы

Метод Тип возвращаемого значения Краткое описание
as Hex String() String Возвращает цвет в виде шестнадцатеричной строки в стиле CSS из 7 символов (#rrggbb) или из 9 символов (#aarrggbb).
get Blue() Integer Синий канал этого цвета представлен числом от 0 до 255.
get Color Type() Color Type Выберите оттенок этого цвета.
get Green() Integer Зеленый канал этого цвета представлен числом от 0 до 255.
get Red() Integer Красный канал этого цвета представлен числом от 0 до 255.

Session

Методы

Метод Тип возвращаемого значения Краткое описание
get Active User() User Получает информацию о текущем пользователе.
get Active User Locale() String Получает языковые настройки текущего пользователя в виде строки — например, en для английского языка.
get Effective User() User Получает информацию о пользователе, от имени которого выполняется скрипт.
get Script Time Zone() String Получает часовой пояс скрипта.
get Temporary Active User Key() String Получает временный ключ, уникальный для активного пользователя, но не раскрывающий личность пользователя.

Ui

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

Свойство Тип Описание
Button Button Перечисление, представляющее собой заранее определенные локализованные кнопки диалогового окна, возвращаемые всплывающим окном или Prompt Response.getSelectedButton() , указывающее, на какую кнопку в диалоговом окне нажал пользователь.
Button Set Button Set Перечисление, представляющее собой заранее определенные локализованные наборы из одной или нескольких кнопок диалогового окна, которые можно добавить в оповещение или подсказку .

Методы

Метод Тип возвращаемого значения Краткое описание
alert(prompt) Button Открывает диалоговое окно в редакторе пользователя с заданным сообщением и кнопкой «ОК».
alert(prompt, buttons) Button Открывает диалоговое окно в редакторе пользователя с заданным сообщением и набором кнопок.
alert(title, prompt, buttons) Button Открывает диалоговое окно в редакторе пользователя с заданным заголовком, сообщением и набором кнопок.
create Addon Menu() Menu Создает конструктор, который можно использовать для вставки подменю в меню расширений редактора.
create Menu(caption) Menu Создает конструктор, который можно использовать для добавления меню в пользовательский интерфейс редактора.
prompt(prompt) Prompt Response Открывает диалоговое окно ввода в редакторе пользователя с заданным сообщением и кнопкой «ОК».
prompt(prompt, buttons) Prompt Response Открывает диалоговое окно ввода в редакторе пользователя с заданным сообщением и набором кнопок.
prompt(title, prompt, buttons) Prompt Response Открывает диалоговое окно ввода в редакторе пользователя с заданным заголовком, сообщением и набором кнопок.
show Modal Dialog(userInterface, title) void Открывает модальное диалоговое окно в редакторе пользователя с пользовательским содержимым, созданным на стороне клиента.
show Modeless Dialog(userInterface, title) void Открывает немодальное диалоговое окно в редакторе пользователя с пользовательским содержимым на стороне клиента.
show Sidebar(userInterface) void Открывает боковую панель в редакторе пользователя с пользовательским контентом, созданным на стороне клиента.

User

Методы

Метод Тип возвращаемого значения Краткое описание
get Email() String Получает адрес электронной почты пользователя, если он доступен.

Weekday

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

Свойство Тип Описание
SUNDAY Enum Воскресенье.
MONDAY Enum Понедельник.
TUESDAY Enum Вторник.
WEDNESDAY Enum Среда.
THURSDAY Enum Четверг.
FRIDAY Enum Пятница.
SATURDAY Enum Суббота.

console

Методы

Метод Тип возвращаемого значения Краткое описание
error() void Выводит пустое сообщение уровня ERROR в систему логирования Stackdriver.
error(formatOrObject, values) void Выводит сообщение уровня ERROR в систему логирования Stackdriver.
info() void Выводит пустое сообщение уровня INFO в систему логирования Stackdriver.
info(formatOrObject, values) void Выводит сообщение уровня INFO в систему логирования Stackdriver.
log() void Выводит пустое сообщение уровня DEBUG в систему логирования Stackdriver.
log(formatOrObject, values) void Выводит сообщение уровня DEBUG в систему логирования Stackdriver.
time(label) void Запускает таймер, который можно использовать для отслеживания времени выполнения операции.
time End(label) void Останавливает таймер, который был запущен ранее вызовом console.time() .
warn() void Выводит пустое сообщение уровня WARNING в систему логирования Stackdriver.
warn(formatOrObject, values) void Выводит сообщение уровня WARNING в систему логирования Stackdriver.