EventObject

EventObject

Событие взаимодействия с дополнением Google, которое содержит данные о взаимодействии пользователя с дополнением в родительском приложении.

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

Подробнее об объектах событий…

JSON-представление
{
  "commonEventObject": {
    object (CommonEventObject)
  },
  "authorizationEventObject": {
    object (AuthorizationEventObject)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "calendar": {
    object (CalendarEventObject)
  },
  "drive": {
    object (DriveEventObject)
  },
  "gmail": {
    object (GmailEventObject)
  },
  "sheets": {
    object (SheetsEventObject)
  },
  "slides": {
    object (SlidesEventObject)
  },
  "docs": {
    object (DocsEventObject)
  },
  "chat": {
    object (ChatEventObject)
  },
  "workflow": {
    object (WorkflowEventObject)
  }
  // End of mutually exclusive fields.
}
Поля
commonEventObject

object (CommonEventObject)

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

authorizationEventObject

object (AuthorizationEventObject)

Задается только для запросов к конечным точкам HTTP.

Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
calendar

object (CalendarEventObject)

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

drive

object (DriveEventObject)

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

gmail

object (GmailEventObject)

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

sheets

object (SheetsEventObject)

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

slides

object (SlidesEventObject)

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

docs

object (DocsEventObject)

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

chat

object (ChatEventObject)

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

workflow

object (WorkflowEventObject)

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

Конец взаимоисключающих полей.

CommonEventObject

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

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

Для приложений Chat – название функции, которую пользователь вызвал при взаимодействии с виджетом.

JSON-представление
{
  "userLocale": string,
  "hostApp": enum (HostApp),
  "platform": enum (Platform),
  "timeZone": {
    object (TimeZone)
  },
  "formInputs": {
    string: {
      object (Inputs)
    },
    ...
  },
  "parameters": {
    string: string,
    ...
  },
  "invokedFunction": string
}
Поля
userLocale

string

По умолчанию отключено. Идентификатор языка и страны или региона пользователя в формате кода языка ISO 639 и кода страны или региона ISO 3166. Пример: en-US.

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

hostApp

enum (HostApp)

Указывает на хост-приложение, в котором дополнение активно, когда создается объект события. Возможные значения:

  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
  • CHAT
platform

enum (Platform)

Перечисление, указывающее на платформу, на которой произошло событие (WEB, IOS или ANDROID). Не поддерживается приложениями Chat.

timeZone

object (TimeZone)

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

Поддерживается только для типов событий CARD_CLICKED и SUBMIT_DIALOG.

formInputs

map (key: string, value: object (Inputs))

Карта, содержащая текущие значения виджетов на отображаемой карточке. Ключи карты – это строковые значения name, назначенные каждому виджету ввода (например, TextInput.name, SelectionInput.name, DateTimePicker.name или DecoratedText.SwitchControl.name).

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

Примечание. Приведенные ниже примеры отформатированы для среды выполнения V8 в Apps Script. Если вы используете среду выполнения Rhino, после значения необходимо добавить [""]. Например, вместо e.commonEventObject.formInputs.employeeName.stringInputs.value[0] отформатируйте объект события как e.commonEventObject.formInputs.employeeName[""].stringInputs.value[0]. Подробнее о средах выполнения в Apps Script рассказывается в обзоре среды выполнения V8.

  • Виджеты с одним значением (например, виджет TextInput или виджет SelectionInput типа DROPDOWN или RADIO_BUTTON): объект StringInputs, содержащий список из одного элемента (или пустой список, если выбор не сделан).

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

  • Виджеты с несколькими значениями (например, виджет SelectionInput типа CHECK_BOX, SWITCH или MULTI_SELECT): объект StringInputs, содержащий список строк value выбранных элементов.

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

  • Виджет DecoratedText.SwitchControl – объект StringInputs. Если selected имеет значение true, stringInputs.value содержит поле value переключателя (или "", если value не указано; если у нескольких переключателей одинаковое значение name, в список включается value каждого выбранного переключателя). Если selected – false, то value переключателя не включается в stringInputs.value.

  • Окно выбора даты и времени (DateTimePickerType.DATE_AND_TIME): DateTimeInput object.

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

  • Окно выбора даты (DateTimePickerType.DATE_ONLY) – DateInput object.

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

  • Выбор только времени (DateTimePickerType.TIME_ONLY): TimeInput object.

Пример. Для окна выбора с name myTimePicker доступ к объекту TimeInput можно получить с помощью e.commonEventObject.formInputs.myTimePicker.timeInput.

Объект содержит список из нескольких пар ("key": value). Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

parameters

map (key: string, value: string)

Любые дополнительные параметры, которые вы передаете действию с помощью actionParameters или Action.setParameters().

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

Объект содержит список из нескольких пар ("key": value). Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

invokedFunction

string

Название вызываемой функции.

Это поле не заполняется для дополнений Google Workspace, которые расширяют возможности Google Chat. Чтобы получать данные функций, например идентификаторы, дополнения, расширяющие Chat, должны использовать поле parameters. Подробнее о создании интерактивных интерфейсов для приложений Chat…

HostApp

Приложение Google Workspace для дополнения Google Workspace или приложения Google Chat.

Приложение Workspace, из которого запускается дополнение Google Workspace. Для приложений Chat хостом всегда является CHAT.

Перечисления
UNSPECIFIED_HOST_APP Google не может определить основное приложение.
GMAIL Дополнение запускается из Gmail.
CALENDAR Дополнение запускается из Google Календаря.
DRIVE Дополнение запускается из Google Диска.
DEMO Не используется.
DOCS Дополнение запускается из Google Документов.
MEET Дополнение запускается из Google Meet.
SHEETS Дополнение запускается из Google Таблиц.
SLIDES Дополнение запускается из Google Презентаций.
DRAWINGS Дополнение запускается из Google Рисунков.
CHAT Приложение Google Chat.

Платформа

Указывает, с какой платформы поступил звонок.

Перечисления
UNKNOWN_PLATFORM
WEB
IOS
ANDROID

TimeZone (часовой пояс)

Идентификатор часового пояса и смещение относительно всемирного координированного времени (UTC). Поддерживается только для типов событий CARD_CLICKED и SUBMIT_DIALOG.

JSON-представление
{
  "id": string,
  "offset": integer
}
Поля
id

string

Код часового пояса из базы данных IANA TZ, например "America/Toronto".

offset

integer

Смещение часового пояса пользователя в миллисекундах относительно всемирного координированного времени (UTC).

Входы

Типы данных, которые пользователи могут вводить на карточках или в диалоговых окнах. Тип ввода зависит от типа значений, которые принимает виджет.

JSON-представление
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "stringInputs": {
    object (StringInputs)
  },
  "dateTimeInput": {
    object (DateTimeInput)
  },
  "dateInput": {
    object (DateInput)
  },
  "timeInput": {
    object (TimeInput)
  }
  // End of mutually exclusive fields.
}
Поля
Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
stringInputs

object (StringInputs)

Список строк, представляющих значения, которые пользователь вводит в виджет.

