Package google.apps.script.type

Индекс

AddOnWidgetSet

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

Поля
usedWidgets[]

WidgetType

Список виджетов, используемых в дополнении.

Тип виджета

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

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

CommonAddOnManifest

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

Поля
name

string

Обязательно. Отображаемое имя дополнения.

logoUrl

string

Обязательно. URL-адрес изображения логотипа, отображаемого на панели инструментов дополнения.

layoutProperties

LayoutProperties

Общие свойства макета для дополнительных карт.

addOnWidgetSet

AddOnWidgetSet

Виджеты, используемые в дополнении. Если это поле не указано, используется набор по умолчанию.

useLocaleFromApp

bool

Передавать ли информацию о локали из хост-приложения.

homepageTrigger

HomepageExtensionPoint

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

universalActions[]

UniversalActionExtensionPoint

Определяет список точек расширения в универсальном меню действий, которое служит меню настроек дополнения. Точка расширения может быть URL-адресом для открытия или конечной точкой для выполнения отправки формы.

openLinkUrlPrefixes

ListValue

Действие OpenLink может использовать только URL-адрес со схемой HTTPS , MAILTO или TEL . Для HTTPS -ссылок URL-адрес также должен соответствовать одному из префиксов, указанных в списке разрешенных. Если префикс не соответствует схеме, подразумевается HTTPS . HTTP ссылки автоматически преобразуются в HTTPS -ссылки.

CreateActionExtensionPoint

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

Поля
id

string

Обязательно. Уникальный идентификатор для различения этой точки расширения. Идентификатор может содержать до 64 символов и должен иметь формат [a-zA-Z0-9-]+ .

labelText

string

Обязательно. Текст, отображаемый рядом со значком точки входа для создания ресурса, например Create support case . Этот текст статический и отображается до того, как пользователи запускают надстройку.

localizedLabelText

map<string, string>

Необязательно. Карта labelText для локализации на другие языки. Язык должен быть отформатирован в соответствии со стандартом ISO 639 , а страна/регион — в соответствии со стандартом ISO 3166 , разделённые дефисом - . Например, en-US .

Если в ключах карты присутствует локаль пользователя, пользователь увидит локализованную версию labelText .

runFunction

string

Обязательно. Конечная точка, которая будет выполняться при запуске рабочего процесса создания ресурса для создания ссылки.

logoUrl

string

Необязательно. Значок, отображаемый для точки входа в создание ресурса. Если этот параметр не указан, в меню используется значок панели инструментов вашего дополнения — logoUrl .

GranularOauthPermissionSupport

Включено ли в дополнении гранулярное согласие OAuth.

Перечисления
GRANULAR_OAUTH_PERMISSION_SUPPORT_UNSPECIFIED Значение по умолчанию, не следует использовать.
OPT_IN Дополнение включено в функцию Granular OAuth Consent.
OPT_OUT Дополнение отключено от Granular OAuth Consent.

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

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

Поля
runFunction

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 .

Поля
authorizationHeader

HttpAuthorizationHeader

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

granularOauthPermissionSupport

GranularOauthPermissionSupport

Включено ли в дополнении гранулярное согласие OAuth.

LayoutProperties

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

Поля
primaryColor

string

Основной цвет надстройки. Задаёт цвет панели инструментов. Если основной цвет не задан, используется значение по умолчанию, предоставляемое фреймворком.

secondaryColor

string

Вторичный цвет надстройки. Задаёт цвет кнопок. Если задан основной цвет, но не задан вторичный, вторичный цвет совпадает с основным. Если не задан ни основной, ни вторичный, используется значение по умолчанию, предоставленное фреймворком.

useNewMaterialDesign
(deprecated)

bool

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

LinkPreviewExtensionPoint

Конфигурация триггера, который срабатывает, когда пользователь вводит или вставляет ссылку из стороннего или не принадлежащего Google сервиса в файл Google Docs, Sheets или Slides.

Поля
labelText

string

Обязательно. Текст для примера смарт-чипа, предлагающий пользователям просмотреть ссылку, например Example: Support case . Этот текст статический и отображается до того, как пользователи запускают надстройку.

localizedLabelText

map<string, string>

Необязательно. Карта labelText для локализации на другие языки. Язык должен быть отформатирован в соответствии со стандартом ISO 639 , а страна/регион — в соответствии со стандартом ISO 3166 , разделённые дефисом - . Например, en-US .

Если в ключах карты присутствует локаль пользователя, пользователь увидит локализованную версию labelText .

patterns[]

UriPattern

Обязательно. Массив шаблонов URL, которые активируют надстройку для предварительного просмотра ссылок.

runFunction

string

Обязательно. Конечная точка, которая будет выполняться при запуске предварительного просмотра ссылки.

logoUrl

string

Необязательный. Значок, отображаемый на смарт-чипе и в окне предварительного просмотра. Если не указан, надстройка использует значок на панели инструментов, logoUrl .

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

Поля
runFunction

string

Обязательно. Конечная точка, которая будет выполнена при активации этой точки расширения.

label

string

Обязательно. Видимый пользователю текст, описывающий действие, выполняемое при активации этой точки расширения. Например, «Вставить счёт».

logoUrl

string

URL-адрес изображения логотипа, отображаемого на панели инструментов надстройки.

Если не задано, по умолчанию используется URL-адрес основного логотипа дополнения.

UniversalActionExtensionPoint

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

Поля
label

string

Обязательно. Видимый пользователю текст, описывающий действие, выполняемое при активации этой точки расширения, например, «Добавить новый контакт».

Поле объединения action_type . Обязательное. Тип действия, поддерживаемый для пункта меню универсальных действий. Это может быть как ссылка для открытия, так и конечная точка для выполнения. action_type может быть только одним из следующих:
runFunction

string

Конечная точка, которая будет запускаться UniversalAction.

UriPattern

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

Поля
hostPattern

string

Требуется для предварительного просмотра каждого шаблона URL. Домен шаблона URL. Надстройка выполняет предварительный просмотр ссылок, содержащих этот домен в URL. Для предварительного просмотра ссылок для конкретного поддомена, например, subdomain.example.com , включите этот поддомен. Для предварительного просмотра ссылок для всего домена укажите подстановочный знак со звездочкой ( * ) в качестве поддомена.

Например, *.example.com соответствует subdomain.example.com и another.subdomain.example.com .

pathPrefix

string

Необязательно. Путь, добавляющий домен hostPattern .

Например, если шаблон хоста URL-адреса — support.example.com , то для сопоставления URL-адресов для случаев, размещенных на support.example.com/cases/ , введите cases .

Чтобы сопоставить все URL-адреса в домене шаблона хоста, оставьте pathPrefix пустым.