Package google.apps.script.type

Индекс

• AddOnWidgetSet (сообщение)
• AddOnWidgetSet.WidgetType (перечисление)
• CommonAddOnManifest (сообщение)
• CreateActionExtensionPoint (сообщение)
• HomepageExtensionPoint (сообщение)
• HttpAuthorizationHeader (перечисление)
• HttpOptions (сообщение)
• LayoutProperties (сообщение)
• LinkPreviewExtensionPoint (сообщение)
• MenuItemExtensionPoint (сообщение)
• UniversalActionExtensionPoint (сообщение)
• UriPattern (сообщение)

Аддонвиджетсет

Подмножество виджетов, используемое надстройкой.

Поля
used Widgets[]	WidgetType Список виджетов, используемых в дополнении.

Тип виджета

Тип виджета. WIDGET_TYPE_UNSPECIFIED — базовый набор виджетов.

Перечисления
WIDGET_TYPE_UNSPECIFIED	Набор виджетов по умолчанию.
DATE_PICKER	Выбор даты.
STYLED_BUTTONS	К стилизованным кнопкам относятся заполненные и деактивированные кнопки.
PERSISTENT_FORMS	Постоянные формы позволяют сохранять значения формы во время действий.
FIXED_FOOTER	Исправлен нижний колонтитул в карточке.
UPDATE_SUBJECT_AND_RECIPIENTS	Обновите тему и получателей черновика.
GRID_WIDGET	Виджет сетки.
ADDON_COMPOSE_UI_ACTION	Действие надстройки Gmail, которое применяется к пользовательскому интерфейсу создания надстройки.

Коммонаддонманифест

Конфигурация надстройки, которая используется всеми дополнительными хост-приложениями.

Поля
name	string Необходимый. Отображаемое имя дополнения.
logo Url	string Необходимый. URL-адрес изображения логотипа, отображаемого на панели инструментов надстройки.
layout Properties	LayoutProperties Общие свойства макета для дополнительных карт.
add On Widget Set	AddOnWidgetSet Виджеты, используемые в дополнении. Если это поле не указано, используется набор по умолчанию.
use Locale From App	bool Передавать ли информацию о локали из хост-приложения.
homepage Trigger	HomepageExtensionPoint Определяет конечную точку, которая будет выполняться в любом контексте и на любом хосте. Любые карточки, созданные этой функцией, всегда будут доступны пользователю, но могут быть затмены контекстным контентом, когда это дополнение объявляет более целевые триггеры.
universal Actions[]	UniversalActionExtensionPoint Определяет список точек расширения в универсальном меню действий, которое служит меню настроек дополнения. Точкой расширения может быть URL-адрес ссылки для открытия или конечная точка для выполнения при отправке формы.
open Link Url Prefixes	ListValue Действие OpenLink может использовать только URL-адрес со схемой HTTPS , MAILTO или TEL . Для ссылок HTTPS URL-адрес также должен соответствовать одному из префиксов, указанных в белом списке. Если в префиксе отсутствует схема, предполагается HTTPS . HTTP ссылки автоматически перезаписываются в HTTPS ссылки.

CreateActionExtensionPoint

Конфигурация триггера, который срабатывает, когда пользователь запускает рабочий процесс создания ресурса в приложении Google Workspace. Дополнительные сведения см. в разделе Создание сторонних ресурсов из меню @ .

Поля
id	string Необходимый. Уникальный идентификатор, позволяющий отличить эту точку расширения. Идентификатор может содержать до 64 символов и должен быть в формате [a-zA-Z0-9-]+ .
label Text	string Необходимый. Текст, который отображается рядом со значком точки входа для создания ресурса, например Create support case . Этот текст является статическим и отображается до того, как пользователи запустят надстройку.
localized Label Text	map<string, string> Необязательный. Карта labelText для локализации на другие языки. Отформатируйте язык в формате ISO 639 и страну/регион в формате ISO 3166 , разделив их дефисом - . Например, en-US . Если локаль пользователя присутствует в ключах карты, пользователь видит локализованную версию labelText .
run Function	string Необходимый. Конечная точка, которая будет выполняться, когда рабочий процесс создания ресурса запускается для создания ссылки.
logo Url	string Необязательный. Значок, отображаемый для точки входа создания ресурса. Если этот параметр опущен, в меню используется значок панели инструментов вашего дополнения, logoUrl .

Домашняя страницаExtensionPoint

Общий формат объявления представления домашней страницы надстройки.

Поля
run Function	string Необходимый. Конечная точка, которая будет выполняться при активации этой точки расширения.
enabled	BoolValue Необязательный. Если установлено значение false , деактивируется просмотр домашней страницы в этом контексте. По умолчанию true , если не установлено. Если пользовательский вид домашней страницы надстройки отключен, вместо этого пользователям предоставляется общая обзорная карточка.

