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

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

Объект события
eventObject.commonEventObject Common fields object
Объект, содержащий информацию, общую для всех объектов событий, независимо от хост-приложения.
eventObject.calendar Calendar event object
Присутствует только в том случае, если вызывающим хостом является Google Calendar . Объект, содержащий информацию о календаре и событиях.
eventObject.chat Chat event object
Присутствует только в том случае, если вызывающим хостом является Google Chat . Объект, содержащий информацию о чате.
eventObject.drive Drive event object
Присутствует только в том случае, если вызывающим хостом является Google Drive . Объект, содержащий информацию о Диске.
eventObject.gmail Gmail event object
Присутствует только в том случае, если вызывающим хостом является Gmail . Объект, содержащий информацию Gmail.
eventObject.docs Docs event object
Присутствует только в том случае, если вызывающим хостом является Google Docs . Объект, содержащий информацию о Docs.
eventObject.sheets Sheets event object
Присутствует только в том случае, если вызывающим хостом являются Google Таблицы . Объект, содержащий информацию из Таблиц.
eventObject.slides Slides event object
Присутствует только в том случае, если вызывающим хостом является Google Slides . Объект, содержащий информацию о слайдах.
Оригинальные дополнительные поля 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 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 : 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 .

Чтобы включить это поле, необходимо установить true addOns.common.useLocaleFromApp в манифесте дополнения. Список областей действия дополнения также должен включать 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 . Чтобы включить это поле, необходимо установить 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.space object ( Space )
Пространство чата, в котором пользователь взаимодействует с приложением чата.
chat.eventTime

string ( Timestamp format)

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

payload на борту «Союза».

payload может быть только одной из следующих:

chat.messagePayload

object ( MessagePayload )

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

chat.addedToSpacePayload

object ( AddedToSpacePayload )

Полезная нагрузка, которую приложения чата получают от триггера «Добавлено в пространство» .

chat.removedFromSpacePayload

object ( RemovedFromSpacePayload )

Полезная нагрузка, которую приложения чата получают от триггера « Удален из космоса» .

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 событие содержит полезную нагрузку с одним или несколькими ресурсами API Chat.

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

Добавлено к космической полезной нагрузке
AddedToSpacePayload
chat.addedToSpacePayload.space object ( Space )
Пространство чата, в которое пользователь добавил или установил приложение чата.

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

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

Удалено из космической полезной нагрузки
Удалено из SpacePayload
chat.removedFromSpacePayload.space object ( Space )
Пространство чата, из которого пользователь удалил или деинсталлировал приложение чата.

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

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

Полезная нагрузка команды приложения
AppCommandPayload
chat.appCommandPayload.appCommandMetadata object ( AppCommandMetadata )
Метаданные о том, какую команду использовал пользователь и как именно она была запущена.
chat.appCommandPayload.space object ( Space )
Пространство чата, в котором пользователь использовал команду.
chat.appCommandPayload.thread object ( Thread )
Если взаимодействие произошло в потоке, то поток чата, в котором пользователь использовал команду.
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 )
Тип команды.

Enum AppCommandType .

Значение AppCommandType может быть только одним из следующих:

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

Объект события календаря

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

В следующей таблице перечислены поля, присутствующие в поле calendarEventObject объекта события. Поля, отмеченные как «Сгенерированные пользователем данные», присутствуют в объекте события только в том случае, если эти данные присутствуют в событии Calendar, и дополнение устанавливает для своего поля манифеста addOns.calendar.currentEventAccess значение READ или READ_WRITE .

Объект события календаря
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.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
Карта ключей и значений строк параметров. Эти ключи и значения определяются разработчиком дополнения для присоединения информации к конкретной конференции для использования дополнением.

Точка входа

Объекты точек входа содержат информацию о выбранных способах доступа к данной конференции, например, по телефону или видео. Эта информация присутствует в объекте события только в том случае, если данные присутствуют в событии Calendar, а дополнение устанавливает поле манифеста 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:

Объект события привода

Объект события Drive — это часть общего объекта события, содержащая информацию о 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(accessToken) чтобы предоставить вашему дополнению временный доступ к открытому сообщению Gmail пользователя или разрешить ему создавать новые черновики.
gmail.bccRecipients[] list of strings
Отключено по умолчанию . Список адресов электронной почты получателей «BCC:», которые в данный момент включены в черновик, создаваемый дополнением. Чтобы включить это поле, необходимо установить для поля 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

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

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

URL-адрес ссылки, которая создаёт предварительный просмотр в Google Docs. Чтобы использовать это поле, необходимо настроить LinkPreviewTriggers в манифесте вашего дополнения. Подробнее см. в разделе Предварительный просмотр ссылок с помощью смарт-чипов .

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

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

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

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

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

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

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

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