Directory API'nin groups.list yöntemini kullanarak belirli özelliklerle eşleşen grupları arayabilirsiniz. Bu yöntem, bir veya daha fazla arama yan tümcesini birleştiren bir arama sorgusu olan query parametresini kabul eder. Her arama yan tümcesi üç bölümden oluşur:
- Alan
- Aranılan 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şip eşleşmediğini test eder. - Değer
- Test edilen özelliğin içeriği. Örneğin,
groupName.
Birden fazla yan tümce boşlukla ayrılır ve AND operatörüyle örtülü olarak birleştirilir.
Alanlar
| Alan | Değer Türü | Operatörler | Açıklama |
|---|---|---|---|
email |
dize | =, :{PREFIX}* |
Grubun e-posta adresi. Not: Bu parametre, aynı sorgudaki memberKey parametresiyle birlikte kullanılamaz. |
name |
dize | =, :{PREFIX}* |
Grubun görünen adı. Not: Bu parametre, aynı sorgudaki memberKey parametresiyle birlikte kullanılamaz. |
memberKey |
dize | =, |
memberKey sorgu parametresi, bir kullanıcının veya grubun üye olduğu tüm grupları döndürür. Bu değer, kullanıcının birincil veya takma ad e-posta adresi, bir grubun birincil veya takma ad e-posta adresi ya da kullanıcının benzersiz kimliği olabilir. Not: Bu parametre, aynı sorgudaki email veya name parametreleriyle birlikte kullanılamaz. |
Değer Türleri
| Değer Türü | Notlar |
|---|---|
| dize | Sorgu boşluk içeriyorsa tek tırnak işareti ' içine alın. Sorgulardaki tek tırnak işaretlerini \' ile 'Valentine\'s Day' gibi bir karakterle tırnak içine alın. |
Operatörler
| Operatör | Desteklenen Değer Türleri | Notlar |
|---|---|---|
= |
dize, boole, sayı, tarih | Alan ve değer tam olarak eşleşir. Örneğin, name=contact, name özelliği "contact" olan 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ında desteklenir (yukarıya bakın). |
Örnekler
Tüm sorgular, aşağıdakine benzer bir HTTP isteği içeren groups.list yöntemini kullanır (okunabilirlik için satır sonları dahil edilmiştir):
GET https://admin.googleapis.com/admin/directory/v1/groups ?domain=primary domain &query=query parameters
query parametreleri URL olarak kodlanmış olmalıdır. Örneğin, query=email:support* sorgusu URL olarak query=email%3Asupport* olarak kodlanır.
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 arama
name='contact'
E-posta ön ekiyle eşleşen grupları arama
email:admin*
Bir kullanıcının tüm gruplarını arama
memberKey=user@company.com
Adı ve e-postası "kişi" ile başlayan grupları arama
name:contact* email:contact*