REST Resource: projects.deployments

Ресурс: развертывание

Развертывание дополнения Google Workspace.

JSON-представление 
{
  "name": string,
  "oauthScopes": [
    string
  ],
  "addOns": {
    object (AddOns)
  },
  "etag": string
}
Поля
name

string

Название ресурса развертывания. Пример: projects/123/deployments/my_deployment.
oauthScopes[]

string

Список областей действия Google OAuth, для которых нужно запрашивать согласие конечного пользователя перед выполнением конечной точки дополнения.
addOns

object (AddOns)

Конфигурация дополнения Google Workspace.
etag

string

Это значение вычисляется сервером на основе версии развертывания в хранилище и может отправляться в запросах на обновление и удаление, чтобы у клиента было актуальное значение, прежде чем он продолжит работу.

AddOns

Конфигурация дополнения Google Workspace.

JSON-представление 
{
  "common": {
    object (CommonAddOnManifest)
  },
  "gmail": {
    object (GmailAddOnManifest)
  },
  "drive": {
    object (DriveAddOnManifest)
  },
  "calendar": {
    object (CalendarAddOnManifest)
  },
  "docs": {
    object (DocsAddOnManifest)
  },
  "meet": {
    object (MeetAddOnManifest)
  },
  "sheets": {
    object (SheetsAddOnManifest)
  },
  "slides": {
    object (SlidesAddOnManifest)
  },
  "httpOptions": {
    object (HttpOptions)
  }
}
Поля
common

object (CommonAddOnManifest)

Конфигурация, общая для всех дополнений Google Workspace.
gmail

object (GmailAddOnManifest)

Конфигурация дополнения Gmail.
drive

object (DriveAddOnManifest)

Конфигурация дополнения для Диска.
calendar

object (CalendarAddOnManifest)

Конфигурация дополнения Календаря.
docs

object (DocsAddOnManifest)

Конфигурация дополнения для Документов.
meet

object (MeetAddOnManifest)

Конфигурация дополнения Meet.
sheets

object (SheetsAddOnManifest)

Конфигурация дополнения для Таблиц.
slides

object (SlidesAddOnManifest)

Конфигурация дополнения для Презентаций.
httpOptions

object (HttpOptions)

Варианты отправки запросов к конечным точкам HTTP дополнения

CommonAddOnManifest

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

JSON-представление 
{
  "name": string,
  "logoUrl": string,
  "layoutProperties": {
    object (LayoutProperties)
  },
  "addOnWidgetSet": {
    object (AddOnWidgetSet)
  },
  "useLocaleFromApp": boolean,
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "universalActions": [
    {
      object (UniversalActionExtensionPoint)
    }
  ],
  "openLinkUrlPrefixes": array
}
Поля
name

string

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

string

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

object (LayoutProperties)

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

object (AddOnWidgetSet)

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

boolean

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

object (HomepageExtensionPoint)

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

object (UniversalActionExtensionPoint)

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

array (ListValue format)

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

LayoutProperties

Свойства макета карточки, общие для всех размещаемых приложений дополнений.

JSON-представление 
{
  "primaryColor": string,
  "secondaryColor": string,
  "useNewMaterialDesign": boolean
}
Поля
primaryColor

string

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

string

Дополнительный цвет дополнения. Задает цвет кнопок. Если задан только основной цвет, то дополнительный будет таким же. Если не задан ни основной, ни дополнительный цвет, используется значение по умолчанию, предоставленное фреймворком.
useNewMaterialDesign
(deprecated)

boolean

Включает дизайн Material Design для карточек.

AddOnWidgetSet

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

JSON-представление 
{
  "usedWidgets": [
    enum (WidgetType)
  ]
}
Поля
usedWidgets[]

enum (WidgetType)

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

WidgetType

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

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

HomepageExtensionPoint

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

JSON-представление 
{
  "runFunction": string,
  "enabled": boolean
}
Поля
runFunction

string

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

boolean

Необязательное поле. Если задано значение false, главная страница в этом контексте не показывается.

Если значение не задано, по умолчанию используется true.

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

UniversalActionExtensionPoint

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

