Google API tertentu (yang menerima cakupan Sensitif atau Dibatasi ) memiliki persyaratan untuk aplikasi yang meminta izin untuk mengakses data konsumen. Persyaratan tambahan untuk cakupan yang dibatasi ini mengharuskan aplikasi untuk menunjukkan bahwa aplikasi tersebut merupakan jenis aplikasi yang diizinkan dan harus dikirim ke peninjauan tambahan, yang mencakup penilaian keamanan yang memungkinkan.
Penerapan cakupan yang dibatasi dalam API sebagian besar bergantung pada tingkat akses yang diperlukan untuk menyediakan fitur yang relevan dalam aplikasi Anda: hanya baca, hanya tulis, baca dan tulis, dll.
Saat menggunakan OAuth 2.0 untuk mendapatkan izin dari Akun Google guna mengakses data ini, Anda menggunakan string yang disebut cakupan untuk menentukan jenis data yang ingin diakses dan jumlah akses yang diperlukan. Jika aplikasi Anda meminta cakupan sensitif atau dibatasi, Anda harus menyelesaikan proses verifikasi kecuali jika penggunaan aplikasi Anda memenuhi syarat untuk pengecualian.
Jumlah cakupan yang dibatasi lebih sedikit dibandingkan dengan cakupan sensitif. FAQ Verifikasi OAuth API berisi daftar cakupan Sensitif dan Dibatasi saat ini. Cakupan ini memberikan akses luas ke data pengguna Google dan mengharuskan Anda melalui proses verifikasi cakupan sebelum meminta cakupan dari Akun Google mana pun. Untuk informasi tentang persyaratan ini, lihat Kebijakan Data Pengguna Layanan Google API dan Persyaratan tambahan untuk cakupan API tertentu atau halaman Developer Google khusus produk. Jika Anda menyimpan atau mengirimkan data cakupan yang dibatasi di server, Anda harus menyelesaikan penilaian keamanan.
Memahami cakupan yang dibatasi
Jika aplikasi Anda meminta cakupan yang dibatasi dan tidak memenuhi syarat untuk pengecualian, Anda harus memenuhi Persyaratan tambahan untuk cakupan API tertentu dari Kebijakan Data Pengguna Layanan Google API, atau persyaratan khusus produk di halaman Google Developer produk, yang memerlukan proses peninjauan yang lebih menyeluruh.
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. For example, for an app that only uses Gmail APIs to occasionally send emails on a user's behalf, don't request the scope that provides full access to the user's email data.
- 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.
Pastikan untuk memperhitungkan waktu yang diperlukan untuk menyelesaikan verifikasi ke dalam rencana peluncuran aplikasi Anda atau fitur baru yang memerlukan cakupan baru. Salah satu persyaratan tambahan ini terjadi jika aplikasi mengakses atau memiliki kemampuan untuk mengakses data pengguna Google dari atau melalui server. Dalam hal ini, sistem harus menjalani penilaian keamanan tahunan dari penilai pihak ketiga independen yang disetujui oleh Google. Karena alasan ini, proses verifikasi cakupan yang dibatasi berpotensi memerlukan waktu beberapa minggu untuk diselesaikan. Perhatikan bahwa semua aplikasi harus menyelesaikan langkah verifikasi merek terlebih dahulu, yang biasanya memerlukan waktu 2-3 hari kerja, jika informasi branding telah berubah sejak verifikasi layar izin OAuth terakhir yang disetujui.
Jenis aplikasi yang diizinkan
Jenis aplikasi tertentu dapat mengakses cakupan yang dibatasi untuk setiap produk. Anda dapat menemukan jenis aplikasi di Halaman Developer Google khusus produk (misalnya, Kebijakan Gmail API).
Anda bertanggung jawab untuk memahami dan menentukan jenis aplikasi Anda. Namun, jika benar-benar tidak yakin dengan jenis aplikasi Anda, Anda tidak dapat memilih opsi untuk pertanyaan Fitur apa saja yang akan Anda gunakan? saat mengirimkan aplikasi untuk verifikasi. Tim verifikasi Google API kemudian akan menentukan jenis aplikasi.
Penilaian keamanan
Setiap aplikasi yang meminta akses ke data yang dibatasi pengguna Google dan memiliki kemampuan untuk mengakses data dari atau melalui server pihak ketiga harus melalui penilaian keamanan dari penilai keamanan yang dipilih Google. Penilaian ini membantu menjaga keamanan data pengguna Google dengan memverifikasi bahwa semua aplikasi yang mengakses data pengguna Google menunjukkan kemampuan dalam menangani data dengan aman dan menghapus data pengguna atas permintaan pengguna.
Untuk menstandarkan penilaian keamanan, kami menggunakan App Defense Alliance dan cloud application security assessment framework (CASA).
Seperti yang disebutkan sebelumnya, untuk mempertahankan akses ke cakupan terverifikasi yang dibatasi, aplikasi harus diverifikasi ulang untuk kepatuhan dan menyelesaikan penilaian keamanan setidaknya setiap 12 bulan setelah tanggal persetujuan Surat Penilaian (LOA) penilai Anda. Jika aplikasi Anda menambahkan cakupan baru yang dibatasi, aplikasi Anda mungkin perlu dinilai ulang untuk mencakup cakupan tambahan jika tidak disertakan dalam penilaian keamanan sebelumnya.
Tim peninjau Google akan mengirimkan email jika sudah tiba waktunya untuk sertifikasi ulang aplikasi Anda. Untuk memastikan bahwa anggota tim yang benar diberi tahu tentang penegakan tahunan ini, kaitkan Akun Google tambahan dengan project API Console Anda sebagai Pemilik atau Editor. Ada baiknya juga untuk terus mendapatkan info terbaru tentang dukungan pengguna dan email kontak developer yang ditentukan dalam Consent Screen pageGoogle API Console OAuth.
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. The privacy policy must comply with the Google API Services User Data Policy and the Limited Use requirements for restricted scopes. Anda harus membatasi penggunaan data pengguna Google oleh Anda untuk praktik yang diungkapkan oleh kebijakan privasi yang Anda publikasikan.
- Review example cases of privacy policies that don't meet the Limited Use requirements.
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.
- Ensure your app complies with the Additional requirements for specific API scopes, which includes undergoing an annual security assessment if your app accesses restricted scope Google users' data from or through a third-party server.
- Ensure your app is one of the allowed types specified in the Limited Use section of the Additional requirements for specific API scopes page.
- If your app is a task automation platform, your demonstration video must showcase how multiple API workflows are created and automated, and in which directions user data flows.
-
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 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 and restricted scope that you request.
- If you use multiple clients, and therefore have multiple OAuth client IDs, show how the data is accessed on each OAuth client.
- Select your permitted application type from the "What features will you use?" list.
- Describe how you will use the restricted scopes in your app and why more limited scopes aren't sufficient.
- 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.