Поиск групп, соответствующих определенным атрибутам, можно выполнить с помощью метода 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
Поиск групп по названию и адресу электронной почты, начинающимся с contact.
name:contact* email:contact*