Объекты событий

На этой странице описывается структура объектов событий дополнений Google Workspace.

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

Дополнения Google Workspace используют объекты событий в следующих местах:

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

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

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

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

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

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

  • Триггеры предварительного просмотра ссылок В Google Документах, Таблицах и Презентациях можно настроить предварительный просмотр ссылок для сторонних сервисов на основе определенных шаблонов URL. Когда пользователь нажимает на ссылку, соответствующую шаблону, активируется триггер linkPreviewTriggers, а объект события, содержащий ссылку, передается в функцию обратного вызова триггера. Дополнение может использовать этот объект события, чтобы создать умный чип и карточку с информацией о ссылке в размещаемом приложении. Вы также можете создать действия виджета, чтобы пользователи могли взаимодействовать с карточкой предварительного просмотра и ее содержимым.

  • Триггеры приложений Google Chat. В Google Chat дополнение выглядит как приложение Chat, и пользователи могут взаимодействовать с ним, добавляя его в чат-группы, отправляя сообщения, используя слеш-команды и т. д. Чтобы создать интерактивные функции, вы настраиваете и используете различные триггеры приложения Chat. Каждый триггер отправляет разные полезные нагрузки объекта события, которые помогают обрабатывать каждый тип взаимодействия или реагировать на него.

Структура объекта события

В таблице ниже описана структура верхнего уровня объектов событий дополнений Google Workspace. Структура включает поле верхнего уровня commonEventObject для информации, не зависящей от хоста. Каждый объект события также может иметь одно из следующих полей верхнего уровня, определяемых активным хост-приложением: gmailEventObject, calendarEventObject или driveEventObject.

Для обратной совместимости объекты событий дополнений Google Workspace включают исходные поля, используемые в объектах событий действий дополнений Gmail. Эти поля находятся в разделе "Исходные поля дополнения Gmail" и не являются частью commonEventObject.

Исходные поля дополнения Gmail устарели. При разработке или переносе дополнения Google Workspace используйте новую структуру объекта события. В будущем эти поля могут быть удалены.

Объект события
eventObject.commonEventObject Common fields object
Объект, содержащий информацию, общую для всех объектов событий, независимо от хост-приложения.
eventObject.calendar Calendar event object
Указывается, только если хостом вызова является Google Календарь. Объект, содержащий информацию о календаре и мероприятии.
eventObject.chat Chat event object
Присутствует, только если вызов инициирован в Google Chat. Объект, содержащий информацию о чате.
eventObject.drive Drive event object
Присутствует, только если вызывающий хост – Google Диск. Объект, содержащий информацию о Диске.
eventObject.gmail Gmail event object
Присутствует, только если вызывающим хостом является Gmail. Объект, содержащий информацию о Gmail.
eventObject.docs Docs event object
Присутствует, только если вызывающим хостом является Google Документы. Объект, содержащий информацию о документе.
eventObject.sheets Sheets event object
Присутствует, только если вызывающий хост – Google Таблицы. Объект, содержащий информацию о таблицах.
eventObject.slides Slides event object
Присутствует, только если вызывающим хостом является Google Презентации. Объект, содержащий информацию о слайдах.
Поля исходного дополнения Gmail
eventObject.messageMetadata.accessToken string
Поддержка прекращена. Токен доступа. Вы можете использовать его, чтобы включить доступ к пользовательским данным с помощью временных областей действия дополнений Gmail.

Для дополнений Google Workspace эта информация указана в поле eventObject.gmail.accessToken.

eventObject.messageMetadata.messageId string
Поддержка прекращена. Идентификатор цепочки, открытой в интерфейсе Gmail.

Для дополнений Google Workspace эта информация указана в поле eventObject.gmail.messageId.

eventObject.clientPlatform string
Поддержка прекращена. Указывает, где произошло событие (на сайте, в iOS или Android).

Для дополнений Google Workspace эта информация указана в поле eventObject.commonEventObject.platform.

eventObject.formInput object
Поддержка прекращена. Карта текущих значений всех виджетов формы на карточке, ограниченная одним значением на виджет. Ключи – это строковые идентификаторы, связанные с виджетами, а значения – это строки. Объект события предоставляет formInput для удобства, когда вам нужно прочитать данные из нескольких виджетов с ожидаемыми единичными значениями, такими как текстовые вводы и переключатели. Для виджетов с несколькими значениями, например флажков, считывайте каждое значение из formInputs.

