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 kosong.

Mendukung jenis autentikasi berikut dengan cakupan otorisasi yang sesuai untuk membaca data yang diminta:

  • Autentikasi aplikasi dengan persetujuan administrator di Pratinjau Developer dengan salah satu cakupan otorisasi berikut:

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

  • Autentikasi pengguna dengan salah satu cakupan otorisasi berikut:

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

Untuk mencantumkan acara, pemanggil yang diautentikasi harus menjadi anggota ruang.

Untuk contohnya, lihat Mencantumkan peristiwa dari ruang Google Chat.

Permintaan HTTP

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

URL ini 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 akan menampilkan error INVALID_ARGUMENT.
pageToken

string

Opsional. Token halaman, diterima dari panggilan list space events sebelumnya. Berikan ini untuk mengambil halaman selanjutnya.

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

string

Wajib. Filter kueri.

Anda harus menentukan setidaknya satu jenis peristiwa (eventType) menggunakan operator has :. Untuk memfilter menurut beberapa jenis peristiwa, gunakan operator OR. Menghilangkan jenis peristiwa batch dalam filter Anda. Permintaan akan otomatis menampilkan peristiwa batch terkait. Misalnya, jika Anda memfilter menurut 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.

Secara opsional, Anda juga dapat memfilter berdasarkan waktu mulai (startTime) dan waktu berakhir (endTime):

  • startTime: Stempel waktu eksklusif dari mana harus mulai mencantumkan peristiwa ruang. Anda dapat mencantumkan acara 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, mencantumkan peristiwa hingga waktu permintaan.

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

Misalnya, kueri berikut 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 acara 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). Catatan: Kolom permissionSettings tidak ditampilkan dalam objek Ruang untuk permintaan daftar.
nextPageToken

string

Token kelanjutan yang digunakan untuk mengambil lebih banyak acara. Jika kolom ini dihilangkan, tidak akan ada halaman berikutnya.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.app.messages.readonly
  • https://www.googleapis.com/auth/chat.app.spaces
  • 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 mengetahui informasi selengkapnya, lihat Panduan otorisasi.