Если виджет принимает только одно значение, например виджет TextInput, список содержит один строковый объект. Если виджет принимает несколько значений, например виджет SelectionInput флажков, список содержит строковый объект для каждого значения, которое пользователь вводит или выбирает.

dateTimeInput

object (DateTimeInput)

Значения даты и времени, введенные в виджет DateTimePicker, который принимает и дату, и время.

dateInput

object (DateInput)

Значения дат, введенные в виджет DateTimePicker, который принимает только даты.

timeInput

object (TimeInput)

Значения времени, введенные в виджет DateTimePicker, который принимает только значения времени.

Конец взаимоисключающих полей.

StringInputs

Входной параметр для обычных виджетов. Для виджетов с одним значением это список с одним значением. Для виджетов с несколькими значениями, например флажков, показываются все значения.

JSON-представление
{
  "value": [
    string
  ]
}
Поля
value[]

string

Список строк, введенных пользователем.

DateTimeInput

Значения даты и времени.

JSON-представление
{
  "msSinceEpoch": string,
  "hasDate": boolean,
  "hasTime": boolean
}
Поля
msSinceEpoch

string (int64 format)

Время с начала эпохи в миллисекундах.

hasDate

boolean

Указывает, содержит ли входной параметр datetime календарную дату.

hasTime

boolean

Включает ли входной параметр datetime временную метку.

DateInput

Значения даты.

JSON-представление
{
  "msSinceEpoch": string
}
Поля
msSinceEpoch

string (int64 format)

Время с начала эпохи в миллисекундах.

TimeInput

Значения времени.

JSON-представление
{
  "hours": integer,
  "minutes": integer
}
Поля
hours

integer

Час в 24-часовом формате.

minutes

integer

Минута часа. Допустимые значения: от 0 до 59.

AuthorizationEventObject

Инкапсулирует информацию об авторизации для запроса дополнения.

JSON-представление
{
  "userOAuthToken": string,
  "userIdToken": string,
  "systemIdToken": string,
  "authorizedScopes": [
    string
  ]
}
Поля
userOAuthToken

string

Токен доступа OAuth конечного пользователя, авторизованный с запрошенными областями действия. (После разделения согласия OAuth это будет авторизовано с областями, авторизованными конечным пользователем)

userIdToken

string

Токен идентификатора пользователя, если запрашиваются соответствующие области действия идентификатора.

systemIdToken

string

Токен идентификатора для сервисного аккаунта дополнений G Suite для этого развертывания.

authorizedScopes[]

string

Список областей действия OAuth, авторизованных пользователем.

CalendarEventObject

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

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

JSON-представление
{
  "id": string,
  "recurringEventId": string,
  "calendarId": string,
  "organizer": {
    object (Organizer)
  },
  "attendees": [
    {
      object (Attendee)
    }
  ],
  "conferenceData": {
    object (ConferenceData)
  },
  "capabilities": {
    object (Capabilities)
  }
}
Поля
id

string

Идентификатор события.

recurringEventId

string

Идентификатор повторяющегося мероприятия.

calendarId

string

Идентификатор календаря.

organizer

object (Organizer)

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

attendees[]

object (Attendee)

Данные, созданные пользователями. Список участников мероприятия из календаря.

conferenceData

object (ConferenceData)

Данные, созданные пользователями. Объект, представляющий любые данные видеовстречи, связанные с этим мероприятием, например сведения о видеовстрече Google Meet.

capabilities

object (Capabilities)

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

Организатор

JSON-представление
{
  "email": string
}
Поля
email

string

Адрес электронной почты организатора мероприятия.

Участник

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

JSON-представление
{
  "email": string,
  "displayName": string,
  "organizer": boolean,
  "self": boolean,
  "resource": boolean,
  "optional": boolean,
  "responseStatus": string,
  "comment": string,
  "additionalGuests": integer
}
Поля
email

string

Адрес электронной почты участника.

displayName

string

Отображаемое имя участника.

organizer

boolean

true, если участник является организатором мероприятия.

self

boolean

true, если этот участник представляет календарь, в котором появляется это мероприятие; в противном случае – false.

resource

boolean

true, если участник представляет ресурс, например переговорную комнату или оборудование; false в противном случае.

optional

boolean

true, если участие этого участника отмечено как необязательное; false в противном случае.

responseStatus

string

Статус ответа участника. Возможные значения:

  • accepted – участник принял приглашение на мероприятие.
  • declined – участник отклонил приглашение на мероприятие.
  • needsAction – участник не ответил на приглашение.
  • tentative – участник предварительно принял приглашение на мероприятие.
comment

string

Комментарий участника, если он есть.

additionalGuests

integer

Количество дополнительных гостей, которых участник планирует привести с собой. Значение по умолчанию равно нулю.

ConferenceData

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

JSON-представление
{
  "conferenceId": string,
  "conferenceSolution": {
    object (ConferenceSolution)
  },
  "entryPoints": [
    {
      object (EntryPoint)
    }
  ],
  "notes": string,
  "parameters": {
    object (Parameters)
  }
}
Поля
conferenceId

string

Идентификатор видеовстречи. Этот идентификатор позволяет приложениям отслеживать видеовстречи. Не показывайте его пользователям.

conferenceSolution

object (ConferenceSolution)

Объект, представляющий решение для видеовстреч, например Hangouts или Google Meet.

entryPoints[]

object (EntryPoint)

Список точек входа в видеовстречу, например URL или номера телефонов.

notes

string

Дополнительные примечания (например, инструкции от администратора домена или юридические уведомления) о видеовстрече, которые будут показаны пользователю. Может содержать HTML-код. Максимальное число символов: 2048.

parameters

object (Parameters)

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

ConferenceSolution

JSON-представление
{
  "iconUri": string,
  "key": {
    object (Key)
  },
  "name": string
}
Поля
iconUri

string

URI значка, который пользователи видят рядом с названием решения для видеовстреч.

key

object (Key)

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

name

string

Название решения для видеовстреч, которое видят пользователи (не локализовано).

Ключ

JSON-представление
{
  "type": string
}
Поля
type

string

