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

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

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

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

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

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

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

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

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

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

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

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

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

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

Для обеспечения обратной совместимости объекты событий дополнений Google Workspace также включают все исходные поля, используемые в объектах событий действий дополнений Gmail . Эти поля перечислены в таблице ниже в разделе «Исходные поля дополнений Gmail»; информация в этих полях воспроизведена в новой структуре объекта.

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

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

  • A date-only picker : DateInput object .

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

  • A time-only picker : TimeInput object .

    Пример : Для элемента управления выбора времени с идентификатором myTimePicker получите доступ к объекту TimeInput , используя e.commonEventObject.formInputs.myTimePicker.timeInput .

commonEventObject.hostApp string
Указывает, в каком приложении активен данный аддон на момент генерации объекта события. Возможные значения:
  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
commonEventObject.parameters object
Любые дополнительные параметры, которые вы передаете действию с помощью actionParameters или Action.setParameters() .

Предварительная версия для разработчиков: Для дополнений, расширяющих функциональность Google Chat , чтобы предлагать элементы на основе ввода пользователей в меню с множественным выбором, используйте значение ключа "autocomplete_widget_query" ( event.commonEventObject.parameters["autocomplete_widget_query"] ). Вы можете использовать это значение для запроса к базе данных и предложения выбираемых элементов пользователям по мере ввода текста. Подробнее см. раздел «Сбор и обработка информации от пользователей Google Chat» .

commonEventObject.userLocale string
По умолчанию отключено . Язык пользователя и идентификатор страны/региона в формате код языка ISO 639 - код страны/региона ISO 3166. Например, en-US .

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

commonEventObject.timeZone string
Отключено по умолчанию . Идентификатор часового пояса и смещение. Чтобы включить это поле, необходимо установить addOns.common.useLocaleFromApp в true в манифесте вашего дополнения. В список областей действия вашего дополнения также должен входить https://www.googleapis.com/auth/script.locale . Дополнительные сведения см. в разделе «Доступ к локали и часовому поясу пользователя» .
commonEventObject.timeZone.id string
Идентификатор часового пояса пользователя. Примеры: America/New_York , Europe/Vienna и Asia/Seoul . Чтобы включить это поле, необходимо установить 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
Количество минут, выбранное пользователем.

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

Объект события «Чат» — это часть общего объекта события, содержащая информацию о взаимодействии пользователя с приложением «Чат». Он присутствует в объекте события только в том случае, если дополнение расширяет функциональность 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 )

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

chat.widgetUpdatedPayload

object ( WidgetUpdatedPayload )

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

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

chat.appCommandPayload

object ( AppCommandPayload )

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

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

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

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

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

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

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

Извлечено из космического полезного груза
RemovedFromSpacePayload
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 )
Тип команды.

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

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

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

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

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

В следующей таблице перечислены поля, присутствующие в поле calendarEventObject объекта события. Поля, помеченные как «Пользовательские данные», присутствуют в объекте события только в том случае, если эти данные присутствуют в событии календаря и надстройка устанавливает поле манифеста 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 Календаря. Это могут быть решения 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:

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

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

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

Приводной элемент

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

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

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

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

Объект события Gmail
gmail.accessToken string
Токен доступа, специфичный для Gmail. Вы можете использовать этот токен с методом GmailApp.setCurrentMessageAccessToken(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
По умолчанию отключено . Список адресов электронной почты получателей "Кому:", которые в данный момент включены в черновик, создаваемый дополнением. Чтобы включить это поле, необходимо установить для поля 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 , то дополнение запросило и получило разрешение на доступ к документу, открытому в пользовательском интерфейсе Google Документы, https://www.googleapis.com/auth/drive.file ; в противном случае это поле имеет значение 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 . Идентификатор электронной таблицы, открытой в интерфейсе Google Sheets.
sheets.title string
Отображается только в том случае, если пользователь авторизовал область действия https://www.googleapis.com/auth/drive.file . Заголовок электронной таблицы, открытой в интерфейсе Google Sheets.
sheets.addonHasFileScopePermission boolean
Если true , то дополнение запросило и получило разрешение на доступ к электронной таблице, открытой в интерфейсе Google Sheets, по адресу 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"
  }
}

Объект события слайдов

The Slides event object is the portion of the overall event object that carries information about a user's document and its contents. It's only present in an event object if the add-on extends Google Slides.

Slides event object
slides.id string
Only present if the https://www.googleapis.com/auth/drive.file scope has been authorized by the user . The ID of the presentation open in the Slides UI.
slides.title string
Only present if the https://www.googleapis.com/auth/drive.file scope has been authorized by the user . The title of the presentation open in the Slides UI.
slides.addonHasFileScopePermission boolean
If true , the add-on has requested and received https://www.googleapis.com/auth/drive.file scope authorization for the presentation open in the Slides UI; otherwise this field is false .
slides.matchedUrl.url string
Only present if the following conditions are met:
  • https://www.googleapis.com/auth/workspace.linkpreview has been authorized by the user.
  • The URL matches the host pattern specified in the LinkPreviewTriggers trigger.

The URL of the link that generates a preview in Google Slides. To use this field, you must configure the LinkPreviewTriggers in your add-on's manifest. See Preview links with smart chips for more details.

Example payload for when a user previews the link https://www.example.com/12345 :

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