Kelola grup

Halaman ini membahas cara mengelola Google Grup dengan Directory API:

• Buat grup
• Memperbarui grup
• Menambahkan alias grup
• Mengambil grup
• Ambil semua grup untuk domain atau akun
• Mengambil semua grup untuk anggota
• Ambil semua alias grup
• Menghapus alias grup
• Menghapus grup

Buat grup

Untuk membuat grup, gunakan permintaan POST berikut dan sertakan otorisasi dijelaskan dalam Mengizinkan permintaan. Anda dapat membuat grup untuk domain mana pun yang terkait dengan akun. Untuk {i>string<i} kueri, {i>request<i} dan properti respons, lihat Metode groups.insert.

POST https://admin.googleapis.com/admin/directory/v1/groups

Permintaan JSON berikut menunjukkan contoh isi permintaan yang membuat grup. Email grup alamatnya adalah [e-mail]:

{
   "email": "[e-mail]",
   "name": "Sales Group",
   "description": "This is the Sales group."
}

Respons yang berhasil akan menampilkan Kode status HTTP 201 dan properti untuk grup baru.

Catatan: Grup baru tidak memiliki anggota. Anda harus menambahkan anggota ke grup. Selain itu, klien Anda harus menunggu satu menit sebelum menambahkan anggota atau mengirim pesan ke grup baru.

Memperbarui grup

Untuk memperbarui setelan grup, gunakan permintaan PUT berikut dan sertakan otorisasi yang dijelaskan dalam Mengizinkan permintaan. groupKey adalah alamat email grup, atau alamat email alias grup, atau id unik grup. Untuk string kueri, properti permintaan dan respons, lihat Metode groups.update.

PUT https://admin.googleapis.com/admin/directory/v1/groups/groupKey 

Secara umum, Google merekomendasikan untuk tidak menggunakan alamat email grup sebagai kunci untuk data persisten karena alamat email dapat berubah sewaktu-waktu.

Dalam contoh berikut, groupKey unik adalah nnn dan grup namanya adalah APAC Sales Group:

PUT https://admin.googleapis.com/admin/directory/v1/groups/nnn

{
    "email": "[e-mail]",
    "name": "APAC Sales Group"
}

Untuk permintaan pembaruan, Anda hanya perlu mengirimkan informasi yang diperbarui dalam permintaan Anda. Anda tidak perlu memasukkan semua properti grup dalam permintaan.

Catatan: Directory API juga mendukung semantik patch.

Respons yang berhasil akan menampilkan Kode status HTTP 201 dan properti untuk grup baru:

{
    "kind": "directory#groups",
    "id": "group's unique ID",
    "etag": "group's unique ETag",
    "email": "[e-mail]",
    "name": "APAC Sales Group",
    "directMembersCount": "5",
    "description": "This is the APAC sales group.",
    "adminCreated": true,
    "aliases": [
     {
        "alias": "[e-mail]"
     }
    ],
    "nonEditableAliases: [
     {
        "alias": "[e-mail]"
     }
    ]
}

Menambahkan alias grup

Untuk menambahkan alias grup, gunakan permintaan POST berikut dan sertakan otorisasi yang dijelaskan dalam Mengizinkan permintaan. groupKey adalah alamat email grup, salah satu alias grup alamat email, atau id unik grup. Untuk string kueri, properti permintaan dan respons, lihat referensi groups.

POST https://admin.googleapis.com/admin/directory/v1/groups/groupKey/aliases

Secara umum, Google merekomendasikan untuk tidak menggunakan alamat email grup sebagai kunci untuk data persisten karena alamat email dapat berubah sewaktu-waktu.

Permintaan JSON berikut menunjukkan contoh permintaan untuk membuat alias grup. Tujuan groupKey adalah id unik grup yang diwakili oleh NNNN

POST https://admin.googleapis.com/admin/directory/v1/groups/NNNN/aliases

{
    "alias": "[e-mail]"
}

Respons yang berhasil akan menampilkan Kode status HTTP 201 dan properti untuk alias grup baru.

Mengambil grup

Untuk mengambil grup, gunakan permintaan GET berikut dan sertakan otorisasi dijelaskan dalam Mengizinkan permintaan. groupKey adalah alamat email grup, salah satu alias grup alamat email, atau id unik grup. Untuk string kueri, properti permintaan dan respons, lihat metode groups.get.

GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey

Secara umum, Google merekomendasikan untuk tidak menggunakan alamat email grup sebagai kunci untuk data persisten karena alamat email dapat berubah sewaktu-waktu.

Dalam contoh berikut, ID groupKey unik adalah nnnn:

GET https://admin.googleapis.com/admin/directory/v1/groups/nnnn

Respons yang berhasil akan menampilkan Kode status HTTP 200 dan setelan grup:

{
    "kind": "directory#groups",
    "id": "group's unique ID",
    "etag": "group's unique ETag",
    "email": "[e-mail]",
    "name": "APAC Sales Group",
    "directMembersCount": "5",
    "description": "This is the APAC sales group.",
    "adminCreated": true,
    "aliases": [
     {
        "alias": "[e-mail]"
     }
    ],
    "nonEditableAliases: [
     {
        "alias": "[e-mail]"
     }
    ]
}

Ambil semua grup untuk domain atau akun

Untuk mengambil semua grup untuk domain atau akun tertentu, gunakan GET berikut dan sertakan otorisasi yang dijelaskan dalam Mengizinkan permintaan. Untuk kueri properti string, permintaan, dan respons, lihat Metode groups.list. Agar mudah dibaca, contoh ini menggunakan pengembalian baris:

GET https://admin.googleapis.com/admin/directory/v1/groups?domain=domain name
&customer=my_customer or customerId&pageToken=pagination token
&maxResults=max results

Saat mengambil semua grup untuk domain atau akun, pertimbangkan hal berikut:

• Semua grup untuk subdomain: Gunakan argumen domain dengan nama domain.
• Semua grup untuk akun: Gunakan argumen customer dengan my_customer atau nilai customerId akun. Sebagai akun administrator, gunakan string my_customer untuk mewakili customerId. Jika Anda adalah reseller yang mengakses akun pelanggan reseller, gunakan customerId akun reseller. Untuk nilai customerId, gunakan nama domain primer akun Anda di Mengambil semua pengguna di domain permintaan operasi. Respons yang dihasilkan memiliki nilai customerId.
• Menggunakan argumen domain dan customer: Directory API menampilkan semua grup untuk domain.
• Tidak menggunakan argumen domain dan customer: Directory API menampilkan semua grup untuk akun yang terkait dengan my_customer. Ini adalah akun customerId dari administrator yang membuat terhadap permintaan.
• Menggunakan argumen customer dan userKey: Directory API menampilkan error. Anda harus membuat dua permintaan terpisah dengan argumen.

Pada contoh berikut, administrator akun menggunakan my_customer untuk meminta daftar semua grup akun:

GET https://admin.googleapis.com/admin/directory/v1/groups?domain=sales.com&customer=my_customer&maxResults=2

Dalam contoh berikut, permintaan administrator reseller menampilkan semua grup untuk akun reseller dengan customerId C03az79cb. Hasil maksimum yang ditampilkan per halaman respons adalah 2. Ada nextPageToken untuk daftar pengguna lanjutan dalam respons ini:

GET https://admin.googleapis.com/admin/directory/v1/groups?domain=sales.com&customer=C03az79cb&maxResults=2

Respons yang berhasil akan menampilkan Kode status HTTP 200 dan grup sesuai urutan alfabet di email grup:

{
"kind": "directory#groups",
    "groups": [
     {
      "kind": "directory#groups",
      "id": "group's unique ID",
      "etag": "group's unique ETag",
      "email": "[e-mail]",
      "name": "Sales support",
      "directMembersCount": "6",
      "description": "The sales support group",
      "adminCreated": true
     },
     {
      "kind": "directory#groups",
      "id": "group's unique ID",
      "etag": "group's unique ETag",
      "email": "[e-mail]",
      "name": "Sales travel",
      "directMembersCount": "2",
      "description": "The travel group supporting sales",
      "adminCreated": false,
      "aliases": [
       {
         "alias": "[e-mail]"
       }
      ],
      "nonEditableAliases: [
       {
         "alias": "[e-mail]"
       }
      ]
     },
  "nextPageToken": "NNNN"
  }

Mengambil semua grup untuk anggota