Тип решения для видеовстреч. Возможные значения:

  • eventHangout для Hangouts для обычных пользователей (http://hangouts.google.com).
  • eventNamedHangout для классической версии Hangouts для пользователей Google Workspace (http://hangouts.google.com).
  • hangoutsMeet для Google Meet (http://meet.google.com).
  • addOn для сторонних решений для видеовстреч.

EntryPoint

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

JSON-представление
{
  "accessCode": string,
  "entryPointType": string,
  "label": string,
  "meetingCode": string,
  "passcode": string,
  "password": string,
  "pin": string,
  "uri": string,
  "regionCode": string,
  "entryPointFeatures": [
    string
  ]
}
Поля
accessCode

string

Код доступа, использованный для подключения к видеовстрече. Максимальная длина – 128 символов. Как правило, поставщики услуг видеоконференций используют только часть параметров {accessCode, meetingCode, passcode, password, pin} для предоставления доступа к видеовстречам. Сопоставляйте и показывайте только те поля, которые использует поставщик видеоконференций.

entryPointType

string

Тип точки входа. Возможные значения:

  • more – дополнительные инструкции по подключению к видеовстрече, например альтернативные номера телефонов. В видеовстрече может быть только одна точка входа типа more. Если она есть, также требуется по крайней мере одна точка входа другого типа.
  • phone – присоединиться к видеовстрече по номеру телефона. У видеовстречи может быть несколько телефонных точек подключения. В Google Календаре показываются только первые два номера телефона, отформатированные и отсортированные по алфавиту.
  • sip – присоединиться к видеовстрече по протоколу SIP. У видеовстречи может быть не более одной точки входа sip.
  • video – присоединиться к видеовстрече по протоколу HTTP. У видеовстречи может быть не более одной точки входа для видео.
label

string

Видимый пользователю ярлык для URI точки входа (не локализован).

meetingCode

string

Код встречи, использованный для доступа к видеовстрече. Максимальная длина – 128 символов. Как правило, поставщики услуг видеоконференций используют только часть параметров {accessCode, meetingCode, passcode, password, pin} для предоставления доступа к видеовстречам. Сопоставляйте и показывайте только те поля, которые использует поставщик видеоконференций.

passcode

string

Код доступа, используемый для подключения к конференции. Максимальная длина – 128 символов. Как правило, поставщики услуг видеоконференций используют только часть параметров {accessCode, meetingCode, passcode, password, pin} для предоставления доступа к видеовстречам. Сопоставляйте и показывайте только те поля, которые использует поставщик видеоконференций.

password

string

Пароль, используемый для доступа к конференции. Максимальная длина – 128 символов. Как правило, поставщики услуг видеоконференций используют только часть параметров {accessCode, meetingCode, passcode, password, pin} для предоставления доступа к видеовстречам. Сопоставляйте и показывайте только те поля, которые использует поставщик видеоконференций.

pin

string

PIN-код, используемый для доступа к видеовстрече. Максимальная длина – 128 символов. Как правило, поставщики услуг видеоконференций используют только часть параметров {accessCode, meetingCode, passcode, password, pin} для предоставления доступа к видеовстречам. Сопоставляйте и показывайте только те поля, которые использует поставщик видеоконференций.

uri

string

URI точки входа. Максимальная длина – 1300 символов. Форматирование зависит от типа точки входа:

  • more – требуется схема http: или https:.
  • phone – требуется схема tel:. URI должен включать всю последовательность набора номера (например, "tel:+12345678900,,,12345678;1234").
  • sip – требуется схема sip: или sips:. Пример: sip:12345678@myprovider.com.
  • video: требуется схема http: или https:.
regionCode

string

Код региона номера телефона. Требуется пользователям, если URI не содержит код страны. Значения основаны на общедоступном списке кодов регионов CLDR.

entryPointFeatures[]

string

Функции точки входа. В настоящее время эти функции применяются только к точкам входа по телефону:

  • toll – точка входа представляет собой платный телефонный звонок.
  • toll_free – точка входа представляет собой бесплатный телефонный звонок.

Параметры

JSON-представление
{
  "addOnParameters": {
    object (AddOnParameters)
  }
}
Поля
addOnParameters

object (AddOnParameters)

Карта строковых ключей и значений параметров. Эти ключи и значения определяются разработчиком дополнения, чтобы прикреплять информацию к определенной видеовстрече для использования дополнением.

AddOnParameters

JSON-представление
{
  "parameters": {
    string: string,
    ...
  }
}
Поля
parameters

map (key: string, value: string)

Объект содержит список из нескольких пар ("key": value). Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Возможности

JSON-представление
{
  "canSeeAttendees": boolean,
  "canAddAttendees": boolean,
  "canSeeConferenceData": boolean,
  "canSetConferenceData": boolean,
  "canAddAttachments": boolean
}
Поля
canSeeAttendees

boolean

Данные, созданные пользователем. true, если дополнение может читать список участников мероприятия; false в противном случае.

canAddAttendees

boolean

Пользовательские данные. true, если дополнение может добавлять новых участников в список участников мероприятия; false в противном случае.

canSeeConferenceData

boolean

Пользовательские данные. true, если дополнение может считывать данные о видеовстрече, связанной с мероприятием; false в противном случае.

canSetConferenceData

boolean

Данные, созданные пользователем. true, если дополнение может обновлять данные о видеовстрече; false в противном случае.

canAddAttachments

boolean

Пользовательские данные. true, если дополнение может добавлять новые прикрепленные файлы к мероприятию; false в противном случае.

DriveEventObject

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

JSON-представление
{
  "selectedItems": [
    {
      object (DriveItemMetadata)
    }
  ],
  "activeCursorItem": {
    object (DriveItemMetadata)
  }
}
Поля
selectedItems[]

object (DriveItemMetadata)

Список объектов (файлов или папок), выбранных на Диске.

activeCursorItem

object (DriveItemMetadata)

Объект Диска, который сейчас активен.

DriveItemMetadata

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

JSON-представление
{
  "id": string,
  "iconUrl": string,
  "mimeType": string,
  "title": string,
  "addonHasFileScopePermission": boolean
}
Поля
id

string

Идентификатор выбранного объекта.

iconUrl

string

URL значка, представляющего выбранный объект.

mimeType

string

MIME-тип выбранного объекта.

title

string

Название выбранного объекта.

addonHasFileScopePermission

boolean

Если задано значение true, дополнение запросило и получило авторизацию области действия https://www.googleapis.com/auth/drive.file для этого объекта. В противном случае значение этого поля – false.

Если дополнение использует область действия с более широкими разрешениями, например https://www.googleapis.com/auth/drive или https://www.googleapis.com/auth/drive.readonly, это поле не имеет значения. При разработке дополнений всегда используйте области действия с минимальными разрешениями, чтобы защитить информацию пользователей.

GmailEventObject

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

JSON-представление
{
  "messageId": string,
  "threadId": string,
  "accessToken": string,
  "toRecipients": [
    string
  ],
  "ccRecipients": [
    string
  ],
  "bccRecipients": [
    string
  ]
}
Поля
messageId

string

Идентификатор открытого письма Gmail.

threadId

string

Идентификатор открытой цепочки писем Gmail.

accessToken

string

Токен доступа к Gmail. Этот токен можно использовать с методом GmailApp.setCurrentMessageAccessToken(accessToken), чтобы предоставить дополнению временный доступ к открытому в данный момент письму Gmail или разрешить дополнению создавать черновики.

toRecipients[]

string

По умолчанию отключено. Список адресов электронной почты получателей, указанных в поле "Кому" в черновике, который создается дополнением. Чтобы включить это поле, задайте для поля addOns.gmail.composeTrigger.draftAccess в манифесте значение METADATA.

ccRecipients[]

string

По умолчанию отключено. Список адресов электронной почты получателей, указанных в поле "Копия" в черновике, который создается дополнением. Чтобы включить это поле, задайте для поля addOns.gmail.composeTrigger.draftAccess в манифесте значение METADATA.

bccRecipients[]

string

По умолчанию отключено. Список адресов электронной почты получателей скрытой копии, которые в настоящее время включены в черновик, создаваемый дополнением. Чтобы включить это поле, задайте для поля addOns.gmail.composeTrigger.draftAccess в манифесте значение METADATA.

SheetsEventObject

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

JSON-представление
{
  "id": string,
  "title": string,
  "addonHasFileScopePermission": boolean,
  "matchedUrl": {
    object (MatchedUrl)
  }
}
Поля
id

string

Присутствует, только если пользователь авторизовал область действия https://www.googleapis.com/auth/drive.file. Идентификатор таблицы, открытой в интерфейсе Таблиц.

title

string

Присутствует, только если пользователь авторизовал область действия https://www.googleapis.com/auth/drive.file. Название таблицы, открытой в интерфейсе Google Таблиц.

addonHasFileScopePermission

boolean

Если значение равно true, дополнение запросило и получило авторизацию области действия https://www.googleapis.com/auth/drive.file для таблицы, открытой в интерфейсе Таблиц. В противном случае значение равно false.

matchedUrl

object (MatchedUrl)

Показывается только при соблюдении следующих условий:

  • Пользователь авторизовал 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"
  }
}

MatchedUrl

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

JSON-представление
{
  "url": string
}
Поля
url

string

URL, который был сопоставлен.

SlidesEventObject

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

JSON-представление
{
  "id": string,
  "title": string,
  "addonHasFileScopePermission": boolean,
  "matchedUrl": {
    object (MatchedUrl)
  }
}
Поля
id

string

Присутствует, только если пользователь авторизовал область действия https://www.googleapis.com/auth/drive.file. Идентификатор презентации, открытой в интерфейсе Презентаций.

title

string

Присутствует, только если пользователь авторизовал область действия https://www.googleapis.com/auth/drive.file. Название презентации, открытой в интерфейсе Презентаций.

addonHasFileScopePermission

boolean

Если значение равно true, дополнение запросило и получило авторизацию области действия https://www.googleapis.com/auth/drive.file для презентации, открытой в интерфейсе Презентаций. В противном случае значение этого поля равно false.

matchedUrl

object (MatchedUrl)

Показывается только при соблюдении следующих условий:

  • Пользователь авторизовал https://www.googleapis.com/auth/workspace.linkpreview.
  • URL соответствует шаблону хоста, указанному в триггере LinkPreviewTriggers.

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

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

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

DocsEventObject

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

JSON-представление
{
  "id": string,
  "title": string,
  "addonHasFileScopePermission": boolean,
  "matchedUrl": {
    object (MatchedUrl)
  }
}
Поля
id

string

Присутствует, только если пользователь авторизовал область действия https://www.googleapis.com/auth/drive.file. Идентификатор документа, открытого в интерфейсе Документов.

title

string

Присутствует, только если пользователь авторизовал область действия https://www.googleapis.com/auth/drive.file. Название документа, открытого в интерфейсе Документов.

addonHasFileScopePermission

boolean

Если значение равно true, дополнение запросило и получило авторизацию области действия https://www.googleapis.com/auth/drive.file для документа, открытого в интерфейсе Документов. В противном случае значение равно false.

matchedUrl

object (MatchedUrl)

Показывается только при соблюдении следующих условий:

  • Пользователь авторизовал https://www.googleapis.com/auth/workspace.linkpreview.
  • URL соответствует шаблону хоста, указанному в триггере LinkPreviewTriggers.

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

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

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

ChatEventObject

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

JSON-представление
{
  "type": enum (EventType),
  "user": {
    object (User)
  },
  "space": {
    object (Space)
  },
  "eventTime": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "messagePayload": {
    object (MessagePayload)
  },
  "addedToSpacePayload": {
    object (AddedToSpacePayload)
  },
  "removedFromSpacePayload": {
    object (RemovedFromSpacePayload)
  },
  "buttonClickedPayload": {
    object (ButtonClickedPayload)
  },
  "widgetUpdatedPayload": {
    object (WidgetUpdatedPayload)
  },
  "appCommandPayload": {
    object (AppCommandPayload)
  },
  "systemCommandPayload": {
    object (SystemCommandPayload)
  }
  // End of mutually exclusive fields.
}
Поля
type

enum (EventType)

Тип события. Заполняется только для событий на главной странице приложения в приложениях Chat, которые не являются дополнениями.

user

object (User)

Пользователь, который взаимодействует с приложением Chat.

space

object (Space)

Чат-группа, в которой произошло событие. Заполняется только для событий на главном экране приложения в приложениях Chat, которые не являются дополнениями.

eventTime

string (Timestamp format)

Временная метка, указывающая, когда происходит объект события.

Используется формат RFC 3339. Результат всегда будет Z-нормализованным, и в нем будут использоваться цифры дробных частей 0, 3, 6 или 9. Допустимы и другие типы нормализации. Примеры: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30".

Полезная нагрузка объекта события. Полезная нагрузка зависит от типа объекта события. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
messagePayload

object (MessagePayload)

Пользователь отправляет сообщение приложению Chat или упоминает его в чат-группе. Вызовы команд приложения (например, слеш-команд и быстрых команд) доставляются в appCommandPayload.

addedToSpacePayload

object (AddedToSpacePayload)

Пользователь добавляет приложение Chat в чат-группу Google Chat, или администратор Google Workspace устанавливает приложение Chat в чаты для прямой переписки для пользователей в своей организации.

removedFromSpacePayload

object (RemovedFromSpacePayload)

Пользователь удаляет приложение Chat из чат-группы.

buttonClickedPayload

object (ButtonClickedPayload)

Представляет данные полезной нагрузки, когда пользователь взаимодействует с интерактивным элементом карточки или диалогового окна, который запускает обратный вызов Action. Несмотря на название, эти полезные данные заполняются для всех обратных вызовов Action карточек и диалоговых окон – не только для нажатий кнопок, но и для триггеров onChangeAction, действий onClick, кликов CardAction, а также отправки или отмены диалоговых окон (SUBMIT_DIALOG и CANCEL_DIALOG).

Если пользователь взаимодействует с диалоговым окном, поле isDialogEvent объекта ButtonClickedPayload принимает значение true и включает DialogEventType.

Полная полезная нагрузка также включает commonEventObject.formInputs и commonEventObject.parameters.

widgetUpdatedPayload

object (WidgetUpdatedPayload)

Пользователь обновляет виджет на карточке в чате или в диалоговом окне.

Полная полезная нагрузка также включает CommonEventObject.parameters['autocomplete_widget_query'].

appCommandPayload

object (AppCommandPayload)

Пользователь вызывает команду приложения.

systemCommandPayload

object (SystemCommandPayload)

Пользователь вызывает системную команду.

Конец взаимоисключающих полей.

EventType

Тип события. Заполняется только для событий на главной странице приложения в приложениях Chat, которые не являются дополнениями.

Перечисления
EVENT_TYPE_UNSPECIFIED Значение по умолчанию для перечисления. DO NOT USE.
APP_HOME Пользователь открывает прямую переписку из приложения Chat, в котором используется главный экран приложения. Для событий этого типа включаются только поля type, user и space. Подробнее о том, как создать главную страницу для приложения Google Chat…
SUBMIT_FORM Пользователь отправляет информацию в карточке главного экрана приложения. Для событий этого типа включаются только поля type, user и space. Подробнее о том, https://developers.google.com/workspace/chat/send-app-home-card-message)…

MessagePayload

Пользователь отправляет сообщение приложению Chat или упоминает его в чат-группе. Для вызова команд приложений (например, слеш-команд и быстрых команд) используется AppCommandPayload.

JSON-представление
{
  "space": {
    object (Space)
  },
  "message": {
    object (Message)
  },
  "configCompleteRedirectUri": string
}
Поля
space

object (Space)

Обязательно. Чат-группа Google Chat, в которой происходит объект события.

message

object (Message)

Сообщение, которое активирует объект события.

configCompleteRedirectUri

string

Необязательное поле. URL, на который приложение Chat должно перенаправлять пользователя после завершения процесса авторизации или настройки за пределами Google Chat. Подробнее о том, как подключить приложение Chat к другим сервисам и инструментам…

AddedToSpacePayload

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

JSON-представление
{
  "space": {
    object (Space)
  },
  "interactionAdd": boolean,
  "configCompleteRedirectUri": string
}
Поля
space

object (Space)

Обязательно. Чат-группа Google Chat, в которой происходит объект события.

interactionAdd

boolean

Было ли приложение добавлено в чат-группу в результате взаимодействия с пользователем (например, путем @ упоминания приложения Chat или вызова с помощью слеш-команды). Если задано значение true, с самим взаимодействием будет связан отдельный объект события, отправляемый в приложение Chat.

configCompleteRedirectUri

string

Необязательное поле. URL, на который приложение Chat должно перенаправлять пользователя после завершения процесса авторизации или настройки за пределами Google Chat. Подробнее о том, как подключить приложение Chat к другим сервисам и инструментам…

RemovedFromSpacePayload

Пользователь удаляет приложение Chat из чат-группы.

JSON-представление
{
  "space": {
    object (Space)
  }
}
Поля
space

object (Space)

Обязательно. Чат-группа Google Chat, в которой происходит объект события.

ButtonClickedPayload

Пользователь взаимодействует с интерактивным элементом карточки или диалогового окна из дополнения Chat, которое запускает обратный вызов Action. Несмотря на название, эти полезные данные заполняются для всех обратных вызовов Action карточек и диалоговых окон, включая нажатия кнопок, триггеры onChangeAction, действия onClick, нажатия CardAction, а также отправку или отмену диалоговых окон (SUBMIT_DIALOG и CANCEL_DIALOG).

Если пользователь взаимодействует с диалоговым окном, поле isDialogEvent объекта ButtonClickedPayload принимает значение true и включает DialogEventType. Эти полезные данные сопоставляются с типами событий SUBMIT_FORM и CARD_CLICKED для приложений Chat, которые не являются дополнениями.

Полная полезная нагрузка также включает CommonEventObject.form_inputs и CommonEventObject.parameters.

JSON-представление
{
  "space": {
    object (Space)
  },
  "message": {
    object (Message)
  },
  "isDialogEvent": boolean,
  "dialogEventType": enum (DialogEventType)
}
Поля
space

object (Space)

Обязательно. Чат-группа Google Chat, в которой происходит объект события.

message

object (Message)

Сообщение, которое активирует объект события.

isDialogEvent

boolean

Для объектов событий ButtonClicked и Message – взаимодействует ли пользователь с диалоговым окном или собирается это сделать.

dialogEventType

enum (DialogEventType)

Тип полученного объекта события dialog.

DialogEventType

Для объектов событий, содержащих полезную нагрузку событий ButtonClicked или AppCommand, – типы взаимодействий с диалоговыми окнами.

Чтобы узнать больше об объектах событий приложений Google Chat, ознакомьтесь со статьей Как получать сообщения и отвечать на них в приложении Google Chat.

Перечисления
DIALOG_EVENT_TYPE_UNSPECIFIED Значение по умолчанию. Не указано.
REQUEST_DIALOG Пользователь открывает диалоговое окно.
SUBMIT_DIALOG Пользователь нажимает на интерактивный элемент диалогового окна. Например, пользователь заполняет информацию в диалоговом окне и нажимает кнопку, чтобы отправить ее.
CANCEL_DIALOG Пользователь закрывает диалоговое окно, не отправляя информацию, или диалоговое окно отменяется.

WidgetUpdatedPayload

Пользователь обновляет виджет в карточке или диалоговом окне в чате.

Полная полезная нагрузка также включает CommonEventObject.parameters['autocomplete_widget_query'].

JSON-представление
{
  "space": {
    object (Space)
  }
}
Поля
space

object (Space)

Обязательно. Чат-группа Google Chat, в которой происходит объект события.

AppCommandPayload

Пользователь вызывает команду приложения.

JSON-представление
{
  "appCommandMetadata": {
    object (AppCommandMetadata)
  },
  "space": {
    object (Space)
  },
  "thread": {
    object (Thread)
  },
  "message": {
    object (Message)
  },
  "configCompleteRedirectUri": string,
  "isDialogEvent": boolean,
  "dialogEventType": enum (DialogEventType)
}
Поля
appCommandMetadata

object (AppCommandMetadata)

Заполняется для команд приложений, включая слеш-команды и быстрые команды.

space

object (Space)

Необязательное поле. Чат-группа Google Chat, в которой происходит объект события.

thread

object (Thread)

Необязательное поле. Цепочка, в которой находится объект события (если применимо). Это поле заполняется, если объект события связан с определенным сообщением или цепочкой.

message

object (Message)

Необязательное поле. Сообщение, которое активирует объект события, если применимо. Это поле заполняется только для слеш-команд.

configCompleteRedirectUri

string

Необязательное поле. URL, на который пользователь должен быть перенаправлен после завершения процесса авторизации или настройки за пределами Google Chat. Подробнее о том, как подключить приложение Chat к другим сервисам и инструментам…

isDialogEvent

boolean

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

dialogEventType

enum (DialogEventType)

Необязательное поле. Тип полученного объекта события dialog. Это поле применяется, только если для параметра isDialogEvent задано значение true.

AppCommandMetadata

Метаданные о команде приложения Chat.

JSON-представление
{
  "appCommandId": integer,
  "appCommandType": enum (AppCommandType)
}
Поля
appCommandId

integer

Идентификатор команды, указанный в конфигурации Chat API.

appCommandType

enum (AppCommandType)

Тип команды приложения Chat.

AppCommandType

Тип команды приложения Chat. Подробнее о типах команд приложений Chat…

Перечисления
APP_COMMAND_TYPE_UNSPECIFIED Значение по умолчанию. Не указано.
SLASH_COMMAND Слеш-команда. Пользователь отправляет команду в сообщении Chat.
QUICK_COMMAND Быстрая команда. Пользователь выбирает команду из меню Chat в области ответа на сообщение.
MESSAGE_ACTION Действие с сообщением. Пользователь выбирает команду из контекстного меню сообщения в Chat.

SystemCommandPayload

Пользователь вызывает системную команду.

JSON-представление
{
  "systemCommandMetadata": {
    object (SystemCommandMetadata)
  },
  "space": string,
  "thread": {
    object (Thread)
  }
}
Поля
systemCommandMetadata

object (SystemCommandMetadata)

Метаданные о вызванной системной команде.

space

string

Необязательное поле. Чат-группа Google Chat, в которой происходит объект события.

thread

object (Thread)

Необязательное поле. Цепочка, в которой находится объект события (если применимо). Это поле заполняется, если объект события связан с определенным сообщением или цепочкой.

SystemCommandMetadata

Метаданные о системной команде, запущенной пользователем.

JSON-представление
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "cancelStream": {
    object (CancelStream)
  }
  // End of mutually exclusive fields.
}
Поля
Вызвана системная команда. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
cancelStream

