Эта страница переведена с помощью Cloud Translation API.

Event

Представление JSON
CommonEventObject
- Представление JSON
Часовой пояс
- Представление JSON
Входы
- Представление JSON
Строковые входы
- Представление JSON
ДатаВремяВвод
- Представление JSON
ДатаВвод
- Представление JSON
ввод времени
- Представление JSON

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

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

Представление JSON

Представление JSON
{ "type": enum (`EventType`), "eventTime": string, "token": string, "threadKey": string, "message": { object (`Message`) }, "user": { object (`User`) }, "space": { object (`Space`) }, "action": { object (`FormAction`) }, "configCompleteRedirectUrl": string, "isDialogEvent": boolean, "dialogEventType": enum (`DialogEventType`), "common": { object (`CommonEventObject`) } }

{
  "type": enum (EventType),
  "eventTime": string,
  "token": string,
  "threadKey": string,
  "message": {
    object (Message)
  },
  "user": {
    object (User)
  },
  "space": {
    object (Space)
  },
  "action": {
    object (FormAction)
  },
  "configCompleteRedirectUrl": string,
  "isDialogEvent": boolean,
  "dialogEventType": enum (DialogEventType),
  "common": {
    object (CommonEventObject)
  }
}

Поля
`type`	`enum ( EventType )` Тип события взаимодействия. Дополнительные сведения см. в разделе Типы событий взаимодействия с приложением Google Chat .
`eventTime`	`string ( Timestamp format)` Отметка времени, указывающая, когда произошло событие взаимодействия.
`token`	`string` Секретное значение, которое устаревшие приложения Chat могут использовать для проверки того, исходит ли запрос от Google. Google случайным образом генерирует токен, и его значение остается неизменным. Вы можете получить, отозвать или повторно сгенерировать токен на странице конфигурации Chat API в Google Cloud Console. Современные приложения для чата не используют это поле. Он отсутствует в ответах API и на странице конфигурации Chat API .
`threadKey`	`string` Определенный приложением Chat ключ для цепочки, связанной с событием взаимодействия. См. `spaces.messages.thread.threadKey` для получения дополнительной информации.
`message`	`object ( Message )` Сообщение, вызвавшее событие взаимодействия, если применимо.
`user`	`object ( User )` Пользователь, инициировавший событие взаимодействия.
`space`	`object ( Space )` Пространство, в котором произошло событие взаимодействия.
`action`	`object ( FormAction )` Для событий взаимодействия `CARD_CLICKED` — данные действия формы, связанные, когда пользователь щелкает карточку или диалоговое окно. Дополнительные сведения см. в разделе Чтение данных, введенных пользователями на карточках .
`configCompleteRedirectUrl`	`string` URL-адрес, на который приложение Chat должно перенаправлять пользователя после завершения процесса авторизации или настройки за пределами Google Chat. Дополнительные сведения см. в разделе Подключение приложения чата к другим службам и инструментам .
`isDialogEvent`	`boolean` Для событий взаимодействия `CARD_CLICKED` — взаимодействовал ли пользователь с диалоговым окном .
`dialogEventType`	`enum ( DialogEventType )` Тип полученного события диалогового взаимодействия.
`common`	`object ( CommonEventObject )` Представляет информацию о клиенте пользователя, такую как языковой стандарт, хост-приложение и платформа. Для приложений чата `CommonEventObject` включает информацию, отправленную пользователями, взаимодействующими с диалогами , например данные, введенные на карточке.

CommonEventObject

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

Представление JSON

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

{
  "userLocale": string,
  "hostApp": enum (HostApp),
  "platform": enum (Platform),
  "timeZone": {
    object (TimeZone)
  },
  "formInputs": {
    string: {
      object (Inputs)
    },
    ...
  },
  "parameters": {
    string: string,
    ...
  },
  "invokedFunction": string
}

