Anda dapat menelusuri grup yang cocok dengan atribut tertentu menggunakan metode
groups.list dari
Directory API. Metode ini menerima parameter query yang merupakan kueri
penelusuran yang menggabungkan satu atau beberapa klausa penelusuran. Setiap klausa penelusuran terdiri dari
tiga bagian:
- Kolom
- Atribut grup yang ditelusuri. Misalnya,
name. - Operator
- Pengujian yang dilakukan pada data untuk memberikan kecocokan. Misalnya, operator
=menguji apakah atribut teks cocok dengan nilai. - Nilai
- Konten atribut yang diuji. Misalnya,
groupName.
Beberapa klausa dipisahkan dengan spasi kosong dan secara implisit digabungkan oleh
operator AND.
Kolom
| Kolom | Jenis Nilai | Operator | Deskripsi |
|---|---|---|---|
email |
string | =, :{PREFIX}* |
Alamat email grup. Catatan: Parameter ini tidak dapat digunakan dengan parameter memberKey dalam kueri yang sama. |
name |
string | =, :{PREFIX}* |
Nama tampilan grup. Catatan: Ini tidak dapat digunakan dengan parameter memberKey dalam kueri yang sama. |
memberKey |
string | =, |
Parameter kueri memberKey menampilkan semua grup yang memiliki keanggotaan atau grup. Nilai ini dapat berupa alamat email utama atau alias, alamat email utama atau alias grup, atau ID unik pengguna. Catatan: Ini tidak dapat digunakan bersama dengan parameter email atau name dalam kueri yang sama. |
Jenis Nilai
| Jenis Nilai | Catatan |
|---|---|
| string | Mengapit dengan tanda kutip tunggal ' jika kueri berisi spasi kosong. Hapus tanda kutip tunggal dalam kueri dengan \', misalnya 'Valentine\'s Day'. |
Operator
| Operator | Jenis Nilai yang Didukung | Catatan |
|---|---|---|
= |
string, boolean, number, date | Kolom dan nilai sama persis. Misalnya, name=contact cocok dengan semua grup dengan atribut name "contact", tetapi tidak cocok dengan "contactgroup". Didukung pada sebagian besar kolom string (lihat di atas). |
:{PREFIX}* |
string | Kolom ini diawali dengan nilai. Misalnya, kueri dengan email:support* cocok dengan grup dengan nilai email "supportgroup@", dan "support@", tetapi tidak "contactsupport". Hanya didukung pada kumpulan kolom string yang terbatas (lihat di atas). |
Contoh
Semua kueri menggunakan metode groups.list, yang memiliki permintaan HTTP yang mirip dengan berikut ini (baris baru disertakan agar mudah dibaca):
GET https://admin.googleapis.com/admin/directory/v1/groups ?domain=primary domain &query=query parameters
Parameter query harus dienkode ke URL. Misalnya, kueri
query=email:support* adalah URL yang dienkode sebagai query=email%3Asupport*.
Semua contoh di halaman ini menampilkan parameter query yang tidak dienkode.
Library klien menangani encoding URL ini secara otomatis.
Telusuri grup berdasarkan nama tampilan
name='contact'
Telusuri grup yang cocok dengan awalan email
email:admin*
Telusuri semua grup pengguna
memberKey=user@company.com
Telusuri grup dengan nama dan email yang diawali dengan kontak
name:contact* email:contact*