object (CancelStream)

Команда для отмены активного сообщения в чате.

Конец взаимоисключающих полей.

CancelStream

Команда для отмены активного сообщения в чате.

JSON-представление
{
  "streamMessage": string
}
Поля
streamMessage

string

Обязательно. Название ресурса сообщения потока, для которого была выполнена команда отмены.

Формат: spaces/{space}/streamMessages/{streamMessage}

WorkflowEventObject

LINT.IfChange Объект события, передаваемый дополнениям Workflow.

JSON-представление
{
  "executionMetadata": {
    object (ExecutionMetadata)
  },
  "triggerEventSource": enum (TriggerEventSource),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "actionInvocation": {
    object (ActionInvocation)
  },
  "triggerCreation": {
    object (TriggerCreation)
  },
  "triggerDeletion": {
    object (TriggerDeletion)
  },
  "resourceRetrieval": {
    object (ResourceRetrieval)
  },
  "elementConfiguration": {
    object (ElementConfiguration)
  },
  "resourceFieldsDefinitionRetrieval": {
    object (ResourceFieldsDefinitionRetrieval)
  },
  "elementUiAutocomplete": {
    object (ElementUiAutocomplete)
  }
  // End of mutually exclusive fields.
}
Поля
executionMetadata

object (ExecutionMetadata)

