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 )

Встречайте конфигурацию дополнений.

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 .

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

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

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

string

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

secondaryColor

string

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

useNewMaterialDesign
(deprecated)

boolean

Включает возможность использования материального дизайна для карточек.

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,

  // 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 третьих сторон. Если проверка не удается, функция должна сгенерировать исключение для запуска процесса авторизации. Эта функция вызывается перед каждым запуском дополнения для обеспечения бесперебойной работы пользователя.

Контекстный триггер

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

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

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

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

object ( HomepageExtensionPoint )

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

onItemsSelectedTrigger

object ( DriveExtensionPoint )

Соответствует действиям, которые выполняются при выборе элементов в соответствующем представлении Диска, например, в списке документов «Мой Диск».

DriveExtensionPoint

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

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 . Не применимо к Apps Script add-ons и Apps Script installable triggers .

eventAttachmentTrigger

object ( MenuItemExtensionPoint )

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

currentEventAccess

enum ( EventAccess )

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

Конференц-решение

Определяет ценности, связанные с конференцией.

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-адрес логотипа, который будет отображаться для дополнения. Если не указан, по умолчанию будет использоваться логотип из раздела common манифеста.

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 Дополнение должно запускаться в потоке отображения "дополнительных функций".

SheetsAddOnManifest

Свойства, позволяющие настраивать внешний вид и работу надстройки Google Sheets.

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

object ( HomepageExtensionPoint )

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

onFileScopeGrantedTrigger

object ( SheetsExtensionPoint )

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

linkPreviewTriggers[]

object ( LinkPreviewExtensionPoint )

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

SheetsExtensionPoint

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

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

granularOauthPermissionSupport

enum ( GranularOauthPermissionSupport )

Включено ли в дополнении параметрическое согласие OAuth (Granular OAuth Consent).

HttpAuthorizationHeader

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

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

GranularOauthPermissionSupport

Включено ли в дополнении параметрическое согласие OAuth (Granular OAuth Consent).

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

Методы

create

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

delete

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

get

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

getInstallStatus

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

install

 Устанавливает тестовый пакет в вашу учетную запись.

list

 Отображает список всех развертываний в конкретном проекте.

replaceDeployment

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

uninstall

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