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 menggunakan 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 dan menghindari permintaan cakupan yang tidak diperlukan aplikasi Anda. Pengguna lebih bersedia memberikan akses ke cakupan terbatas yang 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 sensitif |
https://www.googleapis.com/auth/gmail.addons.current.message.action |
Melihat pesan email Anda saat Anda berinteraksi dengan add-on. | Tidak sensitif |
https://www.googleapis.com/auth/gmail.addons.current.message.metadata |
Melihat metadata pesan email Anda saat add-on dijalankan. | Sensitif |
https://www.googleapis.com/auth/gmail.addons.current.message.readonly |
Melihat pesan email Anda saat add-on sedang dijalankan. | Sensitif |
https://www.googleapis.com/auth/gmail.labels |
Hanya membuat, membaca, memperbarui, dan menghapus label. | Tidak sensitif |
https://www.googleapis.com/auth/gmail.send |
Hanya mengirim pesan. Tidak ada hak istimewa baca atau ubah pada 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 |
Hanya menyisipkan dan mengimpor pesan. | Dibatasi |
https://www.googleapis.com/auth/gmail.modify |
Semua operasi baca/tulis kecuali penghapusan langsung dan permanen rangkaian pesan dan pesan, dengan melewati Sampah. | Dibatasi |
https://www.googleapis.com/auth/gmail.metadata |
Membaca metadata resource termasuk label, catatan histori, dan header pesan email, tetapi bukan isi pesan atau lampiran. | Dibatasi |
https://www.googleapis.com/auth/gmail.settings.basic |
Mengelola setelan email dasar. | Dibatasi |
https://www.googleapis.com/auth/gmail.settings.sharing |
Mengelola setelan email sensitif, termasuk aturan penerusan dan alias.
Catatan:Operasi yang dilindungi oleh cakupan ini dibatasi untuk penggunaan administratif saja. API ini hanya tersedia untuk pelanggan Google Workspace yang menggunakan akun layanan dengan delegasi tingkat domain. |
Dibatasi |
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 secara permanen menghapus rangkaian pesan dan pesan, melewati Sampah; semua tindakan lainnya dapat dilakukan dengan cakupan yang kurang permisif. | Dibatasi |
Kolom Penggunaan dalam tabel di atas menunjukkan sensitivitas setiap cakupan, sesuai dengan definisi berikut:
Tidak sensitif——Cakupan ini memberikan akses otorisasi terkecil dan hanya memerlukan verifikasi aplikasi dasar. Untuk mengetahui informasi tentang persyaratan ini, lihat Langkah-langkah untuk bersiap melakukan verifikasi.
Sensitif—Cakupan ini memungkinkan akses ke Data Pengguna Google dan memerlukan proses verifikasi cakupan 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 menjalani proses verifikasi 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 terbatas di server (atau mengirimkannya), 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 Data Pengguna dan Developer Layanan Gmail 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.
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.