Для дополнений Google Workspace эта информация находится в поле eventObject.commonEventObject.formInputs. Виджеты с одним значением представлены в виде массивов с одним элементом.

eventObject.formInputs object
Поддержка прекращена. Карта текущих значений виджетов в карточке, представленная в виде списков строк. Ключи – это строковые идентификаторы, связанные с виджетом. Для виджетов с одним значением оно представлено в массиве с одним элементом. Для виджетов с несколькими значениями, например групп флажков, все значения представлены в виде списка.

Для дополнений Google Workspace эта информация указана в поле eventObject.commonEventObject.formInputs.

eventObject.parameters object
Поддержка прекращена. Карта дополнительных параметров, которые вы передаете в Action с помощью Action.setParameters. Ключи и значения карты являются строками.

Для дополнений Google Workspace эта информация указана в поле eventObject.commonEventObject.parameters.

eventObject.userCountry string
Устарело и отключено по умолчанию. Двухбуквенный код страны или региона пользователя. Также можно использовать цифровой код страны в формате UN M49.

Для дополнений Google Workspace эта информация указана в поле eventObject.commonEventObject.userLocale.

eventObject.userLocale string
Устарело и отключено по умолчанию. Двухбуквенный код ISO 639, указывающий язык пользователя. Подробнее о том, как получить доступ к региональным настройкам и часовому поясу пользователя…

Для дополнений Google Workspace эта информация указана в поле eventObject.commonEventObject.userLocale.

eventObject.userTimezone.id string
Устарело и отключено по умолчанию. Идентификатор часового пояса пользователя. America/New_York, Europe/Vienna и Asia/Seoul, поэтому, чтобы заблокировать контент в Google, нужно удалить или скрыть все указывающие на него URL. Подробнее о том, как получить доступ к региональным настройкам и часовому поясу пользователя…

Для дополнений Google Workspace эта информация указана в поле eventObject.commonEventObject.timeZone.id.

eventObject.userTimezone.offset string
Устарело и отключено по умолчанию. Смещение по времени относительно всемирного координированного времени (UTC) для часового пояса пользователя, измеряемое в миллисекундах. Подробнее о том, как получить доступ к региональным настройкам и часовому поясу пользователя…

Для дополнений Google Workspace эта информация указана в поле eventObject.commonEventObject.timeZone.offset.

Объект CommonEvent

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

Помимо триггеров главной страницы и контекстных триггеров, дополнения создают и передают объекты событий функциям обратного вызова действий, когда пользователь взаимодействует с виджетами. Функция обратного вызова вашего дополнения может запрашивать общий объект события, чтобы определить содержимое открытых виджетов в клиенте пользователя. Например, дополнение может найти текст, который пользователь ввел в виджет TextInput, в объекте eventObject.commentEventObject.formInputs.

Поля объекта CommonEvent
commonEventObject.platform string
Указывает, откуда поступило событие (`WEB`, `IOS` или `ANDROID`).
commonEventObject.formInputs object
Карта, содержащая текущие значения виджетов на отображаемой карточке. Ключи карты – это строковые идентификаторы, назначенные каждому виджету.

Структура объекта map value зависит от типа виджета:

  • Виджеты с одним значением (например, текстовое поле): список строк (только один элемент).

    Пример. Чтобы получить доступ к значению текстового ввода для виджета ввода текста с идентификатором employeeName, используйте e.commonEventObject.formInputs.employeeName.stringInputs.value[0].

  • Виджеты с несколькими значениями (например, группы флажков): список строк.

    Пример. Для виджета с несколькими значениями и идентификатором participants доступ к массиву значений можно получить с помощью e.commonEventObject.formInputs.participants.stringInputs.value.

  • A date-time picker: DateTimeInput object.

    Пример. Для селектора с идентификатором myDTPicker доступ к объекту DateTimeInput можно получить с помощью e.commonEventObject.formInputs.myDTPicker.dateTimeInput.

  • A date-only picker: DateInput object.

    Пример. Для окна выбора с идентификатором myDatePicker доступ к объекту DateInput можно получить с помощью e.commonEventObject.formInputs.myDatePicker.dateInput.

  • A time-only picker: TimeInput object.

    Пример. Для окна выбора с идентификатором myTimePicker доступ к объекту TimeInput можно получить с помощью e.commonEventObject.formInputs.myTimePicker.timeInput.
