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

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

Дополнения

Конфигурация надстройки 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 )

Конфигурация надстройки Docs.

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

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

AddOnWidgetSet

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

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

enum ( WidgetType )

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

Тип виджета

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

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

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

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

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

string

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

enabled

boolean

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

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

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

UniversalActionExtensionPoint

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

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

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}
Поля
label

string

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

Поле объединения action_type . Обязательное. Тип действия, поддерживаемый для пункта меню универсальных действий. Это может быть как ссылка для открытия, так и конечная точка для выполнения. action_type может быть только одним из следующих:
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,

  // Union field trigger can be only one of the following:
  "unconditional": {
    object (UnconditionalTrigger)
  }
  // End of list of possible types for union field trigger.
}
Поля
onTriggerFunction

string

Обязательно. Имя конечной точки, вызываемой при срабатывании триггера в сообщении.

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

object ( UnconditionalTrigger )

Безусловные триггеры срабатывают при открытии любого почтового сообщения.

БезусловныйТриггер

Этот тип не имеет полей.

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

UniversalAction

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

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

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}
Поля
text

string

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

Поле объединения action_type . Тип действия определяет поведение Gmail при его вызове пользователем. action_type может быть только одним из следующих:
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)
  },
  "eventAttachmentTrigger": {
    object (MenuItemExtensionPoint)
  },
  "currentEventAccess": enum (EventAccess)
}
Поля
homepageTrigger

object ( HomepageExtensionPoint )

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

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

conferenceSolution[]

object ( ConferenceSolution )

Определяет решения для конференций, предоставляемые этим дополнением. Сторонние дополнения для конференций могут быть созданы только в Apps Script .

createSettingsUrlFunction

string

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

eventOpenTrigger

object ( CalendarExtensionPoint )

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

eventUpdateTrigger

object ( CalendarExtensionPoint )

Конечная точка, срабатывающая при обновлении открытого события.

eventAttachmentTrigger

object ( MenuItemExtensionPoint )

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

currentEventAccess

enum ( EventAccess )

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

ConferenceSolution

Определяет значения, связанные с конференцией. Сторонние надстройки для конференций могут быть созданы только в Apps Script .

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 Docs.

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 Docs. Подробнее см. в разделе Предварительный просмотр ссылок с помощью смарт-чипов .

createActionTriggers[]

object ( CreateActionExtensionPoint )

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

DocsExtensionPoint

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

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

string

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

LinkPreviewExtensionPoint

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

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

Встречайте манифест дополнений.

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

Версия logourl в тёмном режиме.

displayFlow
(deprecated)

enum ( DisplayFlow )

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

Состояние

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

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

DisplayFlow

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

Перечисления
DISPLAY_FLOW_UNSPECIFIED Поток отображения не указан.
FOCUS Дополнение должно запускаться в потоке отображения «фокуса».
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 Slides.

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

object ( HomepageExtensionPoint )

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

onFileScopeGrantedTrigger

object ( SlidesExtensionPoint )

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

linkPreviewTriggers[]

object ( LinkPreviewExtensionPoint )

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

SlidesExtensionPoint

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

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 Не отправляйте заголовок аутентификации.

GranularOauthPermissionSupport

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

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

Методы

create

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

delete

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

get

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

getInstallStatus

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

install

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

list

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

replaceDeployment

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

uninstall

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