Method: spaces.search

boolean

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

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

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

Menetapkan useAdminAccess ke false tersedia dalam Pratinjau Developer.

integer

Jumlah maksimum ruang yang akan ditampilkan. Layanan dapat menampilkan kurang dari nilai ini.

Jika tidak ditentukan, paling banyak 100 ruang akan ditampilkan.

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

string

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

Saat melakukan penomoran halaman, semua parameter lain yang disediakan harus sesuai dengan panggilan yang menyediakan token halaman. Meneruskan nilai yang berbeda ke parameter lain dapat menyebabkan hasil yang tidak terduga.

string

Wajib. Kueri penelusuran.

Anda dapat menelusuri menggunakan parameter berikut saat useAdminAccess ditetapkan ke true:

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

Jika useAdminAccess ditetapkan ke false:

• displayName
• externalUserAllowed

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

customer diperlukan saat useAdminAccess ditetapkan ke true, dan digunakan untuk menunjukkan pelanggan mana yang akan diambil ruangnya. customers/my_customer adalah satu-satunya nilai yang didukung.

displayName hanya menerima operator HAS (:) saja. Teks yang akan dicocokkan pertama-tama di-tokenisasi menjadi token dan setiap token dicocokkan dengan awalan secara tidak peka huruf besar/kecil dan independen sebagai substring di mana saja dalam displayName ruang. Misalnya, Fun Eve cocok dengan Fun event atau The evening was fun, tetapi tidak cocok dengan notFun event atau even. Jika useAdminAccess ditetapkan ke false, displayName diperlukan untuk mengambil hasil yang bermakna. Jika tidak, perilaku defaultnya adalah menampilkan respons kosong.

externalUserAllowed menerima true atau false.

spaceHistoryState hanya menerima nilai dari kolom historyState resource space.

spaceType diperlukan saat useAdminAccess ditetapkan ke true, 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 merepresentasikan interval, seperti lastActiveTime < "2022-01-01T00:00:00+00:00" AND lastActiveTime > "2023-01-01T00:00:00+00:00".

Contoh kueri berikut valid jika useAdminAccess ditetapkan ke true:

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")

Contoh kueri berikut valid jika useAdminAccess ditetapkan ke false:

displayName:"Hello World"

(displayName:"Hello" OR displayName:"Fun")

(externalUserAllowed = "true") // Returns an empty response.

(externalUserAllowed = "true" AND displayName:"Hello")

string

Opsional. Cara daftar ruang diurutkan.

Atribut yang didukung untuk diurutkan adalah:

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

Jika useAdminAccess adalah false, hanya createTime dan relevance yang didukung untuk pengurutan. Hanya DESC yang didukung untuk kolom ini dalam penelusuran non-admin.

Nilai operasi pengurutan yang valid adalah:

• ASC untuk naik. Nilai default.

• DESC untuk menurun.

Sintaksis yang didukung adalah saat useAdminAccess ditetapkan ke true:

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

Jika useAdminAccess ditetapkan ke false:

• createTime DESC
• relevance DESC

object (Space)

Hanya output. Ruang yang cocok.