commonEventObject.hostApp string
Указывает на основное приложение, в котором дополнение активно, когда создается объект события. Возможные значения:
  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
commonEventObject.parameters object
Любые дополнительные параметры, которые вы передаете в действие с помощью actionParameters или Action.setParameters.

Предварительная версия для разработчиков. В приложениях Google Chat для предложения вариантов на основе того, что пользователи вводят в меню с множественным выбором, используйте значение ключа "autocomplete_widget_query" (event.commonEventObject.parameters["autocomplete_widget_query"]). С помощью этого значения можно запрашивать данные из базы данных и предлагать пользователям варианты по мере ввода. Подробнее о том, как собирать и обрабатывать информацию от пользователей Google Chat…
commonEventObject.userLocale string
Отключено по умолчанию. Идентификатор языка и страны или региона пользователя в формате кода языка ISO 639 и кода страны или региона ISO 3166. например en-US.

Чтобы включить это поле, задайте для addOns.common.useLocaleFromApp значение true в манифесте дополнения. В список областей действия дополнения также необходимо включить https://www.googleapis.com/auth/script.locale. Подробнее о том, как получить доступ к региональным настройкам и часовому поясу пользователя…

commonEventObject.timeZone string
Отключено по умолчанию. Идентификатор и смещение часового пояса. Чтобы включить это поле, задайте для addOns.common.useLocaleFromApp значение true в манифесте дополнения. В список областей действия дополнения также необходимо включить https://www.googleapis.com/auth/script.locale. Подробнее о том, как получить доступ к региональным настройкам и часовому поясу пользователя…
commonEventObject.timeZone.id string
Идентификатор часового пояса пользователя. America/New_York, Europe/Vienna и Asia/Seoul, поэтому, чтобы заблокировать контент в Google, нужно удалить или скрыть все указывающие на него URL. Чтобы включить это поле, задайте для addOns.common.useLocaleFromApp значение true в манифесте дополнения. В список областей действия дополнения также необходимо включить https://www.googleapis.com/auth/script.locale. Подробнее о том, как получить доступ к региональным настройкам и часовому поясу пользователя…
commonEventObject.timeZone.offset string
Смещение по времени относительно всемирного координированного времени (UTC) для часового пояса пользователя, измеряемое в миллисекундах. Подробнее о том, как получить доступ к региональным настройкам и часовому поясу пользователя…

Поля формы для выбора даты и времени

Функции обратного вызова действия могут получать текущие значения виджета в поле commonEventObject.formInputs. Это включает выбранные пользователем значения даты или времени в виджетах выбора даты или времени. Структура информации зависит от того, как был настроен виджет: для выбора даты и времени, только даты или только времени. Структурные различия описаны в таблице ниже.

Объект DateTimeInput
dateTimeInput.hasDate boolean
true, если входные данные включают дату; false, если входные данные включают только время.
dateTimeInput.hasTime boolean
true, если в исходной дате указано время; false, если указана только дата.
dateTimeInput.msSinceEpoch string
Время, выбранное пользователем, в миллисекундах с начала эпохи (00:00:00 UTC 1 января 1970 года).
Объект DateInput
dateInput.msSinceEpoch string
Время, выбранное пользователем, в миллисекундах с начала эпохи (00:00:00 UTC 1 января 1970 года).
Объект TimeInput
timeInput.hours number
Выбранный пользователем час.
timeInput.minutes number
Минута, выбранная пользователем.

Объект события Chat

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

Чат
chat.user object (User)
Пользователь Chat, который взаимодействовал с приложением Chat.
chat.space object (Space)
Чат-группа Chat, в которой пользователь взаимодействовал с приложением Chat.
chat.eventTime

string (Timestamp format)

Время, когда произошло взаимодействие.

Объединенное поле payload. Для триггера App Home (когда пользователь открывает вкладку Главная) payload не задано, а chat содержит chat.user и chat.eventTime.

Поле payload может иметь одно из следующих значений:
chat.messagePayload

object (MessagePayload)

Полезная нагрузка, которую приложения Chat получают от триггера Сообщение.
chat.addedToSpacePayload

object (AddedToSpacePayload)

Полезная нагрузка, которую приложения Chat получают от триггера Добавление в чат-группу.
chat.removedFromSpacePayload

object (RemovedFromSpacePayload)

