Puoi cercare gruppi corrispondenti 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 del gruppo per cui viene eseguita la ricerca. Ad esempio,
name. - Operatore
- Test eseguito sui dati per trovare una corrispondenza. Ad esempio, l'operatore
=verifica se un attributo di testo corrisponde a un valore. - Valore
- I contenuti dell'attributo sottoposto a test. Ad esempio,
groupName.
Più clausole sono separate da spazi 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 di cui un utente o un gruppo è membro. Questo valore 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 valori
| Tipo di valore | Note |
|---|---|
| stringa | Racchiudi la query tra virgolette singole ' se contiene spazi vuoti. Inserisci un carattere di escape per le virgolette singole nelle query con \', ad esempio 'Valentine\'s Day'. |
Operatori
| Operatore | Tipi di valori supportati | Note |
|---|---|---|
= |
stringa, booleano, numero, data | Il campo e il valore corrispondono esattamente. Ad esempio, name=contact corrisponde a tutti i gruppi con l'attributo name "contact", ma non a "contactgroup". Supportato dalla maggior parte dei campi di stringa (vedi sopra). |
:{PREFIX}* |
stringa | Il campo inizia con il valore. Ad esempio, una query con email:support* corrisponde ai gruppi con valori email di "supportgroup@" e "support@", ma non "contactsupport". Supportato solo per un insieme limitato di campi di stringa (vedi sopra). |
Esempi
Tutte le query utilizzano 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 essere codificati nell'URL. Ad esempio, la queryquery=email:support* è codificata in URL come query=email%3Asupport*.
Tutti gli esempi in questa pagina mostrano parametri query non codificati.
Le librerie client gestiscono automaticamente questa codifica dell'URL.
Cercare un gruppo per nome visualizzato
name='contact'
Cercare gruppi corrispondenti a un prefisso email
email:admin*
Cercare tutti i gruppi di un utente
memberKey=user@company.com
Cerca gruppi con nome e indirizzo email che iniziano con contatto
name:contact* email:contact*