Поля
`userLocale`	`string` Полное `locale.displayName` в формате [код языка ISO 639]-[код страны/региона ISO 3166], например "en-US".
`hostApp`	`enum ( HostApp )` Перечисление hostApp, указывающее приложение, из которого вызывается надстройка. Всегда `CHAT` для приложений чата.
`platform`	`enum ( Platform )` Перечисление платформы, указывающее платформу, на которой происходит событие ( `WEB` , `IOS` или `ANDROID` ). Не поддерживается приложениями для чата.
`timeZone`	`object ( TimeZone )` Идентификатор часового пояса и смещение от всемирного координированного времени (UTC). Поддерживается только для типов событий `CARD_CLICKED` и `SUBMIT_DIALOG` .
`formInputs`	`map (key: string, value: object ( Inputs ))` Карта, содержащая текущие значения виджетов в карточке. Ключи карты — это строковые идентификаторы, назначенные каждому виджету, а значения представляют входные данные для виджета. В зависимости от типа входных данных каждый вход представляет отдельный объект: для виджетов с одним значением — `StringInput` . Для многозначных виджетов массив объектов `StringInput` . Для средства выбора даты и времени `DateTimeInput` . Для средства выбора только даты `DateInput` . Для средства выбора времени `TimeInput` . Соответствует данным, введенным пользователем на карточке в диалоге .
`parameters`	`map (key: string, value: string)` Пользовательские параметры, переданные вызываемой функции. И ключи, и значения должны быть строками.
`invokedFunction`	`string` Имя вызываемой функции, связанной с виджетом. Устанавливается только для приложений чата.

Часовой пояс

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

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

Поля

Поля
`id`	`string` Код базы данных часовых поясов IANA TZ , например «Америка/Торонто».
`offset`	`integer` Смещение часового пояса пользователя в миллисекундах от всеобщего скоординированного времени (UTC).

id

string

Код базы данных часовых поясов IANA TZ , например «Америка/Торонто».

offset

integer

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

Входы

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

Представление JSON

