Ресурс манифеста 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. При срабатывании триггера выполняется определённая функция Apps Script, обычно для создания новых карточек и обновления пользовательского интерфейса.
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 .

ContextualTrigger

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

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

string

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

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

unconditional

object

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

SelectAction

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

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

string

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

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

text

string

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