- Ресурс: Развертывание
- Дополнения
- Коммонаддонманифест
- Свойства макета
- Аддонвиджетсет
- Тип виджета
- Домашняя страницаExtensionPoint
- Универсальное действиеExtensionPoint
- GmailAddOnManifest
- Контекстуальный триггер
- Безусловный триггер
- Универсальное действие
- ComposeTrigger
- МенюItemExtensionPoint
- ПроектДоступ
- DriveAddOnManifest
- Дискекстенсионпоинт
- КалендарьАддонМанифест
- Решение для конференций
- Календарекстенсионпоинт
- EventAccess
- Документыаддонманифест
- ДокументыExtensionPoint
- Линкпревиевекстенсионпоинт
- Урипаттерн
- CreateActionExtensionPoint
- ЛистыAddOnManifest
- ЛистыExtensionPoint
- СлайдыAddOnManifest
- СлайдыExtensionPoint
- HttpOptions
- HttpAuthorizationHeader
- Методы
Ресурс: Развертывание
Развертывание надстройки Google Workspace
JSON-представление |
---|
{
"name": string,
"oauthScopes": [
string
],
"addOns": {
object ( |
Поля | |
---|---|
name | Имя ресурса развертывания. Пример: |
oauthScopes[] | Список областей Google OAuth, для которых запрашивается согласие конечного пользователя перед выполнением конечной точки надстройки. |
addOns | Конфигурация надстройки Google Workspace. |
etag | Это значение вычисляется сервером на основе версии развертывания в хранилище и может отправляться в запросах на обновление и удаление, чтобы убедиться, что клиент имеет актуальное значение, прежде чем продолжить. |
Дополнения
Конфигурация надстройки Google Workspace.
JSON-представление |
---|
{ "common": { object ( |
Поля | |
---|---|
common | Конфигурация, общая для всех дополнений Google Workspace. |
gmail | Конфигурация дополнения Gmail. |
drive | Конфигурация надстройки диска. |
calendar | Настройка дополнения календаря. |
docs | Конфигурация дополнения «Документы». |
sheets | Конфигурация надстройки Таблиц. |
slides | Конфигурация надстройки слайдов. |
httpOptions | Варианты отправки запросов на дополнительные конечные точки HTTP |
Коммонаддонманифест
Конфигурация надстройки, которая используется всеми дополнительными хост-приложениями.
JSON-представление |
---|
{ "name": string, "logoUrl": string, "layoutProperties": { object ( |
Поля | |
---|---|
name | Необходимый. Отображаемое имя дополнения. |
logoUrl | Необходимый. URL-адрес изображения логотипа, отображаемого на панели инструментов надстройки. |
layoutProperties | Общие свойства макета для дополнительных карт. |
addOnWidgetSet | Виджеты, используемые в дополнении. Если это поле не указано, используется набор по умолчанию. |
useLocaleFromApp | Передавать ли информацию о локали из хост-приложения. |
homepageTrigger | Определяет конечную точку, которая будет выполняться в любом контексте и на любом хосте. Любые карточки, созданные этой функцией, всегда будут доступны пользователю, но могут быть затмены контекстным контентом, когда это дополнение объявляет более целевые триггеры. |
universalActions[] | Определяет список точек расширения в универсальном меню действий, которое служит меню настроек дополнения. Точкой расширения может быть URL-адрес ссылки для открытия или конечная точка для выполнения при отправке формы. |
openLinkUrlPrefixes | Действие OpenLink может использовать только URL-адрес со схемой |
Свойства макета
Свойства макета карты используются всеми дополнительными хост-приложениями.
JSON-представление |
---|
{ "primaryColor": string, "secondaryColor": string, "useNewMaterialDesign": boolean } |
Поля | |
---|---|
primaryColor | Основной цвет дополнения. Он устанавливает цвет панели инструментов. Если основной цвет не установлен, используется значение по умолчанию, предоставленное платформой. |
secondaryColor | Вторичный цвет дополнения. Он устанавливает цвет кнопок. Если основной цвет установлен, но не задан дополнительный цвет, дополнительный цвет совпадает с основным цветом. Если ни основной, ни вторичный цвет не заданы, используется значение по умолчанию, предоставленное платформой. |
useNewMaterialDesign | Включает материальный дизайн для карточек. |
Аддонвиджетсет
Подмножество виджетов, используемое надстройкой.
JSON-представление |
---|
{
"usedWidgets": [
enum ( |
Поля | |
---|---|
usedWidgets[] | Список виджетов, используемых в дополнении. |
Тип виджета
Тип виджета. 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, которое применяется к пользовательскому интерфейсу создания надстройки. |
Домашняя страницаExtensionPoint
Общий формат объявления представления домашней страницы надстройки.
JSON-представление |
---|
{ "runFunction": string, "enabled": boolean } |
Поля | |
---|---|
runFunction | Необходимый. Конечная точка, которая будет выполняться при активации этой точки расширения. |
enabled | Необязательный. Если установлено значение По умолчанию Если пользовательский вид домашней страницы надстройки отключен, вместо этого пользователям предоставляется общая обзорная карточка. |
Универсальное действиеExtensionPoint
Формат объявления точки расширения универсального пункта меню действий.
JSON-представление |
---|
{ "label": string, // Union field |
Поля | |
---|---|
label | Необходимый. Видимый пользователю текст, описывающий действие, выполняемое при активации этой точки расширения, например «Добавить новый контакт». |
Поле объединения action_type . Необходимый. Тип действия, поддерживаемый в пункте меню универсального действия. Это может быть либо ссылка для открытия, либо конечная точка для выполнения. action_type может быть только одним из следующих: | |
openLink | URL-адрес, который будет открыт UniversalAction. |
runFunction | Конечная точка, которую будет запускать UniversalAction. |
GmailAddOnManifest
Свойства, настраивающие внешний вид и работу надстройки Gmail.
JSON-представление |
---|
{ "homepageTrigger": { object ( |
Поля | |
---|---|
homepageTrigger | Определяет конечную точку, которая будет выполняться в контекстах, не соответствующих объявленному контекстному триггеру. Любые карточки, созданные этой функцией, всегда будут доступны пользователю, но могут быть затмены контекстным контентом, когда это дополнение объявляет более целевые триггеры. Если он присутствует, он переопределяет конфигурацию из |
contextualTriggers[] | Определяет набор условий, которые запускают надстройку. |
universalActions[] | Определяет набор универсальных действий для дополнения. Пользователь запускает универсальные действия из меню панели инструментов надстройки. |
composeTrigger | Определяет триггер времени создания для надстройки времени создания. Это триггер, который заставляет надстройку выполнять действие, когда пользователь составляет электронное письмо. Все надстройки времени создания должны иметь область действия |
authorizationCheckFunction | Имя конечной точки, которая проверяет наличие у надстройки всех необходимых сторонних авторизаций путем проверки сторонних API. Если проверка не удалась, функция должна выдать исключение, чтобы инициировать поток авторизации. Эта функция вызывается перед каждым вызовом надстройки, чтобы обеспечить удобство работы пользователя. |
Контекстуальный триггер
Определяет триггер, который срабатывает, когда открытое электронное письмо соответствует определенным критериям. Когда триггер срабатывает, он выполняет определенную конечную точку, обычно для создания новых карточек и обновления пользовательского интерфейса.
JSON-представление |
---|
{ "onTriggerFunction": string, // Union field |
Поля | |
---|---|
onTriggerFunction | Необходимый. Имя конечной точки для вызова, когда сообщение соответствует триггеру. |
trigger поля объединения. Тип триггера определяет условия, которые Gmail использует для отображения дополнения. trigger может быть только одно из следующих: | |
unconditional | Безусловные триггеры выполняются при открытии любого почтового сообщения. |
Безусловный триггер
Этот тип не имеет полей.
Триггер, который срабатывает при открытии любого сообщения электронной почты.
Универсальное действие
Действие, которое всегда доступно в меню панели инструментов дополнения, независимо от контекста сообщения.
JSON-представление |
---|
{ "text": string, // Union field |
Поля | |
---|---|
text | Необходимый. Видимый пользователю текст, описывающий действие, например «Добавить новый контакт». |
Поле объединения action_type . Тип действия определяет поведение Gmail, когда пользователь вызывает это действие. action_type может быть только одним из следующих: | |
openLink | Ссылка, которая открывается Gmail, когда пользователь запускает действие. |
runFunction | Конечная точка, которая вызывается, когда пользователь запускает действие. Подробности смотрите в руководстве по универсальным действиям . |
ComposeTrigger
Триггер, который активируется, когда пользователь составляет электронное письмо.
JSON-представление |
---|
{ "actions": [ { object ( |
Поля | |
---|---|
actions[] | Определяет набор действий для надстройки времени создания. Это действия, которые пользователи могут запускать в надстройке времени создания сообщения. |
draftAccess | Определяет уровень доступа к данным при запуске надстройки времени создания. |
МенюItemExtensionPoint
Общий формат объявления пункта меню или кнопки, отображаемой в ведущем приложении.
JSON-представление |
---|
{ "runFunction": string, "label": string, "logoUrl": string } |
Поля | |
---|---|
runFunction | Необходимый. Конечная точка, которая будет выполняться при активации этой точки расширения. |
label | Необходимый. Видимый пользователю текст, описывающий действие, предпринятое при активации этой точки расширения. Например, «Вставить счет». |
logoUrl | URL-адрес изображения логотипа, отображаемого на панели инструментов надстройки. Если этот параметр не установлен, по умолчанию используется основной URL-адрес логотипа надстройки. |
ПроектДоступ
Перечисление, определяющее уровень доступа к данным, требуемый триггером создания.
Перечисления | |
---|---|
UNSPECIFIED | Значение по умолчанию, если для черновика доступа ничего не установлено. |
NONE | Триггер создания не может получить доступ к каким-либо данным черновика при запуске надстройки создания. |
METADATA | Дает триггеру создания разрешение на доступ к метаданным черновика при запуске надстройки создания. Сюда входит список аудитории, например список «Кому» и «Копия» черновика сообщения. |
DriveAddOnManifest
Свойства, настраивающие внешний вид и работу надстройки Диска.
JSON-представление |
---|
{ "homepageTrigger": { object ( |
Поля | |
---|---|
homepageTrigger | Если он присутствует, он переопределяет конфигурацию из |
onItemsSelectedTrigger | Соответствует поведению, которое выполняется при выборе элементов в соответствующем представлении Диска, например в списке документов «Мой диск». |
Дискекстенсионпоинт
Общий формат объявления триггеров надстройки Диска.
JSON-представление |
---|
{ "runFunction": string } |
Поля | |
---|---|
runFunction | Необходимый. Конечная точка, которая будет выполняться при активации точки расширения. |
КалендарьАддонМанифест
Свойства, настраивающие внешний вид и выполнение надстройки «Календарь».
JSON-представление |
---|
{ "homepageTrigger": { object ( |
Поля | |
---|---|
homepageTrigger | Определяет конечную точку, которая выполняется в контекстах, не соответствующих объявленному контекстному триггеру. Любые карточки, созданные этой функцией, всегда будут доступны пользователю, но могут быть затмены контекстным контентом, когда это дополнение объявляет более целевые триггеры. Если он присутствует, он переопределяет конфигурацию из |
conferenceSolution[] | Определяет решения для конференций, предоставляемые этим дополнением. |
createSettingsUrlFunction | Конечная точка для выполнения, которая создает URL-адрес страницы настроек надстройки. |
eventOpenTrigger | Конечная точка, которая срабатывает, когда событие открывается для просмотра или редактирования. |
eventUpdateTrigger | Конечная точка, которая срабатывает при обновлении события открытия. |
eventAttachmentTrigger | Конфигурация контекстного триггера, который срабатывает, когда пользователь щелкает поставщика дополнительных вложений в раскрывающемся меню «Календарь». |
currentEventAccess | Определяет уровень доступа к данным при запуске надстройки события. |
Решение для конференций
Определяет значения, связанные с конференцией.
JSON-представление |
---|
{ "onCreateFunction": string, "id": string, "name": string, "logoUrl": string } |
Поля | |
---|---|
onCreateFunction | Необходимый. Конечная точка для вызова при создании данных конференции. |
id | Необходимый. Идентификаторы должны быть уникальными для всех решений конференц-связи в рамках одной надстройки, в противном случае при запуске надстройки может использоваться неправильное решение конференц-связи. Хотя вы можете изменить отображаемое имя надстройки, идентификатор менять не следует. |
name | Необходимый. Отображаемое имя решения для конференции. |
logoUrl | Необходимый. URL-адрес логотипа решения для конференций. |
Календарекстенсионпоинт
Общий формат объявления триггеров надстройки календаря.
JSON-представление |
---|
{ "runFunction": string } |
Поля | |
---|---|
runFunction | Необходимый. Конечная точка, которая будет выполняться при активации этой точки расширения. |
EventAccess
Перечисление, определяющее уровень, который требуется триггерам событий доступа к данным.
Перечисления | |
---|---|
UNSPECIFIED | Значение по умолчанию, если для eventAccess ничего не установлено. |
METADATA | Предоставляет триггерам событий разрешение на доступ к метаданным событий, таким как идентификатор события и идентификатор календаря. |
READ | Предоставляет триггерам событий доступ ко всем предоставленным полям событий, включая метаданные, участников и данные конференции. |
WRITE | Предоставляет триггерам событий доступ к метаданным событий и возможность выполнять все действия, включая добавление участников и настройку данных конференции. |
READ_WRITE | Предоставляет триггерам событий доступ ко всем предоставленным полям событий, включая метаданные, участников и данные конференции, а также возможность выполнять все действия. |
Документыаддонманифест
Свойства, настраивающие внешний вид и выполнение надстройки Google Docs.
JSON-представление |
---|
{ "homepageTrigger": { object ( |
Поля | |
---|---|
homepageTrigger | Если он присутствует, он переопределяет конфигурацию из |
onFileScopeGrantedTrigger | Конечная точка для выполнения, когда для этой пары документ/пользователь предоставлена авторизация в области файла. |
linkPreviewTriggers[] | Список точек расширения для предварительного просмотра ссылок в документе Google Docs. Подробности см. в разделе Предварительный просмотр ссылок со смарт-чипами . |
createActionTriggers[] | Список точек расширения для создания сторонних ресурсов из приложений Google Workspace. Дополнительные сведения см. в разделе Создание сторонних ресурсов из меню @ . |
ДокументыExtensionPoint
Общий формат объявления триггеров надстройки Документов.
JSON-представление |
---|
{ "runFunction": string } |
Поля | |
---|---|
runFunction | Необходимый. Конечная точка, которая будет выполняться при активации этой точки расширения. |
Линкпревиевекстенсионпоинт
Конфигурация триггера, который срабатывает, когда пользователь вводит или вставляет ссылку из сторонней или сторонней службы Google в файл Документов, Таблиц или Презентаций Google.
JSON-представление |
---|
{
"labelText": string,
"localizedLabelText": {
string: string,
...
},
"patterns": [
{
object ( |
Поля | |
---|---|
labelText | Необходимый. Текст примера смарт-чипа, который предлагает пользователям предварительно просмотреть ссылку, например |
localizedLabelText | Необязательный. Карта Если локаль пользователя присутствует в ключах карты, пользователь видит локализованную версию Объект, содержащий список пар |
patterns[] | Необходимый. Массив шаблонов URL-адресов, которые запускают надстройку для предварительного просмотра ссылок. |
runFunction | Необходимый. Конечная точка для выполнения при запуске предварительного просмотра ссылки. |
logoUrl | Необязательный. Значок, который отображается на смарт-чипе и карте предварительного просмотра. Если этот параметр опущен, надстройка использует значок на панели инструментов |
Урипаттерн
Конфигурация для каждого шаблона URL-адреса, запускающего предварительный просмотр ссылки.
JSON-представление |
---|
{ "hostPattern": string, "pathPrefix": string } |
Поля | |
---|---|
hostPattern | Требуется для предварительного просмотра каждого шаблона URL. Домен шаблона URL. Надстройка просматривает ссылки, содержащие этот домен в URL-адресе. Чтобы просмотреть ссылки для определенного субдомена, например Например, |
pathPrefix | Необязательный. Путь, по которому добавляется домен к Например, если шаблон хоста URL-адреса — Чтобы сопоставить все URL-адреса в домене шаблона хоста, оставьте |
CreateActionExtensionPoint
Конфигурация триггера, который срабатывает, когда пользователь запускает рабочий процесс создания ресурса в приложении Google Workspace. Дополнительные сведения см. в разделе Создание сторонних ресурсов из меню @ .
JSON-представление |
---|
{ "id": string, "labelText": string, "localizedLabelText": { string: string, ... }, "runFunction": string, "logoUrl": string } |
Поля | |
---|---|
id | Необходимый. Уникальный идентификатор, позволяющий отличить эту точку расширения. Идентификатор может содержать до 64 символов и должен быть в формате |
labelText | Необходимый. Текст, который отображается рядом со значком точки входа для создания ресурса, например « |
localizedLabelText | Необязательный. Карта Если локаль пользователя присутствует в ключах карты, пользователь видит локализованную версию Объект, содержащий список пар |
runFunction | Необходимый. Конечная точка, которая будет выполняться, когда рабочий процесс создания ресурса запускается для создания ссылки. |
logoUrl | Необязательный. Значок, отображаемый для точки входа создания ресурса. Если этот параметр опущен, в меню используется значок панели инструментов вашего дополнения, |
ЛистыAddOnManifest
Свойства, настраивающие внешний вид и работу надстройки Google Таблиц.
JSON-представление |
---|
{ "homepageTrigger": { object ( |
Поля | |
---|---|
homepageTrigger | Если он присутствует, он переопределяет конфигурацию из |
onFileScopeGrantedTrigger | Конечная точка для выполнения, когда для этой пары документ/пользователь предоставлена авторизация в области файла. |
linkPreviewTriggers[] | Список точек расширения для предварительного просмотра ссылок в документе Google Таблиц. Подробности см. в разделе Предварительный просмотр ссылок со смарт-чипами . |
ЛистыExtensionPoint
Общий формат объявления триггеров надстройки Таблиц.
JSON-представление |
---|
{ "runFunction": string } |
Поля | |
---|---|
runFunction | Необходимый. Конечная точка, которая будет выполняться при активации этой точки расширения. |
СлайдыAddOnManifest
Свойства, настраивающие внешний вид и работу надстройки Google Slides.
JSON-представление |
---|
{ "homepageTrigger": { object ( |
Поля | |
---|---|
homepageTrigger | Если он присутствует, он переопределяет конфигурацию из |
onFileScopeGrantedTrigger | Конечная точка для выполнения, когда для этой пары документ/пользователь предоставлена авторизация в области файла. |
linkPreviewTriggers[] | Список точек расширения для предварительного просмотра ссылок в документе Google Slides. Подробности см. в разделе Предварительный просмотр ссылок со смарт-чипами . |
СлайдыExtensionPoint
Общий формат объявления триггеров надстройки Slides.
JSON-представление |
---|
{ "runFunction": string } |
Поля | |
---|---|
runFunction | Необходимый. Конечная точка, которая будет выполняться при активации этой точки расширения. |
HttpOptions
Параметры отправки запросов на дополнительные конечные точки HTTP
.
JSON-представление |
---|
{
"authorizationHeader": enum ( |
Поля | |
---|---|
authorizationHeader | Конфигурация токена, отправленного в заголовке |
HttpAuthorizationHeader
Заголовок авторизации, отправляемый в дополнительных HTTP
запросах.
Перечисления | |
---|---|
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED | Значение по умолчанию, эквивалентное SYSTEM_ID_TOKEN . |
SYSTEM_ID_TOKEN | Отправьте токен идентификатора для учетной записи системной службы надстройки Google Workspace для конкретного проекта (по умолчанию). |
USER_ID_TOKEN | Отправьте токен идентификатора конечному пользователю. |
NONE | Не отправляйте заголовок аутентификации. |
Методы | |
---|---|
| Создает развертывание с указанным именем и конфигурацией. |
| Удаляет развертывание с указанным именем. |
| Получает развертывание с указанным именем. |
| Получает состояние установки тестового развертывания. |
| Устанавливает развертывание в вашу учетную запись для тестирования. |
| Перечисляет все развертывания в конкретном проекте. |
| Создает или заменяет развертывание с указанным именем. |
| Удаляет тестовое развертывание из учетной записи пользователя. |