Puedes buscar grupos que coincidan con ciertos atributos con el
groups.list método de la
API de Directory. Este método acepta el parámetro query, que es una consulta de búsqueda que combina una o más cláusulas de búsqueda. Cada cláusula de búsqueda se compone de tres partes:
- Campo
- Atributo de grupo que se busca. Por ejemplo,
name. - Operador
- Prueba que se realiza en los datos para proporcionar una coincidencia. Por ejemplo, el operador
=prueba si un atributo de texto coincide con un valor. - Valor
- El contenido del atributo que se prueba. Por ejemplo,
groupName.
Las cláusulas múltiples se separan con espacios en blanco y se unen de forma implícita con un operador AND.
Campos
| Campo | Tipo de valor | Operadores | Descripción |
|---|---|---|---|
email |
string | =, :{PREFIX}* |
La dirección de correo electrónico del grupo. Nota: No se puede usar con el parámetro memberKey en la misma consulta. |
name |
string | =, :{PREFIX}* |
El nombre visible del grupo. Nota: No se puede usar con el parámetro memberKey en la misma consulta. |
memberKey |
string | =, |
El parámetro de consulta memberKey muestra todos los grupos para los que un usuario o grupo tiene una membresía. Este valor puede ser cualquiera de las direcciones de correo electrónico principales o de alias del usuario, la dirección de correo electrónico principal o de alias de un grupo, o el ID único de un usuario. Nota: No se puede usar junto con los parámetros email o name en la misma consulta. |
Tipos de valores
| Tipo de valor | Notas |
|---|---|
| string | Encierra entre comillas simples ' si la consulta contiene espacios en blanco. Escapa las comillas simples en las consultas con \', por ejemplo, 'Valentine\'s Day'. |
Operadores
| Operador | Tipos de valores admitidos | Notas |
|---|---|---|
= |
string, booleano, número, fecha | El campo y el valor coinciden exactamente. Por ejemplo, name=contact coincide con todos los grupos con el atributo name "contact", pero no con "contactgroup". Se admite en la mayoría de los campos de cadena (consulta lo anterior). |
:{PREFIX}* |
string | El campo comienza con el valor. Por ejemplo, una consulta con email:support* coincide con grupos con valores email de "supportgroup@", y "support@" pero no con "contactsupport". Solo se admite en un conjunto limitado de campos de cadena (consulta lo anterior). |
Ejemplos
Todas las consultas usan el groups.list
método, que tiene una solicitud HTTP similar a la siguiente (se incluyen saltos de línea para facilitar la lectura):
GET https://admin.googleapis.com/admin/directory/v1/groups ?domain=primary domain &query=query parameters
Los parámetros query deben estar codificados como URL. Por ejemplo, la consulta query=email:support* se codifica como URL como query=email%3Asupport*.
En todos los ejemplos de esta página, se muestran parámetros query sin codificar.
Las bibliotecas cliente controlan esta codificación de URL de forma automática.
Cómo buscar un grupo por nombre visible
name='contact'
Cómo buscar grupos que coincidan con un prefijo de correo electrónico
email:admin*
Cómo buscar todos los grupos de un usuario
memberKey=user@company.com
Cómo buscar grupos con nombre y correo electrónico que comiencen con contacto
name:contact* email:contact*