Полезная нагрузка, которую приложения Chat получают от триггера Удалено из чат-группы.
chat.buttonClickedPayload

object (ButtonClickedPayload)

Полезная нагрузка, которую получают приложения Chat, когда пользователи нажимают кнопку в сообщении или карточке. Если пользователь нажимает кнопку, чтобы отправить информацию, объект commonEventObject.formInputs содержит значения, полученные от пользователя. Подробнее о том, как собирать информацию от пользователей Google Chat…
chat.widgetUpdatedPayload

object (WidgetUpdatedPayload)

Полезная нагрузка, которую получают приложения Chat, когда пользователи вводят текст в меню множественного выбора виджета selectionInput. Приложения Chat могут использовать этот объект события для заполнения предлагаемых элементов из динамического источника данных. Например, чтобы заполнить список запросов в службу поддержки из внешнего источника данных, приложение Chat может запросить источник данных на основе того, что пользователь вводит в меню, а затем вернуть соответствующие запросы в службу поддержки в виде выбираемых элементов.

Объект CommonEventObject.parameters['autocomplete_widget_query'] содержит строковое значение, которое пользователь вводит в меню.

chat.appCommandPayload

object (AppCommandPayload)

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

Полезная нагрузка

В зависимости от типа взаимодействия с приложением Chat событие содержит полезную нагрузку с одним или несколькими ресурсами Chat API.

Полезная нагрузка сообщения
MessagePayload
chat.messagePayload.message object (Message)
Сообщение Chat, которое активировало событие.
chat.messagePayload.space object (Space)
Чат-группа Chat, в которой пользователь отправил сообщение, вызвавшее приложение Chat.
chat.messagePayload.configCompleteRedirectUri string
URL, на который приложение Chat должно перенаправлять пользователя после завершения авторизации или настройки за пределами Google Chat. Подробнее о подключении дополнения Google Workspace к стороннему сервису…
Добавлено в полезную нагрузку чат-группы
AddedToSpacePayload
chat.addedToSpacePayload.space object (Space)
Чат-группа Chat, в которую пользователь добавил или установил приложение Chat.

Когда администраторы устанавливают приложения Chat, для поля space.adminInstalled задается значение true.

chat.addedToSpacePayload.interactionAdd boolean
Добавляет ли пользователь приложение Chat в чат-группу с помощью сообщения. Например, упоминает приложение Chat или использует команду. Если true, Chat отправляет другой объект события с messagePayload, который содержит информацию о сообщении.
chat.addedToSpacePayload.configCompleteRedirectUri string
URL, на который приложение Chat должно перенаправлять пользователя после завершения процесса авторизации или настройки за пределами Google Chat. Подробнее о подключении дополнения Google Workspace к стороннему сервису…
Полезная нагрузка удалена из чат-группы
RemovedFromSpacePayload
chat.removedFromSpacePayload.space object (Space)
Чат-группа Chat, из которой пользователь удалил приложение Chat.

Когда администраторы удаляют приложения Chat, для поля space.adminInstalled задается значение false.

Полезная нагрузка при нажатии кнопки
ButtonClickedPayload
chat.buttonClickedPayload.message object (Message)
Сообщение Chat, содержащее кнопку, которую нажал пользователь.
chat.buttonClickedPayload.space object (Space)
Чат-группа Chat, в которой пользователь нажал кнопку в сообщении приложения Chat.
chat.buttonClickedPayload.isDialogEvent boolean
Нажал ли пользователь кнопку, чтобы взаимодействовать с диалоговым окном.
chat.buttonClickedPayload.dialogEventType enum (DialogEventType)
Если isDialogEvent – это true, то тип взаимодействия в диалоге.

Перечисление DialogEventType.