Представление JSON
{ // Union field `inputs` can be only one of the following: "stringInputs": { object (`StringInputs`) }, "dateTimeInput": { object (`DateTimeInput`) }, "dateInput": { object (`DateInput`) }, "timeInput": { object (`TimeInput`) } // End of list of possible types for union field `inputs`. }

{

  // Union field inputs can be only one of the following:
  "stringInputs": {
    object (StringInputs)
  },
  "dateTimeInput": {
    object (DateTimeInput)
  },
  "dateInput": {
    object (DateInput)
  },
  "timeInput": {
    object (TimeInput)
  }
  // End of list of possible types for union field inputs.
}

Поля
`inputs` поля объединения. `inputs` могут быть только одним из следующих:
`stringInputs`	`object ( StringInputs )` Входной параметр для обычных виджетов. Для виджетов с одним значением это список с одним значением. Для многозначных виджетов, таких как флажок, представлены все значения.
`dateTimeInput`	`object ( DateTimeInput )` Вводные значения даты и времени.
`dateInput`	`object ( DateInput )` Значения ввода даты.
`timeInput`	`object ( TimeInput )` Входные значения времени.

Строковые входы

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

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

Поля

Поля
`value[]`	`string` Массив строк, введенных пользователем.

value[]

string

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

ДатаВремяВход

Вводные значения даты и времени.

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

Поля

Поля
`msSinceEpoch`	`string ( int64 format)` Время с начала эпохи, в миллисекундах.
`hasDate`	`boolean` Включает ли ввод `datetime` календарную дату.
`hasTime`	`boolean` Включает ли ввод `datetime` и времени отметку времени.

msSinceEpoch

string ( int64 format)

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

hasDate

boolean

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

hasTime

boolean

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

ДатаВвод

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

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

Поля

Поля
`msSinceEpoch`	`string ( int64 format)` Время с начала эпохи, в миллисекундах.

msSinceEpoch

string ( int64 format)

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

ввод времени

Входные значения времени.

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

Поля

Поля
`hours`	`integer` Час в 24-часовом формате.
`minutes`	`integer` Количество минут после часа. Допустимые значения: от 0 до 59.

hours

integer

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

minutes

integer

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

Представление JSON
CommonEventObject
- Представление JSON
Часовой пояс
- Представление JSON
Входы
- Представление JSON
Строковые входы
- Представление JSON
ДатаВремяВход
- Представление JSON
ДатаВвод
- Представление JSON
ввод времени
- Представление JSON

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

Представление JSON

Представление JSON
{ "type": enum (`EventType`), "eventTime": string, "token": string, "threadKey": string, "message": { object (`Message`) }, "user": { object (`User`) }, "space": { object (`Space`) }, "action": { object (`FormAction`) }, "configCompleteRedirectUrl": string, "isDialogEvent": boolean, "dialogEventType": enum (`DialogEventType`), "common": { object (`CommonEventObject`) } }

{
  "type": enum (EventType),
  "eventTime": string,
  "token": string,
  "threadKey": string,
  "message": {
    object (Message)
  },
  "user": {
    object (User)
  },
  "space": {
    object (Space)
  },
  "action": {
    object (FormAction)
  },
  "configCompleteRedirectUrl": string,
  "isDialogEvent": boolean,
  "dialogEventType": enum (DialogEventType),
  "common": {
    object (CommonEventObject)
  }
}

Поля
`type`	`enum ( EventType )` Тип события взаимодействия. Дополнительные сведения см. в разделе Типы событий взаимодействия с приложением Google Chat .
`eventTime`	`string ( Timestamp format)` Отметка времени, указывающая, когда произошло событие взаимодействия.
`token`	`string` Секретное значение, которое устаревшие приложения Chat могут использовать для проверки того, исходит ли запрос от Google. Google случайным образом генерирует токен, и его значение остается неизменным. Вы можете получить, отозвать или повторно сгенерировать токен на странице конфигурации Chat API в Google Cloud Console. Современные приложения для чата не используют это поле. Он отсутствует в ответах API и на странице конфигурации Chat API .
`threadKey`	`string` Определенный приложением Chat ключ для цепочки, связанной с событием взаимодействия. См. `spaces.messages.thread.threadKey` для получения дополнительной информации.
`message`	`object ( Message )` Сообщение, вызвавшее событие взаимодействия, если применимо.
`user`	`object ( User )` Пользователь, инициировавший событие взаимодействия.
`space`	`object ( Space )` Пространство, в котором произошло событие взаимодействия.
`action`	`object ( FormAction )` Для событий взаимодействия `CARD_CLICKED` — данные действия формы, связанные, когда пользователь щелкает карточку или диалоговое окно. Дополнительные сведения см. в разделе Чтение данных, введенных пользователями на карточках .
`configCompleteRedirectUrl`	`string` URL-адрес, на который приложение Chat должно перенаправлять пользователя после завершения процесса авторизации или настройки за пределами Google Chat. Дополнительные сведения см. в разделе Подключение приложения чата к другим службам и инструментам .
`isDialogEvent`	`boolean` Для событий взаимодействия `CARD_CLICKED` — взаимодействовал ли пользователь с диалоговым окном .
`dialogEventType`	`enum ( DialogEventType )` Тип полученного события диалогового взаимодействия.
`common`	`object ( CommonEventObject )` Представляет информацию о клиенте пользователя, такую как языковой стандарт, хост-приложение и платформа. Для приложений чата `CommonEventObject` включает информацию, отправленную пользователями, взаимодействующими с диалогами , например данные, введенные на карточке.

CommonEventObject

Представление JSON

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

{
  "userLocale": string,
  "hostApp": enum (HostApp),
  "platform": enum (Platform),
  "timeZone": {
    object (TimeZone)
  },
  "formInputs": {
    string: {
      object (Inputs)
    },
    ...
  },
  "parameters": {
    string: string,
    ...
  },
  "invokedFunction": string
}

Поля
`userLocale`	`string` Полное `locale.displayName` в формате [код языка ISO 639]-[код страны/региона ISO 3166], например "en-US".
`hostApp`	`enum ( HostApp )` Перечисление hostApp, указывающее приложение, из которого вызывается надстройка. Всегда `CHAT` для приложений чата.
`platform`	`enum ( Platform )` Перечисление платформы, указывающее платформу, на которой происходит событие ( `WEB` , `IOS` или `ANDROID` ). Не поддерживается приложениями для чата.
`timeZone`	`object ( TimeZone )` Идентификатор часового пояса и смещение от всемирного координированного времени (UTC). Поддерживается только для типов событий `CARD_CLICKED` и `SUBMIT_DIALOG` .
`formInputs`	`map (key: string, value: object ( Inputs ))` Карта, содержащая текущие значения виджетов в карточке. Ключи карты — это строковые идентификаторы, назначенные каждому виджету, а значения представляют входные данные для виджета. В зависимости от типа входных данных каждый вход представляет отдельный объект: для виджетов с одним значением — `StringInput` . Для многозначных виджетов массив объектов `StringInput` . Для средства выбора даты и времени `DateTimeInput` . Для средства выбора только даты `DateInput` . Для средства выбора времени `TimeInput` . Соответствует данным, введенным пользователем на карточке в диалоге .
`parameters`	`map (key: string, value: string)` Пользовательские параметры, переданные вызываемой функции. И ключи, и значения должны быть строками.
`invokedFunction`	`string` Имя вызываемой функции, связанной с виджетом. Устанавливается только для приложений чата.

Часовой пояс

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

Поля

Поля
`id`	`string` Код базы данных часовых поясов IANA TZ , например «Америка/Торонто».
`offset`	`integer` Смещение часового пояса пользователя в миллисекундах от всеобщего скоординированного времени (UTC).

id

string

Код базы данных часовых поясов IANA TZ , например «Америка/Торонто».

offset

integer

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

Входы

Представление JSON

Представление JSON
{ // Union field `inputs` can be only one of the following: "stringInputs": { object (`StringInputs`) }, "dateTimeInput": { object (`DateTimeInput`) }, "dateInput": { object (`DateInput`) }, "timeInput": { object (`TimeInput`) } // End of list of possible types for union field `inputs`. }

{

  // Union field inputs can be only one of the following:
  "stringInputs": {
    object (StringInputs)
  },
  "dateTimeInput": {
    object (DateTimeInput)
  },
  "dateInput": {
    object (DateInput)
  },
  "timeInput": {
    object (TimeInput)
  }
  // End of list of possible types for union field inputs.
}

Поля
`inputs` поля объединения. `inputs` могут быть только одним из следующих:
`stringInputs`	`object ( StringInputs )` Входной параметр для обычных виджетов. Для виджетов с одним значением это список с одним значением. Для многозначных виджетов, таких как флажок, представлены все значения.
`dateTimeInput`	`object ( DateTimeInput )` Вводные значения даты и времени.
`dateInput`	`object ( DateInput )` Значения ввода даты.
`timeInput`	`object ( TimeInput )` Входные значения времени.

Строковые входы

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

Поля

Поля
`value[]`	`string` Массив строк, введенных пользователем.

value[]

string

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

ДатаВремяВход

Вводные значения даты и времени.

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

Поля

Поля
`msSinceEpoch`	`string ( int64 format)` Время с начала эпохи, в миллисекундах.
`hasDate`	`boolean` Включает ли ввод `datetime` календарную дату.
`hasTime`	`boolean` Включает ли ввод `datetime` и времени отметку времени.

msSinceEpoch

string ( int64 format)

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

hasDate

boolean

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

hasTime

boolean

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

ДатаВвод

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

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

Поля

Поля
`msSinceEpoch`	`string ( int64 format)` Время с начала эпохи, в миллисекундах.

msSinceEpoch

string ( int64 format)

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

ввод времени

Входные значения времени.

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

Поля

Поля
`hours`	`integer` Час в 24-часовом формате.
`minutes`	`integer` Количество минут после часа. Допустимые значения: от 0 до 59.

hours

integer

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

minutes

integer

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