Sebelum memanggil Mail Admin Quarantine API, selesaikan langkah-langkah di halaman ini untuk mengaktifkan API, menemukan ID yang diperlukan setiap permintaan, dan memberikan hak istimewa administrator yang diperlukan di akun Google Workspace Anda.
Prasyarat
- Akun Google Workspace dengan fitur karantina admin. Untuk mempelajari lebih lanjut, lihat Menyiapkan dan mengelola karantina email.
- Project Google Cloud. Untuk membuat project, lihat Membuat project.
- Keanggotaan dalam Program Pratinjau Developer Google Workspace. Project Cloud Anda harus terdaftar dalam program sebelum dapat memanggil Admin Quarantine API.
- Akses ke konsol Google Admin sebagai administrator super, untuk memberikan hak istimewa administrator dan mengizinkan delegasi tingkat domain.
Mengaktifkan API
Aktifkan mailadminquarantine.googleapis.com di project Cloud yang menghosting integrasi Anda.
Konsol
Di Konsol Google Cloud, aktifkan Mail Admin Quarantine API.
gcloud
Jalankan perintah berikut, dengan mengganti PROJECT_ID dengan ID project Cloud Anda:
gcloud services enable mailadminquarantine.googleapis.com \
--project=PROJECT_ID
Menemukan ID pelanggan Anda
Setiap permintaan ke Admin Quarantine API mengidentifikasi akun Google Workspace Anda dengan nama resource customers/CUSTOMER_ID.
Untuk menemukan ID pelanggan Anda:
- Login ke konsol Admin sebagai administrator.
- Buka Akun > Setelan akun > Profil.
- Salin ID Pelanggan.
Jika ID pelanggan diawali dengan C, hapus C dan gunakan nilai alfanumerik yang tersisa dalam nama resource, misalnya customers/01abc23de.
Jangan gunakan nama domain Anda sebagai ID pelanggan.
Untuk mengetahui informasi selengkapnya, lihat Menemukan ID pelanggan Anda.
Memberikan hak istimewa administrator yang diperlukan
Admin Quarantine API menerapkan pemeriksaan hak istimewa administrator yang sama dengan karantina admin di konsol Admin. Setiap permintaan dijalankan atas nama administrator Google Workspace, dan administrator tersebut harus memiliki salah satu hak istimewa Gmail berikut:
| Privilese | Hal yang diizinkan |
|---|---|
| Mengakses Karantina Admin | Mengakses dan mengelola pesan di semua karantina, termasuk karantina default. |
| Mengakses karantina yang dibatasi | Mengakses dan mengelola pesan hanya di karantina yang terkait dengan grup tempat administrator bernaung. |
Administrator super otomatis memiliki hak istimewa ini. Untuk administrator lainnya, tetapkan peran yang mencakup hak istimewa:
- Login ke konsol Admin sebagai administrator super.
- Buka Akun > Peran admin.
- Pilih peran yang ada atau klik Create new role.
- Di tab Hak istimewa, buka Layanan > Gmail, lalu pilih Mengakses Karantina Admin atau Mengakses karantina yang dibatasi.
- Tetapkan peran ke akun administrator yang ditiru oleh integrasi Anda saat memanggil API.
Untuk mengetahui detail tentang peran administrator yang didelegasikan, lihat Mendelegasikan hak istimewa administrator di Gmail dan Definisi hak istimewa administrator.
Jika administrator yang ditiru tidak memiliki hak istimewa yang diperlukan, API akan menampilkan error 403 PERMISSION_DENIED.