REST Resource: groups
Mantieni tutto organizzato con le raccolte
Salva e classifica i contenuti in base alle tue preferenze.
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 |
|
|
Consente di eliminare un gruppo. |
|
|
Recupera le proprietà di un gruppo. |
|
|
Crea un gruppo. |
|
|
Recupera tutti i gruppi di un dominio o di un utente a partire da un valore userKey (paginato). |
|
|
Aggiorna le proprietà di un gruppo. |
|
|
Aggiorna le proprietà di un gruppo. |
Salvo quando diversamente specificato, i contenuti di questa pagina sono concessi in base alla licenza Creative Commons Attribution 4.0, mentre gli esempi di codice sono concessi in base alla licenza Apache 2.0. Per ulteriori dettagli, consulta le norme del sito di Google Developers. Java è un marchio registrato di Oracle e/o delle sue consociate.
Ultimo aggiornamento 2025-07-24 UTC.
[null,null,["Ultimo aggiornamento 2025-07-24 UTC."],[],[],null,["# REST Resource: groups\n\nResource: Group\n---------------\n\nGoogle Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](https://developers.google.com/workspace/admin/directory/v1/guides/manage-groups).\n\nFor information about other types of groups, see the [Cloud Identity Groups API documentation](https://cloud.google.com/identity/docs/groups).\n\nNote: The user calling the API (or being impersonated by a service account) must have an assigned [role](https://developers.google.com/workspace/admin/directory/v1/guides/manage-roles) that includes Admin API Groups permissions, such as Super Admin or Groups Admin.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"id\": string, \"email\": string, \"name\": string, \"description\": string, \"adminCreated\": boolean, \"directMembersCount\": string, \"kind\": string, \"etag\": string, \"aliases\": [ string ], \"nonEditableAliases\": [ string ] } ``` |\n\n| Fields ||\n|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `id` | `string` Read-only. The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`. |\n| `email` | `string` The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The `email` must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the [help center](https://support.google.com/a/answer/9193374) for details. |\n| `name` | `string` The group's display name. |\n| `description` | `string` An extended description to help users determine the purpose of a group. For example, you can include information about who should join the group, the types of messages to send to the group, links to FAQs about the group, or related groups. Maximum length is `4,096` characters. |\n| `adminCreated` | `boolean` Read-only. Value is `true` if this group was created by an administrator rather than a user. |\n| `directMembersCount` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the `directMembersCount` property of the parent group. |\n| `kind` | `string` The type of the API resource. For Groups resources, the value is `admin#directory#group`. |\n| `etag` | `string` ETag of the resource. |\n| `aliases[]` | `string` Read-only. The list of a group's alias email addresses. To add, update, or remove a group's aliases, use the `groups.aliases` methods. If edited in a group's POST or PUT request, the edit is ignored. |\n| `nonEditableAliases[]` | `string` Read-only. The list of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group. This is a read-only property returned in the API's response for a group. If edited in a group's POST or PUT request, the edit is ignored. |\n\n| Methods ------- ||\n|--------------------------------------------------------------------------|----------------------------------------------------------------------------|\n| ### [delete](/workspace/admin/directory/reference/rest/v1/groups/delete) | Deletes a group. |\n| ### [get](/workspace/admin/directory/reference/rest/v1/groups/get) | Retrieves a group's properties. |\n| ### [insert](/workspace/admin/directory/reference/rest/v1/groups/insert) | Creates a group. |\n| ### [list](/workspace/admin/directory/reference/rest/v1/groups/list) | Retrieves all groups of a domain or of a user given a userKey (paginated). |\n| ### [patch](/workspace/admin/directory/reference/rest/v1/groups/patch) | Updates a group's properties. |\n| ### [update](/workspace/admin/directory/reference/rest/v1/groups/update) | Updates a group's properties. |"]]