Метаданные о выполнении рабочего процесса.

triggerEventSource

enum (TriggerEventSource)

Источник событий-триггеров.

Тип полезной нагрузки события рабочего процесса. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
actionInvocation

object (ActionInvocation)

Вызов действия рабочего процесса.

triggerCreation

object (TriggerCreation)

Создание триггера рабочего процесса.

triggerDeletion

object (TriggerDeletion)

Удаление триггера рабочего процесса.

resourceRetrieval

object (ResourceRetrieval)

Получение ресурса (используется для увеличения переменной).

elementConfiguration

object (ElementConfiguration)

Конфигурация элемента рабочего процесса.

resourceFieldsDefinitionRetrieval

object (ResourceFieldsDefinitionRetrieval)

Получение определений полей, поддерживаемых ресурсом.

elementUiAutocomplete

object (ElementUiAutocomplete)

Подсказки автозаполнения для текущей карточки.

Конец взаимоисключающих полей.

ActionInvocation

Вызов действия рабочего процесса.

JSON-представление
{
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "triggerId": string,
  "flowLevelContext": {
    object (FlowLevelContext)
  }
}
Поля
inputs

map (key: string, value: object (VariableData))

Карта входных переменных, упорядоченных по названию.

Объект содержит список из нескольких пар ("key": value). Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

