Dokumen ini berisi otorisasi spesifik Gmail API dan informasi autentikasi. Sebelum membaca dokumen ini, pastikan Anda membaca Informasi autentikasi umum dan otorisasi Google Workspace di Pelajari autentikasi dan otorisasi.
Mengonfigurasi OAuth 2.0 untuk otorisasi
Mengonfigurasi layar izin OAuth dan memilih cakupan untuk menentukan informasi yang akan ditampilkan kepada pengguna dan peninjau aplikasi, dan mendaftarkan aplikasi Anda sehingga Anda dapat memublikasikannya nanti.
Cakupan Gmail API
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 level akses. Cakupan adalah permintaan aplikasi Anda untuk bekerja dengan data Google Workspace, termasuk pengguna data Akun Google.
Saat aplikasi Anda diinstal, pengguna akan diminta untuk memvalidasi cakupan yang digunakan oleh aplikasi. Umumnya, Anda harus memilih ruang lingkup dengan fokus yang paling sempit mungkin dan menghindari permintaan cakupan yang tidak diperlukan aplikasi Anda. Pengguna lainnya langsung 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 |
Kelola draf dan kirim email saat Anda berinteraksi dengan {i>add-on<i}. | Tidak sensitif |
https://www.googleapis.com/auth/gmail.addons.current.message.action |
Lihat pesan email Anda saat Anda berinteraksi dengan {i>add-on<i}. | Tidak sensitif |
https://www.googleapis.com/auth/gmail.addons.current.message.metadata |
Melihat metadata pesan email saat add-on sedang berjalan. | Sensitif |
https://www.googleapis.com/auth/gmail.addons.current.message.readonly |
Melihat pesan email saat add-on sedang sedang berjalan. | Sensitif |
https://www.googleapis.com/auth/gmail.labels |
Membuat, membaca, memperbarui, dan menghapus label saja. | Tidak sensitif |
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. | Dibatasi |
https://www.googleapis.com/auth/gmail.compose |
Membuat, membaca, memperbarui, dan menghapus draf. Mengirim pesan dan draf. | Dibatasi |
https://www.googleapis.com/auth/gmail.insert |
Sisipkan dan impor pesan saja. | Dibatasi |
https://www.googleapis.com/auth/gmail.modify |
Semua operasi baca/tulis kecuali penghapusan langsung dan permanen atas rangkaian pesan dan pesan, dengan mengabaikan Sampah. | Dibatasi |
https://www.googleapis.com/auth/gmail.metadata |
Membaca metadata resource termasuk label, catatan histori, dan email header pesan, tetapi bukan isi atau lampiran pesan. | Dibatasi |
https://www.googleapis.com/auth/gmail.settings.basic |
Kelola setelan email dasar. | Dibatasi |
https://www.googleapis.com/auth/gmail.settings.sharing |
Mengelola setelan email yang sensitif, termasuk aturan penerusan dan alias.
Catatan:Operasi yang dilindungi oleh cakupan ini dibatasi untuk hanya untuk penggunaan administratif. Fitur ini hanya tersedia untuk pelanggan Google Workspace menggunakan akun layanan dengan delegasi seluruh domain. |
Dibatasi |
https://mail.google.com/ |
Akses penuh ke kotak surat akun, termasuk penghapusan permanen utas dan pesan Cakupan ini hanya harus diminta jika aplikasi Anda perlu segera dan secara permanen menghapus rangkaian pesan dan pesan, mengabaikan Sampah; semua tindakan lainnya dapat dilakukan dengan cakupan yang kurang permisif. | Dibatasi |
Kolom {i> Usage<i} di tabel di atas menunjukkan sensitivitas setiap ruang lingkup, menurut definisi berikut:
Tidak sensitif——Cakupan ini menyediakan cakupan terkecil akses otorisasi dan hanya memerlukan verifikasi aplikasi dasar. Untuk informasi tentang persyaratan ini, lihat Langkah-langkah untuk mempersiapkan verifikasi.
Sensitif—Cakupan ini memungkinkan akses ke Data Pengguna Google dan mewajibkan 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 cakupan yang dibatasi. Sebagai informasi tentang persyaratan ini, lihat Layanan Google API: Kebijakan Data Pengguna dan Persyaratan Tambahan untuk Cakupan API Tertentu. Jika Anda menyimpan data cakupan terbatas di server (atau mengirimkan), Anda harus melakukan penilaian keamanan.
Informasi tambahan yang mengatur penggunaan dan akses Anda ke Gmail API saat Anda permintaan untuk mengakses data pengguna dapat ditemukan di Kebijakan Developer dan Data Pengguna Layanan Gmail API.
Jika aplikasi Anda memerlukan akses ke Google API lainnya, Anda dapat menambahkan cakupannya juga. 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 melalui Proses verifikasi OAuth Google. Baca FAQ verifikasi OAuth untuk menentukan kapan aplikasi Anda harus menjalani verifikasi dan jenis verifikasi diperlukan. Lihat juga Layanan Google API: Kebijakan Data Pengguna.