Эта служба обеспечивает доступ к информации о пользователях, такой как адреса электронной почты и имена пользователей. Он также управляет журналами сценариев и диалоговыми окнами в приложениях Google Workspace.
Классы
| Имя | Краткое описание |
|---|---|
Blob | Объект обмена данными для служб Apps Script. |
BlobSource | Интерфейс для объектов, которые могут экспортировать свои данные в виде Blob . |
Browser | Этот класс обеспечивает доступ к диалоговым окнам, специфичным для Google Таблиц. |
Button | Перечисление, представляющее заранее определенные локализованные кнопки диалогового окна, возвращаемые alert или PromptResponse.getSelectedButton() чтобы указать, какую кнопку в диалоговом окне нажал пользователь. |
ButtonSet | Перечисление, представляющее заранее определенные локализованные наборы одной или нескольких диалоговых кнопок, которые можно добавить к alert или prompt . |
ColorType | Типы цветов |
Logger | Этот класс позволяет разработчику вести запись в журнал выполнения и в Google Cloud Logging, если сценарий связан со стандартным облачным проектом . |
Menu | Пользовательское меню в экземпляре пользовательского интерфейса приложения Google. |
MimeType | Перечисление, обеспечивающее доступ к объявлениям MIME-типа без явного ввода строк. |
Month | Перечисление, представляющее месяцы года. |
PromptResponse | Ответ на диалоговое окно prompt , отображаемое в среде пользовательского интерфейса приложения Google. |
RgbColor | Цвет, определяемый красным, зеленым и синим цветовыми каналами. |
Session | Класс Session предоставляет доступ к информации о сеансе, такой как адрес электронной почты пользователя (в некоторых случаях) и языковые настройки. |
Ui | Экземпляр среды пользовательского интерфейса для приложения Google, который позволяет сценарию добавлять такие функции, как меню, диалоговые окна и боковые панели. |
User | Представление пользователя, подходящее для написания сценариев. |
Weekday | Перечисление, представляющее дни недели. |
console | Этот класс позволяет разработчику вести запись в журнал выполнения и в Google Cloud Logging, если сценарий связан со стандартным облачным проектом . |
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 | Вызывает диалоговое окно с заданным сообщением и кнопкой ОК в браузере пользователя. |
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 | Записывает форматированную строку в консоль журналирования, используя предоставленный формат и значения. |
Menu
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
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 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 месяц). |
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 | Выводит пустое сообщение уровня ОШИБКИ в журнал Stackdriver Logging. |
error(formatOrObject, values) | void | Выводит сообщение уровня ERROR в журнал Stackdriver Logging. |
info() | void | Выводит пустое сообщение уровня INFO в журнал Stackdriver Logging. |
info(formatOrObject, values) | void | Выводит сообщение уровня INFO в журнал Stackdriver Logging. |
log() | void | Выводит пустое сообщение уровня DEBUG в журнал Stackdriver Logging. |
log(formatOrObject, values) | void | Выводит сообщение уровня DEBUG в журнал Stackdriver Logging. |
time(label) | void | Запускает таймер, который можно использовать для отслеживания продолжительности операции. |
timeEnd(label) | void | Останавливает таймер, который ранее был запущен вызовом console.time() . |
warn() | void | Выводит пустое сообщение уровня ПРЕДУПРЕЖДЕНИЕ в журнал Stackdriver Logging. |
warn(formatOrObject, values) | void | Выводит сообщение уровня ПРЕДУПРЕЖДЕНИЕ в журнал Stackdriver Logging. |