triggerId

string

Идентификатор триггера, который будет использоваться для ответов на асинхронные действия.

flowLevelContext

object (FlowLevelContext)

Необязательное поле. Контекст на уровне процесса из предыдущих шагов.

VariableData

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

JSON-представление
{
  "booleanValues": [
    boolean
  ],
  "integerValues": [
    string
  ],
  "floatValues": [
    number
  ],
  "stringValues": [
    string
  ],
  "timestampValues": [
    string
  ],
  "resourceReferences": [
    {
      object (ResourceReference)
    }
  ],
  "emailAddressValues": [
    string
  ],
  "googleUserValues": [
    string
  ],
  "textFormatValues": [
    {
      object (WorkflowTextFormat)
    }
  ]
}
Поля
booleanValues[]

boolean

Логические значения.

integerValues[]

string (int64 format)

Целые числа.

floatValues[]

number

Значения с плавающей запятой.

stringValues[]

string

Строковые значения.

timestampValues[]

string (Timestamp format)

Значения временных меток.

Используется формат RFC 3339. Результат всегда будет Z-нормализованным, и в нем будут использоваться цифры дробных частей 0, 3, 6 или 9. Допустимы и другие типы нормализации. Примеры: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30".

resourceReferences[]

object (ResourceReference)

Ссылки на ресурсы (идентификаторы).

emailAddressValues[]

string

Значения адресов электронной почты.

googleUserValues[]

string

Значения пользователей Google в формате users/{user}.

textFormatValues[]

object (WorkflowTextFormat)

Значения формата текста рабочего процесса.

ResourceReference

Идентификатор ресурса, относящегося к приложению.

JSON-представление
{
  "resourceType": {
    object (ResourceType)
  },
  "resourceId": string
}
Поля
resourceType

object (ResourceType)

Тип ресурса, на который указывает этот идентификатор.

resourceId

string

Идентификатор ресурса.

ResourceType

Название типа специального ресурса.

JSON-представление
{
  "workflowBundleId": string,
  "workflowResourceDefinitionId": string
}
Поля
workflowBundleId

string

Идентификатор пакета рабочих процессов, которому принадлежит этот тип ресурса. Это необязательный параметр. Если он не указан, считается, что используется тот же пакет.

workflowResourceDefinitionId

string

Уникальный идентификатор ресурса. Идентификатор должен быть уникальным только в пределах одного пакета.

WorkflowTextFormat

Блок текста с расширенными возможностями форматирования, включая стили, гиперссылки и интерактивные элементы.

JSON-представление
{
  "textFormatElements": [
    {
      object (TextFormatElement)
    }
  ]
}
Поля
textFormatElements[]

object (TextFormatElement)

Набор элементов форматирования текста.

TextFormatElement

Один элемент в сообщении WorkflowTextFormat, который может быть чипом, стилизованным текстом, гиперссылкой или контейнером списка.

JSON-представление
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "text": string,
  "chip": {
    object (Chip)
  },
  "styledText": {
    object (StyledText)
  },
  "hyperlink": {
    object (Hyperlink)
  },
  "listContainer": {
    object (ListContainer)
  }
  // End of mutually exclusive fields.
}
Поля
Элемент, представляющий один из нескольких возможных элементов форматирования текста. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
text

string

Текст в текстовом формате.

chip

object (Chip)

Интерактивный чип в текстовом формате.

