Menampilkan daftar ruang dalam organisasi Google Workspace berdasarkan penelusuran administrator. Dalam permintaan, tetapkan useAdminAccess ke true. Untuk contoh, lihat Menelusuri dan mengelola ruang.
Memerlukan cakupan OAuth 2.0chat.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 maksimum ruang yang akan ditampilkan. Layanan mungkin menampilkan lebih sedikit 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.
pageToken
string
Token, diterima dari panggilan ruang penelusuran sebelumnya. Berikan parameter ini untuk mengambil halaman berikutnya.
Saat melakukan penomoran halaman, semua parameter lain yang diberikan harus sesuai dengan panggilan yang menyediakan token halaman. Meneruskan nilai yang berbeda ke parameter lain dapat menyebabkan hasil yang tidak terduga.
query
string
Wajib. Kueri penelusuran.
Anda dapat menelusuri 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 pertama-tama di-tokenisasi menjadi token dan setiap token dicocokkan dengan awalan secara tidak peka huruf besar/kecil dan secara 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.
externalUserAllowed menerima true atau false.
spaceHistoryState hanya menerima nilai dari kolom historyState resource space.
spaceType wajib diisi 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:
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 mengurutkan 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 apa pun di ruang ini.
[[["Mudah dipahami","easyToUnderstand","thumb-up"],["Memecahkan masalah saya","solvedMyProblem","thumb-up"],["Lainnya","otherUp","thumb-up"]],[["Informasi yang saya butuhkan tidak ada","missingTheInformationINeed","thumb-down"],["Terlalu rumit/langkahnya terlalu banyak","tooComplicatedTooManySteps","thumb-down"],["Sudah usang","outOfDate","thumb-down"],["Masalah terjemahan","translationIssue","thumb-down"],["Masalah kode / contoh","samplesCodeIssue","thumb-down"],["Lainnya","otherDown","thumb-down"]],["Terakhir diperbarui pada 2025-08-20 UTC."],[[["\u003cp\u003eReturns a paginated list of Google Workspace spaces based on an administrator's search criteria, including parameters like displayName, createTime, and spaceType.\u003c/p\u003e\n"],["\u003cp\u003eRequires administrator privileges and the \u003ccode\u003euseAdminAccess\u003c/code\u003e parameter set to \u003ccode\u003etrue\u003c/code\u003e in the request.\u003c/p\u003e\n"],["\u003cp\u003eUtilizes the \u003ccode\u003eGET https://chat.googleapis.com/v1/spaces:search\u003c/code\u003e HTTP request with query parameters for customization.\u003c/p\u003e\n"],["\u003cp\u003eNeeds authorization with either the \u003ccode\u003echat.admin.spaces\u003c/code\u003e or \u003ccode\u003echat.admin.spaces.readonly\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"],["\u003cp\u003eResponse body includes an array of spaces, a token for pagination, and an estimate of the total number of matching spaces.\u003c/p\u003e\n"]]],["To search for Google Workspace spaces, send a `GET` request to `https://chat.googleapis.com/v1/spaces:search`, ensuring admin privileges and setting `useAdminAccess` to `true`. Define the search using query parameters, including a required `query` to filter spaces (by `customer`, `displayName`, etc.), optional `pageSize` and `pageToken` for pagination, and optional `orderBy` for sorting. You must have one of the authorization scopes: `chat.admin.spaces` or `chat.admin.spaces.readonly`. The response will list spaces matching the query.\n"],null,[]]
