Method: spaces.spaceEvents.list

Mencantumkan peristiwa dari ruang Google Chat. Untuk setiap peristiwa, payload berisi versi terbaru resource Chat. Misalnya, jika Anda mencantumkan peristiwa tentang anggota ruang baru, server akan menampilkan resource Membership yang berisi detail keanggotaan terbaru. Jika anggota baru dihapus selama periode yang diminta, payload peristiwa akan berisi resource Membership yang kosong.

Memerlukan autentikasi pengguna. Untuk mencantumkan peristiwa, pengguna yang diautentikasi harus merupakan anggota ruang.

Sebagai contoh, lihat Mencantumkan peristiwa dari ruang Google Chat.

Permintaan HTTP

GET https://chat.googleapis.com/v1/{parent=spaces/*}/spaceEvents

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
parent

string

Wajib. Nama resource ruang Google Chat tempat peristiwa terjadi.

Format: spaces/{space}.

Parameter kueri

Parameter
pageSize

integer

Opsional. Jumlah maksimum peristiwa ruang yang ditampilkan. Layanan mungkin menampilkan lebih sedikit dari nilai ini.

Nilai negatif menampilkan error INVALID_ARGUMENT.
pageToken

string

Token halaman, yang diterima dari panggilan peristiwa ruang daftar sebelumnya. Berikan ini untuk mengambil halaman berikutnya.

Saat melakukan penomoran halaman, semua parameter lain yang disediakan untuk mencantumkan peristiwa ruang harus cocok dengan panggilan yang menyediakan token halaman. Meneruskan nilai yang berbeda ke parameter lain dapat menyebabkan hasil yang tidak diharapkan.
filter

string

Wajib. Filter kueri.

Anda harus menentukan setidaknya satu jenis peristiwa (eventType) menggunakan operator :. Untuk memfilter menurut beberapa jenis peristiwa, gunakan operator OR. Hapus jenis peristiwa batch di filter Anda. Permintaan akan otomatis menampilkan peristiwa batch terkait. Misalnya, jika Anda memfilter berdasarkan reaksi baru (google.workspace.chat.reaction.v1.created), server juga akan menampilkan peristiwa reaksi baru batch (google.workspace.chat.reaction.v1.batchCreated). Untuk mengetahui daftar jenis peristiwa yang didukung, lihat dokumentasi referensi SpaceEvents.

Jika ingin, Anda juga dapat memfilter menurut waktu mulai (startTime) dan waktu berakhir (endTime):

  • startTime: Stempel waktu eksklusif untuk mulai mencantumkan peristiwa ruang. Anda dapat membuat daftar peristiwa yang terjadi hingga 28 hari yang lalu. Jika tidak ditentukan, akan mencantumkan peristiwa ruang dari 28 hari terakhir.
  • endTime: Stempel waktu inklusif hingga peristiwa ruang dicantumkan. Jika tidak ditentukan, akan mencantumkan peristiwa hingga waktu permintaan.

Untuk menentukan waktu mulai atau berakhir, gunakan operator dan format = yang sama dengan di RFC-3339. Untuk memfilter menurut startTime dan endTime, gunakan operator AND.

Misalnya, kueri berikut ini valid:

startTime="2023-08-23T19:20:33+00:00" AND
endTime="2023-08-23T19:21:54+00:00"

startTime="2023-08-23T19:20:33+00:00" AND
(eventTypes:"google.workspace.chat.space.v1.updated" OR
eventTypes:"google.workspace.chat.message.v1.created")

Kueri berikut tidak valid:

startTime="2023-08-23T19:20:33+00:00" OR
endTime="2023-08-23T19:21:54+00:00"

eventTypes:"google.workspace.chat.space.v1.updated" AND
eventTypes:"google.workspace.chat.message.v1.created"

Kueri yang tidak valid ditolak oleh server dengan error INVALID_ARGUMENT.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Pesan respons untuk mencantumkan peristiwa ruang.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "spaceEvents": [
    {
      object (SpaceEvent)
    }
  ],
  "nextPageToken": string
}
Kolom
spaceEvents[]

object (SpaceEvent)

Hasil ditampilkan dalam urutan kronologis (peristiwa terlama terlebih dahulu).
nextPageToken

string

Token lanjutan digunakan untuk mengambil lebih banyak peristiwa. Jika kolom ini dihilangkan, tidak akan ada halaman berikutnya.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

Untuk informasi selengkapnya, lihat Panduan otorisasi.