Mengonfigurasi OAuth

Saat memublikasikan aplikasi, ada 4 tugas utama yang harus diselesaikan untuk autentikasi dan otorisasi:

  1. Isi layar izin OAuth.
  2. Buat kredensial OAuth 2.0.
  3. Mengonfigurasi semua cakupan yang perlu dijalankan aplikasi di Google Workspace Marketplace SDK
  4. Kirimkan aplikasi Anda untuk diverifikasi OAuth.

Cakupan yang Anda tambahkan ke setiap tempat harus cocok dan digunakan dengan cara berikut:

  • Cakupan yang ditambahkan ke layar izin OAuth digunakan untuk verifikasi OAuth.
  • Cakupan yang ditambahkan ke Google Workspace Marketplace SDK digunakan untuk penginstalan tingkat domain dan penginstalan individual guna memberikan otorisasi ke aplikasi Anda saat diinstal dari Google Workspace Marketplace.
  • Cakupan yang ditambahkan ke manifes diperlukan agar aplikasi Anda berfungsi dengan benar.

Misalnya, jika Anda memublikasikan aplikasi yang menyertakan add-on Google Spreadsheet dan add-on Google Dokumen, setiap manifes Apps Script add-on hanya menyertakan cakupan khusus untuk add-on. Dalam project Google Cloud Anda, layar izin OAuth dan Google Workspace Marketplace SDK menyertakan cakupan untuk kedua add-on tersebut.

Prasyarat

Layar izin OAuth adalah perintah yang memberi tahu pengguna siapa yang meminta akses ke data mereka dan jenis data yang diizinkan pengguna untuk diakses aplikasi Anda.

  1. Di konsol Google Cloud, buka Menu > APIs & Services > OAuth consent screen.

    Buka layar izin OAuth

  2. Pilih jenis pengguna untuk aplikasi Anda, lalu klik Buat.
  3. Isi formulir pendaftaran aplikasi, lalu klik Simpan dan Lanjutkan.

  4. Jika Anda membuat aplikasi untuk digunakan di luar organisasi Google Workspace, klik Tambahkan atau Hapus Cakupan. Sebaiknya terapkan praktik terbaik berikut saat memilih cakupan:

    • Pilih cakupan yang memberikan tingkat akses minimum yang diperlukan oleh aplikasi Anda. Untuk daftar cakupan yang tersedia, lihat Cakupan OAuth 2.0 untuk Google API.
    • Tinjau cakupan yang tercantum di setiap tiga bagian: cakupan tidak sensitif, cakupan sensitif, dan cakupan terbatas. Untuk cakupan apa pun yang tercantum di bagian "Cakupan sensitif Anda" atau "Cakupan terbatas Anda", coba identifikasi cakupan alternatif yang tidak sensitif untuk menghindari peninjauan tambahan yang tidak perlu.
    • Beberapa cakupan memerlukan peninjauan tambahan oleh Google. Untuk aplikasi yang hanya digunakan secara internal oleh organisasi Google Workspace Anda, cakupan tidak tercantum di layar izin dan penggunaan cakupan yang dibatasi atau sensitif tidak memerlukan peninjauan lebih lanjut oleh Google. Untuk mengetahui informasi selengkapnya, lihat Kategori cakupan.
  5. Setelah memilih cakupan yang diperlukan oleh aplikasi Anda, klik Simpan dan Lanjutkan.
  6. Jika Anda memilih Eksternal untuk jenis pengguna, tambahkan pengguna pengujian:
    1. Di bagian Pengguna pengujian, klik Tambahkan pengguna.
    2. Masukkan alamat email Anda dan pengguna pengujian resmi lainnya, lalu klik Simpan dan Lanjutkan.
  7. Tinjau ringkasan pendaftaran aplikasi Anda. Untuk melakukan perubahan, klik Edit. Jika pendaftaran aplikasi terlihat OK, klik Kembali ke Dasbor.

2. Membuat kredensial OAuth 2.0

Bergantung pada cara Anda mem-build aplikasi, ada dua cara berbeda untuk membuat kredensial OAuth 2.0.

Jika Anda mem-build aplikasi di Apps Script

Alihkan project Apps Script dari project Google Cloud defaultnya ke project standar baru Anda. Lihat Beralih ke project standar lain.

Setelah Anda mengaitkan project Apps Script dengan project Google Cloud, kredensial OAuth 2.0 Anda akan otomatis dibuat.

Jika Anda tidak menggunakan Apps Script untuk mem-build aplikasi

Untuk membuat kredensial OAuth 2.0, lihat Kredensial client ID OAuth.

3. Mengonfigurasi cakupan

Berikan daftar lengkap cakupan OAuth yang diperlukan aplikasi Anda. Selalu gunakan cakupan sempit.

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 akses. Cakupan adalah permintaan aplikasi Anda untuk menggunakan 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 sempit dan menghindari permintaan cakupan yang tidak diperlukan aplikasi Anda. Pengguna lebih mudah memberikan akses ke cakupan terbatas yang dijelaskan dengan jelas.

4. Mengirim untuk verifikasi OAuth (Khusus aplikasi publik)

Jika aplikasi publik menggunakan cakupan sensitif atau yang dibatasi, aplikasi tersebut harus melalui proses peninjauan verifikasi OAuth.

  • Untuk verifikasi OAuth, Anda harus mengirimkan video demo yang menunjukkan perjalanan atau alur yang menjelaskan penggunaan cakupan atau data yang diminta kepada pengguna.
  • Jika menggunakan cakupan terbatas, aplikasi Anda mungkin juga perlu melalui penilaian keamanan. Lihat Alasan penilaian keamanan diperlukan.

Untuk mengirimkan permintaan verifikasi, ikuti langkah-langkah berikut:

  1. Di konsol Google Cloud, buka Menu > APIs & Services > OAuth consent screen.

    Buka layar izin OAuth

  2. Klik Project selector, lalu pilih project Anda.
  3. Klik Edit aplikasi
  4. Masukkan informasi yang diperlukan, lalu klik Kirim untuk verifikasi.
  5. Pada dialog Verifikasi diperlukan, masukkan justifikasi yang sesuai, lalu klik Kirim untuk memulai proses verifikasi.

Jika Anda mengupdate aplikasi untuk menggunakan cakupan yang berbeda yang sensitif atau membatasi, Anda harus mengirimkan aplikasi untuk diverifikasi OAuth lagi. Anda tidak perlu mengirimkannya lagi untuk peninjauan aplikasi.

Perbedaan verifikasi OAuth dengan peninjauan aplikasi

Verifikasi OAuth adalah proses terpisah dari peninjauan aplikasi. Pengujian ini berfokus pada memastikan layar izin Anda merepresentasikan identitas dan intent aplikasi secara akurat, serta memastikan aplikasi Anda tidak menyalahgunakan data pengguna. Listingan aplikasi Anda tidak dapat disetujui hingga verifikasi OAuth aplikasi selesai. Untuk informasi selengkapnya tentang verifikasi OAuth, lihat FAQ verifikasi OAuth API.

Peninjauan aplikasi berfokus pada informasi yang Anda berikan di Google Workspace Marketplace API, serta fungsi dan kegunaan aplikasi Anda. Untuk mempelajari lebih lanjut kriteria peninjauan aplikasi, lihat Tentang peninjauan aplikasi.