Directory API'nin groups.list yöntemiyle belirli özelliklerle eşleşen grupları arayabilirsiniz. Bu yöntem, bir veya daha fazla arama ifadesini birleştiren bir arama sorgusu olan query parametresini kabul eder. Her arama ifadesi üç bölümden oluşur:
- Alan
- Aranan grup özelliği. Örneğin,
name. - Operatör
- Eşleşme sağlamak için veriler üzerinde gerçekleştirilen test. Örneğin,
=operatörü bir metin özelliğinin bir değerle eşleşmesi olup olmadığını test eder. - Değer
- Test edilen özelliğin içeriği. Örneğin,
groupName.
Birden fazla yan tümceler boşlukla ayrılır ve dolaylı olarak bir AND operatörüyle birleştirilir.
Alanlar
| Alan | Değer Türü | Operatörler | Açıklama |
|---|---|---|---|
email |
dize | =, :{PREFIX}* |
Grubun e-posta adresi. Not: Bu anahtar, aynı sorgu içinde memberKey parametresiyle kullanılamaz. |
name |
dize | =, :{PREFIX}* |
Grubun görünen adı. Not: Bu anahtar, aynı sorgu içinde memberKey parametresiyle kullanılamaz. |
memberKey |
dize | =, |
memberKey sorgu parametresi, bir kullanıcının veya grubun üyesi olduğu tüm grupları döndürür. Bu değer, herhangi bir kullanıcının birincil veya takma ad e-posta adresi, grubun birincil veya takma ad e-posta adresi ya da kullanıcının benzersiz kimliği olabilir. Not: Bu anahtar, aynı sorgu içinde email veya name parametreleriyle birlikte kullanılamaz. |
Değer Türleri
| Değer Türü | Notlar |
|---|---|
| dize | Sorguda boşluk varsa tek tırnak işaretleri ' içine alın. \' kullanan sorgularda tek tırnak için çıkış yapın (örneğin, 'Valentine\'s Day'). |
Operatörler
| Operatör | Desteklenen Değer Türleri | Notlar |
|---|---|---|
= |
string, boolean, number, date | Alan ve değer tam olarak eşleşiyor. Örneğin name=contact, name "contact" özelliğine sahip tüm gruplarla eşleşir ancak "contactgroup" ile eşleşmez. Çoğu dize alanında desteklenir (yukarıya bakın). |
:{PREFIX}* |
dize | Alan değerle başlar. Örneğin, email:support* içeren bir sorgu, email değerleri "supportgroup@" ve "support@" olan gruplarla eşleşir ancak "contactsupport" ile eşleşmez. Yalnızca sınırlı sayıda dize alanı grubunda desteklenir (yukarıya bakın). |
Örnekler
Tüm sorgular, aşağıdakine benzer bir HTTP isteğine sahip groups.list yöntemini kullanır (okunabilirlik için satır sonları eklenmiştir):
GET https://admin.googleapis.com/admin/directory/v1/groups ?domain=primary domain &query=query parameters
query parametreleri URL kodlamalı olmalıdır. Örneğin query=email:support* sorgusu, query=email%3Asupport* olarak kodlanmış URL'dir.
Bu sayfadaki tüm örneklerde kodlanmamış query parametreleri gösterilmektedir.
İstemci kitaplıkları bu URL kodlamasını otomatik olarak işler.
Görünen ada göre grup arayın
name='contact'
Bir e-posta önekiyle eşleşen grupları arama
email:admin*
Kullanıcının tüm gruplarını arama
memberKey=user@company.com
Ad ve e-posta adresi kişi ile başlayan grupları arayın
name:contact* email:contact*