Za pomocą metody groups.list interfejsu Directory API możesz wyszukiwać grupy pasujące do określonych atrybutów. Ta metoda akceptuje parametr query, który jest zapytaniem wyszukiwania zawierającym co najmniej 1 klauzulę wyszukiwania. Każda klauzula wyszukiwania składa się z 3 części:
- Pole
- Atrybut grupy, w którym jest przeprowadzane wyszukiwanie. Na przykład:
name. - Operator
- Test wykonywany na danych w celu zapewnienia dopasowania. Na przykład operator
=sprawdza, czy atrybut tekstowy pasuje do wartości. - Wartość
- Treści atrybutu, który jest testowany. Na przykład:
groupName.
Wiele klauzul jest oddzielonych od siebie spacjami i jest domyślnie połączonych operatorem AND.
Pola
| Pole | Typ wartości | Operatory | Opis |
|---|---|---|---|
email |
ciąg znaków | =, :{PREFIX}* |
Adres e-mail grupy. Uwaga: tego parametru nie można używać w tym samym zapytaniu z parametrem memberKey. |
name |
ciąg znaków | =, :{PREFIX}* |
Wyświetlana nazwa grupy. Uwaga: tego parametru nie można używać z parametrem memberKey w tym samym zapytaniu. |
memberKey |
ciąg znaków | =, |
Parametr zapytania memberKey zwraca wszystkie grupy, do których należy użytkownik lub grupa. Ta wartość może być dowolnym podstawowym adresem e-mail lub aliasem e-mail użytkownika, podstawowym adresem e-mail lub aliasem e-mail grupy albo unikalnym identyfikatorem użytkownika. Uwaga: tego parametru nie można używać razem z parametrami email ani name w tym samym zapytaniu. |
Typy wartości
| Typ wartości | Uwagi |
|---|---|
| ciąg znaków | Jeśli zapytanie zawiera spacje, ująć je w cudzysłowie '. W zapytaniach należy stosować cudzysłów pojedynczy z użyciem znaku \', np. 'Valentine\'s Day'. |
Operatory
| Operator | Obsługiwane typy wartości | Uwagi |
|---|---|---|
= |
ciąg znaków, wartość logiczna, liczba, data | Pole i wartość są identyczne. Na przykład reguła name=contact pasuje do wszystkich grup z atrybutem name "contact", ale nie "contactgroup". Obsługiwane w większości pól ciągu znaków (patrz wyżej). |
:{PREFIX}* |
ciąg znaków | Pole zaczyna się od wartości. Na przykład zapytanie z wartością email:support* pasuje do grup o wartościach email "supportgroup@" i "support@", ale nie "contactsupport". Obsługiwane tylko w przypadku ograniczonego zbioru pól ciągu znaków (patrz wyżej). |
Przykłady
Wszystkie zapytania korzystają z metody groups.list, która ma żądanie HTTP podobne do tego (przerwy w wierszach dodano w celu ułatwienia odczytania):
GET https://admin.googleapis.com/admin/directory/v1/groups ?domain=primary domain &query=query parameters
Parametry query muszą być zakodowane na potrzeby adresu URL. Na przykład zapytanie query=email:support* jest zakodowane w formacie adresu URL jako query=email%3Asupport*.
Wszystkie przykłady na tej stronie zawierają niezakodowane parametry query.
Biblioteki klienta automatycznie obsługują kodowanie adresów URL.
Wyszukaj grupę według wyświetlanej nazwy
name='contact'
Wyszukiwanie grup pasujących do prefiksu adresu e-mail
email:admin*
Wyszukaj wszystkie grupy użytkownika
memberKey=user@company.com
Wyszukaj grupy, których nazwa i adres e-mail zaczynają się od kontaktu
name:contact* email:contact*