Base Service

Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.
База

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

Классы

Имя Краткое описание
Blob Объект обмена данными для сервисов Apps Script.
BlobSource Интерфейс для объектов, которые могут экспортировать свои данные в виде Blob -объектов.
Browser Этот класс предоставляет доступ к диалоговым окнам, характерным для Google Таблиц.
Button Перечисление, представляющее предопределенные локализованные кнопки диалога, возвращенные alert или PromptResponse.getSelectedButton() , чтобы указать, какую кнопку в диалоге щелкнул пользователь.
ButtonSet Перечисление, представляющее предопределенные локализованные наборы одной или нескольких диалоговых кнопок, которые можно добавить к alert или prompt .
ColorType Типы цветов
Logger Этот класс позволяет разработчику записывать текст в журналы отладки.
Menu Пользовательское меню в экземпляре пользовательского интерфейса для приложения Google.
MimeType Перечисление, обеспечивающее доступ к объявлениям типа MIME без явного ввода строк.
Month Перечисление, представляющее месяцы года.
PromptResponse Ответ на диалоговое окно с prompt , отображаемое в среде пользовательского интерфейса для приложения Google.
RgbColor Цвет, определяемый красными, зелеными и синими цветовыми каналами.
Session Класс Session предоставляет доступ к информации о сеансе, такой как адрес электронной почты пользователя (в некоторых случаях) и языковые настройки.
Ui Экземпляр среды пользовательского интерфейса для приложения Google, который позволяет скрипту добавлять такие функции, как меню, диалоговые окна и боковые панели.
User Представление пользователя, пригодное для скриптинга.
Weekday Перечисление, представляющее дни недели.
console Этот класс позволяет разработчику записывать журналы в службу ведения журналов Stackdriver облачной платформы Google.

Blob

Методы

Метод Тип возврата Краткое описание
copyBlob() Blob Возвращает копию этого большого двоичного объекта.
getAs(contentType) Blob Верните данные внутри этого объекта в виде большого двоичного объекта, преобразованного в указанный тип контента.
getBytes() Byte[] Получает данные, хранящиеся в этом большом двоичном объекте.
getContentType() String Получает тип содержимого байтов в этом большом двоичном объекте.
getDataAsString() String Получает данные этого большого двоичного объекта в виде строки с кодировкой UTF-8.
getDataAsString(charset) String Получает данные этого большого двоичного объекта в виде строки с указанной кодировкой.
getName() String Получает имя этого большого двоичного объекта.
isGoogleType() Boolean Возвращает, является ли этот большой двоичный объект файлом Google Workspace (Таблицы, Документы и т. д.).
setBytes(data) Blob Задает данные, хранящиеся в этом большом двоичном объекте.
setContentType(contentType) Blob Задает тип содержимого байтов в этом большом двоичном объекте.
setContentTypeFromExtension() Blob Задает тип содержимого байтов в этом большом двоичном объекте на основе расширения файла.
setDataFromString(string) Blob Задает данные этого большого двоичного объекта из строки с кодировкой UTF-8.
setDataFromString(string, charset) Blob Задает данные этого большого двоичного объекта из строки с указанной кодировкой.
setName(name) Blob Задает имя этого большого двоичного объекта.

BlobSource

Методы

Метод Тип возврата Краткое описание
getAs(contentType) Blob Верните данные внутри этого объекта в виде большого двоичного объекта, преобразованного в указанный тип контента.
getBlob() Blob Верните данные внутри этого объекта в виде большого двоичного объекта.

Browser

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

Имущество Тип Описание
Buttons ButtonSet

Методы

Метод Тип возврата Краткое описание
inputBox(prompt) String Открывает диалоговое окно с полем ввода текста в браузере пользователя.
inputBox(prompt, buttons) String Открывает диалоговое окно с полем ввода текста в браузере пользователя.
inputBox(title, prompt, buttons) String Открывает диалоговое окно с полем ввода текста в браузере пользователя.
msgBox(prompt) String Выводит диалоговое окно с заданным сообщением и кнопкой OK в браузере пользователя.
msgBox(prompt, buttons) String Выводит диалоговое окно с данным сообщением и указанными кнопками в браузере пользователя.
msgBox(title, prompt, buttons) String Выводит диалоговое окно с заданным заголовком, сообщением и указанными кнопками в браузере пользователя.

Button

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

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

ButtonSet

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

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

ColorType

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

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

Logger

Методы

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

Методы

