Event

Peristiwa interaksi aplikasi Google Chat.

Untuk mempelajari peristiwa interaksi, lihat artikel Menerima dan merespons interaksi dengan aplikasi Google Chat Anda. Untuk mempelajari jenis peristiwa dan misalnya payload peristiwa, lihat Jenis peristiwa interaksi aplikasi Google Chat.

Representasi 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)
  }
}
Kolom
type

enum (EventType)

Jenis peristiwa interaksi. Untuk mengetahui detailnya, lihat Jenis peristiwa interaksi aplikasi Google Chat.

eventTime

string (Timestamp format)

Stempel waktu yang menunjukkan kapan peristiwa interaksi terjadi.

token

string

Nilai rahasia yang dapat digunakan aplikasi Chat lama untuk memverifikasi apakah permintaan berasal dari Google. Google membuat token secara acak, dan nilainya tetap statis. Anda dapat memperoleh, mencabut, atau membuat ulang token dari halaman konfigurasi Chat API di Konsol Google Cloud.

Aplikasi Chat modern tidak menggunakan kolom ini. Fitur ini tidak ada dalam respons API dan halaman konfigurasi Chat API.

threadKey

string

Kunci yang ditentukan aplikasi Chat untuk rangkaian pesan yang terkait dengan peristiwa interaksi. Lihat spaces.messages.thread.threadKey untuk mengetahui informasi selengkapnya.

message

object (Message)

Pesan yang memicu peristiwa interaksi, jika berlaku.

user

object (User)

Pengguna yang memicu peristiwa interaksi.

space

object (Space)

Ruang tempat peristiwa interaksi terjadi.

action

object (FormAction)

Untuk peristiwa interaksi CARD_CLICKED, data tindakan formulir terkait saat pengguna mengklik kartu atau dialog. Untuk mempelajari lebih lanjut, lihat Membaca input data formulir oleh pengguna di kartu.

configCompleteRedirectUrl

string

URL tempat aplikasi Chat akan mengalihkan pengguna setelah mereka menyelesaikan alur otorisasi atau konfigurasi di luar Google Chat. Untuk mengetahui informasi selengkapnya, lihat Menghubungkan aplikasi Chat dengan layanan & alat lainnya.

isDialogEvent

boolean

Untuk peristiwa interaksi CARD_CLICKED, apakah pengguna berinteraksi dengan dialog.

dialogEventType

enum (DialogEventType)

Jenis peristiwa interaksi dialog yang diterima.

common

object (CommonEventObject)

Menampilkan informasi tentang klien pengguna, seperti lokalitas, aplikasi host, dan platform. Untuk aplikasi Chat, CommonEventObject menyertakan informasi yang dikirimkan oleh pengguna yang berinteraksi dengan dialog, seperti data yang dimasukkan pada kartu.

CommonEventObject

Menampilkan informasi tentang klien pengguna, seperti lokalitas, aplikasi host, dan platform. Untuk aplikasi Chat, CommonEventObject menyertakan data yang dikirimkan oleh pengguna yang berinteraksi dengan kartu, seperti data yang dimasukkan dalam dialog.

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

string

locale.displayName lengkap dalam format [kode bahasa ISO 639]-[kode negara/wilayah ISO 3166] seperti "id-ID".

hostApp

enum (HostApp)

Enum hostApp yang menunjukkan aplikasi tempat add-on dipanggil. Selalu CHAT untuk aplikasi Chat.

platform

enum (Platform)

Enum platform yang menunjukkan platform tempat peristiwa berasal (WEB, IOS, atau ANDROID). Tidak didukung oleh aplikasi Chat.

timeZone

object (TimeZone)

ID zona waktu dan offset dari Waktu Universal Terkoordinasi (UTC). Hanya didukung untuk jenis peristiwa CARD_CLICKED dan SUBMIT_DIALOG.

formInputs

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

Peta yang berisi nilai yang dimasukkan pengguna di widget dari kartu atau dialog. Kunci peta adalah ID string yang ditetapkan untuk setiap widget, dan nilainya mewakili input untuk widget.

Untuk mengetahui detailnya, lihat Memproses informasi yang dimasukkan oleh pengguna.

parameters

map (key: string, value: string)

Parameter kustom yang diteruskan ke fungsi yang dipanggil. Kunci dan nilai harus berupa string.

invokedFunction

string

Nama fungsi yang dipanggil yang terkait dengan widget. Hanya disetel untuk aplikasi Chat.

TimeZone

ID zona waktu dan offset dari Waktu Universal Terkoordinasi (UTC). Hanya didukung untuk jenis peristiwa CARD_CLICKED dan SUBMIT_DIALOG.

Representasi JSON
{
  "id": string,
  "offset": integer
}
Kolom
id

string

Kode database zona waktu IANA TZ, seperti "America/Toronto".

offset

integer

Offset zona waktu pengguna, dalam milidetik, dari Waktu Universal Terkoordinasi (UTC).

Input

Jenis data yang dapat dimasukkan pengguna ke kartu atau dialog. Jenis input bergantung pada jenis nilai yang diterima widget.

Representasi 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.
}
Kolom

Kolom union inputs.

inputs hanya dapat berupa salah satu dari yang berikut:

stringInputs

object (StringInputs)

Daftar string yang mewakili nilai yang dimasukkan pengguna dalam widget.

Jika widget hanya menerima satu nilai, seperti widget TextInput, daftar akan berisi satu objek string. Jika widget menerima beberapa nilai, seperti kotak centang SelectionInput, daftar akan berisi objek string untuk setiap nilai yang dimasukkan atau dipilih pengguna.

dateTimeInput

object (DateTimeInput)

Nilai input tanggal dan waktu dari widget DateTimePicker yang menerima tanggal dan waktu.

dateInput

object (DateInput)

Nilai input tanggal dari widget DateTimePicker yang hanya menerima nilai tanggal.

timeInput

object (TimeInput)

Nilai input waktu dari widget DateTimePicker yang hanya menerima nilai waktu.

StringInputs

Parameter input untuk widget reguler. Untuk widget bernilai tunggal, merupakan daftar nilai tunggal. Untuk widget multi-nilai, seperti kotak centang, semua nilai ditampilkan.

Representasi JSON
{
  "value": [
    string
  ]
}
Kolom
value[]

string

Daftar string yang dimasukkan oleh pengguna.

DateTimeInput

Nilai input tanggal dan waktu.

Representasi JSON
{
  "msSinceEpoch": string,
  "hasDate": boolean,
  "hasTime": boolean
}
Kolom
msSinceEpoch

string (int64 format)

Waktu sejak waktu epoch, dalam milidetik.

hasDate

boolean

Apakah input datetime menyertakan tanggal kalender.

hasTime

boolean

Apakah input datetime menyertakan stempel waktu.

DateInput

Nilai input tanggal.

Representasi JSON
{
  "msSinceEpoch": string
}
Kolom
msSinceEpoch

string (int64 format)

Waktu sejak waktu epoch, dalam milidetik.

TimeInput

Nilai input waktu.

Representasi JSON
{
  "hours": integer,
  "minutes": integer
}
Kolom
hours

integer

Jam dalam format 24 jam.

minutes

integer

Jumlah menit setelah satu jam. Nilai yang valid adalah 0 hingga 59.