REST Resource: groups
Koleksiyonlar ile düzeninizi koruyun
İçeriği tercihlerinize göre kaydedin ve kategorilere ayırın.
Kaynak: Grup
Google Gruplar, kullanıcılarınıza grubun e-posta adresini kullanarak kullanıcı gruplarına ileti gönderme olanağı sunar. Sık yapılan işlemler hakkında daha fazla bilgi için Geliştirici Kılavuzu'na bakın.
Diğer grup türleri hakkında bilgi edinmek için Cloud Identity Groups API belgelerine bakın.
Not: API'yi çağıran (veya bir hizmet hesabı tarafından kimliğine bürünen) kullanıcının, Admin API Grup izinlerini içeren bir rolüne (ör. Süper Yönetici veya Grup Yöneticisi) sahip olması gerekir.
| JSON gösterimi |
{
"id": string,
"email": string,
"name": string,
"description": string,
"adminCreated": boolean,
"directMembersCount": string,
"kind": string,
"etag": string,
"aliases": [
string
],
"nonEditableAliases": [
string
]
} |
| Alanlar |
id |
string
Salt okunur. Bir grubun benzersiz kimliği. Bir grup id, grup istek URI'sinin groupKey olarak kullanılabilir.
|
email |
string
Grubun e-posta adresi. Hesabınızda birden fazla alan varsa e-posta adresi için uygun alanı seçin. email benzersiz olmalıdır. Grup oluştururken bu özellik gereklidir. Grup e-posta adresleri, kullanıcı adlarıyla aynı karakter kullanımı kurallarına tabidir. Ayrıntılar için Yardım Merkezi'ne bakın.
|
name |
string
Grubun görünen adı.
|
description |
string
Kullanıcıların grubun amacını belirlemesine yardımcı olacak ayrıntılı bir açıklama. Örneğin, gruba kimlerin katılması gerektiğine ilişkin bilgileri, gruba gönderilecek ileti türlerini, grupla ilgili SSS bağlantılarını veya ilgili grupları ekleyebilirsiniz. Maksimum uzunluk 4,096 karakterdir.
|
adminCreated |
boolean
Salt okunur. Bu grup bir kullanıcı yerine yönetici tarafından oluşturulduysa değer true olur.
|
directMembersCount |
string (int64 format)
Grubun doğrudan üyesi olan kullanıcıların sayısı. Bir grup, bu grubun (üst grubun) üyesiyse (alt grup), alt grubun üyeleri üst grubun directMembersCount mülkünde sayılmaz.
|
kind |
string
API kaynağının türü. Gruplar kaynakları için değer admin#directory#group'tür.
|
etag |
string
Kaynağın ETag'i.
|
aliases[] |
string
Salt okunur. Bir grubun takma ad e-posta adreslerinin listesi. Bir grubun takma adlarını eklemek, güncellemek veya kaldırmak için groups.aliases yöntemlerini kullanın. Bir grubun POST veya PUT isteğinde düzenlenirse düzenleme yoksayılır.
|
nonEditableAliases[] |
string
Salt okunur. Grubun, hesabın birincil alanının veya alt alanlarının dışındaki, düzenlenemeyen takma ad e-posta adreslerinin listesi. Bunlar, grup tarafından kullanılan ve etkin e-posta adresleridir. Bu, API'nin bir grupla ilgili yanıtında döndürülen salt okunur bir özelliktir. Bir grubun POST veya PUT isteğinde düzenlenirse düzenleme yoksayılır.
|
Yöntemler |
|
|
Grubu siler. |
|
|
Bir grubun özelliklerini alır. |
|
|
Grup oluşturur. |
|
|
Bir alan adının veya kullanıcı anahtarı verilen bir kullanıcının tüm gruplarını getirir (sayfalandırılmış). |
|
|
Bir grubun özelliklerini günceller. |
|
|
Bir grubun özelliklerini günceller. |
Aksi belirtilmediği sürece bu sayfanın içeriği Creative Commons Atıf 4.0 Lisansı altında ve kod örnekleri Apache 2.0 Lisansı altında lisanslanmıştır. Ayrıntılı bilgi için Google Developers Site Politikaları'na göz atın. Java, Oracle ve/veya satış ortaklarının tescilli ticari markasıdır.
Son güncelleme tarihi: 2025-07-24 UTC.
[null,null,["Son güncelleme tarihi: 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. |"]]