Метод Тип возврата Краткое описание
addItem(caption, functionName) Menu Добавляет пункт в меню.
addSeparator() Menu Добавляет визуальный разделитель в меню.
addSubMenu(menu) Menu Добавляет подменю в меню.
addToUi() void Вставляет меню в экземпляр пользовательского интерфейса редактора.

MimeType

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

Имущество Тип Описание
GOOGLE_APPS_SCRIPT Enum Представление типа MIME для проекта Google Apps Script.
GOOGLE_DRAWINGS Enum Представление типа MIME для файла Google Drawings.
GOOGLE_DOCS Enum Представление типа MIME для файла Документов Google.
GOOGLE_FORMS Enum Представление типа MIME для файла Google Forms.
GOOGLE_SHEETS Enum Представление типа MIME для файла Google Sheets.
GOOGLE_SITES Enum Представление типа MIME для файла Сайтов Google.
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).

PromptResponse

Методы

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

RgbColor

Методы

Метод Тип возврата Краткое описание
asHexString() String Возвращает цвет в виде 7-символьной шестнадцатеричной строки в стиле CSS (#rrggbb) или 9-символьной шестнадцатеричной строки (#aarrggbb).
getBlue() Integer Синий канал этого цвета, как число от 0 до 255.
getColorType() ColorType Получите тип этого цвета.
getGreen() Integer Зеленый канал этого цвета, как число от 0 до 255.
getRed() Integer Красный канал этого цвета, как число от 0 до 255.

Session

Методы

Метод Тип возврата Краткое описание
getActiveUser() User Получает информацию о текущем пользователе.
getActiveUserLocale() String Получает настройку языка текущего пользователя в виде строки, например en для английского.
getEffectiveUser() User Получает информацию о пользователе, с правами которого запущен скрипт.
getScriptTimeZone() String Получает часовой пояс скрипта.
getTemporaryActiveUserKey() String Получает временный ключ, уникальный для активного пользователя, но не раскрывающий личность пользователя.

Ui

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

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

Методы

Метод Тип возврата Краткое описание
alert(prompt) Button Открывает диалоговое окно в пользовательском редакторе с заданным сообщением и кнопкой «ОК».
alert(prompt, buttons) Button Открывает диалоговое окно в пользовательском редакторе с заданным сообщением и набором кнопок.
alert(title, prompt, buttons) Button Открывает диалоговое окно в пользовательском редакторе с заданным заголовком, сообщением и набором кнопок.
createAddonMenu() Menu Создает построитель, который можно использовать для вставки подменю в меню дополнений редактора.
createMenu(caption) Menu Создает построитель, который можно использовать для добавления меню в пользовательский интерфейс редактора.
prompt(prompt) PromptResponse Открывает диалоговое окно ввода в пользовательском редакторе с заданным сообщением и кнопкой «ОК».
prompt(prompt, buttons) PromptResponse Открывает диалоговое окно ввода в пользовательском редакторе с заданным сообщением и набором кнопок.
prompt(title, prompt, buttons) PromptResponse Открывает диалоговое окно ввода в пользовательском редакторе с заданным заголовком, сообщением и набором кнопок.
showModalDialog(userInterface, title) void Открывает модальное диалоговое окно в пользовательском редакторе с пользовательским содержимым на стороне клиента.
showModelessDialog(userInterface, title) void Открывает немодальное диалоговое окно в пользовательском редакторе с пользовательским содержимым на стороне клиента.
showSidebar(userInterface) void Открывает боковую панель в пользовательском редакторе с пользовательским содержимым на стороне клиента.

User

Методы

Метод Тип возврата Краткое описание
getEmail() 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 Logging.
info() void Выводит пустое сообщение уровня INFO в ведение журнала Stackdriver.
info(formatOrObject, values) void Выводит сообщение уровня INFO в Stackdriver Logging.
log() void Выводит пустое сообщение уровня DEBUG в журнал Stackdriver.
log(formatOrObject, values) void Выводит сообщение уровня DEBUG в ведение журнала Stackdriver.
time(label) void Запускает таймер, который можно использовать для отслеживания времени выполнения операции.
timeEnd(label) void Останавливает таймер, который ранее был запущен вызовом console.time() .
warn() void Выводит пустое сообщение уровня ПРЕДУПРЕЖДЕНИЕ в ведение журнала Stackdriver.
warn(formatOrObject, values) void Выводит сообщение уровня ПРЕДУПРЕЖДЕНИЕ в журнал Stackdriver.