JSON-представление 
{
  "label": string,

  "openLink": string,
  "runFunction": string
}
Поля
label

string

Обязательно. Видимый пользователю текст, описывающий действие, выполняемое при активации этой точки расширения, например "Добавить новый контакт".
Обязательно. Тип действия, поддерживаемый в пункте меню универсальных действий. Это может быть ссылка, которую нужно открыть, или конечная точка, которую нужно выполнить. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
runFunction

string

Конечная точка, которая будет запущена UniversalAction.
Конец взаимоисключающих полей.

GmailAddOnManifest

Свойства, настраивающие внешний вид и выполнение дополнения Gmail.

JSON-представление 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "contextualTriggers": [
    {
      object (ContextualTrigger)
    }
  ],
  "universalActions": [
    {
      object (UniversalAction)
    }
  ],
  "composeTrigger": {
    object (ComposeTrigger)
  },
  "authorizationCheckFunction": string
}
Поля
homepageTrigger

object (HomepageExtensionPoint)

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

Если он используется, то конфигурация из файла addons.common.homepageTrigger перезаписывается.
contextualTriggers[]

object (ContextualTrigger)

Определяет набор условий, которые запускают дополнение.
universalActions[]

object (UniversalAction)

Определяет набор универсальных действий для дополнения. Пользователь запускает универсальные действия из меню на панели инструментов дополнения.
composeTrigger

object (ComposeTrigger)

Определяет триггер времени создания для дополнения времени создания. Это триггер, который заставляет дополнение выполнять действие, когда пользователь создает электронное письмо. Все дополнения, работающие в режиме создания письма, должны иметь область действия gmail.addons.current.action.compose, даже если они не редактируют черновик.
authorizationCheckFunction

string

Название конечной точки, которая проверяет, есть ли у дополнения все необходимые разрешения от сторонних сервисов, отправляя запросы к сторонним API. Если проверка не удалась, функция должна выдать исключение, чтобы запустить процесс авторизации. Эта функция вызывается перед каждым запуском дополнения, чтобы обеспечить удобство работы пользователей.

ContextualTrigger

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

JSON-представление 
{
  "onTriggerFunction": string,

  "unconditional": {
    object (UnconditionalTrigger)
  }
}
Поля
onTriggerFunction

string

Обязательно. Название конечной точки, которая будет вызываться, когда сообщение соответствует триггеру.
Тип триггера определяет условия, при которых Gmail показывает дополнение. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
unconditional

object (UnconditionalTrigger)

Безусловные триггеры выполняются при открытии любого письма.
Конец взаимоисключающих полей.

UnconditionalTrigger

У этого типа нет полей.

Триггер, который срабатывает, когда открывается любое электронное письмо.

UniversalAction

Действие, которое всегда доступно в меню панели инструментов дополнения независимо от контекста сообщения.

JSON-представление 
{
  "text": string,

  "openLink": string,
  "runFunction": string
}
Поля
text

string

Обязательно. Текст, описывающий действие, например "Добавить контакт".
Тип действия определяет поведение Gmail, когда пользователь вызывает действие. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
runFunction

string

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

ComposeTrigger

Триггер, который активируется, когда пользователь пишет письмо.

JSON-представление 
{
  "actions": [
    {
      object (MenuItemExtensionPoint)
    }
  ],
  "draftAccess": enum (DraftAccess)
}
Поля
actions[]

object (MenuItemExtensionPoint)

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

enum (DraftAccess)

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

DraftAccess

Перечисление, определяющее уровень доступа к данным, необходимый триггеру создания.

Перечисления
UNSPECIFIED Значение по умолчанию, если для draftaccess ничего не задано.
NONE Триггер создания не может получить доступ к данным черновика, когда запускается дополнение для создания.
METADATA Предоставляет триггеру создания разрешение на доступ к метаданным черновика при активации дополнения для создания. Это касается и списка аудитории, например списка получателей в полях "Кому" и "Копия" в черновике письма.

DriveAddOnManifest

Свойства, настраивающие внешний вид и выполнение дополнения Диска.

