Anda dapat menelusuri grup yang cocok dengan atribut tertentu dengan 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 oleh spasi kosong dan secara implisit digabungkan dengan
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: Parameter ini tidak dapat digunakan dengan parameter memberKey dalam kueri yang sama. |
memberKey |
string | =, |
Parameter kueri memberKey menampilkan semua grup yang memiliki keanggotaan pengguna atau grup. Nilai ini dapat berupa alamat email utama atau alias pengguna, alamat email utama atau alias grup, atau ID unik pengguna. Catatan: Parameter ini tidak dapat digunakan bersama dengan parameter email atau name dalam kueri yang sama. |
Jenis Nilai
| Jenis Nilai | Catatan |
|---|---|
| string | Apit dengan tanda kutip tunggal ' jika kueri berisi spasi kosong. Escape tanda kutip tunggal dalam kueri dengan \', misalnya 'Valentine\'s Day'. |
Operator
| Operator | Jenis Nilai yang Didukung | Catatan |
|---|---|---|
= |
string, boolean, angka, tanggal | Kolom dan nilai sama persis. Misalnya, name=contact cocok dengan semua grup dengan atribut name "contact", tetapi tidak dengan "contactgroup". Didukung di sebagian besar kolom string (lihat di atas). |
:{PREFIX}* |
string | Kolom diawali dengan nilai. Misalnya, kueri dengan email:support* cocok dengan grup dengan nilai email "supportgroup@", dan "support@", tetapi tidak dengan "contactsupport". Hanya didukung pada kumpulan kolom string terbatas (lihat di atas). |
Contoh
Semua kueri menggunakan metode groups.list, yang memiliki permintaan HTTP yang mirip dengan berikut (jeda baris disertakan agar mudah dibaca):
GET https://admin.googleapis.com/admin/directory/v1/groups ?domain=primary domain &query=query parameters
Parameter query harus dienkode URL. Misalnya, kueri
query=email:support* dienkode ke URL sebagai query=email%3Asupport*.
Semua contoh di halaman ini menampilkan parameter query yang tidak dienkode.
Library klien menangani encoding URL ini secara otomatis.
Menelusuri grup menurut nama tampilan
name='contact'
Menelusuri grup yang cocok dengan prefiks email
email:admin*
Menelusuri semua grup pengguna
memberKey=user@company.com
Menelusuri grup dengan nama dan email yang diawali dengan kontak
name:contact* email:contact*