Jika aplikasi Anda meminta izin untuk menggunakan Google API guna mengakses data pengguna Google, Anda mungkin harus menyelesaikan proses verifikasi sebelum dapat membuat aplikasi Anda tersedia untuk publik untuk pertama kalinya.
Apakah persyaratan ini berlaku untuk aplikasi Anda sebagian besar bergantung pada dua faktor:
- Jenis data pengguna yang Anda akses—informasi profil publik, entri kalender, file di Drive, data kesehatan dan kebugaran tertentu, dll.
- Tingkat akses yang Anda butuhkan—hanya baca, baca dan tulis, dll.
Saat menggunakan OAuth 2.0 untuk mendapatkan izin dari Akun Google guna mengakses data pengguna, Anda menggunakan string yang disebut cakupan untuk menentukan jenis data yang ingin diakses atas nama pengguna. Jika aplikasi Anda meminta cakupan yang dikategorikan sebagai sensitif atau dibatasi, Anda mungkin perlu menyelesaikan proses verifikasi kecuali jika penggunaan aplikasi Anda memenuhi syarat untuk pengecualian.
Contoh cakupan sensitif meliputi membaca peristiwa yang disimpan di Google Kalender, menyimpan kontak baru di Google Kontak, atau menghapus video YouTube. Untuk mengetahui informasi selengkapnya tentang cakupan yang tersedia dan klasifikasinya, lihat dokumentasi referensi endpoint API yang dipanggil oleh aplikasi Anda, dan panduan otorisasi terkait yang dipublikasikan untuk API.
Anda harus meminta cakupan yang memerlukan jumlah akses paling sedikit ke data pengguna yang diperlukan untuk menyediakan fungsi tersebut. Misalnya, aplikasi yang hanya membaca data tidak boleh meminta akses untuk membaca, menulis, dan menghapus konten jika cakupan yang lebih sempit tersedia untuk API dan endpoint terkaitnya. Data yang Anda terima dari Google API hanya boleh digunakan sesuai dengan kebijakan API dan dengan cara yang Anda tunjukkan kepada pengguna dalam tindakan aplikasi dan dalam kebijakan privasi Anda.
Pastikan untuk memperhitungkan waktu yang diperlukan untuk menyelesaikan verifikasi ke dalam rencana peluncuran aplikasi Anda atau fitur baru yang memerlukan cakupan baru. Proses verifikasi cakupan sensitif biasanya memerlukan waktu 3-5 hari kerja. Perhatikan bahwa aplikasi Anda mungkin memenuhi syarat untuk menyelesaikan verifikasi merek sebagai bagian dari permintaan verifikasi cakupan sensitif.
Memahami cakupan sensitif
Cakupan sensitif perlu ditinjau oleh Google sebelum Akun Google dapat memberikan akses. Administrator organisasi Google Workspace dapat membatasi akses ke cakupan sensitif untuk mencegah akses oleh client ID OAuth yang tidak ditandai secara eksplisit oleh organisasi sebagai tepercaya.
Memahami penggunaan ruang lingkup Anda
- Tinjau cakupan yang digunakan atau ingin digunakan oleh aplikasi Anda. Untuk menemukan penggunaan cakupan yang ada, periksa kode sumber aplikasi Anda untuk semua cakupan yang dikirim dengan permintaan otorisasi.
- Tentukan bahwa setiap cakupan yang diminta diperlukan untuk tindakan yang dimaksudkan dari fitur aplikasi dan menggunakan hak istimewa terendah yang diperlukan untuk menyediakan fitur tersebut. Google API biasanya memiliki dokumentasi referensi di halaman Google Developer produk untuk endpoint-nya yang mencakup cakupan yang diperlukan untuk memanggil endpoint atau properti tertentu di dalamnya. Untuk mengetahui informasi selengkapnya tentang cakupan akses yang diperlukan untuk endpoint API yang dipanggil aplikasi Anda, baca dokumentasi referensi endpoint tersebut.
- Data yang Anda terima dari Google API hanya boleh digunakan sesuai dengan kebijakan API dan dengan cara yang Anda tampilkan kepada pengguna dalam tindakan aplikasi dan dalam kebijakan privasi Anda.
- Lihat dokumentasi API untuk mempelajari setiap cakupan lebih lanjut, termasuk kemungkinan status sensitive or restricted -nya.
- Deklarasikan semua cakupan yang digunakan oleh aplikasi Anda di halaman cakupan konfigurasi Layar izin OAuth API Console. Cakupan yang Anda tentukan dikelompokkan ke dalam kategori sensitif atau yang dibatasi untuk menyoroti verifikasi tambahan yang diperlukan.
- Temukan cakupan terbaik yang cocok dengan data yang digunakan oleh integrasi Anda, pahami penggunaannya, konfirmasi ulang bahwa semuanya masih berfungsi di lingkungan pengujian, lalu bersiaplah untuk mengirimkannya untuk diverifikasi.
![Tabel menampilkan nama API, salah satu cakupan sensitifnya, dan deskripsi
cakupannya.](https://developers-dot-devsite-v2-prod.appspot.com/static/identity/protocols/oauth2/images/examples/sensitive-scope-example.png?authuser=4&hl=id)
Langkah-langkah persiapan verifikasi
Semua aplikasi yang menggunakan Google API untuk meminta akses ke data harus melakukan langkah-langkah berikut guna menyelesaikan verifikasi merek:
- Konfirmasi bahwa aplikasi Anda tidak termasuk dalam kasus penggunaan apa pun di bagian Pengecualian terhadap persyaratan verifikasi.
- Pastikan aplikasi Anda mematuhi persyaratan branding API atau produk terkait. Misalnya, lihat pedoman branding untuk cakupan Login dengan Google.
- Verifikasi kepemilikan domain resmi project Anda dalam Google Search Console. Gunakan Akun Google yang terkait dengan project API Console Anda sebagai Pemilik atau Editor.
- Pastikan semua informasi branding di layar izin OAuth, seperti nama aplikasi, email dukungan, URI halaman beranda, URI kebijakan privasi, dll., secara akurat mewakili identitas aplikasi.
Persyaratan halaman beranda aplikasi
Pastikan halaman beranda Anda memenuhi persyaratan berikut:
- Halaman beranda Anda harus dapat diakses secara publik, dan tidak hanya dapat diakses oleh pengguna yang login di situs Anda.
- Relevansi halaman beranda Anda dengan aplikasi yang sedang dalam peninjauan harus jelas.
- Link ke listingan aplikasi Anda di Google Play Store atau halaman Facebook-nya tidak dianggap sebagai halaman beranda aplikasi yang valid.
Persyaratan link kebijakan privasi aplikasi
Pastikan kebijakan privasi aplikasi Anda memenuhi persyaratan berikut:
- Kebijakan privasi harus dapat dilihat oleh pengguna, dihosting dalam domain yang sama dengan halaman beranda aplikasi Anda, dan ditautkan ke layar izin OAuth Google API Console. Perhatikan bahwa halaman beranda harus menyertakan deskripsi fungsi aplikasi, serta link ke kebijakan privasi dan persyaratan layanan opsional.
- Kebijakan privasi harus mengungkapkan cara yang digunakan aplikasi Anda untuk mengakses, menggunakan, menyimpan, atau membagikan data pengguna Google. Anda harus membatasi penggunaan data pengguna Google oleh Anda untuk praktik yang diungkapkan oleh kebijakan privasi yang Anda publikasikan.
Cara mengirimkan aplikasi Anda untuk verifikasi
Sebuah projectGoogle API Console mengatur semua resource API Console Anda. Project terdiri dari kumpulan Akun Google terkait yang memiliki izin untuk menjalankan operasi project, sekumpulan API yang diaktifkan, serta setelan penagihan, autentikasi, dan pemantauan untuk API tersebut. Misalnya, sebuah project dapat berisi satu atau beberapa klien OAuth, mengonfigurasi API untuk digunakan oleh klien tersebut, dan mengonfigurasi layar izin OAuth yang ditampilkan kepada pengguna sebelum mereka mengizinkan akses ke aplikasi Anda.
Jika salah satu klien OAuth Anda belum siap untuk diproduksi, sebaiknya hapus klien tersebut dari project yang meminta verifikasi. Anda dapat melakukannya di Google API Console.
Untuk mengirimkan verifikasi, ikuti langkah-langkah berikut:
- Pastikan aplikasi Anda mematuhi Persyaratan Layanan Google API, dan Kebijakan Data Pengguna Layanan Google API.
- Pastikan peran pemilik dan editor untuk akun terkait project Anda sudah saat ini, serta email dukungan pengguna dan informasi kontak developer layar izin OAuth, di API ConsoleAnda. Langkah ini memastikan bahwa anggota tim Anda yang tepat diberi tahu jika ada persyaratan baru.
- Buka API Console OAuth Consent Screen page.
- Klik tombol Project selector.
-
Pada dialog Select from yang muncul, pilih project Anda. Jika Anda tidak dapat menemukan project, tetapi mengetahui project ID, Anda dapat membuat URL di browser dalam format berikut:
https://console.developers.google.com/apis/credentials/consent?project=[PROJECT_ID]
Ganti [PROJECT_ID] dengan project ID yang ingin Anda gunakan.
- Pilih tombol Edit Aplikasi.
- Masukkan informasi yang diperlukan pada halaman layar izin OAuth, lalu pilih tombol Save and continue.
- Gunakan tombol Tambahkan atau hapus cakupan untuk mendeklarasikan semua cakupan yang diminta oleh aplikasi Anda. Kumpulan awal cakupan yang diperlukan untuk Login dengan Google sudah terisi di bagian Cakupan non-sensitif. Cakupan yang ditambahkan diklasifikasikan sebagai tidak sensitif, yaitu sensitive, or restricted.
- Berikan hingga tiga link ke dokumentasi yang relevan untuk fitur terkait di aplikasi Anda.
-
Berikan informasi tambahan apa pun yang diminta terkait aplikasi Anda dalam langkah-langkah berikutnya.
- Prepare a detailed justification for each requested sensitive scope, as well as an explanation
for why a narrower scope isn't sufficient. For example: "My app will use
https://www.googleapis.com/auth/calendar
to show a user's Google calendar data on the scheduling screen of my app. This lets users manage their schedules through my app and sync the changes with their Google calendar." -
Prepare a video that fully demonstrates how a user initiates and grants access to the requested scopes and shows, in detail, the usage of the granted sensitive and restricted scopes in the app. Upload the video to YouTube Studio and set its Visibility as Unlisted. You need to provide a link to the demonstration video in the YouTube link field.
- Show the OAuth grant process that users will experience, in English. This includes the consent flow and, if you use Google Sign-In, the sign-in flow.
- Show that the OAuth consent screen correctly displays the App Name.
- Show that the browser address bar of the OAuth consent screen correctly includes your app's OAuth client ID.
- To show how the data will be used, demonstrate the functionality that's enabled by each sensitive scope that you request.
- Prepare a detailed justification for each requested sensitive scope, as well as an explanation
for why a narrower scope isn't sufficient. For example: "My app will use
- Jika konfigurasi aplikasi yang Anda berikan memerlukan verifikasi, Anda memiliki kesempatan untuk mengirimkan aplikasi tersebut agar diverifikasi. Lengkapi kolom yang wajib diisi, lalu klik Submit untuk memulai proses verifikasi.
Setelah Anda mengirimkan aplikasi, tim Kepercayaan & Keamanan Google akan menindaklanjuti melalui email dengan menyertakan informasi tambahan apa pun yang mereka butuhkan atau langkah-langkah yang harus Anda selesaikan. Periksa alamat email Anda di bagian Informasi kontak developer dan email dukungan layar persetujuan OAuth Anda untuk melihat permintaan informasi tambahan. Anda juga dapat melihat halaman layar izin OAuth project Anda untuk mengonfirmasi status peninjauan project saat ini, termasuk apakah proses peninjauan dijeda selagi kami menunggu respons Anda.
Pengecualian untuk persyaratan verifikasi
Jika aplikasi Anda akan digunakan dalam salah satu skenario yang dijelaskan di bagian berikut, Anda tidak perlu mengirimkannya untuk ditinjau.
Penggunaan pribadi
Salah satu kasus penggunaannya adalah jika Anda adalah satu-satunya pengguna aplikasi atau jika aplikasi tersebut hanya digunakan oleh sedikit pengguna, yang semuanya Anda kenal secara pribadi. Anda dan jumlah pengguna Anda yang terbatas mungkin tidak keberatan untuk beralih melalui layar aplikasi yang belum diverifikasi dan mengizinkan akun pribadi Anda mengakses aplikasi.
Project yang digunakan dalam tingkat Pengembangan, Pengujian, atau Staging
Untuk mematuhi Kebijakan Google OAuth 2.0, sebaiknya Anda memiliki project yang berbeda untuk lingkungan pengujian dan produksi. Sebaiknya Anda hanya mengirimkan aplikasi untuk verifikasi jika ingin aplikasi tersebut tersedia untuk semua pengguna yang memiliki Akun Google. Oleh karena itu, jika aplikasi Anda berada dalam fase pengembangan, pengujian, atau staging, verifikasi tidak diperlukan.
Jika aplikasi berada dalam fase pengembangan atau pengujian, Anda dapat membiarkan Status Publikasi dalam setelan default Testing. Setelan ini berarti bahwa aplikasi Anda masih dalam pengembangan dan hanya tersedia untuk pengguna yang Anda tambahkan ke daftar pengguna pengujian. Anda harus mengelola daftar Akun Google yang terlibat dalam pengembangan atau pengujian aplikasi.
![Pesan peringatan bahwa Google belum memverifikasi aplikasi yang sedang menjalani pengujian.](https://developers-dot-devsite-v2-prod.appspot.com/static/identity/protocols/oauth2/images/examples/tester-warning-screen.png?authuser=4&hl=id)
Hanya data yang dimiliki layanan
Jika aplikasi Anda menggunakan akun layanan untuk mengakses datanya sendiri, dan tidak mengakses data pengguna apa pun (ditautkan ke Akun Google), Anda tidak perlu mengirimkan permohonan verifikasi.
Untuk memahami apa itu akun layanan, lihat Akun layanan di dokumentasi Google Cloud. Untuk petunjuk cara menggunakan akun layanan, lihat Menggunakan OAuth 2.0 untuk aplikasi server ke server.
Khusus penggunaan internal
Artinya, aplikasi hanya digunakan oleh orang di organisasi Google Workspace atau Cloud Identity Anda. Project harus dimiliki oleh organisasi, dan layar izin OAuth-nya perlu dikonfigurasi untuk jenis pengguna Internal. Dalam hal ini, aplikasi Anda mungkin memerlukan persetujuan dari administrator organisasi. Untuk mengetahui informasi selengkapnya, lihat Pertimbangan tambahan untuk Google Workspace.
- Pelajari lebih lanjut aplikasi publik dan internal.
- Pelajari cara menandai aplikasi Anda sebagai internal dalam FAQ Bagaimana cara menandai aplikasi saya sebagai khusus internal?
Penginstalan di seluruh domain
Jika Anda berencana agar aplikasi hanya menargetkan pengguna organisasi Google Workspace atau Cloud Identity dan selalu menggunakan penginstalan seluruh domain, aplikasi tidak akan memerlukan verifikasi aplikasi. Hal ini karena penginstalan seluruh domain memungkinkan administrator domain memberikan akses kepada aplikasi internal dan pihak ketiga ke data pengguna Anda. Administrator organisasi adalah satu-satunya akun yang dapat menambahkan aplikasi ke daftar yang diizinkan untuk digunakan dalam domain mereka.
Pelajari cara menjadikan aplikasi Anda sebagai Penginstalan di Seluruh Domain dalam FAQ Aplikasi saya memiliki pengguna dengan akun perusahaan dari Domain Google Workspace lain.