REST Resource: groups

Referensi: Grup

Google Grup memberi pengguna 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 ditiru identitasnya 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 bersifat wajib 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 lengkap untuk membantu pengguna menentukan tujuan grup. Misalnya, Anda dapat menyertakan informasi tentang siapa yang harus bergabung ke grup, jenis pesan yang akan 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) 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, hasil edit akan diabaikan.

nonEditableAliases[]

string

Hanya baca. Daftar alamat email alias grup yang tidak dapat diedit yang berada di luar domain atau subdomain utama akun. Ini adalah alamat email berfungsi yang digunakan oleh grup. Ini adalah properti hanya-baca yang ditampilkan dalam respons API untuk grup. Jika diedit dalam permintaan POST atau PUT grup, hasil edit akan diabaikan.

Metode

delete

Menghapus grup.

get

Mengambil properti grup.

insert

Membuat grup.

list

Mengambil semua grup domain atau pengguna yang diberi userKey (bernomor halaman).

patch

Memperbarui properti grup.

update

Memperbarui properti grup.