Mengonfigurasi OAuth

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

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

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

  • Cakupan yang ditambahkan ke layar izin OAuth akan digunakan untuk verifikasi OAuth.
  • Cakupan yang ditambahkan ke Google Workspace Marketplace SDK digunakan untuk penginstalan individual dan seluruh domain guna mengizinkan aplikasi Anda saat diinstal dari Google Workspace Marketplace.
  • Cakupan yang ditambahkan ke manifes diperlukan agar aplikasi Anda berfungsi dengan baik.

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 oleh pengguna untuk diakses oleh 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. Lengkapi 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. Kami merekomendasikan praktik terbaik berikut saat memilih cakupan:

    • Pilih cakupan yang menyediakan 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 masing-masing bagian: cakupan tidak sensitif, cakupan sensitif, dan cakupan yang dibatasi. Untuk setiap cakupan yang tercantum di bagian "Cakupan sensitif Anda" atau "Cakupan yang dibatasi", coba identifikasi alternatif cakupan 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 informasi selengkapnya, lihat Kategori cakupan.
  5. Setelah memilih cakupan yang dibutuhkan oleh aplikasi Anda, klik Simpan dan Lanjutkan.
  6. Jika memilih Eksternal untuk jenis pengguna, tambahkan pengguna pengujian:
    1. Di bagian Pengguna uji coba, klik Tambahkan pengguna.
    2. Masukkan alamat email Anda dan pengguna pengujian yang diotorisasi lainnya, lalu klik Simpan dan Lanjutkan.
  7. Tinjau ringkasan pendaftaran aplikasi Anda. Untuk melakukan perubahan, klik Edit. Jika pendaftaran aplikasi terlihat baik-baik saja, klik Back to Dashboard.

2. Membuat kredensial OAuth 2.0

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

Jika Anda membuat aplikasi di Apps Script

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

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

Jika Anda tidak menggunakan Apps Script untuk membuat 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 terkecil yang memungkinkan.

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 diaksesnya, dan tingkat akses. Cakupan adalah permintaan aplikasi Anda untuk menangani data Google Workspace, termasuk data Akun Google pengguna.

Saat aplikasi Anda diinstal, pengguna akan diminta untuk memvalidasi cakupan yang digunakan oleh aplikasi. Umumnya, Anda harus memilih cakupan yang paling difokuskan dan menghindari permintaan cakupan yang tidak diperlukan aplikasi. Pengguna dapat lebih mudah memberikan akses ke cakupan yang terbatas dan dijelaskan dengan jelas.

4. Kirim untuk verifikasi OAuth (Khusus aplikasi publik)

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

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

Untuk mengirimkan 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 Submit for verification.
  5. Pada dialog Perlu verifikasi, masukkan justifikasi yang sesuai, lalu klik Kirim untuk memulai proses verifikasi.

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

Perbedaan verifikasi OAuth dengan peninjauan aplikasi

Verifikasi OAuth adalah proses terpisah dari peninjauan aplikasi. Fitur ini berfokus untuk memastikan bahwa layar izin Anda mewakili identitas dan intent aplikasi Anda secara akurat, dan memastikan aplikasi Anda tidak menyalahgunakan data pengguna. Listingan aplikasi Anda tidak dapat disetujui hingga verifikasi OAuth aplikasi Anda 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. Untuk mempelajari lebih lanjut kriteria peninjauan aplikasi, lihat Tentang peninjauan aplikasi.