Поле dialogEventType может иметь одно из следующих значений:
TYPE_UNSPECIFIED Значение по умолчанию. Не указано.
REQUEST_DIALOG Пользователь запрашивает диалог. Например, они могут использовать команду или нажать кнопку в сообщении.
SUBMIT_DIALOG Пользователь нажимает на интерактивный элемент в диалоговом окне. Например, пользователь заполняет информацию в диалоговом окне и нажимает кнопку, чтобы отправить ее.
Обновленная полезная нагрузка виджета
WidgetUpdatedPayload
chat.widgetUpdatedPayload.space object (Space)
Чат-группа Chat, в которой произошло взаимодействие.
Полезная нагрузка команды приложения
AppCommandPayload
chat.appCommandPayload.appCommandMetadata object (AppCommandMetadata)
Метаданные о том, какую команду использовал пользователь и как он ее активировал.
chat.appCommandPayload.space object (Space)
Чат-группа Chat, в которой пользователь применил команду.
chat.appCommandPayload.thread object (Thread)
Если взаимодействие произошло в цепочке, то цепочка Chat, в которой пользователь применил команду.
chat.appCommandPayload.message object (Message)
Для слеш-команд – сообщение со слеш-командой.
chat.appCommandPayload.configCompleteRedirectUri string
Если для команды требуется авторизация или настройка, URL, на который будет перенаправлен пользователь после завершения процесса за пределами Google Chat.
chat.appCommandPayload.isDialogEvent boolean
Открывает ли команда диалоговое окно.
chat.appCommandPayload.dialogEventType enum (DialogEventType)
Тип взаимодействия с диалоговым окном.

Перечисление DialogEventType.

Поле dialogEventType может иметь одно из следующих значений:
TYPE_UNSPECIFIED Значение по умолчанию. Не указано.
REQUEST_DIALOG Пользователь запрашивает диалог. Например, они могут использовать команду или нажать кнопку в сообщении.
SUBMIT_DIALOG Пользователь нажимает на интерактивный элемент в диалоговом окне. Например, пользователь заполняет информацию в диалоговом окне и нажимает кнопку, чтобы отправить ее.
Метаданные команды приложения
AppCommandMetadata
chat.appCommandPayload.appCommandMetadata.appCommandId

string (int64 format)

Идентификатор команды.
chat.appCommandPayload.appCommandMetadata.appCommandType enum (AppCommandType)
Тип команды.

Перечисление AppCommandType.

Поле AppCommandType может иметь одно из следующих значений:
APP_COMMAND_TYPE_UNSPECIFIED Значение по умолчанию. Не указано.
SLASH_COMMAND Чтобы использовать команду, пользователь отправляет сообщение, которое начинается с косой черты /.
QUICK_COMMAND Пользователь выбирает команду из меню Chat в области ответа на сообщение.

Объект мероприятия из календаря

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

В таблице ниже перечислены поля, которые присутствуют в поле calendarEventObject объекта события. Поля, помеченные как Пользовательские данные, присутствуют в объекте события, только если данные есть в мероприятии из календаря и дополнение устанавливает для поля addOns.calendar.currentEventAccess манифеста значение READ или READ_WRITE.

Многие поля в этом объекте и его подструктурах напрямую сопоставляются с полями ресурса Event в Calendar API с тем же названием. Если описания полей различаются, правильной является информация в таблице ниже.

Объект мероприятия из календаря
calendar.attendees[] list of attendee objects
Данные, созданные пользователями. Список участников мероприятия из календаря.
calendar.calendarId string
Идентификатор календаря.
calendar.capabilities object
Данные, созданные пользователями. Объект, описывающий возможности дополнения по просмотру и обновлению информации о мероприятии.
calendar.capabilities.canAddAttendees boolean
Данные, созданные пользователями. true если дополнение может добавлять новых участников в список участников мероприятия; false в противном случае.
calendar.capabilities.canSeeAttendees boolean
Данные, созданные пользователями. true, если дополнение может читать список участников мероприятия; false в противном случае.
calendar.capabilities.canSeeConferenceData boolean
Данные, созданные пользователями. true, если дополнение может читать данные видеовстречи, и false в противном случае.
calendar.capabilities.canSetConferenceData boolean
Данные, созданные пользователями. true, если дополнение может обновлять данные видеовстречи, и false в противном случае.
calendar.capabilities.canAddAttachments boolean
Данные, созданные пользователями. true, если дополнение может добавлять новые прикрепленные файлы к мероприятию; false в противном случае.
calendar.conferenceData Conference data object
Данные, созданные пользователями. Объект, представляющий любые данные видеовстречи, связанные с этим мероприятием, например сведения о видеовстрече Google Meet.
calendar.id string
Идентификатор события.
calendar.organizer object
Объект, представляющий организатора мероприятия.
calendar.organizer.email string
Адрес электронной почты организатора мероприятия.
calendar.recurringEventId string
Идентификатор повторяющегося мероприятия.

Участник

