Możesz wyszukiwać grupy pasujące do określonych atrybutów za pomocą metody groups.list interfejsu Directory API. Ta metoda akceptuje parametr query, który jest zapytaniem wyszukiwania łączącym co najmniej 1 klauzulę wyszukiwania. Każda klauzula wyszukiwania składa się z 3 części:
- Pole
- Atrybut grupy, który jest wyszukiwany. Na przykład:
name. - Operator
- Test przeprowadzany na danych w celu dopasowania. Na przykład operator
=sprawdza, czy atrybut tekstowy pasuje do wartości. - Wartość
- Treść testowanego atrybutu. Na przykład:
groupName.
Poszczególne klauzule są oddzielone odstępami i połączone domyślnie operatorem AND.
Pola
| Pole | Typ wartości | Operatory | Opis |
|---|---|---|---|
email |
ciąg znaków | =, :{PREFIX}* |
Adres e-mail grupy. Uwaga: nie można go używać w tym samym zapytaniu co parametr memberKey. |
name |
ciąg znaków | =, :{PREFIX}* |
Wyświetlana nazwa grupy. Uwaga: nie można go używać w tym samym zapytaniu co parametr memberKey. |
memberKey |
ciąg znaków | =, |
Parametr zapytania memberKey zwraca wszystkie grupy, do których należy użytkownik lub grupa. Może to być podstawowy adres e-mail użytkownika lub alias adresu e-mail, podstawowy adres e-mail grupy lub alias adresu e-mail albo unikalny identyfikator użytkownika. Uwaga: nie można go używać w tym samym zapytaniu co parametry email lub name. |
Typy wartości
| Typ wartości | Uwagi |
|---|---|
| ciąg znaków | Jeśli zapytanie zawiera spacje, umieść je w apostrofach '. W zapytaniach używaj znaku \', aby uniknąć pojedynczych cudzysłowów, np. 'Valentine\'s Day'. |
Operatory
| Operator | Obsługiwane typy wartości | Uwagi |
|---|---|---|
= |
ciąg znaków, wartość logiczna, liczba, data | Pole i wartość muszą być dokładnie takie same. Na przykład name=contact pasuje do wszystkich grup z atrybutem name "contact", ale nie do "contactgroup". Obsługiwane w większości pól tekstowych (patrz wyżej). |
:{PREFIX}* |
ciąg znaków | Pole zaczyna się od wartości. Na przykład zapytanie z warunkiem email:support* pasuje do grup z wartościami email równymi "supportgroup@" i "support@", ale nie pasuje do grup z wartością "contactsupport". Obsługiwane tylko w przypadku ograniczonego zestawu pól tekstowych (patrz wyżej). |
Przykłady
Wszystkie zapytania używają metody groups.list, która ma żądanie HTTP podobne do tego (podziały wierszy zostały dodane dla 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 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 adresu URL.
Wyszukiwanie grupy według wyświetlanej nazwy
name='contact'
Wyszukiwanie grup pasujących do prefiksu adresu e-mail
email:admin*
Wyszukiwanie wszystkich grup użytkownika
memberKey=user@company.com
Wyszukaj grupy, których nazwa i adres e-mail zaczynają się od słowa „kontakt”
name:contact* email:contact*