REST Resource: groups

Risorsa: gruppo

Google Gruppi offre agli utenti la possibilità di inviare messaggi a gruppi di persone utilizzando l'indirizzo email del gruppo. Per scoprire di più sulle attività comuni, consulta la Guida per gli sviluppatori.

Per informazioni su altri tipi di gruppi, consulta la documentazione dell'API Cloud Identity Groups.

Nota: l'utente che chiama l'API (o la cui identità viene usurpata da un account di servizio) deve avere un ruolo assegnato che includa le autorizzazioni per i gruppi dell'API Admin, ad esempio Super amministratore o Amministratore gruppi.

Rappresentazione JSON
{
  "id": string,
  "email": string,
  "name": string,
  "description": string,
  "adminCreated": boolean,
  "directMembersCount": string,
  "kind": string,
  "etag": string,
  "aliases": [
    string
  ],
  "nonEditableAliases": [
    string
  ]
}
Campi
id

string

Sola lettura. L'ID univoco di un gruppo. Un gruppo id può essere utilizzato come groupKey dell'URI di richiesta di gruppo.

email

string

L'indirizzo email del gruppo. Se il tuo account ha più domini, seleziona quello appropriato per l'indirizzo email. email deve essere univoco. Questa proprietà è obbligatoria per la creazione di un gruppo. Gli indirizzi email di gruppo sono soggetti alle stesse regole di utilizzo dei caratteri dei nomi utente. Per maggiori dettagli, visita il Centro assistenza.

name

string

Il nome visualizzato del gruppo.

description

string

Una descrizione estesa per aiutare gli utenti a determinare lo scopo di un gruppo. Ad esempio, puoi includere informazioni su chi deve partecipare al gruppo, i tipi di messaggi da inviare al gruppo, link alle domande frequenti sul gruppo o su gruppi correlati. La lunghezza massima è di 4,096 caratteri.

adminCreated

boolean

Sola lettura. Il valore è true se il gruppo è stato creato da un amministratore anziché da un utente.

directMembersCount

string (int64 format)

Il numero di utenti che sono membri diretti del gruppo. Se un gruppo è un membro (secondario) di questo gruppo (principale), i membri del gruppo secondario non vengono conteggiati nella proprietà directMembersCount del gruppo principale.

kind

string

Il tipo di risorsa API. Per le risorse Gruppi, il valore è admin#directory#group.

etag

string

ETag della risorsa.

aliases[]

string

Sola lettura. L'elenco degli indirizzi email degli alias di un gruppo. Per aggiungere, aggiornare o rimuovere gli alias di un gruppo, utilizza i metodi groups.aliases. Se la modifica viene apportata nella richiesta POST o PUT di un gruppo, la modifica viene ignorata.

nonEditableAliases[]

string

Sola lettura. L'elenco degli indirizzi email alias non modificabili del gruppo che non si trovano nel dominio principale o nei sottodomini dell'account. Si tratta di indirizzi email funzionanti utilizzati dal gruppo. Si tratta di una proprietà di sola lettura restituita nella risposta dell'API per un gruppo. Se la modifica viene apportata nella richiesta POST o PUT di un gruppo, la modifica viene ignorata.

Metodi

delete

Consente di eliminare un gruppo.

get

Recupera le proprietà di un gruppo.

insert

Crea un gruppo.

list

Recupera tutti i gruppi di un dominio o di un utente a partire da un valore userKey (paginato).

patch

Aggiorna le proprietà di un gruppo.

update

Aggiorna le proprietà di un gruppo.