JSON-представление 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onItemsSelectedTrigger": {
    object (DriveExtensionPoint)
  }
}
Поля
homepageTrigger

object (HomepageExtensionPoint)

Если он используется, то конфигурация из файла addons.common.homepageTrigger перезаписывается.
onItemsSelectedTrigger

object (DriveExtensionPoint)

Соответствует поведению, которое выполняется, когда объекты выбраны в соответствующем представлении Диска, например в списке документов в разделе "Мой диск".

DriveExtensionPoint

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

JSON-представление 
{
  "runFunction": string
}
Поля
runFunction

string

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

CalendarAddOnManifest

Свойства, настраивающие внешний вид и выполнение дополнения Календаря.

JSON-представление 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "conferenceSolution": [
    {
      object (ConferenceSolution)
    }
  ],
  "createSettingsUrlFunction": string,
  "eventOpenTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventUpdateTrigger": {
    object (CalendarExtensionPoint)
  },
  "calendarNotificationTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventAttachmentTrigger": {
    object (MenuItemExtensionPoint)
  },
  "currentEventAccess": enum (EventAccess)
}
Поля
homepageTrigger

object (HomepageExtensionPoint)

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

Если он используется, то конфигурация из файла addons.common.homepageTrigger перезаписывается.
conferenceSolution[]

object (ConferenceSolution)

Необязательное поле. Определяет решения для видеовстреч, предоставляемые этим дополнением.
createSettingsUrlFunction

string

Конечная точка, которая создает URL страницы настроек дополнения.
eventOpenTrigger

object (CalendarExtensionPoint)

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

object (CalendarExtensionPoint)

Конечная точка, которая активируется при обновлении события открытия.
calendarNotificationTrigger

object (CalendarExtensionPoint)

Необязательное поле. Срабатывает, когда в календаре, на который подписан пользователь, создается или обновляется мероприятие. Применяется только к триггерам, созданным HTTP endpoints с помощью CalendarSubscriptionActionMarkup.

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

Неприменимо к Apps Script add-ons и Apps Script installable triggers.
eventAttachmentTrigger

object (MenuItemExtensionPoint)

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

enum (EventAccess)

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

ConferenceSolution

Определяет значения, связанные с видеовстречами.

JSON-представление 
{
  "onCreateFunction": string,
  "id": string,
  "name": string,
  "logoUrl": string
}
Поля
onCreateFunction

string

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

string

Обязательно. Идентификаторы должны быть уникальными для всех решений для видеовстреч в рамках одного дополнения, иначе при запуске дополнения может быть использовано не то решение. Отображаемое название дополнения можно изменить, но идентификатор должен остаться прежним.
name

string

Обязательно. Отображаемое название решения для видеовстреч.
logoUrl

string

Обязательно. URL логотипа решения для видеоконференций.

CalendarExtensionPoint

Общий формат для объявления триггеров дополнения Календаря.

JSON-представление 
{
  "runFunction": string
}
Поля
runFunction

string

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

EventAccess

Перечисление, определяющее уровень доступа к данным, который требуется триггерам событий.

Перечисления
UNSPECIFIED Значение по умолчанию, если для eventAccess ничего не задано.
METADATA Предоставляет триггерам событий разрешение на доступ к метаданным событий, таким как идентификатор события и идентификатор календаря.
READ Предоставляет триггерам мероприятий доступ ко всем полям мероприятий, включая метаданные, участников и данные видеовстреч.
WRITE Предоставляет триггерам событий доступ к метаданным событий и возможность выполнять все действия, включая добавление участников и настройку данных конференции.
READ_WRITE Триггеры событий получают доступ ко всем полям событий, включая метаданные, участников и данные видеовстреч, а также возможность выполнять любые действия.

DocsAddOnManifest

Свойства, настраивающие внешний вид и выполнение дополнения Google Документов.

JSON-представление 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (DocsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ],
  "createActionTriggers": [
    {
      object (CreateActionExtensionPoint)
    }
  ]
}
Поля
homepageTrigger

object (HomepageExtensionPoint)

Если он используется, то конфигурация из файла addons.common.homepageTrigger перезаписывается.
onFileScopeGrantedTrigger

