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

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

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

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

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

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

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

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

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

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

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

  • Триггеры приложения Google Chat (Developer Preview) . В 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 . Объект, содержащий информацию о 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() .

Developer Preview: Для дополнений, расширяющих 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 . Чтобы включить это поле, необходимо установить 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.

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

Добавлено в космическую полезную нагрузку
Добавлено в SpacePayload
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 к сторонней службе .

Извлечен из космической полезной нагрузки
УдаленоИзКосмосаПолезная нагрузка
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 Пользователь нажимает на интерактивный элемент в диалоге. Например, пользователь заполняет информацию в диалоге и нажимает кнопку, чтобы отправить информацию.

Виджет обновил полезную нагрузку
ВиджетОбновленПолезная нагрузка
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 )
Тип команды.

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

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

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

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

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

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

Объект события привода
drive.activeCursorItem Drive item object
Элемент Drive в данный момент активен.
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
Отключено по умолчанию . Список адресов электронной почты получателей "CC:", которые в настоящее время включены в черновик, создаваемый дополнением. Чтобы включить это поле, необходимо установить поле addOns.gmail.composeTrigger.draftAccess в манифесте на METADATA .
gmail.messageId string
Идентификатор текущего открытого сообщения Gmail.
gmail.threadId string
Идентификатор открытой в данный момент ветки Gmail.
gmail.toRecipients[] list of strings
Отключено по умолчанию . Список адресов электронной почты получателей "To:", которые в настоящее время включены в черновик, создаваемый дополнением. Чтобы включить это поле, необходимо установить поле 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 — это часть общего объекта события, которая несет информацию о документе пользователя и его содержимом. Он присутствует в объекте события только в том случае, если надстройка расширяет 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 Sheets. Чтобы использовать это поле, вы должны настроить 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"
  }
}