Você pode pesquisar grupos que correspondam 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
de três partes:
- Campo
- Atributo de grupo pesquisado. Por exemplo,
name. - Operador
- Teste 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 implicitamente unidas por um operador AND.
Campos
| Campo | Tipo de valor | Operadores | Descrição |
|---|---|---|---|
email |
string | = e :{PREFIX}* |
O endereço de e-mail do grupo. Observação: isso não pode ser usado com o parâmetro memberKey na mesma consulta. |
name |
string | = e :{PREFIX}* |
O nome de exibição do grupo. Observação: isso não pode ser usado com o parâmetro memberKey na mesma consulta. |
memberKey |
string | =, |
O parâmetro de consulta memberKey retorna todos os grupos aos quais um usuário ou grupo tem uma associação. Esse valor pode ser qualquer endereço de e-mail principal, alias, endereço de e-mail principal ou alias de um grupo ou ID exclusivo de um usuário. Observação: isso não pode ser usado com os parâmetros email ou name na mesma consulta. |
Tipos de valor
| Tipo de valor | Observações |
|---|---|
| string | Coloque aspas simples ' se a consulta tiver espaços em branco. Escape de aspas simples em consultas com \', por exemplo, 'Valentine\'s Day'. |
Operadores
| Operador | Tipos de valores compatíveis | Observações |
|---|---|---|
= |
string, boolean, number, date | O campo e o valor correspondem exatamente. Por exemplo, name=contact corresponde a todos os grupos com o atributo name "contact", mas não com "contactgroup". Compatível com a maioria dos campos de string (confira 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 de "contactsupport". Compatível apenas com um conjunto limitado de campos de string (confira acima). |
Exemplos
Todas as consultas usam o método groups.list, que tem uma solicitação HTTP semelhante à seguinte (quebras de linha incluídas para legibilidade):
GET https://admin.googleapis.com/admin/directory/v1/groups ?domain=primary domain &query=query parameters
Os parâmetros query precisam ter codificação de URL. Por exemplo, a consulta
query=email:support* é um URL codificado como query=email%3Asupport*.
Todos os exemplos nesta página mostram parâmetros query não codificados.
As bibliotecas de cliente lidam com essa codificação de URL automaticamente.
Pesquisar um grupo por nome de exibição
name='contact'
Pesquisar grupos que correspondam 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 o contato
name:contact* email:contact*