Вы можете искать группы, соответствующие определенным атрибутам, с помощью метода groups.list API каталога. Этот метод принимает параметр query , который представляет собой поисковый запрос, объединяющий одно или несколько предложений поиска. Каждое предложение поиска состоит из трех частей:
- Поле
- Атрибут группы, по которому осуществляется поиск. Например,
name. - Оператор
- Тест, выполняемый с данными для обеспечения соответствия. Например, оператор
=проверяет, соответствует ли текстовый атрибут значению. - Ценить
- Содержимое проверяемого атрибута. Например,
groupName.
Несколько предложений разделяются пробелами и неявно соединяются оператором AND .
Поля
| Поле | Тип значения | Операторы | Описание |
|---|---|---|---|
email | нить | = , :{PREFIX}* | Адрес электронной почты группы. Примечание. Его нельзя использовать с memberKey в том же запросе. |
name | нить | = , :{PREFIX}* | Отображаемое имя группы. Примечание. Его нельзя использовать с memberKey в том же запросе. |
memberKey | нить | = , | Параметр memberKey возвращает все группы, в которых состоит пользователь или группа. Это значение может быть любым: основным или псевдонимом адреса электронной почты пользователя, основным или псевдонимом адреса электронной почты группы или уникальным идентификатором пользователя. Примечание. Его нельзя использовать вместе с параметрами email или name в одном запросе. |
Типы значений
| Тип значения | Примечания |
|---|---|
| нить | Заключите одинарные кавычки ' если запрос содержит пробелы. Экранируйте одинарные кавычки в запросах с помощью \' , например 'Valentine\'s Day' . |
Операторы
| Оператор | Поддерживаемые типы значений | Примечания |
|---|---|---|
= | строка, логическое значение, число, дата | Поле и значение точно совпадают. Например, name=contact соответствует всем группам с атрибутом name "contact" , но не "contactgroup" . Поддерживается в большинстве строковых полей ( см. выше ). |
:{PREFIX}* | нить | Поле начинается со значения. Например, запрос с email:support* сопоставляет группы со значениями email "supportgroup@" и "support@" но не "contactsupport" . Поддерживается только для ограниченного набора строковых полей ( см. выше ). |
Примеры
Все запросы используют метод groups.list , который имеет HTTP-запрос, аналогичный следующему (для удобства чтения включены разрывы строк):
GET https://admin.googleapis.com/admin/directory/v1/groups ?domain=primary domain &query=query parameters
Параметры query должны быть закодированы в URL. Например, query=email:support* — это URL-адрес, закодированный как query=email%3Asupport* . Во всех примерах на этой странице показаны незакодированные параметры query . Клиентские библиотеки автоматически обрабатывают это кодирование URL.
Поиск группы по отображаемому имени
name='contact'
Поиск групп, соответствующих префиксу электронной почты
email:admin*
Поиск всех групп пользователя
memberKey=user@company.com
Поиск групп по имени и адресу электронной почты, начинающимся с контакта.
name:contact* email:contact*