Menampilkan daftar ruang di organisasi Google Workspace berdasarkan penelusuran administrator.
Memerlukan autentikasi pengguna dengan hak istimewa administrator. Dalam permintaan, tetapkan useAdminAccess
ke true
.
Permintaan HTTP
GET https://chat.googleapis.com/v1/spaces:search
URL menggunakan sintaksis gRPC Transcoding.
Parameter kueri
Parameter | |
---|---|
use |
Jika Pengguna yang menelepon harus merupakan administrator Google Workspace dengan hak istimewa mengelola percakapan chat dan ruang. Memerlukan cakupan OAuth 2.0 Metode ini saat ini hanya mendukung akses admin, sehingga hanya |
page |
Jumlah maksimum spasi 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 tersebut akan otomatis diubah menjadi 1.000. |
page |
Token, yang 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 memberikan hasil yang tidak diharapkan. |
query |
Wajib. Kueri penelusuran. Anda dapat menelusuri menggunakan parameter berikut:
Di berbagai kolom, hanya operator Di antara kolom yang sama, Contoh kueri berikut valid:
|
order |
Opsional. Cara pengurutan daftar ruang. Atribut yang didukung untuk diurutkan adalah:
Nilai operasi pengurutan yang valid adalah:
Sintaksis yang didukung adalah:
|
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 ( |
Kolom | |
---|---|
spaces[] |
Halaman dari ruang yang diminta. |
next |
Token yang dapat digunakan untuk mengambil halaman berikutnya. Jika kolom ini kosong, tidak ada halaman berikutnya. |
total |
Total jumlah spasi yang cocok dengan kueri, di semua halaman. Jika hasilnya lebih dari 10.000 spasi, nilai ini adalah estimasi. |
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 mengetahui informasi selengkapnya, lihat Panduan otorisasi.