object (DocsExtensionPoint)

Конечная точка, которая будет выполнена, когда для этой пары документа и пользователя будет предоставлена авторизация области действия файла.
linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

Список точек расширения для предварительного просмотра ссылок в документе Google Документов. Подробнее о том, как использовать умные чипы для предварительного просмотра ссылок…
createActionTriggers[]

object (CreateActionExtensionPoint)

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

DocsExtensionPoint

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

JSON-представление 
{
  "runFunction": string
}
Поля
runFunction

string

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

LinkPreviewExtensionPoint

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

JSON-представление 
{
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "patterns": [
    {
      object (UriPattern)
    }
  ],
  "runFunction": string,
  "logoUrl": string
}
Поля
labelText

string

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

map (key: string, value: string)

Необязательное поле. Карта labeltext для локализации на другие языки. Язык указывается в формате ISO 639, а страна или регион – в формате ISO 3166. Они разделяются дефисом -. например en-US.

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

Объект содержит список из нескольких пар ("key": value). Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
patterns[]

object (UriPattern)

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

string

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

string

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

UriPattern

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

JSON-представление 
{
  "hostPattern": string,
  "pathPrefix": string
}
Поля
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 пустым.

CreateActionExtensionPoint

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

JSON-представление 
{
  "id": string,
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string
}
Поля
id

string

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

string

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

map (key: string, value: string)

Необязательное поле. Карта labeltext для локализации на другие языки. Язык указывается в формате ISO 639, а страна или регион – в формате ISO 3166. Они разделяются дефисом -. например en-US.

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

Объект содержит список из нескольких пар ("key": value). Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
runFunction

string

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

string

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

MeetAddOnManifest

Манифест дополнения Meet.

JSON-представление 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "web": {
    object (Web)
  },
  "supportsCollaboration": boolean,
  "termsUri": string
}
Поля
homepageTrigger

object (HomepageExtensionPoint)

Если он используется, то конфигурация из файла addons.common.homepageTrigger перезаписывается.
web

object (Web)

Сведения о дополнениях, которые расширяют возможности веб-клиента Meet.
supportsCollaboration

boolean

Поддерживает ли дополнение совместную работу или приглашение других пользователей.
termsUri

string

Ссылка на условия использования дополнения, если они есть.

Веб

Сведения о дополнениях, которые расширяют возможности веб-клиента Meet.

JSON-представление 
{
  "sidePanelUri": string,
  "sidePanelUrl": string,
  "mainStageUri": string,
  "supportsScreenSharing": boolean,
  "supportsCollaboration": boolean,
  "supportsPopOut": boolean,
  "hostOrigins": [
    string
  ],
  "addOnOrigins": [
    string
  ],
  "openState": enum (State),
  "supportsCollaborationHostControls": boolean,
  "logoUrl": string,
  "darkModeLogoUrl": string,
  "displayFlow": enum (DisplayFlow)
}
Поля
sidePanelUri
(deprecated)

string

URI для окна iframe боковой панели.
sidePanelUrl

string

URL для iframe боковой панели.
mainStageUri
(deprecated)

string

URI для iframe основного этапа.
supportsScreenSharing

boolean

Поддерживает ли дополнение демонстрацию экрана в основной области.
supportsCollaboration
(deprecated)

boolean

Поддерживает ли дополнение совместную работу или приглашение других пользователей. Это поле больше не поддерживается. Используйте поле верхнего уровня в MeetAddOnManifest.
supportsPopOut

boolean

Поддерживает ли дополнение режим "картинка в картинке" в браузере.
hostOrigins[]
(deprecated)

string

Устаревшее название. Источники, которые нужно добавить в свойство frame-src элемента iframe, содержащего сторонний сайт. Используйте вместо него addonorigins.
addOnOrigins[]

string

Источники, которые нужно добавить в свойство frame-src элемента iframe, содержащего сторонний сайт.
openState

enum (State)

Начальное состояние при открытии дополнения.
supportsCollaborationHostControls

boolean

Поддерживает ли дополнение для совместной работы управление для организаторов.
logoUrl

