Dokumen ini berisi informasi otorisasi dan autentikasi khusus Gmail API. Sebelum membaca dokumen ini, pastikan Anda membaca informasi autentikasi dan otorisasi umum Google Workspace di Mempelajari autentikasi dan otorisasi.
Mengonfigurasi OAuth 2.0 untuk otorisasi
Mengonfigurasi layar izin OAuth dan memilih cakupan untuk menentukan informasi yang ditampilkan kepada pengguna dan peninjau aplikasi, serta mendaftarkan aplikasi Anda agar dapat dipublikasikan nanti.
Cakupan Gmail API
Untuk menentukan tingkat akses yang diberikan ke aplikasi Anda, 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 akses. Cakupan adalah permintaan aplikasi Anda untuk bekerja dengan data Google Workspace, termasuk data Akun Google pengguna.
Saat aplikasi Anda diinstal, pengguna akan diminta untuk memvalidasi cakupan yang digunakan oleh aplikasi. Secara umum, Anda harus memilih cakupan yang paling berfokus sempit dan menghindari permintaan cakupan yang tidak diperlukan aplikasi Anda. Pengguna lebih bersedia memberikan akses ke cakupan terbatas yang dijelaskan dengan jelas.
Jika memungkinkan, gunakan cakupan yang tidak sensitif untuk mempersempit akses hanya ke fitur tertentu yang diperlukan oleh aplikasi.
Cakupan tidak sensitif
Cakupan Gmail API berikut direkomendasikan untuk sebagian besar kasus penggunaan:
| Kode cakupan | Deskripsi |
|---|---|
https://www.googleapis.com/auth/gmail.addons.current.action.compose |
Mengelola draf dan mengirim email saat Anda berinteraksi dengan add-on. |
https://www.googleapis.com/auth/gmail.addons.current.message.action |
Melihat pesan email Anda saat Anda berinteraksi dengan add-on. |
https://www.googleapis.com/auth/gmail.labels |
Melihat dan mengedit label email Anda. |
Cakupan sensitif
| Kode cakupan | Deskripsi |
|---|---|
https://www.googleapis.com/auth/gmail.addons.current.message.metadata |
Melihat metadata pesan email Anda saat add-on dijalankan. |
https://www.googleapis.com/auth/gmail.addons.current.message.readonly |
Melihat pesan email Anda saat add-on sedang dijalankan. |
https://www.googleapis.com/auth/gmail.send |
Mengirim email atas nama Anda. |
Cakupan yang dibatasi
| Kode cakupan | Deskripsi |
|---|---|
https://mail.google.com/ |
Membaca, menulis, mengirim, dan menghapus semua email Anda secara permanen dari Gmail.
Catatan: Minta cakupan ini hanya jika aplikasi Anda perlu menghapus rangkaian pesan dan pesan secara langsung dan permanen, dengan melewati sampah. Anda dapat melakukan semua tindakan lainnya menggunakan cakupan yang kurang permisif. |
https://www.googleapis.com/auth/gmail.readonly |
Melihat setelan dan pesan email Anda. |
https://www.googleapis.com/auth/gmail.compose |
Mengelola draf dan mengirim email. |
https://www.googleapis.com/auth/gmail.insert |
Menambahkan email ke kotak masuk Gmail Anda. |
https://www.googleapis.com/auth/gmail.modify |
Membaca, menulis, dan mengirim email dari akun Gmail Anda. Cakupan ini tidak mengizinkan penghapusan langsung dan permanen rangkaian pesan dan pesan, melewati sampah. |
https://www.googleapis.com/auth/gmail.metadata |
Melihat metadata pesan email seperti label dan header, tetapi bukan isi email. |
https://www.googleapis.com/auth/gmail.settings.basic |
Melihat, mengedit, membuat, atau mengubah setelan dan filter email Anda di Gmail. |
https://www.googleapis.com/auth/gmail.settings.sharing |
Mengelola setelan email sensitif Anda, termasuk orang yang dapat mengelola email Anda.
Catatan: Operasi yang dilindungi oleh cakupan ini hanya dibatasi untuk penggunaan administratif. API ini hanya tersedia untuk pelanggan Google Workspace yang menggunakan akun layanan dengan delegasi tingkat domain. |
Cakupan dalam tabel sebelumnya menunjukkan sensitivitasnya, menurut definisi berikut:
Tidak sensitif: Cakupan ini memberikan cakupan otorisasi terkecil dan hanya memerlukan Verifikasi Aplikasi OAuth dasar. Untuk mengetahui informasi selengkapnya, lihat Persyaratan verifikasi.
Sensitif: Cakupan ini memberikan akses ke data pengguna Google tertentu yang diizinkan pengguna untuk aplikasi Anda. Cakupan ini memerlukan Verifikasi Aplikasi OAuth tambahan. Untuk mengetahui informasi selengkapnya, lihat Persyaratan Cakupan Sensitif dan Terlarang.
Dibatasi: Cakupan ini memberikan akses luas ke data pengguna Google dan memerlukan Verifikasi Aplikasi OAuth cakupan yang dibatasi. Untuk mengetahui informasi selengkapnya, lihat Kebijakan Data Pengguna Layanan API Google dan Persyaratan Tambahan untuk Cakupan API Tertentu.
Jika Anda menyimpan data cakupan terbatas di server (atau mengirimkan), maka Anda harus menjalani penilaian keamanan.
Informasi tambahan yang mengatur penggunaan dan akses Anda ke Gmail API saat Anda meminta akses ke data pengguna dapat ditemukan di Kebijakan developer dan data pengguna Google Workspace API.
Jika aplikasi Anda memerlukan akses ke Google API lainnya, Anda juga dapat menambahkan cakupan tersebut. Untuk mengetahui informasi selengkapnya tentang cakupan Google API, lihat Menggunakan OAuth 2.0 untuk Mengakses Google API.
Untuk mengetahui informasi selengkapnya tentang cakupan OAuth 2.0 tertentu, lihat Cakupan OAuth 2.0 untuk Google API.
Verifikasi OAuth
Penggunaan cakupan OAuth sensitif tertentu mungkin mengharuskan aplikasi Anda menyelesaikan proses verifikasi OAuth Google. FAQ Verifikasi Aplikasi OAuth dapat membantu Anda menentukan apakah verifikasi ini diperlukan dan jenis verifikasi yang diperlukan.