- EventObject
- CommonEventObject
- HostApp
- Платформа
- TimeZone
- Входные данные
- StringInputs
- DateTimeInput
- DateInput
- TimeInput
- AuthorizationEventObject
- CalendarEventObject
- Организатор
- Участник
- ConferenceData
- ConferenceSolution
- Ключ
- EntryPoint
- Параметры
- AddOnParameters
- Возможности
- DriveEventObject
- DriveItemMetadata
- GmailEventObject
- SheetsEventObject
- MatchedUrl
- SlidesEventObject
- DocsEventObject
- ChatEventObject
- EventType
- MessagePayload
- AddedToSpacePayload
- RemovedFromSpacePayload
- ButtonClickedPayload
- DialogEventType
- WidgetUpdatedPayload
- AppCommandPayload
- AppCommandMetadata
- AppCommandType
- SystemCommandPayload
- SystemCommandMetadata
- CancelStream
- WorkflowEventObject
- ActionInvocation
- VariableData
- ResourceReference
- ResourceType
- WorkflowTextFormat
- TextFormatElement
- Чип
- Значок
- StyledText
- Стиль
- FontWeight
- WrapStyle
- Hyperlink
- ListContainer
- ListType
- ListItem
- FlowLevelContext
- StepContext
- TriggerCreation
- TriggerType
- TriggerDeletion
- ResourceRetrieval
- ElementConfiguration
- DisplayDestination
- VariableReference
- DataType
- BasicType
- ValueMetadata
- SemanticDescriptor
- DynamicSchema
- ResourceFieldsDefinitionRetrieval
- ElementUiAutocomplete
- ExecutionMetadata
- TriggerEventSource
EventObject
Событие взаимодействия с дополнением Google, которое содержит данные о взаимодействии пользователя с дополнением в родительском приложении.
Объект события передается в формате JSON в функцию обратного вызова или триггер дополнения (для Apps Script) или в конечную точку https (для HTTP), когда пользователь взаимодействует с дополнением в родительском приложении. Объект события хранит объект события родительского приложения, определенный каждым родительским приложением, а также общий объект события, содержащий некоторые общие поля, связанные с событием.
Подробнее об объектах событий…
| JSON-представление |
|---|
{ "commonEventObject": { object ( |
| Поля | |
|---|---|
commonEventObject |
Объект, содержащий информацию, общую для всех объектов событий, независимо от размещаемого приложения. |
authorizationEventObject |
Задается только для запросов к конечным точкам HTTP. |
| Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей: | |
calendar |
Присутствует, только если вызывающий хост – Google Календарь. Объект, содержащий информацию о календаре и мероприятии. |
drive |
Присутствует, только если вызывающим хостом является Google Диск. Объект, содержащий информацию о Диске. |
gmail |
Присутствует, только если вызывающий хост – Gmail. Объект, содержащий информацию о Gmail. |
sheets |
Присутствует, только если вызывающим хостом являются Google Таблицы. Объект, содержащий информацию о таблицах. |
slides |
Присутствует, только если вызывающим хостом является Google Презентации. Объект, содержащий информацию о слайдах. |
docs |
Присутствует, только если вызывающим хостом является Google Документы. Объект, содержащий информацию о Документах. |
chat |
Указывается, только если звонок был инициирован в Google Chat. Объект, содержащий информацию о чате. |
workflow |
Присутствует, только если вызывающим хостом является Google Workspace Studio. Объект, содержащий информацию о рабочем процессе. |
| Конец взаимоисключающих полей. | |
CommonEventObject
Общий объект события – это часть общего объекта события, которая передает общую, не зависящую от хоста информацию дополнению от клиента пользователя. К ним относятся, например, региональные настройки пользователя, хост-приложение и платформа.
Помимо триггеров главной страницы и контекстных триггеров, дополнения создают и передают объекты событий функциям обратного вызова действий, когда пользователь взаимодействует с виджетами. Функция обратного вызова дополнения может запрашивать объект общего события, чтобы определить содержимое открытых виджетов в клиенте пользователя. Например, ваше дополнение может найти текст, который пользователь ввел в виджет TextInput в объекте eventObject.commentEventObject.formInputs.
Для приложений Chat – название функции, которую пользователь вызвал при взаимодействии с виджетом.
| JSON-представление |
|---|
{ "userLocale": string, "hostApp": enum ( |
| Поля | |
|---|---|
userLocale |
По умолчанию отключено. Идентификатор языка и страны или региона пользователя в формате кода языка ISO 639 и кода страны или региона ISO 3166. Пример: Чтобы включить это поле, в манифесте дополнения нужно задать для |
hostApp |
Указывает на хост-приложение, в котором дополнение активно, когда создается объект события. Возможные значения:
|
platform |
Перечисление, указывающее на платформу, на которой произошло событие ( |
timeZone |
По умолчанию отключено. Идентификатор часового пояса и разница со всемирным координированным временем (UTC). Чтобы включить это поле, в манифесте дополнения нужно задать для Поддерживается только для типов событий |
formInputs |
Карта, содержащая текущие значения виджетов на отображаемой карточке. Ключи карты – это строковые значения Структура объекта значения карты зависит от типа виджета: Примечание. Приведенные ниже примеры отформатированы для среды выполнения V8 в Apps Script. Если вы используете среду выполнения Rhino, после значения необходимо добавить
Пример. Чтобы получить доступ к значению текстового ввода для виджета ввода текста с
Пример. Для виджета с несколькими значениями, у которого
Пример. Для окна выбора с
Пример. Для окна выбора с
Пример. Для окна выбора с Объект содержит список из нескольких пар ( |
parameters |
Любые дополнительные параметры, которые вы передаете действию с помощью Предварительная версия для разработчиков. Для дополнений, расширяющих возможности Google Chat, чтобы предлагать элементы на основе того, что пользователи вводят в меню с множественным выбором, используйте значение ключа Объект содержит список из нескольких пар ( |
invokedFunction |
Название вызываемой функции. Это поле не заполняется для дополнений Google Workspace, которые расширяют возможности Google Chat. Чтобы получать данные функций, например идентификаторы, дополнения, расширяющие 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 |
Код часового пояса из базы данных IANA TZ, например "America/Toronto". |
offset |
Смещение часового пояса пользователя в миллисекундах относительно всемирного координированного времени (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 |
Значения даты и времени, введенные в виджет |
dateInput |
Значения дат, введенные в виджет |
timeInput |
Значения времени, введенные в виджет |
| Конец взаимоисключающих полей. | |
StringInputs
Входной параметр для обычных виджетов. Для виджетов с одним значением это список с одним значением. Для виджетов с несколькими значениями, например флажков, показываются все значения.
| JSON-представление |
|---|
{ "value": [ string ] } |
| Поля | |
|---|---|
value[] |
Список строк, введенных пользователем. |
DateTimeInput
Значения даты и времени.
| JSON-представление |
|---|
{ "msSinceEpoch": string, "hasDate": boolean, "hasTime": boolean } |
| Поля | |
|---|---|
msSinceEpoch |
Время с начала эпохи в миллисекундах. |
hasDate |
Указывает, содержит ли входной параметр |
hasTime |
Включает ли входной параметр |
DateInput
Значения даты.
| JSON-представление |
|---|
{ "msSinceEpoch": string } |
| Поля | |
|---|---|
msSinceEpoch |
Время с начала эпохи в миллисекундах. |
TimeInput
Значения времени.
| JSON-представление |
|---|
{ "hours": integer, "minutes": integer } |
| Поля | |
|---|---|
hours |
Час в 24-часовом формате. |
minutes |
Минута часа. Допустимые значения: от 0 до 59. |
AuthorizationEventObject
Инкапсулирует информацию об авторизации для запроса дополнения.
| JSON-представление |
|---|
{ "userOAuthToken": string, "userIdToken": string, "systemIdToken": string, "authorizedScopes": [ string ] } |
| Поля | |
|---|---|
userOAuthToken |
Токен доступа OAuth конечного пользователя, авторизованный с запрошенными областями действия. (После разделения согласия OAuth это будет авторизовано с областями, авторизованными конечным пользователем) |
userIdToken |
Токен идентификатора пользователя, если запрашиваются соответствующие области действия идентификатора. |
systemIdToken |
Токен идентификатора для сервисного аккаунта дополнений G Suite для этого развертывания. |
authorizedScopes[] |
Список областей действия OAuth, авторизованных пользователем. |
CalendarEventObject
Объект события Календаря – это часть общего объекта события, которая содержит информацию о календаре пользователя и мероприятиях из календаря. Он присутствует в объекте события, только если хост-приложением является Google Календарь.
В таблице ниже перечислены поля, которые есть в поле calendar объекта события. Поля, помеченные как Данные, созданные пользователем, присутствуют в объекте события, только если данные есть в мероприятии из календаря и в дополнении для поля addOns.calendar.currentEventAccess манифеста задано значение READ или READ_WRITE.
| JSON-представление |
|---|
{ "id": string, "recurringEventId": string, "calendarId": string, "organizer": { object ( |
| Поля | |
|---|---|
id |
Идентификатор события. |
recurringEventId |
Идентификатор повторяющегося мероприятия. |
calendarId |
Идентификатор календаря. |
organizer |
Объект, представляющий организатора мероприятия. |
attendees[] |
Данные, созданные пользователями. Список участников мероприятия из календаря. |
conferenceData |
Данные, созданные пользователями. Объект, представляющий любые данные видеовстречи, связанные с этим мероприятием, например сведения о видеовстрече Google Meet. |
capabilities |
Данные, созданные пользователями. Объект, описывающий возможности дополнения по просмотру или обновлению информации о мероприятии. |
Организатор
| JSON-представление |
|---|
{ "email": string } |
| Поля | |
|---|---|
email |
Адрес электронной почты организатора мероприятия. |
Участник
Объекты 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 |
Адрес электронной почты участника. |
displayName |
Отображаемое имя участника. |
organizer |
true, если участник является организатором мероприятия. |
self |
true, если этот участник представляет календарь, в котором появляется это мероприятие; в противном случае – false. |
resource |
true, если участник представляет ресурс, например переговорную комнату или оборудование; false в противном случае. |
optional |
true, если участие этого участника отмечено как необязательное; false в противном случае. |
responseStatus |
Статус ответа участника. Возможные значения:
|
comment |
Комментарий участника, если он есть. |
additionalGuests |
Количество дополнительных гостей, которых участник планирует привести с собой. Значение по умолчанию равно нулю. |
ConferenceData
Объекты данных видеовстреч содержат информацию о видеовстречах, прикрепленных к мероприятиям Google Календаря. Это могут быть решения Google для видеовстреч, например Google Meet, или сторонние решения для видеовстреч. Эта информация присутствует в объекте события, только если она есть в мероприятии Календаря и в дополнении для поля addOns.calendar.currentEventAccess манифеста задано значение READ или READ_WRITE.
| JSON-представление |
|---|
{ "conferenceId": string, "conferenceSolution": { object ( |
| Поля | |
|---|---|
conferenceId |
Идентификатор видеовстречи. Этот идентификатор позволяет приложениям отслеживать видеовстречи. Не показывайте его пользователям. |
conferenceSolution |
Объект, представляющий решение для видеовстреч, например Hangouts или Google Meet. |
entryPoints[] |
Список точек входа в видеовстречу, например URL или номера телефонов. |
notes |
Дополнительные примечания (например, инструкции от администратора домена или юридические уведомления) о видеовстрече, которые будут показаны пользователю. Может содержать HTML-код. Максимальное число символов: 2048. |
parameters |
Объект, содержащий карту определенных данных параметров для использования дополнением. |
ConferenceSolution
| JSON-представление |
|---|
{
"iconUri": string,
"key": {
object ( |
| Поля | |
|---|---|
iconUri |
URI значка, который пользователи видят рядом с названием решения для видеовстреч. |
key |
Ключ, который уникальным образом идентифицирует решение для видеовстреч для этого мероприятия. |
name |
Название решения для видеовстреч, которое видят пользователи (не локализовано). |
Ключ
| JSON-представление |
|---|
{ "type": string } |
| Поля | |
|---|---|
type |
Тип решения для видеовстреч. Возможные значения:
|
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 |
Код доступа, использованный для подключения к видеовстрече. Максимальная длина – 128 символов. Как правило, поставщики услуг видеоконференций используют только часть параметров {accessCode, meetingCode, passcode, password, pin} для предоставления доступа к видеовстречам. Сопоставляйте и показывайте только те поля, которые использует поставщик видеоконференций. |
entryPointType |
Тип точки входа. Возможные значения:
|
label |
Видимый пользователю ярлык для URI точки входа (не локализован). |
meetingCode |
Код встречи, использованный для доступа к видеовстрече. Максимальная длина – 128 символов. Как правило, поставщики услуг видеоконференций используют только часть параметров {accessCode, meetingCode, passcode, password, pin} для предоставления доступа к видеовстречам. Сопоставляйте и показывайте только те поля, которые использует поставщик видеоконференций. |
passcode |
Код доступа, используемый для подключения к конференции. Максимальная длина – 128 символов. Как правило, поставщики услуг видеоконференций используют только часть параметров {accessCode, meetingCode, passcode, password, pin} для предоставления доступа к видеовстречам. Сопоставляйте и показывайте только те поля, которые использует поставщик видеоконференций. |
password |
Пароль, используемый для доступа к конференции. Максимальная длина – 128 символов. Как правило, поставщики услуг видеоконференций используют только часть параметров {accessCode, meetingCode, passcode, password, pin} для предоставления доступа к видеовстречам. Сопоставляйте и показывайте только те поля, которые использует поставщик видеоконференций. |
pin |
PIN-код, используемый для доступа к видеовстрече. Максимальная длина – 128 символов. Как правило, поставщики услуг видеоконференций используют только часть параметров {accessCode, meetingCode, passcode, password, pin} для предоставления доступа к видеовстречам. Сопоставляйте и показывайте только те поля, которые использует поставщик видеоконференций. |
uri |
URI точки входа. Максимальная длина – 1300 символов. Форматирование зависит от типа точки входа:
|
regionCode |
Код региона номера телефона. Требуется пользователям, если URI не содержит код страны. Значения основаны на общедоступном списке кодов регионов CLDR. |
entryPointFeatures[] |
Функции точки входа. В настоящее время эти функции применяются только к точкам входа по телефону:
|
Параметры
| JSON-представление |
|---|
{
"addOnParameters": {
object ( |
| Поля | |
|---|---|
addOnParameters |
Карта строковых ключей и значений параметров. Эти ключи и значения определяются разработчиком дополнения, чтобы прикреплять информацию к определенной видеовстрече для использования дополнением. |
AddOnParameters
| JSON-представление |
|---|
{ "parameters": { string: string, ... } } |
| Поля | |
|---|---|
parameters |
Объект содержит список из нескольких пар ( |
Возможности
| JSON-представление |
|---|
{ "canSeeAttendees": boolean, "canAddAttendees": boolean, "canSeeConferenceData": boolean, "canSetConferenceData": boolean, "canAddAttachments": boolean } |
| Поля | |
|---|---|
canSeeAttendees |
Данные, созданные пользователем. true, если дополнение может читать список участников мероприятия; false в противном случае. |
canAddAttendees |
Пользовательские данные. true, если дополнение может добавлять новых участников в список участников мероприятия; false в противном случае. |
canSeeConferenceData |
Пользовательские данные. true, если дополнение может считывать данные о видеовстрече, связанной с мероприятием; false в противном случае. |
canSetConferenceData |
Данные, созданные пользователем. true, если дополнение может обновлять данные о видеовстрече; false в противном случае. |
canAddAttachments |
Пользовательские данные. true, если дополнение может добавлять новые прикрепленные файлы к мероприятию; false в противном случае. |
DriveEventObject
Объект события Диска – это часть общего объекта события, которая содержит информацию о Google Диске пользователя и его содержимом. Он присутствует в объекте события, только если хост-приложением является Google Диск.
| JSON-представление |
|---|
{ "selectedItems": [ { object ( |
| Поля | |
|---|---|
selectedItems[] |
Список объектов (файлов или папок), выбранных на Диске. |
activeCursorItem |
Объект Диска, который сейчас активен. |
DriveItemMetadata
Объекты объектов Диска содержат информацию об определенных объектах Диска, таких как файлы или папки.
| JSON-представление |
|---|
{ "id": string, "iconUrl": string, "mimeType": string, "title": string, "addonHasFileScopePermission": boolean } |
| Поля | |
|---|---|
id |
Идентификатор выбранного объекта. |
iconUrl |
URL значка, представляющего выбранный объект. |
mimeType |
MIME-тип выбранного объекта. |
title |
Название выбранного объекта. |
addonHasFileScopePermission |
Если задано значение 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 |
Идентификатор открытого письма Gmail. |
threadId |
Идентификатор открытой цепочки писем Gmail. |
accessToken |
Токен доступа к Gmail. Этот токен можно использовать с методом |
toRecipients[] |
По умолчанию отключено. Список адресов электронной почты получателей, указанных в поле "Кому" в черновике, который создается дополнением. Чтобы включить это поле, задайте для поля |
ccRecipients[] |
По умолчанию отключено. Список адресов электронной почты получателей, указанных в поле "Копия" в черновике, который создается дополнением. Чтобы включить это поле, задайте для поля |
bccRecipients[] |
По умолчанию отключено. Список адресов электронной почты получателей скрытой копии, которые в настоящее время включены в черновик, создаваемый дополнением. Чтобы включить это поле, задайте для поля |
SheetsEventObject
Объект события Таблиц – это часть общего объекта события, которая содержит информацию о документе пользователя и его содержимом. Он присутствует в объекте события, только если дополнение расширяет Google Таблицы.
| JSON-представление |
|---|
{
"id": string,
"title": string,
"addonHasFileScopePermission": boolean,
"matchedUrl": {
object ( |
| Поля | |
|---|---|
id |
Присутствует, только если пользователь авторизовал область действия |
title |
Присутствует, только если пользователь авторизовал область действия |
addonHasFileScopePermission |
Если значение равно |
matchedUrl |
Показывается только при соблюдении следующих условий:
URL ссылки, которая генерирует предварительный просмотр в Google Таблицах. Чтобы использовать это поле, необходимо настроить Пример полезной нагрузки, когда пользователь просматривает ссылку |
MatchedUrl
Объект события, возвращаемый с запросами предварительного просмотра ссылок.
| JSON-представление |
|---|
{ "url": string } |
| Поля | |
|---|---|
url |
URL, который был сопоставлен. |
SlidesEventObject
Объект события Презентаций – это часть общего объекта события, которая содержит информацию о документе пользователя и его содержимом. Он присутствует в объекте события, только если дополнение расширяет Google Презентации.
| JSON-представление |
|---|
{
"id": string,
"title": string,
"addonHasFileScopePermission": boolean,
"matchedUrl": {
object ( |
| Поля | |
|---|---|
id |
Присутствует, только если пользователь авторизовал область действия |
title |
Присутствует, только если пользователь авторизовал область действия |
addonHasFileScopePermission |
Если значение равно |
matchedUrl |
Показывается только при соблюдении следующих условий:
URL ссылки, которая создает предварительный просмотр в Google Презентациях. Чтобы использовать это поле, необходимо настроить Пример полезной нагрузки, когда пользователь просматривает ссылку |
DocsEventObject
Объект события Документов – это часть общего объекта события, которая содержит информацию о документе пользователя и его содержимом. Он присутствует в объекте события, только если дополнение расширяет Google Документы.
| JSON-представление |
|---|
{
"id": string,
"title": string,
"addonHasFileScopePermission": boolean,
"matchedUrl": {
object ( |
| Поля | |
|---|---|
id |
Присутствует, только если пользователь авторизовал область действия |
title |
Присутствует, только если пользователь авторизовал область действия |
addonHasFileScopePermission |
Если значение равно |
matchedUrl |
Показывается только при соблюдении следующих условий:
URL ссылки, которая генерирует предварительный просмотр в Google Документах. Чтобы использовать это поле, необходимо настроить Пример полезной нагрузки, когда пользователь просматривает ссылку |
ChatEventObject
Полезная нагрузка объекта события приложения Google Chat, отправленная с сервера Google в дополнения. Полезную нагрузку можно использовать для определения типа события.
| JSON-представление |
|---|
{ "type": enum ( |
| Поля | |
|---|---|
type |
Тип события. Заполняется только для событий на главной странице приложения в приложениях Chat, которые не являются дополнениями. |
user |
Пользователь, который взаимодействует с приложением Chat. |
space |
Чат-группа, в которой произошло событие. Заполняется только для событий на главном экране приложения в приложениях Chat, которые не являются дополнениями. |
eventTime |
Временная метка, указывающая, когда происходит объект события. Используется формат RFC 3339. Результат всегда будет Z-нормализованным, и в нем будут использоваться цифры дробных частей 0, 3, 6 или 9. Допустимы и другие типы нормализации. Примеры: |
| Полезная нагрузка объекта события. Полезная нагрузка зависит от типа объекта события. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей: | |
messagePayload |
Пользователь отправляет сообщение приложению Chat или упоминает его в чат-группе. Вызовы команд приложения (например, слеш-команд и быстрых команд) доставляются в |
addedToSpacePayload |
Пользователь добавляет приложение Chat в чат-группу Google Chat, или администратор Google Workspace устанавливает приложение Chat в чаты для прямой переписки для пользователей в своей организации. |
removedFromSpacePayload |
Пользователь удаляет приложение Chat из чат-группы. |
buttonClickedPayload |
Представляет данные полезной нагрузки, когда пользователь взаимодействует с интерактивным элементом карточки или диалогового окна, который запускает обратный вызов Если пользователь взаимодействует с диалоговым окном, поле Полная полезная нагрузка также включает |
widgetUpdatedPayload |
Пользователь обновляет виджет на карточке в чате или в диалоговом окне. Полная полезная нагрузка также включает |
appCommandPayload |
Пользователь вызывает команду приложения. |
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 |
Обязательно. Чат-группа Google Chat, в которой происходит объект события. |
message |
Сообщение, которое активирует объект события. |
configCompleteRedirectUri |
Необязательное поле. URL, на который приложение Chat должно перенаправлять пользователя после завершения процесса авторизации или настройки за пределами Google Chat. Подробнее о том, как подключить приложение Chat к другим сервисам и инструментам… |
AddedToSpacePayload
Пользователь добавляет приложение Chat в чат-группу или создает прямую переписку с приложением.
| JSON-представление |
|---|
{
"space": {
object ( |
| Поля | |
|---|---|
space |
Обязательно. Чат-группа Google Chat, в которой происходит объект события. |
interactionAdd |
Было ли приложение добавлено в чат-группу в результате взаимодействия с пользователем (например, путем @ упоминания приложения Chat или вызова с помощью слеш-команды). Если задано значение true, с самим взаимодействием будет связан отдельный объект события, отправляемый в приложение Chat. |
configCompleteRedirectUri |
Необязательное поле. URL, на который приложение Chat должно перенаправлять пользователя после завершения процесса авторизации или настройки за пределами Google Chat. Подробнее о том, как подключить приложение Chat к другим сервисам и инструментам… |
RemovedFromSpacePayload
Пользователь удаляет приложение Chat из чат-группы.
| JSON-представление |
|---|
{
"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 |
Обязательно. Чат-группа Google Chat, в которой происходит объект события. |
message |
Сообщение, которое активирует объект события. |
isDialogEvent |
Для объектов событий |
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 |
Обязательно. Чат-группа Google Chat, в которой происходит объект события. |
AppCommandPayload
Пользователь вызывает команду приложения.
| JSON-представление |
|---|
{ "appCommandMetadata": { object ( |
| Поля | |
|---|---|
appCommandMetadata |
Заполняется для команд приложений, включая слеш-команды и быстрые команды. |
space |
Необязательное поле. Чат-группа Google Chat, в которой происходит объект события. |
thread |
Необязательное поле. Цепочка, в которой находится объект события (если применимо). Это поле заполняется, если объект события связан с определенным сообщением или цепочкой. |
message |
Необязательное поле. Сообщение, которое активирует объект события, если применимо. Это поле заполняется только для слеш-команд. |
configCompleteRedirectUri |
Необязательное поле. URL, на который пользователь должен быть перенаправлен после завершения процесса авторизации или настройки за пределами Google Chat. Подробнее о том, как подключить приложение Chat к другим сервисам и инструментам… |
isDialogEvent |
Необязательное поле. Взаимодействует ли пользователь с диалоговым окном или собирается это сделать. |
dialogEventType |
Необязательное поле. Тип полученного объекта события dialog. Это поле применяется, только если для параметра |
AppCommandMetadata
Метаданные о команде приложения Chat.
| JSON-представление |
|---|
{
"appCommandId": integer,
"appCommandType": enum ( |
| Поля | |
|---|---|
appCommandId |
Идентификатор команды, указанный в конфигурации Chat API. |
appCommandType |
Тип команды приложения Chat. |
AppCommandType
Тип команды приложения Chat. Подробнее о типах команд приложений Chat…
| Перечисления | |
|---|---|
APP_COMMAND_TYPE_UNSPECIFIED |
Значение по умолчанию. Не указано. |
SLASH_COMMAND |
Слеш-команда. Пользователь отправляет команду в сообщении Chat. |
QUICK_COMMAND |
Быстрая команда. Пользователь выбирает команду из меню Chat в области ответа на сообщение. |
MESSAGE_ACTION |
Действие с сообщением. Пользователь выбирает команду из контекстного меню сообщения в Chat. |
SystemCommandPayload
Пользователь вызывает системную команду.
| JSON-представление |
|---|
{ "systemCommandMetadata": { object ( |
| Поля | |
|---|---|
systemCommandMetadata |
Метаданные о вызванной системной команде. |
space |
Необязательное поле. Чат-группа Google Chat, в которой происходит объект события. |
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 |
Команда для отмены активного сообщения в чате. |
| Конец взаимоисключающих полей. | |
CancelStream
Команда для отмены активного сообщения в чате.
| JSON-представление |
|---|
{ "streamMessage": string } |
| Поля | |
|---|---|
streamMessage |
Обязательно. Название ресурса сообщения потока, для которого была выполнена команда отмены. Формат: |
WorkflowEventObject
LINT.IfChange Объект события, передаваемый дополнениям Workflow.
| JSON-представление |
|---|
{ "executionMetadata": { object ( |
| Поля | |
|---|---|
executionMetadata |
Метаданные о выполнении рабочего процесса. |
triggerEventSource |
Источник событий-триггеров. |
| Тип полезной нагрузки события рабочего процесса. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей: | |
actionInvocation |
Вызов действия рабочего процесса. |
triggerCreation |
Создание триггера рабочего процесса. |
triggerDeletion |
Удаление триггера рабочего процесса. |
resourceRetrieval |
Получение ресурса (используется для увеличения переменной). |
elementConfiguration |
Конфигурация элемента рабочего процесса. |
resourceFieldsDefinitionRetrieval |
Получение определений полей, поддерживаемых ресурсом. |
elementUiAutocomplete |
Подсказки автозаполнения для текущей карточки. |
| Конец взаимоисключающих полей. | |
ActionInvocation
Вызов действия рабочего процесса.
| JSON-представление |
|---|
{ "inputs": { string: { object ( |
| Поля | |
|---|---|
inputs |
Карта входных переменных, упорядоченных по названию. Объект содержит список из нескольких пар ( |
triggerId |
Идентификатор триггера, который будет использоваться для ответов на асинхронные действия. |
flowLevelContext |
Необязательное поле. Контекст на уровне процесса из предыдущих шагов. |
VariableData
Представляет переменную, которая может содержать несколько значений разных типов.
| JSON-представление |
|---|
{ "booleanValues": [ boolean ], "integerValues": [ string ], "floatValues": [ number ], "stringValues": [ string ], "timestampValues": [ string ], "resourceReferences": [ { object ( |
| Поля | |
|---|---|
booleanValues[] |
Логические значения. |
integerValues[] |
Целые числа. |
floatValues[] |
Значения с плавающей запятой. |
stringValues[] |
Строковые значения. |
timestampValues[] |
Значения временных меток. Используется формат RFC 3339. Результат всегда будет Z-нормализованным, и в нем будут использоваться цифры дробных частей 0, 3, 6 или 9. Допустимы и другие типы нормализации. Примеры: |
resourceReferences[] |
Ссылки на ресурсы (идентификаторы). |
emailAddressValues[] |
Значения адресов электронной почты. |
googleUserValues[] |
Значения пользователей Google в формате |
textFormatValues[] |
Значения формата текста рабочего процесса. |
ResourceReference
Идентификатор ресурса, относящегося к приложению.
| JSON-представление |
|---|
{
"resourceType": {
object ( |
| Поля | |
|---|---|
resourceType |
Тип ресурса, на который указывает этот идентификатор. |
resourceId |
Идентификатор ресурса. |
ResourceType
Название типа специального ресурса.
| JSON-представление |
|---|
{ "workflowBundleId": string, "workflowResourceDefinitionId": string } |
| Поля | |
|---|---|
workflowBundleId |
Идентификатор пакета рабочих процессов, которому принадлежит этот тип ресурса. Это необязательный параметр. Если он не указан, считается, что используется тот же пакет. |
workflowResourceDefinitionId |
Уникальный идентификатор ресурса. Идентификатор должен быть уникальным только в пределах одного пакета. |
WorkflowTextFormat
Блок текста с расширенными возможностями форматирования, включая стили, гиперссылки и интерактивные элементы.
| JSON-представление |
|---|
{
"textFormatElements": [
{
object ( |
| Поля | |
|---|---|
textFormatElements[] |
Набор элементов форматирования текста. |
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 ( |
| Поля | |
|---|---|
| Элемент, представляющий один из нескольких возможных элементов форматирования текста. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей: | |
text |
Текст в текстовом формате. |
chip |
Интерактивный чип в текстовом формате. |
styledText |
Форматированный текст в текстовом формате. |
hyperlink |
Гиперссылка в текстовом формате. |
listContainer |
Контейнер списка в текстовом формате. |
| Конец взаимоисключающих полей. | |
Чип
Интерактивный чип в текстовом формате.
| JSON-представление |
|---|
{
"icon": {
object ( |
| Поля | |
|---|---|
icon |
Значок, который показывается на чипе. |
label |
Текст, который показывается в чипе. |
url |
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 |
Показывать пользовательский значок, размещенный по URL с протоколом HTTPS. Пример: Поддерживаемые типы файлов: |
materialIconName |
Название значка, определенное в Google Material Icon, например |
| Конец взаимоисключающих полей. | |
StyledText
Текстовый элемент со стилями, такими как полужирный, курсив и цвет.
| JSON-представление |
|---|
{ "text": string, "styles": [ enum ( |
| Поля | |
|---|---|
text |
Основной текст. |
styles[] |
Набор стилей, примененных к тексту. |
fontWeight |
Насыщенность шрифта. |
color |
Цвет текста. |
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 |
Без переноса. |
Гиперссылка
Элемент гиперссылки с текстом и ссылкой.
| JSON-представление |
|---|
{ "link": string, "text": string } |
| Поля | |
|---|---|
link |
Целевой URL гиперссылки. |
text |
Текст гиперссылки. |
ListContainer
Контейнер для элементов списка, каждый из которых может содержать несколько элементов TextFormatElement.
| JSON-представление |
|---|
{ "listNestLevel": string, "listType": enum ( |
| Поля | |
|---|---|
listNestLevel |
Уровень вложенности списка. Для верхнего уровня используется значение 0, а для каждого вложенного списка оно увеличивается на 1. |
listType |
Тип списка. |
listItems[] |
Набор элементов списка. |
ListType
Перечисление для разных типов списков.
| Перечисления | |
|---|---|
LIST_TYPE_UNSPECIFIED |
Не указан тип списка. DO NOT USE. |
ORDERED |
Упорядоченный список. |
UNORDERED |
Маркированный список. |
BLOCKQUOTE |
Представляет список цитат. |
ListItem
Элемент списка.
| JSON-представление |
|---|
{
"textFormatElements": [
{
object ( |
| Поля | |
|---|---|
textFormatElements[] |
Набор элементов форматирования текста. |
FlowLevelContext
Контекст на уровне процесса, содержащий выходные данные предыдущих шагов.
| JSON-представление |
|---|
{
"stepContexts": [
{
object ( |
| Поля | |
|---|---|
stepContexts[] |
Необязательное поле. Список предыдущих шагов. Порядок имеет значение, поэтому убедитесь, что в этом списке он соблюдается. |
StepContext
Метаданные контекста шага и выходные данные для контекста на уровне потока.
| JSON-представление |
|---|
{
"stepId": string,
"outputs": {
string: {
object ( |
| Поля | |
|---|---|
stepId |
Необязательное поле. Уникальный идентификатор шага в графе рабочего процесса. |
outputs |
Необязательное поле. Карта выходных переменных, созданных на этом шаге, с ключом по названию переменной. Объект содержит список из нескольких пар ( |
TriggerCreation
Создание триггера рабочего процесса.
| JSON-представление |
|---|
{ "triggerId": string, "triggerType": enum ( |
| Поля | |
|---|---|
triggerId |
Уникальный идентификатор триггера, указанный при создании. |
triggerType |
Тип триггера. |
inputs |
Карта входных переменных, упорядоченных по названию. Объект содержит список из нескольких пар ( |
notifyUri |
Конечная точка, которая будет вызываться при срабатывании триггера. |
TriggerType
Тип триггера.
| Перечисления | |
|---|---|
TRIGGER_TYPE_UNDEFINED |
Значение по умолчанию. DO NOT USE. |
REPEATING |
Триггер будет срабатывать каждый раз, когда выполняются заданные условия. |
TriggerDeletion
Удаление триггера рабочего процесса.
| JSON-представление |
|---|
{ "triggerId": string } |
| Поля | |
|---|---|
triggerId |
Уникальный идентификатор триггера, указанный при создании. |
ResourceRetrieval
Получение ресурса.
| JSON-представление |
|---|
{
"resourceReference": {
object ( |
| Поля | |
|---|---|
resourceReference |
Тип и идентификатор ресурса, который нужно получить. |
ElementConfiguration
Вызов при настройке элемента рабочего процесса.
| JSON-представление |
|---|
{ "inputs": { string: { object ( |
| Поля | |
|---|---|
inputs |
Карта входных переменных, упорядоченных по названию. Эта карта может быть пустой. Используется при настройке одного элемента рабочего процесса (триггера или действия) на главной странице рабочего процесса. Объект содержит список из нескольких пар ( |
displayDestination |
Целевая страница карточки конфигурации элемента. Элементы могут использовать это поле, чтобы возвращать разные макеты карточек конфигурации в зависимости от целевого сервиса. |
nodeId |
Идентификатор узла примитивной конфигурации, которая отрисовывается. |
workflowId |
Идентификатор рабочего процесса для отрисовываемой конфигурации примитива. |
availableVariables[] |
Доступные переменные, упорядоченные по позиции узла. |
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 ( |
| Поля | |
|---|---|
parentElementId |
Примитивный идентификатор элемента, который создает переменную. При необходимости мы можем расширить его до WorkflowElement или более подробного прототипа метаданных. |
nodeId |
Идентификатор ссылки на узел |
path |
Подпись пути селектора переменных |
dataType |
Тип данных переменной. |
iconUrl |
URL значка примитива, который создает эту переменную. |
stepNumber |
Номер шага примитива, который создает эту переменную. |
descriptionText |
Описание переменной. |
displayText |
Текст, который будет показываться в чипе переменной. |
DataType
Тип переменной.
| JSON-представление |
|---|
{ "valueMetadata": { object ( |
| Поля | |
|---|---|
valueMetadata |
Метаданные о потенциальных значениях переменной. |
| Тип данных. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей: | |
basicType |
Базовый тип данных. |
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 ( |
| Поля | |
|---|---|
enumValues[] |
Необязательное поле. Указывает допустимые значения для строки. Может устанавливаться, только если для |
dynamicTypes[] |
Необязательное поле. Указывает разрешенные типы, которые можно динамически приводить для переменной. Это значение можно задать, только если DataType – строка, а переменная является выходной. |
semanticDescriptors[] |
Необязательное поле. Помогает описать семантическое значение переменной. |
dynamicSchema |
Необязательное поле. Конфигурация для динамического разрешения схемы этой переменной. |
defaultValue |
Необязательное поле. Строка, указывающая значение по умолчанию для этой переменной. Например, для логических значений параметр |
SemanticDescriptor
Метаданные о семантическом значении переменной.
| JSON-представление |
|---|
{ "resourceAttribute": string, "disallowedResourceAttributes": [ string ] } |
| Поля | |
|---|---|
resourceAttribute |
Указывает, что переменная соответствует определенному атрибуту ресурса. Это особенно полезно для переменных, которые представляют собой идентификатор ресурса (id, url, key и т. д.). Рекомендуемый формат: - Примеры: - Клиент будет использовать эту информацию, чтобы подсказывать пользователю, какие выходные переменные совместимы с определенными входными данными. |
disallowedResourceAttributes[] |
Необязательное поле. Применимо только для входных данных и игнорируется для выходных. Запрещенные атрибуты, соответствующие этому семантическому дескриптору. Клиент будет явно запрещать выбор переменных для выходных данных, соответствующих любому из этих запрещенных атрибутов ресурсов. |
DynamicSchema
Конфигурация для динамического разрешения схемы этой переменной во время выполнения.
| JSON-представление |
|---|
{ "requiredInputIds": [ string ], "strictEnum": boolean } |
| Поля | |
|---|---|
requiredInputIds[] |
Идентификаторы родственных входных переменных, которые необходимо предоставить, прежде чем схема этой переменной может быть динамически разрешена. |
strictEnum |
Если задано значение true, значение переменной должно соответствовать одному из динамически разрешенных значений перечисления. Если задано значение False, динамически разрешенные значения обрабатываются как нестрогие предложения. |
ResourceFieldsDefinitionRetrieval
Получает определение полей, поддерживаемых ресурсом.
| JSON-представление |
|---|
{
"elementId": string,
"inputs": {
string: {
object ( |
| Поля | |
|---|---|
elementId |
Указывает идентификатор элемента, схему динамического ресурса которого нужно получить. |
inputs |
Она состоит из полей ввода узла, который предоставляет переменную. Карта входных переменных, упорядоченных по названию. Объект содержит список из нескольких пар ( |
ElementUiAutocomplete
Подсказки автозаполнения для текущей карточки.
| JSON-представление |
|---|
{
"query": string,
"inputs": {
string: {
object ( |
| Поля | |
|---|---|
query |
Запрос для автозаполнения. |
inputs |
Карта входных переменных, упорядоченных по названию. Объект содержит список из нескольких пар ( |
invokedFunction |
Вызываемая функция, связанная с виджетом. |
resourceId |
Идентификатор ресурса, для которого нужно выполнить автозаполнение. Это необязательное поле, которое может быть не заполнено. |
operationId |
Идентификатор операции, которая предоставила ресурс для автозаполнения. Это необязательное поле, которое может быть не заполнено. |
ExecutionMetadata
Метаданные о выполнении рабочего процесса.
| JSON-представление |
|---|
{ "versionId": integer, "timeZone": string, "stepNumber": integer } |
| Поля | |
|---|---|
versionId |
Версия вызываемого элемента рабочего процесса. |
timeZone |
Часовой пояс сохраняемого рабочего процесса, например "America/Los_Angeles". |
stepNumber |
Номер шага вызываемого примитива. |
TriggerEventSource
Источник триггерного события, которое запустило это выполнение.
| Перечисления | |
|---|---|
TRIGGER_EVENT_SOURCE_UNSPECIFIED |
Значение по умолчанию. DO NOT USE. |
TRIGGER_EVENT_SOURCE_AUTOMATED |
Выполнение запускается автоматически при наступлении событий. |
TRIGGER_EVENT_SOURCE_TEST_RUN |
Выполнение запускается через тестовый запуск. |