Method: spaces.search

Menampilkan daftar ruang berdasarkan penelusuran pengguna. Memerlukan autentikasi pengguna. Pengguna harus menjadi administrator untuk organisasi Google Workspace. Dalam permintaan, tetapkan useAdminAccess ke true.

Permintaan HTTP

GET https://chat.googleapis.com/v1/spaces:search

URL menggunakan sintaksis gRPC Transcoding.

Parameter kueri

Parameter
useAdminAccess

boolean

Saat true, metode akan berjalan menggunakan hak istimewa administrator Google Workspace pengguna.

Pengguna yang menelepon harus merupakan administrator Google Workspace dengan hak istimewa mengelola percakapan chat dan ruang.

Memerlukan cakupan OAuth 2.0 chat.admin.spaces.readonly atau chat.admin.spaces.

Saat ini metode ini hanya mendukung akses admin, sehingga hanya true yang diterima untuk kolom ini.
pageSize

integer

Jumlah spasi maksimum yang akan ditampilkan. Layanan mungkin menampilkan lebih sedikit dari nilai ini.

Jika tidak ditentukan, maksimal 100 spasi akan ditampilkan.

Nilai maksimumnya adalah 1.000. Jika Anda menggunakan nilai lebih dari 1.000, nilai akan otomatis diubah menjadi 1.000.
pageToken

string

Token, yang diterima dari panggilan ruang penelusuran sebelumnya. Berikan parameter ini untuk mengambil halaman berikutnya.

Saat memberi nomor halaman, semua parameter lain yang diberikan harus cocok dengan panggilan yang menyediakan token halaman. Meneruskan nilai yang berbeda ke parameter lain dapat memberikan hasil yang tidak diharapkan.
query

string

Wajib diisi. Kueri penelusuran.

Anda dapat melakukan penelusuran menggunakan parameter berikut:

  • createTime
  • customer
  • displayName
  • externalUserAllowed
  • lastActiveTime
  • spaceHistoryState
  • spaceType

createTime dan lastActiveTime menerima stempel waktu dalam format RFC-3339 dan operator perbandingan yang didukung adalah: =, <, >, <=, >=.

customer diperlukan dan digunakan untuk menunjukkan pelanggan mana yang akan diambil ruangnya. customers/my_customer adalah satu-satunya nilai yang didukung.

displayName hanya menerima operator HAS (:). Teks yang akan dicocokkan akan ditokenkan terlebih dahulu menjadi token dan setiap token dicocokkan dengan awalan yang tidak peka huruf besar/kecil dan secara terpisah sebagai substring di mana pun dalam displayName ruang. Misalnya, Fun Eve cocok dengan Fun event atau The evening was fun, tetapi tidak dengan notFun event atau even.

externalUserAllowed menerima true atau false.

spaceHistoryState hanya menerima nilai dari kolom historyState dari resource space.

spaceType wajib ada dan satu-satunya nilai yang valid adalah SPACE.

Di berbagai kolom, hanya operator AND yang didukung. Contoh yang valid adalah spaceType = "SPACE" AND displayName:"Hello" dan contoh yang tidak valid adalah spaceType = "SPACE" OR displayName:"Hello".

Di antara kolom yang sama, spaceType tidak mendukung operator AND atau OR. displayName, 'spaceHistoryState', dan 'externalUserAllowed' hanya mendukung operator OR. lastActiveTime dan createTime mendukung operator AND dan OR. AND hanya dapat digunakan untuk mewakili interval, seperti lastActiveTime < "2022-01-01T00:00:00+00:00" AND lastActiveTime > "2023-01-01T00:00:00+00:00".

Contoh kueri berikut valid:

customer = "customers/my_customer" AND spaceType = "SPACE"

customer = "customers/my_customer" AND spaceType = "SPACE" AND
displayName:"Hello World"

customer = "customers/my_customer" AND spaceType = "SPACE" AND
(lastActiveTime < "2020-01-01T00:00:00+00:00" OR lastActiveTime >
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND spaceType = "SPACE" AND
(displayName:"Hello World" OR displayName:"Fun event") AND
(lastActiveTime > "2020-01-01T00:00:00+00:00" AND lastActiveTime <
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND spaceType = "SPACE" AND
(createTime > "2019-01-01T00:00:00+00:00" AND createTime <
"2020-01-01T00:00:00+00:00") AND (externalUserAllowed = "true") AND
(spaceHistoryState = "HISTORY_ON" OR spaceHistoryState = "HISTORY_OFF")
orderBy

string

Opsional. Cara pengurutan daftar ruang.

Atribut yang didukung untuk diurutkan adalah:

  • membershipCount.joined_direct_human_user_count — Menunjukkan jumlah pengguna manusia yang telah bergabung langsung ke ruang.
  • lastActiveTime — Menunjukkan waktu saat item terakhir yang memenuhi syarat ditambahkan ke topik mana pun di ruang ini.
  • createTime — Menunjukkan waktu pembuatan ruang.

Nilai operasi pengurutan yang valid adalah:

  • ASC untuk menaik. Nilai default.

  • DESC untuk menurun.

Sintaksis yang didukung adalah:

  • membershipCount.joined_direct_human_user_count DESC
  • membershipCount.joined_direct_human_user_count ASC
  • lastActiveTime DESC
  • lastActiveTime ASC
  • createTime DESC
  • createTime ASC

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Respons dengan daftar ruang yang sesuai dengan permintaan ruang penelusuran.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "spaces": [
    {
      object (Space)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Kolom
spaces[]

object (Space)

Halaman dari ruang yang diminta.
nextPageToken

string

Token yang dapat digunakan untuk mengambil halaman berikutnya. Jika kolom ini kosong, tidak ada halaman berikutnya.
totalSize

integer

Total jumlah spasi yang cocok dengan kueri, di semua halaman. Jika hasilnya melebihi 10.000 spasi, nilai ini adalah perkiraan.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces.readonly

Untuk informasi selengkapnya, lihat Panduan otorisasi.