Grupy pasujące do określonych atrybutów możesz wyszukiwać za pomocą metody groups.list interfejsu Directory API. Ta metoda akceptuje parametr query, który jest zapytaniem łączącym co najmniej 1 klauzulę wyszukiwania. Każda klauzula wyszukiwania składa się
z 3 części:
- Pole
- Wyszukiwany atrybut grupy. Na przykład:
name. - Operator
- Test wykonywany na danych w celu znalezienia dopasowania. Na przykład operator
=sprawdza, czy atrybut tekstowy pasuje do wartości. - Wartość
- Zawartość testowanego atrybutu. Na przykład:
groupName.
Wiele klauzul jest rozdzielonych odstępami i domyślnie połączone operatorem AND.
Pola
| Pole | Typ wartości | Operatory | Opis |
|---|---|---|---|
email |
string, | = :{PREFIX}* |
Adres e-mail grupy. Uwaga: tej opcji nie można używać z parametrem memberKey w tym samym zapytaniu. |
name |
string, | = :{PREFIX}* |
Wyświetlana nazwa grupy. Uwaga: tej opcji nie można używać z parametrem memberKey w tym samym zapytaniu. |
memberKey |
string, | =, |
Parametr zapytania memberKey zwraca wszystkie grupy, do których należy użytkownik lub grupa. Może to być dowolny z podstawowych adresów e-mail użytkownika lub aliasów, podstawowy adres e-mail grupy, alias lub unikalny identyfikator użytkownika. Uwaga: tych parametrów nie można używać razem z parametrami email i name w tym samym zapytaniu. |
Typy wartości
| Typ wartości | Uwagi |
|---|---|
| string, | Jeśli zapytanie zawiera spacje, ujmij je w pojedyncze cudzysłowy '. Jeśli w zapytaniach używasz znaku \', zmień znaczenie pojedynczego cudzysłowu, np. 'Valentine\'s Day'. |
Operatory
| Operator | Obsługiwane typy wartości | Uwagi |
|---|---|---|
= |
string, boolean, number, date | Pole i wartość są dokładnie takie same. Na przykład name=contact pasuje do wszystkich grup z atrybutem name "contact", ale nie pasuje do "contactgroup". Obsługiwana w przypadku większości pól ciągu znaków (patrz wyżej). |
:{PREFIX}* |
string, | Pole zaczyna się od wartości. Na przykład zapytanie zawierające email:support* dopasowuje grupy z wartościami email "supportgroup@" i "support@", ale nie "contactsupport". Ta funkcja jest obsługiwana tylko w przypadku ograniczonej liczby pól ciągów tekstowych (patrz wyżej). |
Przykłady
Wszystkie zapytania korzystają z metody groups.list, która zawiera żądanie HTTP podobne do tego (podziały wierszy uwzględnione w celu zwiększenia czytelności):
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 adresem URL zakodowanym jako query=email%3Asupport*.
Wszystkie przykłady na tej stronie zawierają niezakodowane parametry query.
Biblioteki klienta automatycznie obsługują to kodowanie adresów URL.
Wyszukaj grupę według wyświetlanej nazwy
name='contact'
Wyszukaj grupy pasujące 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*