Dokumen ini berisi informasi otorisasi dan autentikasi khusus Gmail API. Sebelum membaca dokumen ini, pastikan Anda membaca informasi otorisasi dan autentikasi umum Google Workspace di Pelajari autentikasi dan otorisasi.
Mengonfigurasi OAuth 2.0 untuk otorisasi
Konfigurasi layar izin OAuth dan pilih cakupan untuk menentukan informasi yang ditampilkan kepada pengguna dan peninjau aplikasi, serta daftarkan aplikasi agar Anda dapat memublikasikannya nanti.
Cakupan API Gmail
Untuk menentukan tingkat akses yang diberikan ke aplikasi, Anda perlu mengidentifikasi dan mendeklarasikan cakupan otorisasi. Cakupan otorisasi adalah string URI OAuth 2.0 yang berisi nama aplikasi Google Workspace, jenis data yang diakses, dan tingkat aksesnya. Cakupan adalah permintaan aplikasi Anda untuk menangani data Google Workspace, termasuk data Akun Google pengguna.
Saat aplikasi diinstal, pengguna akan diminta untuk memvalidasi cakupan yang digunakan oleh aplikasi. Umumnya, Anda harus memilih cakupan yang paling terfokus dan menghindari permintaan cakupan yang tidak diperlukan aplikasi. Pengguna lebih mudah memberikan akses ke cakupan yang terbatas dan dijelaskan dengan jelas.
Gmail API mendukung cakupan berikut:
| Kode cakupan | Deskripsi | Penggunaan |
|---|---|---|
https://www.googleapis.com/auth/gmail.addons.current.action.compose |
Mengelola draf dan mengirim email saat Anda berinteraksi dengan add-on. | Tidak peka |
https://www.googleapis.com/auth/gmail.addons.current.message.action |
Lihat pesan email saat Anda berinteraksi dengan add-on tersebut. | Tidak peka |
https://www.googleapis.com/auth/gmail.addons.current.message.metadata |
Lihat metadata pesan email Anda saat add-on berjalan. | Sensitif |
https://www.googleapis.com/auth/gmail.addons.current.message.readonly |
Melihat pesan email saat add-on berjalan. | Sensitif |
https://www.googleapis.com/auth/gmail.labels |
Membuat, membaca, memperbarui, dan menghapus label hanya. | Tidak peka |
https://www.googleapis.com/auth/gmail.send |
Hanya kirim pesan. Tidak ada hak istimewa baca atau ubah di kotak surat. | Sensitif |
https://www.googleapis.com/auth/gmail.readonly |
Membaca semua resource dan metadatanya—tanpa operasi tulis. | Restricted |
https://www.googleapis.com/auth/gmail.compose |
Membuat, membaca, memperbarui, dan menghapus draf. Mengirim pesan dan draf. | Restricted |
https://www.googleapis.com/auth/gmail.insert |
Hanya menyisipkan dan mengimpor pesan. | Restricted |
https://www.googleapis.com/auth/gmail.modify |
Semua operasi baca/tulis, kecuali penghapusan langsung dan permanen pada thread dan pesan, yang mengabaikan Sampah. | Restricted |
https://www.googleapis.com/auth/gmail.metadata |
Membaca metadata resource termasuk label, data histori, dan header pesan email, tetapi bukan isi atau lampiran pesan. | Restricted |
https://www.googleapis.com/auth/gmail.settings.basic |
Mengelola setelan email dasar. | Restricted |
https://www.googleapis.com/auth/gmail.settings.sharing |
Mengelola setelan email yang sensitif, termasuk alias dan aturan penerusan.
Catatan:Operasi yang dilindungi oleh cakupan ini dibatasi hanya untuk penggunaan administratif. Fitur ini hanya tersedia untuk pelanggan Google Workspace yang menggunakan akun layanan dengan delegasi seluruh domain. |
Restricted |
https://mail.google.com/ |
Akses penuh ke kotak surat akun, termasuk penghapusan permanen rangkaian pesan dan pesan. Cakupan ini hanya boleh diminta jika aplikasi Anda perlu segera dan permanen menghapus rangkaian pesan dan pesan, mengabaikan Sampah; semua tindakan lainnya dapat dilakukan dengan cakupan yang tidak terlalu longgar. | Restricted |
Kolom Usage pada tabel di atas menunjukkan sensitivitas setiap cakupan, sesuai dengan definisi berikut:
Tidak sensitif——Cakupan ini memberikan cakupan akses otorisasi terkecil dan hanya memerlukan verifikasi aplikasi dasar. Untuk informasi tentang persyaratan ini, lihat Langkah-langkah untuk menyiapkan verifikasi.
Sensitif—Cakupan ini memungkinkan akses ke Data Pengguna Google dan memerlukan proses verifikasi cakupan yang sensitif. Untuk mengetahui informasi tentang persyaratan ini, lihat Layanan Google API: Kebijakan Data Pengguna. Cakupan ini tidak memerlukan penilaian keamanan.
Dibatasi—Cakupan ini memberikan akses luas ke Data Pengguna Google dan mengharuskan Anda melalui proses verifikasi dengan cakupan yang dibatasi. Untuk mengetahui informasi tentang persyaratan ini, lihat Layanan Google API: Kebijakan Data Pengguna dan Persyaratan Tambahan untuk Cakupan API Tertentu. Jika Anda menyimpan data cakupan yang dibatasi di server (atau dikirimkan), Anda harus menjalani penilaian keamanan.
Informasi tambahan yang mengatur penggunaan dan akses Anda ke Gmail API saat Anda meminta akses data pengguna dapat ditemukan di Data Pengguna dan Kebijakan Developer Layanan Gmail API.
Jika aplikasi memerlukan akses ke Google API lain, Anda juga dapat menambahkan cakupan tersebut. Untuk informasi selengkapnya tentang cakupan Google API, lihat Menggunakan OAuth 2.0 untuk Mengakses Google API.
Verifikasi OAuth
Penggunaan cakupan OAuth sensitif tertentu mungkin mengharuskan aplikasi Anda melalui proses verifikasi OAuth Google. Baca FAQ verifikasi OAuth untuk menentukan kapan aplikasi Anda harus melalui verifikasi dan jenis verifikasi yang diperlukan. Lihat juga Layanan Google API: Kebijakan Data Pengguna.