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

На этой странице описана структура объектов событий дополнений 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.

Объект обычного события

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

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

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

Структура объекта значения карты зависит от типа виджета:

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

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

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

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

  • A date-time picker: a DateTimeInput object.

    Пример. Чтобы получить доступ к объекту DateTimeInput для элемента выбора с идентификатором myDTPicker, используйте e.commonEventObject.formInputs.myDTPicker.dateTimeInput.

  • A date-only picker: a DateInput object.

    Пример. Чтобы получить доступ к объекту DateInput с помощью элемента выбора с идентификатором myDatePicker, используйте код e.commonEventObject.formInputs.myDatePicker.dateInput.

  • A time-only picker: a TimeInput object.

    Пример. Чтобы получить доступ к объекту TimeInput с помощью элемента выбора с идентификатором myTimePicker, используйте код 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. Он присутствует в объекте события, только если дополнение расширяет возможности Google Chat.

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

string (Timestamp format)

Время взаимодействия.

Объединенное поле payload. При срабатывании триггера Главная страница приложения (когда пользователь открывает вкладку Главная) параметр 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 может запросить источник данных на основе того, что пользователь вводит в меню, а затем вернуть соответствующие запросы в службу поддержки в виде выбираемых элементов.

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

chat.appCommandPayload

object (AppCommandPayload)

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

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

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

Полезная нагрузка сообщения
MessagePayload
chat.messagePayload.message object (Message)
Сообщение Chat, которое активировало событие.
chat.messagePayload.space object (Space)
Чат-группа, в которой пользователь отправил сообщение, вызвавшее чат-приложение.
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.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.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.

Многие поля этого объекта и его подструктур напрямую сопоставляются с полями ресурса событий 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
Идентификатор повторяющегося мероприятия.

Участник

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

Объект участника
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
Список объектов (файлов или папок), выбранных на Диске.

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

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

Объект на Диске
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.

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

Объект события Docs – это часть общего объекта события, в которой содержится информация о документе пользователя и его содержимом. Он присутствует в объекте события, только если дополнение расширяет возможности 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. Название таблицы, открытой в интерфейсе Таблиц.
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. Идентификатор презентации, открытой в интерфейсе Google Презентаций.
slides.title string
Присутствует, только если пользователь авторизовал область действия https://www.googleapis.com/auth/drive.file. Название презентации, открытой в интерфейсе Google Презентаций.
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"
  }
}