Объекты Attendee содержат информацию об отдельных участниках мероприятий Google Календаря. Эта информация присутствует в объекте мероприятия, только если она есть в мероприятии Календаря и в дополнении для поля addOns.calendar.currentEventAccess манифеста задано значение READ или READ_WRITE.

Объект Attendee
attendee.additionalGuests number
Количество дополнительных гостей, которых участник планирует привести с собой. Значение по умолчанию равно нулю.
attendee.comment string
Комментарий участника, если он есть.
attendee.displayName string
Отображаемое название участника.
attendee.email string
Адрес электронной почты участника.
attendee.optional boolean
true, если участие этого гостя отмечено как необязательное; false в противном случае.
attendee.organizer boolean
true, если участник является организатором мероприятия.
attendee.resource boolean
true, если участник представляет ресурс, например комнату или оборудование; false в противном случае.
attendee.responseStatus string
Статус ответа участника. Возможные значения:
  • accepted – участник принял приглашение на мероприятие.
  • declined – участник отклонил приглашение на мероприятие.
  • needsAction – участник не ответил на приглашение.
  • tentative – участник предварительно принял приглашение на мероприятие.
attendee.self boolean
true, если этот участник представляет календарь, в котором появляется это мероприятие; false в противном случае.

Данные видеовстречи

Объекты данных видеовстречи содержат информацию о видеовстречах, прикрепленных к мероприятиям Google Календаря. Это могут быть решения для видеовстреч Google, например Google Meet, или сторонние решения. Эта информация присутствует в объекте мероприятия, только если она есть в мероприятии Календаря и в дополнении для поля addOns.calendar.currentEventAccess манифеста задано значение READ или READ_WRITE.

