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
- Atributo de grupo que se busca. Por ejemplo,
name
- Operador
- Es la prueba que se realiza en los datos para proporcionar una coincidencia. Por ejemplo, el operador
=
comprueba si un atributo de texto coincide con un valor. - Valor
- El contenido del atributo que se prueba. Por ejemplo,
groupName
Si hay varias cláusulas, se separan por espacios en blanco y se unen de forma implícita por un operador AND
.
Campos
Campo | Value Type | Operadores | Descripción |
---|---|---|---|
email |
cadena | = y :{PREFIX}* |
La dirección de correo electrónico del grupo. Nota: Esto no se puede usar con el parámetro memberKey en la misma consulta. |
name |
cadena | = y :{PREFIX}* |
El nombre visible del grupo Nota: Esto no se puede utilizar con el parámetro memberKey en la misma consulta. |
memberKey |
cadena | = , |
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 principales o de alias del usuario, la dirección de correo electrónico principal o del alias de un grupo, o bien el ID único de un usuario. Nota: Esto no se puede utilizar junto con los parámetros email o name en la misma consulta. |
Tipos de valores
Value Type | Notas |
---|---|
cadena | Rodea con comillas simples ' si la consulta contiene un espacio en blanco. Escapa las comillas simples en las consultas con \' , por ejemplo, 'Valentine\'s Day' . |
Operadores
Operador | Tipos de valores admitidos | Notas |
---|---|---|
= |
string, boolean, number, date | 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" . Es compatible con la mayoría de los campos de string (ver arriba). |
:{PREFIX}* |
cadena | 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 "contactsupport" . Solo se admite en un conjunto limitado de campos de string (consulta la sección anterior). |
Ejemplos
Todas las consultas usan el método groups.list
, que tiene una solicitud HTTP similar a la siguiente (saltos de línea incluidos 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 en formato URL. Por ejemplo, la consulta query=email:support*
está codificada como query=email%3Asupport*
como URL.
Todos los ejemplos de esta página muestran parámetros query
sin codificación.
Las bibliotecas cliente manejan esta codificación de URL automáticamente.
Buscar un grupo por nombre visible
name='contact'
Buscar grupos que coincidan con un prefijo de correo electrónico
email:admin*
Buscar todos los grupos de un usuario
memberKey=user@company.com
Buscar grupos cuyos nombres y correos electrónicos comiencen con un contacto
name:contact* email:contact*