Ресурс манифеста надстроек

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

Дополнения

Верхний уровень конфигурации манифеста дополнения Google Workspace.

JSON-представление
{
  "common": {
    object (Common)
  },
  "calendar": {
    object (Calendar)
  },
  "chat": {
    object (Chat)
  },
  "drive": {
    object (Drive)
  },
  "gmail": {
    object (Gmail)
  },
  "docs": {
    object (Docs)
  },
  "sheets": {
    object (Sheets)
  },
  "slides": {
    object (Slides)
  }
}
Поля
common

object ( Common )

Необходимый. Определяет значения для надстройки Google Workspace , общие для каждого хост-приложения. Некоторые значения, определенные здесь, используются по умолчанию, если опущены определенные значения для конкретного хоста.

calendar

object ( Calendar )

Требуется, если надстройка Google Workspace расширяет возможности Calendar . Конфигурации внешнего вида и поведения надстройки Google Workspace в главном приложении Календаря Google. Если это поле опущено, надстройка отключена в Календаре Google.

chat

object ()

Требуется, если надстройка Google Workspace расширяет Chat . Настройка приложения Google Chat. Если это поле опущено, надстройка отключена в Google Chat.

Объект addOns.chat должен быть пустым. Чтобы настроить поведение и внешний вид надстройки в чате, см. раздел Настройка приложения чата.

drive

object ( Drive )

Требуется, если надстройка Google Workspace расширяет возможности Google Диска . Конфигурации внешнего вида и поведения надстройки Google Workspace в главном приложении Google Диска. Если это поле опущено, надстройка отключена на Google Диске.

gmail

object ( Gmail )

Требуется, если надстройка Google Workspace расширяет возможности Gmail . Конфигурации внешнего вида и поведения надстройки Google Workspace в главном приложении Gmail. Если это поле опущено, надстройка отключена в Gmail.

docs

object ( Docs )

Требуется, если надстройка Google Workspace расширяет возможности Документов . Конфигурации внешнего вида и поведения надстройки Google Workspace в главном приложении Документов. Если это поле опущено, надстройка в Документах отключена.

sheets

object ( Sheets )

Требуется, если надстройка Google Workspace расширяет возможности Таблиц . Конфигурации внешнего вида и поведения надстройки Google Workspace в главном приложении Таблиц. Если это поле опущено, надстройка отключена в Таблицах.

slides

object ( Slides )

Требуется, если надстройка Google Workspace расширяет возможности Slides . Конфигурации внешнего вида и поведения надстройки Google Workspace в главном приложении Slides. Если это поле опущено, надстройка отключена в Презентациях.

Общий

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

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

object ( HomepageTrigger )

Спецификация триггерной функции по умолчанию для создания домашней страницы надстройки. Эта спецификация используется, если не определен триггер домашней страницы для конкретного хоста. Если это также опущено, создается общая карточка домашней страницы, которая используется при необходимости.
layoutProperties

object ( LayoutProperties )

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

string

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

name

string

Необходимый. Имя дополнения, отображаемое на панели инструментов.

openLinkUrlPrefixes[]

string

Требуется, если надстройка отображает какие-либо исходящие ссылки, будь то внутри виджетов с использованием OpenLink или текстового виджета с использованием тегов привязки HTML. Список префиксов URL-адресов HTTPS. Для защиты пользовательских данных любая ссылка, отображаемая надстройкой, должна соответствовать одному из префиксов в этом списке.

Дополнительные сведения см. в разделе URL-адреса белого списка .

universalActions[]

object ( UniversalAction )

Список универсальных действий , которые всегда доступны в интерфейсе дополнения.
useLocaleFromApp

boolean

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

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

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

Конфигурация, которая контролирует Google WorkspaceЦвет и внешний вид дополнительной панели инструментов, кнопок.

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

string