Объект данных видеовстречи
conferenceData.conferenceId string
Идентификатор видеовстречи. Этот идентификатор позволяет приложениям отслеживать видеовстречи. Не показывайте его пользователям.
conferenceData.conferenceSolution object
Объект, представляющий решение для видеовстреч, например Hangouts или Google Meet.
conferenceData.conferenceSolution.iconUri string
URI значка, который виден пользователям и представляет это решение для видеовстреч.
conferenceData.conferenceSolution.key object
Ключ, который уникальным образом идентифицирует решение для видеовстреч, используемое в этом мероприятии.
conferenceData.conferenceSolution.key.type string
Тип решения для видеовстреч. Возможные значения:
  • eventHangout для Hangouts для обычных пользователей (http://hangouts.google.com).
  • eventNamedHangout для классической версии Hangouts для пользователей Google Workspace (http://hangouts.google.com).
  • hangoutsMeet для Google Meet (http://meet.google.com).
conferenceData.conferenceSolution.name string
Название решения для видеовстреч, которое видят пользователи (не локализовано).
conferenceData.entryPoints[] list of entry point objects
Список точек входа в видеовстречу, например URL или номера телефонов.
conferenceData.notes string
Дополнительные примечания (например, инструкции от администратора домена или юридические уведомления) о видеовстрече, которые будут показаны пользователю. Может содержать HTML-код. Максимальная длина – 2048 символов.
conferenceData.parameters object
Объект, содержащий карту определенных данных параметров для использования дополнением.
conferenceData.parameters.addOnParameters object
Карта строковых ключей и значений параметров. Эти ключи и значения определяются разработчиком дополнения, чтобы прикреплять информацию к определенной видеовстрече для использования дополнением.

Точка входа

Объекты точек входа содержат информацию об установленных средствах доступа к заданной видеовстрече, например по телефону или видео. Эта информация присутствует в объекте события, только если она есть в мероприятии из календаря и в дополнении для поля addOns.calendar.currentEventAccess манифеста задано значение READ или READ_WRITE.

Объект точки входа
entryPoint.accessCode string
Код доступа, использованный для подключения к видеовстрече. Максимальная длина – 128 символов. Поставщики видеоконференций обычно используют только подмножество {accessCode, meetingCode, passcode, password, pin} для предоставления доступа к видеоконференциям. Сопоставьте и показывайте только те поля, которые использует поставщик услуг видеоконференций.
entryPoint.entryPointFeatures list
Особенности точки входа. В настоящее время эти функции применяются только к следующим точкам входа в phone:
  • toll: точка входа – платный телефонный звонок.
  • toll_free: точка входа – бесплатный телефонный звонок.
entryPoint.entryPointType string
Тип точки входа. Возможные значения:
  • more – дополнительные инструкции по подключению к видеовстрече, например альтернативные номера телефонов. У видеовстречи может быть только одна точка входа more. Если она есть, требуется также хотя бы одна точка входа другого типа.
  • phone – присоединиться к конференции по номеру телефона. У видеовстречи может быть несколько способов подключения phone или не быть ни одного. В Google Календаре показываются только первые два номера телефона, отформатированные и отсортированные по алфавиту.
  • sip – присоединиться к конференции по SIP. У видеовстречи может быть не более одной точки входа sip.
  • video – присоединиться к конференции по протоколу HTTP. У видеовстречи может быть не более одной точки подключения video.
entryPoint.label string
Видимый пользователю ярлык для URI точки входа (не локализован).
entryPoint.meetingCode string
Код встречи, использованный для доступа к видеовстрече. Максимальная длина – 128 символов. Поставщики видеоконференций обычно используют только подмножество {accessCode, meetingCode, passcode, password, pin} для предоставления доступа к видеоконференциям. Сопоставьте и показывайте только те поля, которые использует поставщик услуг видеоконференций.
entryPoint.passcode string
Код доступа, использованный для подключения к видеовстрече. Максимальная длина – 128 символов. Поставщики видеоконференций обычно используют только подмножество {accessCode, meetingCode, passcode, password, pin} для предоставления доступа к видеоконференциям. Сопоставьте и показывайте только те поля, которые использует поставщик услуг видеоконференций.
entryPoint.password string
Пароль, используемый для доступа к конференции. Максимальная длина – 128 символов. Поставщики видеоконференций обычно используют только подмножество {accessCode, meetingCode, passcode, password, pin} для предоставления доступа к видеоконференциям. Сопоставьте и показывайте только те поля, которые использует поставщик услуг видеоконференций.
entryPoint.pin string
PIN-код, используемый для доступа к видеовстрече. Максимальная длина – 128 символов. Поставщики видеоконференций обычно используют только подмножество {accessCode, meetingCode, passcode, password, pin} для предоставления доступа к видеоконференциям. Сопоставьте и показывайте только те поля, которые использует поставщик услуг видеоконференций.
entryPoint.regionCode string
Код региона номера телефона. Требуется пользователям, если URI не содержит код страны. Значения основаны на общедоступном списке кодов регионов CLDR.
entryPoint.uri string
URI точки входа. Максимальная длина – 1300 символов. Форматирование зависит от типа точки входа:
  • more: требуется схема http: или https:.
  • phone: требуется схема tel:. URI должен включать всю последовательность набора номера (например, "tel:+12345678900,,,12345678;1234").
  • sip: требуется схема sip: или sips:. Пример: sip:12345678@myprovider.com.
  • video: требуется схема http: или https:.

Объект события Диска

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

Объект события Диска
drive.activeCursorItem Drive item object
Объект на Диске, который сейчас активен.
drive.selectedItems[] list of Drive item objects
Список объектов (файлов или папок), выбранных на Диске.

Объект на Google Диске

Объекты элементов Диска содержат информацию об определенных элементах Диска, таких как файлы или папки.

Объект на Диске
item.addonHasFileScopePermission boolean
Если значение равно true, дополнение запросило и получило авторизацию области действия https://www.googleapis.com/auth/drive.file для этого объекта. В противном случае значение равно false.
item.id string
Идентификатор выбранного объекта.
item.iconUrl string
URL значка, который представляет выбранный элемент.
item.mimeType string
MIME-тип выбранного объекта.
item.title string
Название выбранного объекта.

Объект события Gmail

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

Объект события Gmail
gmail.accessToken string
Токен доступа к Gmail. Используйте этот токен с методом GmailApp.setCurrentMessageAccessToken, чтобы предоставить дополнению временный доступ к открытому в данный момент письму Gmail или разрешить ему создавать черновики.
gmail.bccRecipients[] list of strings
Отключено по умолчанию. Список адресов электронной почты получателей скрытой копии, которые в настоящее время включены в черновик, создаваемый дополнением. Чтобы включить это поле, задайте для поля addOns.gmail.composeTrigger.draftAccess в манифесте значение METADATA.
gmail.ccRecipients[] list of strings
Отключено по умолчанию. Список адресов электронной почты получателей, указанных в поле "Копия" в черновике, который создается дополнением. Чтобы включить это поле, задайте для поля addOns.gmail.composeTrigger.draftAccess в манифесте значение METADATA.
gmail.messageId string
Идентификатор открытого в данный момент письма Gmail.
gmail.threadId string
Идентификатор открытой цепочки писем Gmail.
gmail.toRecipients[] list of strings
Отключено по умолчанию. Список адресов электронной почты получателей, указанных в поле "Кому" в черновике, который создается дополнением. Чтобы включить это поле, задайте для поля addOns.gmail.composeTrigger.draftAccess в манифесте значение METADATA.

Объект события в Документах

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

Объект события в Документах
docs.id string
Присутствует, только если пользователь авторизовал область действия https://www.googleapis.com/auth/drive.file.
Идентификатор документа, открытого в интерфейсе Документов.
docs.title string
Доступно, только если пользователь авторизовал область действия https://www.googleapis.com/auth/drive.file.
Название документа, открытого в интерфейсе Документов.
docs.addonHasFileScopePermission boolean
Если значение равно true, дополнение запросило и получило авторизацию области действия https://www.googleapis.com/auth/drive.file для документа, открытого в интерфейсе Документов. В противном случае значение этого поля равно false.
docs.matchedUrl.url string
Присутствует, только если выполняются следующие условия:
  • Пользователь авторизовал https://www.googleapis.com/auth/workspace.linkpreview.
  • URL соответствует шаблону хоста, указанному в триггере LinkPreviewTriggers.

URL ссылки, которая генерирует предпросмотр в Google Документах. Чтобы использовать это поле, необходимо настроить LinkPreviewTriggers в манифесте дополнения. Подробнее об умных чипах для предварительного просмотра ссылок…

Пример полезной нагрузки, когда пользователь просматривает ссылку https://www.example.com/12345: 

"docs" : {
  "matchedUrl" : {
      "url" : "https://www.example.com/12345"
  }
}

Объект события Таблиц

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

Объект события Таблиц
sheets.id string
Присутствует, только если пользователь авторизовал область действия https://www.googleapis.com/auth/drive.file. Идентификатор таблицы, открытой в интерфейсе Таблиц.
sheets.title string
Присутствует, только если пользователь авторизовал область действия https://www.googleapis.com/auth/drive.file. Название таблицы, открытой в интерфейсе Google Таблиц.
sheets.addonHasFileScopePermission boolean
Если true, дополнение запросило и получило авторизацию области действия https://www.googleapis.com/auth/drive.file для таблицы, открытой в интерфейсе Таблиц. В противном случае значение этого поля – false.
sheets.matchedUrl.url string
Присутствует, только если выполняются следующие условия:
  • Пользователь авторизовал https://www.googleapis.com/auth/workspace.linkpreview.
  • URL соответствует шаблону хоста, указанному в триггере LinkPreviewTriggers.

URL ссылки, которая генерирует предварительный просмотр в Google Таблицах. Чтобы использовать это поле, настройте LinkPreviewTriggers в манифесте дополнения. Подробнее об умных чипах для предварительного просмотра ссылок…

Пример полезной нагрузки, когда пользователь просматривает ссылку https://www.example.com/12345:

"sheets" : {
  "matchedUrl" : {
      "url" : "https://www.example.com/12345"
  }
}

Объект события в Презентациях

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

Объект события в Презентациях
slides.id string
Присутствует, только если пользователь авторизовал область действия https://www.googleapis.com/auth/drive.file. Идентификатор презентации, открытой в интерфейсе Презентаций.
slides.title string
Присутствует, только если пользователь авторизовал область действия https://www.googleapis.com/auth/drive.file. Название презентации, открытой в интерфейсе Презентаций.
slides.addonHasFileScopePermission boolean
Если значение равно true, дополнение запросило и получило авторизацию области действия https://www.googleapis.com/auth/drive.file для презентации, открытой в интерфейсе Презентаций. В противном случае значение равно false.
slides.matchedUrl.url string
Присутствует, только если выполняются следующие условия:
  • Пользователь авторизовал https://www.googleapis.com/auth/workspace.linkpreview.
  • URL соответствует шаблону хоста, указанному в триггере LinkPreviewTriggers.

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

Пример полезной нагрузки, когда пользователь просматривает ссылку https://www.example.com/12345:

"slides" : {
  "matchedUrl" : {
      "url" : "https://www.example.com/12345"
  }
}