Puedes buscar grupos que coincidan con ciertos atributos con el método groups.list de la API de Directory. Este método acepta el parámetro query, que es una búsqueda que combina una o más cláusulas de búsqueda. Cada cláusula de búsqueda consta de tres partes:
- Campo
- Es el 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
=verifica si un atributo de texto coincide con un valor. - Valor
- Es el contenido del atributo que se prueba. Por ejemplo,
groupName
Varias cláusulas se separan por 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}* |
Es 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 en los que un usuario o grupo tiene una membresía. Este valor puede ser cualquiera de las direcciones de correo electrónico principal 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 |
|---|---|---|
= |
cadena, 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 más arriba). |
:{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 más arriba). |
Ejemplos
Todas las consultas usan el método groups.list, 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 automáticamente.
Busca un grupo por nombre visible
name='contact'
Busca grupos que coincidan con un prefijo de correo electrónico
email:admin*
Busca todos los grupos de un usuario
memberKey=user@company.com
Buscar grupos con nombre y correo electrónico que comiencen con contacto
name:contact* email:contact*