Directory API'nin groups.list yöntemiyle belirli özelliklere uyan 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şip eşleşmediğini test eder. - Değer
- Test edilen özelliğin içeriği. Örneğin,
groupName.
Birden fazla madde boşlukla ayrılır ve örtülü 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 parametre, aynı sorguda memberKey parametresiyle birlikte kullanılamaz. |
name |
dize | =, :{PREFIX}* |
Grubun görünen adı. Not: Bu parametre, aynı sorguda memberKey parametresiyle birlikte kullanılamaz. |
memberKey |
dize | =, |
memberKey sorgu parametresi, bir kullanıcının veya grubun üyelik sahibi olduğu tüm grupları döndürür. Bu değer, 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 parametre, aynı sorguda 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çine alın. Sorgularda tek tırnak işaretlerini \' ile kaçırın. Örneğin, 'Valentine\'s Day'. |
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şlıyor. Örneğin, email:support* içeren bir sorgu, email değerleri "supportgroup@" ve "support@" olan gruplarla eşleşir ancak "contactsupport" olan gruplarla eşleşmez. Yalnızca sınırlı bir dize alanında desteklenir (yukarıya bakın). |
Örnekler
Tüm sorgular, aşağıdaki gibi bir HTTP isteğine sahip olan 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 olarak kodlanmalıdır. Örneğin, query=email:support* sorgusu query=email%3Asupport* olarak URL 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şiyle başlayan grupları arama
name:contact* email:contact*