HttpAuthorizationHeader

Заголовок авторизации, отправляемый в дополнительных HTTP запросах.

Перечисления
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED	Значение по умолчанию, эквивалентное SYSTEM_ID_TOKEN .
SYSTEM_ID_TOKEN	Отправьте токен идентификатора для учетной записи системной службы надстройки Google Workspace для конкретного проекта (по умолчанию).
USER_ID_TOKEN	Отправьте токен идентификатора конечному пользователю.
NONE	Не отправляйте заголовок аутентификации.

HttpOptions

Параметры отправки запросов на дополнительные конечные точки HTTP .

Поля
authorization Header	HttpAuthorizationHeader Конфигурация токена, отправленного в заголовке HTTP авторизации.

Свойства макета

Свойства макета карты используются всеми дополнительными хост-приложениями.

Поля
primary Color	string Основной цвет дополнения. Он устанавливает цвет панели инструментов. Если основной цвет не установлен, используется значение по умолчанию, предоставленное платформой.
secondary Color	string Вторичный цвет дополнения. Он устанавливает цвет кнопок. Если основной цвет установлен, но не задан дополнительный цвет, дополнительный цвет совпадает с основным цветом. Если ни основной, ни вторичный цвет не заданы, используется значение по умолчанию, предоставленное платформой.
use New Material Design	bool Включает материальный дизайн для карточек.

Линкпревиевекстенсионпойнт

Конфигурация триггера, который срабатывает, когда пользователь вводит или вставляет ссылку из сторонней или сторонней службы Google в файл Документов, Таблиц или Презентаций Google.

Поля
label Text	string Необходимый. Текст примера смарт-чипа, предлагающий пользователям просмотреть ссылку, например Example: Support case . Этот текст является статическим и отображается до того, как пользователи запустят надстройку.
localized Label Text	map<string, string> Необязательный. Карта labelText для локализации на другие языки. Отформатируйте язык в формате ISO 639 и страну/регион в формате ISO 3166 , разделив их дефисом - . Например, en-US . Если локаль пользователя присутствует в ключах карты, пользователь видит локализованную версию labelText .
patterns[]	UriPattern Необходимый. Массив шаблонов URL-адресов, которые запускают надстройку для предварительного просмотра ссылок.
run Function	string Необходимый. Конечная точка для выполнения при запуске предварительного просмотра ссылки.
logo Url	string Необязательный. Значок, который отображается на смарт-чипе и карте предварительного просмотра. Если этот параметр опущен, надстройка использует значок на панели инструментов logoUrl .

МенюItemExtensionPoint

Общий формат объявления пункта меню или кнопки, отображаемой в ведущем приложении.

Поля
run Function	string Необходимый. Конечная точка, которая будет выполняться при активации этой точки расширения.
label	string Необходимый. Видимый пользователю текст, описывающий действие, предпринятое при активации этой точки расширения. Например, «Вставить счет».
logo Url	string URL-адрес изображения логотипа, отображаемого на панели инструментов надстройки. Если этот параметр не установлен, по умолчанию используется основной URL-адрес логотипа надстройки.

Универсальное действиеExtensionPoint

Формат объявления точки расширения универсального пункта меню действий.

Поля
label	string Необходимый. Видимый пользователю текст, описывающий действие, выполняемое при активации этой точки расширения, например «Добавить новый контакт».
Поле объединения action_type . Необходимый. Тип действия, поддерживаемый в пункте меню универсального действия. Это может быть либо ссылка для открытия, либо конечная точка для выполнения. action_type может быть только одним из следующих:
open Link	string URL-адрес, который будет открыт UniversalAction.
run Function	string Конечная точка, которую будет запускать UniversalAction.

Урипаттерн

Конфигурация для каждого шаблона URL-адреса, запускающего предварительный просмотр ссылки.

Поля
host Pattern	string Требуется для предварительного просмотра каждого шаблона URL. Домен шаблона URL. Надстройка просматривает ссылки, содержащие этот домен в URL-адресе. Чтобы просмотреть ссылки для определенного субдомена, например subdomain.example.com , включите субдомен. Чтобы просмотреть ссылки для всего домена, укажите в качестве поддомена подстановочный знак со звездочкой ( * ). Например, *.example.com соответствует subdomain.example.com another.subdomain.example.com .
path Prefix	string Необязательный. Путь, по которому добавляется домен hostPattern . Например, если шаблон хоста URL-адреса — support.example.com , чтобы сопоставить URL-адреса обращений, размещенных по адресу support.example.com/cases/ , введите cases . Чтобы сопоставить все URL-адреса в домене шаблона хоста, оставьте pathPrefix пустым.