Untuk mengambil semua grup yang anggotanya memiliki langganan, gunakan GET berikut dan sertakan otorisasi yang dijelaskan dalam Mengizinkan permintaan. Agar mudah dibaca, contoh ini menggunakan pengembalian baris:

GET https://admin.googleapis.com/admin/directory/v1/groups?userKey=user key
?pageToken=pagination token
&maxResults=maximum results per response page

• Anggota dapat berupa pengguna atau grup.
• userKey dapat berupa alamat email utama, alamat email alias pengguna, alamat email utama grup, alias email grup, atau id unik pengguna yang dapat ditemukan menggunakan Mengambil operasi pengguna.
• Pengguna atau grup yang ditentukan dalam userKey harus menjadi bagian dari domain Anda.
• Gunakan string kueri pageToken untuk respons dengan kelompok dalam jumlah besar. Di kolom untuk penomoran halaman, respons akan menampilkan properti nextPageToken yang memberikan token untuk halaman hasil respons berikutnya. Permintaan Anda berikutnya menggunakan token ini sebagai Nilai string kueri pageToken.
• Menggunakan argumen customer dan userKey: Directory API menampilkan error. Anda harus membuat dua permintaan terpisah dengan argumen.

Untuk properti permintaan dan respons, lihat Metode groups.list.

Respons yang berhasil akan menampilkan Kode status HTTP 200 dan daftar informasi anggota:

• Semua grup tempat anggotanya memiliki langganan, termasuk grup dari luar milik pengguna ditampilkan.
• Grup akan ditampilkan dalam urutan abjad dari alamat email setiap grup.
• Dalam isi respons, id adalah ID unik grup.
• Dalam respons, listingan grup yang berasal dari luar domain pengguna tidak menyertakan alias di luar grup.

{
    "kind": "directory#groups",
    "groups": [
     {
      "kind": "directory#group",
      "id": "group's unique ID",
      "etag": "group's unique ETag",
      "email": "[e-mail]",
      "name": "sale group",
      "directMembersCount": "5",
      "description": "Sales group"
     },
     {
      "kind": "directory#group",
      "id": "group's unique ID",
      "etag": "group's unique ETag",
      "email": "support_group.com",
      "name": "support group",
      "directMembersCount": "5",
      "description": "Support group"
     }
  ],
   "nextPakeToken": "NNNNN"
}

Ambil semua alias grup

Untuk mengambil semua alias grup, gunakan permintaan GET berikut dan sertakan otorisasi yang dijelaskan dalam Mengizinkan permintaan. Tujuan groupKey dapat berupa alamat email utama grup, ID unik grup id, atau alias grup mana pun email. Untuk properti permintaan dan respons, lihat referensi groups.

GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/aliases

Catatan: Ini adalah alias grup yang dapat diedit di kolom utama domain atau subdomain. Untuk alias grup di luar akun, lihat properti nonEditableAliases grup.

Respons yang berhasil akan menampilkan Kode status HTTP 201 dan daftar alias grup.

Menghapus alias grup

Untuk menghapus alias grup, gunakan permintaan DELETE berikut dan sertakan otorisasi yang dijelaskan dalam Mengizinkan permintaan. groupKey dapat berupa alamat email utama grup, atribut unik grup id, atau alias grup mana pun email. aliasId adalah alias yang dihapus. Untuk properti permintaan dan respons, lihat referensi groups:

DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey/aliases/aliasId

Respons yang berhasil akan menampilkan Kode status HTTP 201.

Menghapus grup

Untuk menghapus grup, gunakan permintaan DELETE berikut dan sertakan otorisasi dijelaskan dalam Mengizinkan permintaan. groupKey adalah id unik grup:

DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey

Misalnya, permintaan DELETE ini akan menghapus grup yang memiliki grup nnnn id:

DELETE https://admin.googleapis.com/admin/directory/v1/group/nnnn

Respons yang berhasil akan menampilkan Kode status HTTP 200.

Saat grup dihapus, hal berikut akan terjadi:

• Semua anggota grup akan dihapus. Akun pengguna anggota tidak akan dihapus.
• Arsip grup dihapus.
• Pesan yang dikirim ke alamat grup yang dihapus tidak akan terkirim. Sebagai gantinya, pengirim akan menerima pesan email tidak terkirim.