styledText

object (StyledText)

Форматированный текст в текстовом формате.

listContainer

object (ListContainer)

Контейнер списка в текстовом формате.

Конец взаимоисключающих полей.

Чип

Интерактивный чип в текстовом формате.

JSON-представление
{
  "icon": {
    object (Icon)
  },
  "label": string,
  "url": string
}
Поля
icon

object (Icon)

Значок, который показывается на чипе.

label

string

Текст, который показывается в чипе.

url

string

URL, по которому будет выполнен переход при нажатии на чип.

Значок

Значок в чипе.

JSON-представление
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "iconUrl": string,
  "materialIconName": string
  // End of mutually exclusive fields.
}
Поля
Значок, который показывается на чипе. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
iconUrl

string

Показывать пользовательский значок, размещенный по URL с протоколом HTTPS.

Пример:

"iconUrl":
"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png"

Поддерживаемые типы файлов: .png и .jpg.

materialIconName

string

Название значка, определенное в Google Material Icon, например check_box. Недопустимые названия игнорируются и заменяются пустой строкой, в результате чего значок не отображается.

Конец взаимоисключающих полей.

StyledText

Текстовый элемент со стилями, такими как полужирный, курсив и цвет.

JSON-представление
{
  "text": string,
  "styles": [
    enum (Style)
  ],
  "fontWeight": enum (FontWeight),
  "color": {
    object (Color)
  },
  "wrapStyle": enum (WrapStyle)
}
Поля
text

string

Основной текст.

styles[]

enum (Style)

Набор стилей, примененных к тексту.

fontWeight

enum (FontWeight)

Насыщенность шрифта.

color

object (Color)

Цвет текста.

wrapStyle

enum (WrapStyle)

Стиль переноса текста.

Стиль

Перечисление для разных стилей текста, таких как курсив, подчеркивание и т. д.

Перечисления
STYLE_UNSPECIFIED Стиль не применен. DO NOT USE.
ITALIC Курсив.
UNDERLINE Подчеркивание.
STRIKETHROUGH Зачеркнутый шрифт.
LINE_BREAK Разрыв строки.
UPPERCASE Прописные буквы.
CODE Создавайте код
CODE_BLOCK Блок кода.

FontWeight

Перечисление для разных значений насыщенности шрифта.

Перечисления
FONT_WEIGHT_UNSPECIFIED Стандартная толщина. DO NOT USE.
LIGHT Меньший вес и толщина.
MEDIUM Промежуточная насыщенность между светлым и полужирным.
BOLD Более тяжелый и толстый.

WrapStyle

Перечисление для разных стилей переноса.

Перечисления
WRAP_STYLE_UNSPECIFIED Не указан стиль переноса.
NO_WRAP Без переноса.

ListContainer

Контейнер для элементов списка, каждый из которых может содержать несколько элементов TextFormatElement.

JSON-представление
{
  "listNestLevel": string,
  "listType": enum (ListType),
  "listItems": [
    {
      object (ListItem)
    }
  ]
}
Поля
listNestLevel

string (int64 format)

Уровень вложенности списка. Для верхнего уровня используется значение 0, а для каждого вложенного списка оно увеличивается на 1.

listType

enum (ListType)

Тип списка.

listItems[]

object (ListItem)

Набор элементов списка.

ListType

Перечисление для разных типов списков.

Перечисления
LIST_TYPE_UNSPECIFIED Не указан тип списка. DO NOT USE.
ORDERED Упорядоченный список.
UNORDERED Маркированный список.
BLOCKQUOTE Представляет список цитат.

ListItem

Элемент списка.

JSON-представление
{
  "textFormatElements": [
    {
      object (TextFormatElement)
    }
  ]
}
Поля
textFormatElements[]

object (TextFormatElement)

Набор элементов форматирования текста.

FlowLevelContext

Контекст на уровне процесса, содержащий выходные данные предыдущих шагов.

JSON-представление
{
  "stepContexts": [
    {
      object (StepContext)
    }
  ]
}
Поля
stepContexts[]

object (StepContext)

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

StepContext

Метаданные контекста шага и выходные данные для контекста на уровне потока.

JSON-представление
{
  "stepId": string,
  "outputs": {
    string: {
      object (VariableData)
    },
    ...
  }
}
Поля
stepId

string

Необязательное поле. Уникальный идентификатор шага в графе рабочего процесса.

outputs

map (key: string, value: object (VariableData))

Необязательное поле. Карта выходных переменных, созданных на этом шаге, с ключом по названию переменной.

Объект содержит список из нескольких пар ("key": value). Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

TriggerCreation

Создание триггера рабочего процесса.

JSON-представление
{
  "triggerId": string,
  "triggerType": enum (TriggerType),
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "notifyUri": string
}
Поля
triggerId

string

Уникальный идентификатор триггера, указанный при создании.

triggerType

enum (TriggerType)

Тип триггера.

inputs

map (key: string, value: object (VariableData))

Карта входных переменных, упорядоченных по названию.

Объект содержит список из нескольких пар ("key": value). Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

notifyUri

string

Конечная точка, которая будет вызываться при срабатывании триггера.

TriggerType

Тип триггера.

Перечисления
TRIGGER_TYPE_UNDEFINED Значение по умолчанию. DO NOT USE.
REPEATING Триггер будет срабатывать каждый раз, когда выполняются заданные условия.

TriggerDeletion

Удаление триггера рабочего процесса.

JSON-представление
{
  "triggerId": string
}
Поля
triggerId

string

Уникальный идентификатор триггера, указанный при создании.

ResourceRetrieval

Получение ресурса.

JSON-представление
{
  "resourceReference": {
    object (ResourceReference)
  }
}
Поля
resourceReference

object (ResourceReference)

Тип и идентификатор ресурса, который нужно получить.

ElementConfiguration

Вызов при настройке элемента рабочего процесса.

JSON-представление
{
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "displayDestination": enum (DisplayDestination),
  "nodeId": string,
  "workflowId": string,
  "availableVariables": [
    {
      object (VariableReference)
    }
  ]
}
Поля
inputs

map (key: string, value: object (VariableData))

Карта входных переменных, упорядоченных по названию. Эта карта может быть пустой. Используется при настройке одного элемента рабочего процесса (триггера или действия) на главной странице рабочего процесса.

Объект содержит список из нескольких пар ("key": value). Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

displayDestination

enum (DisplayDestination)

Целевая страница карточки конфигурации элемента. Элементы могут использовать это поле, чтобы возвращать разные макеты карточек конфигурации в зависимости от целевого сервиса.

nodeId

string

Идентификатор узла примитивной конфигурации, которая отрисовывается.

workflowId

string

Идентификатор рабочего процесса для отрисовываемой конфигурации примитива.

availableVariables[]

object (VariableReference)

Доступные переменные, упорядоченные по позиции узла.

DisplayDestination

Указывает, где будет показываться карточка конфигурации возвращаемого элемента.

