Puoi cercare i gruppi che corrispondono a determinati attributi con il metodo groups.list dell'API Directory. Questo metodo accetta il parametro query, che è una query di ricerca che combina una o più clausole di ricerca. Ogni clausola di ricerca è composta
da tre parti:
- Campo
- Attributo di gruppo in cui viene eseguita la ricerca. Ad esempio,
name. - Operatore
- Test eseguito sui dati per fornire una corrispondenza. Ad esempio, l'operatore
=verifica se un attributo di testo corrisponde a un valore. - Valore
- I contenuti dell'attributo che viene testato. Ad esempio,
groupName.
Più clausole sono separate da spazi vuoti e sono unite implicitamente da un operatore AND.
Campi
| Campo | Tipo di valore | Operatori | Descrizione |
|---|---|---|---|
email |
stringa | = :{PREFIX}* |
L'indirizzo email del gruppo. Nota: non può essere utilizzato con il parametro memberKey nella stessa query. |
name |
stringa | = :{PREFIX}* |
Il nome visualizzato del gruppo. Nota: non può essere utilizzato con il parametro memberKey nella stessa query. |
memberKey |
stringa | =, |
Il parametro di query memberKey restituisce tutti i gruppi a cui un utente o gruppo è membro. Può essere qualsiasi indirizzo email principale o alias dell'utente, l'indirizzo email principale o alias di un gruppo o l'ID univoco di un utente. Nota: non può essere utilizzato insieme ai parametri email o name nella stessa query. |
Tipi di valore
| Tipo di valore | Note |
|---|---|
| stringa | Racchiudi tra virgolette singole ' se la query contiene spazi vuoti. Utilizza l'escape delle virgolette singole nelle query con \', ad esempio 'Valentine\'s Day'. |
Operatori
| Operatore | Tipi di valori supportati | Note |
|---|---|---|
= |
string, boolean, number, date | Il campo e il valore corrispondono esattamente. Ad esempio, name=contact corrisponde a tutti i gruppi con l'attributo name "contact", ma non "contactgroup". Supportato dalla maggior parte dei campi stringa (vedi sopra). |
:{PREFIX}* |
stringa | Il campo inizia con il valore. Ad esempio, una query con email:support* corrisponde a gruppi con valori email pari a "supportgroup@" e "support@" ma non a "contactsupport". Funzionalità supportata solo su un insieme limitato di campi stringa (vedi sopra). |
Esempi
Per tutte le query viene utilizzato il metodo groups.list, che ha una richiesta HTTP simile alla seguente (interruzioni di riga incluse per la leggibilità):
GET https://admin.googleapis.com/admin/directory/v1/groups ?domain=primary domain &query=query parameters
I parametri query devono avere la codifica URL. Ad esempio, la query query=email:support* è codificata nell'URL come query=email%3Asupport*.
Tutti gli esempi in questa pagina mostrano parametri query non codificati.
Le librerie client gestiscono automaticamente la codifica dell'URL in questione.
Cercare un gruppo per nome visualizzato
name='contact'
Cerca gruppi che corrispondono a un prefisso email
email:admin*
Cerca tutti i gruppi di un utente
memberKey=user@company.com
Cerca gruppi il cui nome e indirizzo email iniziano con il contatto
name:contact* email:contact*