Ресурс манифеста Gmail

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

Gmail

Конфигурация манифеста надстройки Google Workspace для расширений Gmail. Дополнительную информацию см. в разделе Расширение Gmail с помощью надстроек Google Workspace .

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

string

Устарело. Имя функции Apps Script, которая выполняет проверку требований сторонней авторизации. Эта функция вызывается перед каждым вызовом надстройки Google Workspace.

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

composeTrigger

object ( ComposeTrigger )

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

Подробности см. в разделе Расширение пользовательского интерфейса создания с помощью действий создания .

contextualTriggers[]

object ( ContextualTrigger )

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

object ( HomepageTrigger )

Спецификация триггерной функции для создания домашней страницы надстройки на хосте Gmail. Это переопределяет addOns.common.homepageTrigger .

ComposeTrigger

Конфигурация действия создания. Дополнительную информацию см. в разделе Расширение пользовательского интерфейса создания сообщений.

JSON-представление 
{
  "draftAccess": string,
  "selectActions": [
    {
      object (SelectAction)
    }
  ]
}
Поля
draftAccess

string

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

  • NONE , настройка по умолчанию. Это приводит к тому, что объект события, передаваемый триггерной функции составления, в основном оказывается пустым.
  • METADATA , который заполняет объект события, передаваемый триггерной функции составления, списками получателей сообщения. Для этого параметра необходимо, чтобы надстройка включала область действия gmail.addons.current.message.metadata .
selectActions[]

object ( SelectAction )

Список действий создания, которые создают пользовательские интерфейсы создания; однако этот список ограничен одним действием для каждого дополнения . Действие создания имеет соответствующий значок в окне создания сообщения Gmail. Значок указывается gmail.logoUrl .

Контекстуальный триггер

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

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

string

Требуется для каждого контекстного триггера. Имя функции Apps Script, которая выполняется при срабатывании триггера.

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

unconditional

object

Требуется для каждого контекстного триггера. Используется, чтобы указать, что контекстный триггер активируется для всех сообщений Gmail при их открытии. На данный момент это единственный вариант, поэтому это всегда должен быть пустой объект.

ВыберитеДействие

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

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

string

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

Подробности см. в разделе Функция триггера Compose .

text

string

Требуется для создания действий. Краткое текстовое описание этого действия создания.