Перечисления
DISPLAY_DESTINATION_UNSPECIFIED Значение по умолчанию. DO NOT USE.
DISPLAY_DESTINATION_SIDE_PANEL Карточка конфигурации будет показана на боковой панели.
DISPLAY_DESTINATION_FULL_SCREEN Карточка конфигурации будет показана в полноэкранном приложении.

VariableReference

Ссылка на переменную в рабочем процессе.

JSON-представление
{
  "parentElementId": string,
  "nodeId": string,
  "path": string,
  "dataType": {
    object (DataType)
  },
  "iconUrl": string,
  "stepNumber": integer,
  "descriptionText": string,
  "displayText": string
}
Поля
parentElementId

string

Примитивный идентификатор элемента, который создает переменную. При необходимости мы можем расширить его до WorkflowElement или более подробного прототипа метаданных.

nodeId

string

Идентификатор ссылки на узел

path

string

Подпись пути селектора переменных

dataType

object (DataType)

Тип данных переменной.

iconUrl

string

URL значка примитива, который создает эту переменную.

stepNumber

integer

Номер шага примитива, который создает эту переменную.

descriptionText

string

Описание переменной.

displayText

string

Текст, который будет показываться в чипе переменной.

DataType

Тип переменной.

JSON-представление
{
  "valueMetadata": {
    object (ValueMetadata)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "basicType": enum (BasicType),
  "resourceType": {
    object (ResourceType)
  }
  // End of mutually exclusive fields.
}
Поля
valueMetadata

object (ValueMetadata)

Метаданные о потенциальных значениях переменной.

Тип данных. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
basicType

enum (BasicType)

Базовый тип данных.

resourceType

object (ResourceType)

Тип идентификатора ресурса приложения.

Конец взаимоисключающих полей.

BasicType

Базовые общие типы данных.

Перечисления
BASIC_TYPE_UNSPECIFIED Значение по умолчанию. DO NOT USE.
STRING Строка символов.
INTEGER Целое число.
FLOAT Число с плавающей запятой.
TIMESTAMP Временная метка в формате ISO 8601.
BOOLEAN Значение, которое может быть истинным или ложным.
EMAIL_ADDRESS Адрес электронной почты, который представляет собой строку в формате адреса электронной почты.
GOOGLE_USER Пользователь сервисов Google в формате users/{user}.
FILE Ссылка на файл.
FORMATTED_TEXT Текст с расширенным форматированием.

ValueMetadata

Информация о возможных значениях переменной.

JSON-представление
{
  "enumValues": [
    string
  ],
  "dynamicTypes": [
    enum (BasicType)
  ],
  "semanticDescriptors": [
    {
      object (SemanticDescriptor)
    }
  ],
  "dynamicSchema": {
    object (DynamicSchema)
  },
  "defaultValue": string
}
Поля
enumValues[]

string

Необязательное поле. Указывает допустимые значения для строки. Может устанавливаться, только если для DataType задано значение STRING.

dynamicTypes[]

enum (BasicType)

Необязательное поле. Указывает разрешенные типы, которые можно динамически приводить для переменной. Это значение можно задать, только если DataType – строка, а переменная является выходной.

semanticDescriptors[]

object (SemanticDescriptor)

Необязательное поле. Помогает описать семантическое значение переменной.

dynamicSchema

object (DynamicSchema)

Необязательное поле. Конфигурация для динамического разрешения схемы этой переменной.

defaultValue

string

Необязательное поле. Строка, указывающая значение по умолчанию для этой переменной. Например, для логических значений параметр defaultValue может быть задан как true или false.

SemanticDescriptor

Метаданные о семантическом значении переменной.

JSON-представление
{
  "resourceAttribute": string,
  "disallowedResourceAttributes": [
    string
  ]
}
Поля
resourceAttribute

string

Указывает, что переменная соответствует определенному атрибуту ресурса. Это особенно полезно для переменных, которые представляют собой идентификатор ресурса (id, url, key и т. д.).

Рекомендуемый формат: - "{brand}/{appName}/{resource}:{attribute}" {brand} – необязательный элемент, который можно опустить, если он совпадает с {appName}.

Примеры: - "google/drive/file:id" - "google/drive/folder:id" - "google/docs/document:id" - "google/sheets/spreadsheet:id" - "jira/issue:key" - "slack/channel:id" и т. д.

Клиент будет использовать эту информацию, чтобы подсказывать пользователю, какие выходные переменные совместимы с определенными входными данными.

disallowedResourceAttributes[]

string

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

DynamicSchema

Конфигурация для динамического разрешения схемы этой переменной во время выполнения.

JSON-представление
{
  "requiredInputIds": [
    string
  ],
  "strictEnum": boolean
}
Поля
requiredInputIds[]

string

Идентификаторы родственных входных переменных, которые необходимо предоставить, прежде чем схема этой переменной может быть динамически разрешена.

strictEnum

boolean

Если задано значение true, значение переменной должно соответствовать одному из динамически разрешенных значений перечисления. Если задано значение False, динамически разрешенные значения обрабатываются как нестрогие предложения.

ResourceFieldsDefinitionRetrieval

Получает определение полей, поддерживаемых ресурсом.

JSON-представление
{
  "elementId": string,
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  }
}
Поля
elementId

string

Указывает идентификатор элемента, схему динамического ресурса которого нужно получить.

inputs

map (key: string, value: object (VariableData))

Она состоит из полей ввода узла, который предоставляет переменную. Карта входных переменных, упорядоченных по названию.

Объект содержит список из нескольких пар ("key": value). Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

ElementUiAutocomplete

Подсказки автозаполнения для текущей карточки.

JSON-представление
{
  "query": string,
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "invokedFunction": string,
  "resourceId": string,
  "operationId": string
}
Поля
query

string

Запрос для автозаполнения.

inputs

map (key: string, value: object (VariableData))

Карта входных переменных, упорядоченных по названию.

Объект содержит список из нескольких пар ("key": value). Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

invokedFunction

string

Вызываемая функция, связанная с виджетом.

resourceId

string

Идентификатор ресурса, для которого нужно выполнить автозаполнение. Это необязательное поле, которое может быть не заполнено.

operationId

string

Идентификатор операции, которая предоставила ресурс для автозаполнения. Это необязательное поле, которое может быть не заполнено.

ExecutionMetadata

Метаданные о выполнении рабочего процесса.

JSON-представление
{
  "versionId": integer,
  "timeZone": string,
  "stepNumber": integer
}
Поля
versionId

integer

Версия вызываемого элемента рабочего процесса.

timeZone

string

Часовой пояс сохраняемого рабочего процесса, например "America/Los_Angeles".

stepNumber

integer

Номер шага вызываемого примитива.

TriggerEventSource

Источник триггерного события, которое запустило это выполнение.

Перечисления
TRIGGER_EVENT_SOURCE_UNSPECIFIED Значение по умолчанию. DO NOT USE.
TRIGGER_EVENT_SOURCE_AUTOMATED Выполнение запускается автоматически при наступлении событий.
TRIGGER_EVENT_SOURCE_TEST_RUN Выполнение запускается через тестовый запуск.