string

URL логотипа, который будет показываться для дополнения. Если логотип не указан, по умолчанию используется логотип из общего раздела манифеста.
darkModeLogoUrl

string

Версия логотипа для тёмной темы.
displayFlow
(deprecated)

enum (DisplayFlow)

Процесс показа, который будет использоваться при запуске дополнения.

Штат

Перечисление для указания начального состояния открытия дополнения.

Перечисления
STATE_UNSPECIFIED В дополнении не указано начальное состояние.
SIDE_PANEL_ONLY Дополнение открывается, и активна только боковая панель.
MAIN_STAGE_ONLY Дополнение открывается только с активным основным экраном.
SIDE_PANEL_AND_MAIN_STAGE Дополнение открывается с активной боковой панелью и основным экраном.

DisplayFlow

Перечисление для указания процесса отображения, которому будет следовать дополнение при запуске

Перечисления
DISPLAY_FLOW_UNSPECIFIED Не указан процесс показа.
FOCUS Дополнение должно запускаться в режиме фокуса.
AUGMENT Дополнение должно запускаться в режиме augment.

SheetsAddOnManifest

Свойства, настраивающие внешний вид и выполнение дополнения Google Таблиц.

JSON-представление 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SheetsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}
Поля
homepageTrigger

object (HomepageExtensionPoint)

Если он используется, то конфигурация из файла addons.common.homepageTrigger перезаписывается.
onFileScopeGrantedTrigger

object (SheetsExtensionPoint)

Конечная точка, которая будет выполнена, когда для этой пары документа и пользователя будет предоставлена авторизация области действия файла.
linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

Список точек расширения для предварительного просмотра ссылок в документе Google Таблиц. Подробнее о том, как использовать умные чипы для предварительного просмотра ссылок…

SheetsExtensionPoint

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

JSON-представление 
{
  "runFunction": string
}
Поля
runFunction

string

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

SlidesAddOnManifest

Свойства, настраивающие внешний вид и выполнение дополнения Google Презентаций.

JSON-представление 
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SlidesExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}
Поля
homepageTrigger

object (HomepageExtensionPoint)

Если он используется, то конфигурация из файла addons.common.homepageTrigger перезаписывается.
onFileScopeGrantedTrigger

object (SlidesExtensionPoint)

Конечная точка, которая будет выполнена, когда для этой пары документа и пользователя будет предоставлена авторизация области действия файла.
linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

Список точек расширения для предварительного просмотра ссылок в документе Google Презентаций. Подробнее о том, как использовать умные чипы для предварительного просмотра ссылок…

SlidesExtensionPoint

Общий формат для объявления триггеров дополнения Презентаций.

JSON-представление 
{
  "runFunction": string
}
Поля
runFunction

string

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

HttpOptions

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

JSON-представление 
{
  "authorizationHeader": enum (HttpAuthorizationHeader),
  "granularOauthPermissionSupport": enum (GranularOauthPermissionSupport)
}
Поля
authorizationHeader

enum (HttpAuthorizationHeader)

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

enum (GranularOauthPermissionSupport)

Включено ли в дополнении детальное согласие OAuth.

HttpAuthorizationHeader

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

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

GranularOauthPermissionSupport

Включено ли в дополнении детальное согласие OAuth.

Перечисления
GRANULAR_OAUTH_PERMISSION_SUPPORT_UNSPECIFIED Значение по умолчанию, не должно использоваться.
OPT_IN Дополнение поддерживает выборочное согласие OAuth.
OPT_OUT Для дополнения отключено детализированное согласие OAuth.

Методы

create

 Создает развертывание с указанным названием и конфигурацией.

delete

 Удаляет развертывание с указанным названием.

get

 Возвращает развертывание с указанным названием.

getInstallStatus

 Получает статус установки тестового развертывания.

install

 Устанавливает развертывание в аккаунт для тестирования.

list

 Выводит список всех развертываний в определенном проекте.

replaceDeployment

 Создает или заменяет развертывание с указанным названием.

uninstall

 Удаляет тестовое развертывание из аккаунта пользователя.