É possível pesquisar grupos que correspondem a determinados atributos com o método
groups.list da
API Directory. Esse método aceita o parâmetro query, que é uma consulta de pesquisa que combina uma ou mais cláusulas de pesquisa. Cada cláusula de pesquisa é composta por três partes:
- Campo
- Atributo de grupo pesquisado. Por exemplo,
name. - Operador
- Teste que é realizado nos dados para fornecer uma correspondência. Por exemplo, o operador
=testa se um atributo de texto corresponde a um valor. - Valor
- O conteúdo do atributo testado. Por exemplo,
groupName.
Várias cláusulas são separadas por espaços em branco e são agrupadas implicitamente por um operador AND.
Campos
| Campo | Tipo de valor | Operadores | Descrição |
|---|---|---|---|
email |
string | =, :{PREFIX}* |
O endereço de e-mail do grupo. Observação: não é possível usar esse parâmetro com memberKey na mesma consulta. |
name |
string | =, :{PREFIX}* |
O nome de exibição do grupo. Observação: não é possível usar com o parâmetro memberKey na mesma consulta. |
memberKey |
string | =, |
O parâmetro de consulta memberKey retorna todos os grupos em que um usuário ou grupo tem uma associação. Esse valor pode ser qualquer um dos endereços de e-mail principal ou alias do usuário, o endereço de e-mail principal ou alias de um grupo ou o ID exclusivo de um usuário. Observação: não é possível usar esse parâmetro com email ou name na mesma consulta. |
Tipos de valor
| Tipo de valor | Observações |
|---|---|
| string | Coloque entre aspas simples ' se a consulta tiver espaços em branco. Use \' para escapar de aspas simples em consultas, por exemplo, 'Valentine\'s Day'. |
Operadores
| Operador | Tipos de valor aceitos | Observações |
|---|---|---|
= |
string, booleano, número, data | O campo e o valor correspondem exatamente. Por exemplo, name=contact corresponde a todos os grupos com o atributo name "contact", mas não "contactgroup". Oferece suporte à maioria dos campos de string (consulte acima). |
:{PREFIX}* |
string | O campo começa com o valor. Por exemplo, uma consulta com email:support* corresponde a grupos com valores email de "supportgroup@" e "support@", mas não "contactsupport". Suporte limitado a um conjunto de campos de string (consulte acima). |
Exemplos
Todas as consultas usam o método groups.list, que tem uma solicitação HTTP semelhante a esta (quebras de linha incluídas para facilitar a leitura):
GET https://admin.googleapis.com/admin/directory/v1/groups ?domain=primary domain &query=query parameters
Os parâmetros query precisam ser codificados para uso em URLs. Por exemplo, a consulta
query=email:support* é codificada como URL como query=email%3Asupport*.
Todos os exemplos nesta página mostram parâmetros query não codificados.
As bibliotecas de cliente processam essa codificação de URL automaticamente.
Pesquisar um grupo pelo nome de exibição
name='contact'
Pesquisar grupos que correspondem a um prefixo de e-mail
email:admin*
Pesquisar todos os grupos de um usuário
memberKey=user@company.com
Pesquisar grupos com nome e e-mail que começam com contato
name:contact* email:contact*