REST Resource: groups
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Zasób: grupa
Grupy dyskusyjne Google umożliwiają użytkownikom wysyłanie wiadomości do grup osób przy użyciu adresu e-mail grupy. Więcej informacji o typowych zadaniach znajdziesz w przewodniku dla programistów.
Informacje o innych typach grup znajdziesz w dokumentacji interfejsu Cloud Identity Groups API.
Uwaga: użytkownik wywołujący interfejs API (lub użytkownik, którego w ramach podszywania się używa konto usługi) musi mieć przypisaną rolę, która obejmuje uprawnienia administratora grup interfejsu API, np. superadministratora lub administratora grup.
| Zapis JSON |
{
"id": string,
"email": string,
"name": string,
"description": string,
"adminCreated": boolean,
"directMembersCount": string,
"kind": string,
"etag": string,
"aliases": [
string
],
"nonEditableAliases": [
string
]
} |
| Pola |
id |
string
Tylko do odczytu. Unikalny identyfikator grupy. Grupy id można używać jako identyfikatorów URI żądań grupowych groupKey.
|
email |
string
Adres e-mail grupy. Jeśli Twoje konto ma wiele domen, wybierz odpowiednią domenę dla adresu e-mail. Wartość email musi być niepowtarzalna. Ta właściwość jest wymagana podczas tworzenia grupy. Adresy e-mail grup podlegają tym samym regułom dotyczącym znaków co nazwy użytkowników. Więcej informacji znajdziesz w Centrum pomocy.
|
name |
string
Wyświetlana nazwa grupy.
|
description |
string
Rozwinięty opis, który pomaga użytkownikom określić cel grupy. Możesz na przykład dodać informacje opisujące jej członków, typy wiadomości wysyłanych w ramach tej grupy i linki do najczęstszych pytań na jej temat, pokrewnych grup itp. Maksymalna długość to 4,096 znaków.
|
adminCreated |
boolean
Tylko do odczytu. Wartość to true, jeśli grupa została utworzona przez administratora, a nie użytkownika.
|
directMembersCount |
string (int64 format)
Liczba użytkowników, którzy są bezpośrednimi członkami grupy. Jeśli grupa jest członkiem (podrzędnym) tej grupy (nadrzędnej), członkowie grupy podrzędnej nie są wliczani do właściwości directMembersCount grupy nadrzędnej.
|
kind |
string
Typ zasobu interfejsu API. W przypadku zasobów Groups wartość to admin#directory#group.
|
etag |
string
ETag zasobu.
|
aliases[] |
string
Tylko do odczytu. Lista aliasów adresów e-mail grupy. Aby dodać, zaktualizować lub usunąć aliasy grupy, użyj metod groups.aliases. Jeśli zmiany zostaną wprowadzone w żądaniu POST lub PUT grupy, zostaną zignorowane.
|
nonEditableAliases[] |
string
Tylko do odczytu. Lista nieedytowalnych aliasów adresów e-mail grupy, które znajdują się poza domeną podstawową lub subdomenami konta. To działające adresy e-mail używane przez grupę. To właściwość tylko do odczytu zwracana w odpowiedzi interfejsu API dla grupy. Jeśli zmiany zostaną wprowadzone w żądaniu POST lub PUT grupy, zostaną zignorowane.
|
Metody |
|
|
usuwa grupę. |
|
|
Pobiera właściwości grupy. |
|
|
Tworzy grupę. |
|
|
Pobiera wszystkie grupy domeny lub użytkownika na podstawie klucza użytkownika (po stronie). |
|
|
Aktualizuje właściwości grupy. |
|
|
Aktualizuje właściwości grupy. |
O ile nie stwierdzono inaczej, treść tej strony jest objęta licencją Creative Commons – uznanie autorstwa 4.0, a fragmenty kodu są dostępne na licencji Apache 2.0. Szczegółowe informacje na ten temat zawierają zasady dotyczące witryny Google Developers. Java jest zastrzeżonym znakiem towarowym firmy Oracle i jej podmiotów stowarzyszonych.
Ostatnia aktualizacja: 2025-07-24 UTC.
[null,null,["Ostatnia aktualizacja: 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. |"]]