Цвет панели инструментов. По умолчанию серый (#424242).
secondaryColor

string

Цвет кнопок по умолчанию. По умолчанию используется основной цвет (если он установлен); в противном случае по умолчанию используется синий цвет (#2196F3).

Универсальное действие

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

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

  // Union field rule can be only one of the following:
  "openLink": string,
  "runFunction": string,
  // End of list of possible types for union field rule.

}
Поля
label

string

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

string

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

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

,

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

Дополнения

Верхний уровень конфигурации манифеста дополнения Google Workspace.

JSON-представление
{
  "common": {
    object (Common)
  },
  "calendar": {
    object (Calendar)
  },
  "chat": {
    object (Chat)
  },
  "drive": {
    object (Drive)
  },
  "gmail": {
    object (Gmail)
  },
  "docs": {
    object (Docs)
  },
  "sheets": {
    object (Sheets)
  },
  "slides": {
    object (Slides)
  }
}
Поля
common

object ( Common )

Необходимый. Определяет значения для надстройки Google Workspace , общие для каждого хост-приложения. Некоторые значения, определенные здесь, используются по умолчанию, если опущены определенные значения для конкретного хоста.

calendar

object ( Calendar )

Требуется, если надстройка Google Workspace расширяет возможности Calendar . Конфигурации внешнего вида и поведения надстройки Google Workspace в главном приложении Календаря Google. Если это поле опущено, надстройка отключена в Календаре Google.

chat

object ()

Требуется, если надстройка Google Workspace расширяет Chat . Настройка приложения Google Chat. Если это поле опущено, надстройка отключена в Google Chat.

Объект addOns.chat должен быть пустым. Чтобы настроить поведение и внешний вид надстройки в чате, см. раздел Настройка приложения чата.

drive

object ( Drive )

Требуется, если надстройка Google Workspace расширяет возможности Google Диска . Конфигурации внешнего вида и поведения надстройки Google Workspace в главном приложении Google Диска. Если это поле опущено, надстройка отключена на Google Диске.

gmail

object ( Gmail )

Требуется, если надстройка Google Workspace расширяет возможности Gmail . Конфигурации внешнего вида и поведения надстройки Google Workspace в главном приложении Gmail. Если это поле опущено, надстройка отключена в Gmail.

docs

object ( Docs )

Требуется, если надстройка Google Workspace расширяет возможности Документов . Конфигурации внешнего вида и поведения надстройки Google Workspace в главном приложении Документов. Если это поле опущено, надстройка отключена в Документах.

sheets

object ( Sheets )

Требуется, если надстройка Google Workspace расширяет возможности Таблиц . Конфигурации внешнего вида и поведения надстройки Google Workspace в главном приложении Таблиц. Если это поле опущено, надстройка отключена в Таблицах.

slides

object ( Slides )

Требуется, если надстройка Google Workspace расширяет возможности Slides . Конфигурации внешнего вида и поведения надстройки Google Workspace в главном приложении Slides. Если это поле опущено, надстройка отключена в Презентациях.

Общий

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

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

object ( HomepageTrigger )

Спецификация триггерной функции по умолчанию для создания домашней страницы надстройки. Эта спецификация используется, если не определен триггер домашней страницы для конкретного хоста. Если это также опущено, создается общая карточка домашней страницы, которая используется при необходимости.
layoutProperties

object ( LayoutProperties )

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

string

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

name

string

Необходимый. Имя дополнения, отображаемое на панели инструментов.

openLinkUrlPrefixes[]

string

Требуется, если надстройка отображает какие-либо исходящие ссылки, будь то внутри виджетов с использованием OpenLink или текстового виджета с использованием тегов привязки HTML. Список префиксов URL-адресов HTTPS. Для защиты пользовательских данных любая ссылка, отображаемая надстройкой, должна соответствовать одному из префиксов в этом списке.

Дополнительные сведения см. в разделе URL-адреса белого списка .

universalActions[]

object ( UniversalAction )

Список универсальных действий , которые всегда доступны в интерфейсе дополнения.
useLocaleFromApp

boolean

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

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

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

Конфигурация, которая контролирует Google WorkspaceЦвет и внешний вид дополнительной панели инструментов, кнопок.

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

string

Цвет панели инструментов. По умолчанию серый (#424242).
secondaryColor

string

Цвет кнопок по умолчанию. По умолчанию используется основной цвет (если он установлен); в противном случае по умолчанию используется синий цвет (#2196F3).

Универсальное действие

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

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

  // Union field rule can be only one of the following:
  "openLink": string,
  "runFunction": string,
  // End of list of possible types for union field rule.

}
Поля
label

string

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

string

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

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