REST Resource: groups
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
Resource: Grup
Google Grup memberi pengguna Anda kemampuan untuk mengirim pesan ke sekelompok orang menggunakan alamat email grup. Untuk informasi selengkapnya tentang tugas umum, lihat Panduan Developer.
Untuk informasi tentang jenis grup lainnya, lihat dokumentasi Cloud Identity Groups API.
Catatan: Pengguna yang memanggil API (atau yang disamarkan oleh akun layanan) harus memiliki peran yang ditetapkan yang mencakup izin Grup Admin API, seperti Admin Super atau Admin Grup.
| Representasi JSON |
{
"id": string,
"email": string,
"name": string,
"description": string,
"adminCreated": boolean,
"directMembersCount": string,
"kind": string,
"etag": string,
"aliases": [
string
],
"nonEditableAliases": [
string
]
} |
| Kolom |
id |
string
Hanya baca. ID unik grup. id grup dapat digunakan sebagai groupKey URI permintaan grup.
|
email |
string
Alamat email grup. Jika akun Anda memiliki beberapa domain, pilih domain yang sesuai untuk alamat email. email harus unik. Properti ini diperlukan saat membuat grup. Alamat email grup tunduk pada aturan penggunaan karakter yang sama dengan nama pengguna. Lihat pusat bantuan untuk mengetahui detailnya.
|
name |
string
Nama tampilan grup.
|
description |
string
Deskripsi panjang untuk membantu pengguna menentukan tujuan grup. Misalnya, Anda dapat menyertakan informasi tentang siapa saja yang harus bergabung ke grup, jenis pesan yang harus dikirim ke grup, link ke FAQ tentang grup, atau grup terkait. Panjang maksimum adalah 4,096 karakter.
|
adminCreated |
boolean
Hanya baca. Nilainya adalah true jika grup ini dibuat oleh administrator, bukan pengguna.
|
directMembersCount |
string (int64 format)
Jumlah pengguna yang merupakan anggota langsung grup. Jika grup adalah anggota (turunan) dari grup ini (induk), anggota grup turunan tidak dihitung dalam properti directMembersCount grup induk.
|
kind |
string
Jenis resource API. Untuk resource Grup, nilainya adalah admin#directory#group.
|
etag |
string
ETag resource.
|
aliases[] |
string
Hanya baca. Daftar alamat email alias grup. Untuk menambahkan, memperbarui, atau menghapus alias grup, gunakan metode groups.aliases. Jika diedit dalam permintaan POST atau PUT grup, pengeditan akan diabaikan.
|
nonEditableAliases[] |
string
Hanya baca. Daftar alamat email alias grup yang tidak dapat diedit dan berada di luar domain primer atau subdomain akun. Ini adalah alamat email yang berfungsi dan digunakan oleh grup. Ini adalah properti hanya baca yang ditampilkan dalam respons API untuk grup. Jika diedit dalam permintaan POST atau PUT grup, pengeditan akan diabaikan.
|
Metode |
|
|
Menghapus grup. |
|
|
Mengambil properti grup. |
|
|
Membuat grup. |
|
|
Mengambil semua grup domain atau pengguna yang diberi userKey (di-pagination). |
|
|
Memperbarui properti grup. |
|
|
Memperbarui properti grup. |
Kecuali dinyatakan lain, konten di halaman ini dilisensikan berdasarkan Lisensi Creative Commons Attribution 4.0, sedangkan contoh kode dilisensikan berdasarkan Lisensi Apache 2.0. Untuk mengetahui informasi selengkapnya, lihat Kebijakan Situs Google Developers. Java adalah merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2025-07-24 UTC.
[null,null,["Terakhir diperbarui pada 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. |"]]
