Groups Settings API memperbarui dan mengambil setelan untuk Grup Google yang ada. Melalui API, Anda dapat melakukan hal berikut:
- Ubah setelan grup untuk akses grup internal dan eksternal.
- Edit notifikasi grup.
- Mengonfigurasi pengarsipan diskusi dan moderasi pesan.
- Sesuaikan grup pengguna akun Anda.
Untuk mengetahui cara lain menggunakan Google Grup, atau mengelola jenis grup lainnya, lihat dokumentasi Cloud Identity.
Model data Groups Settings API
Groups Settings API beroperasi pada resource Groups yang mewakili cara pengguna
dalam akun berkomunikasi dan berkolaborasi dengan grup orang lain. Setiap grup diidentifikasi
oleh alamat email grup.
Model data API didasarkan pada kumpulan Groups dari grup akun. Setiap
grup memiliki kumpulan setelan konfigurasi yang unik.
Operasi Groups Settings API
Anda dapat memanggil metode setelan grup di Groups Settings API, seperti yang dijelaskan dalam tabel berikut:
| Operasi | Deskripsi | Pemetaan HTTP REST |
|---|---|---|
get |
Mendapatkan setelan grup untuk akun pelanggan. Semua operasi get harus diizinkan oleh pengguna yang diautentikasi. | GET di URI grup. |
update |
Memperbarui setelan grup untuk akun pelanggan. Semua operasi update harus diizinkan oleh pengguna yang terautentikasi. | PUT pada URI grup. |
Format data JSON dan Atom
Secara default, Groups Settings API menampilkan data dalam format JSON. Notasi Atom adalah format data alternatif. Format data JSON dan Atom mendukung kemampuan baca-tulis penuh.
JSON adalah format internet umum yang menyediakan metode untuk merepresentasikan struktur data arbitrer. Menurut json.org, JSON adalah format teks yang sepenuhnya independen bahasa, tetapi menggunakan konvensi yang sudah dikenal oleh programmer bahasa keluarga C, termasuk C, C++, C#, Java, JavaScript, Perl, dan Python.
Untuk mengubah format data API, sertakan string kueri alt dalam URI permintaan
Anda—misalnya:
JSON
GET https://www.googleapis.com/groups/v1/groups/salesgroup@example.com?alt=json
Atom
GET https://www.googleapis.com/groups/v1/groups/salesgroup@example.com?alt=atom