Verifikasi cakupan yang dibatasi

Google API tertentu (yang menerima Sensitif atau cakupan yang dibatasi) memiliki persyaratan untuk aplikasi yang meminta izin untuk mengakses data konsumen. Persyaratan tambahan untuk cakupan yang dibatasi mewajibkan aplikasi untuk menunjukkan bahwa aplikasi tersebut adalah jenis aplikasi yang diizinkan dan harus dikirimkan ke peninjauan tambahan, termasuk kemungkinan penilaian keamanan.

Pemberlakuan cakupan yang dibatasi dalam API sebagian besar bergantung pada tingkat akses yang diperlukan untuk menyediakan fitur yang relevan di aplikasi Anda: hanya baca, hanya tulis, baca dan tulis, dll.

Saat Anda 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 seberapa banyak akses yang dibutuhkan. Jika aplikasi Anda meminta sensitif atau dibatasi, Anda harus menyelesaikan verifikasi proses kecuali penggunaan aplikasi Anda memenuhi syarat untuk pengecualian.

Jumlah cakupan yang dibatasi lebih sedikit dibandingkan dengan cakupan sensitif. Verifikasi FAQ Verifikasi OAuth API berisi daftar cakupan Sensitif dan Dibatasi saat ini. Cakupan ini memberikan akses luas ke data pengguna Google dan mengharuskan Anda menjalani verifikasi cakupan sebelum Anda meminta cakupan tersebut dari Akun Google mana pun. Untuk mengetahui informasi tentang persyaratan layanan, lihat Kebijakan Data Pengguna Layanan Google API dan Persyaratan tambahan untuk cakupan API tertentu atau halaman Developer Google spesifik per produk. Jika Anda menyimpan atau mengirimkan cakupan yang dibatasi data di server, maka Anda perlu menyelesaikan pengamanan penilaian.

Memahami cakupan terbatas

Jika aplikasi Anda meminta cakupan yang dibatasi dan tidak memenuhi syarat untuk pengecualian, Anda harus memenuhi Persyaratan tambahan untuk cakupan API spesifik Data Pengguna Layanan Google API kebijakan, atau persyaratan spesifik per produk tentang Halaman Developer Google, yang membutuhkan proses peninjauan yang lebih ekstensif.

Memahami penggunaan cakupan

  • Tinjau cakupan yang digunakan atau ingin digunakan aplikasi Anda. Untuk menemukan penggunaan cakupan yang ada, memeriksa kode sumber aplikasi Anda untuk setiap cakupan yang dikirim dengan permintaan otorisasi.
  • Menentukan apakah setiap cakupan yang diminta diperlukan untuk tindakan yang dimaksudkan fitur aplikasi Anda dan menggunakan hak istimewa terendah yang diperlukan untuk menyediakan fitur tersebut. Google API biasanya memiliki dokumentasi referensi tentang atribut Halaman Developer Google untuk endpoint-nya yang menyertakan cakupan yang diperlukan untuk memanggil endpoint atau properti tertentu di dalamnya. Untuk informasi selengkapnya tentang cakupan untuk titik akhir API yang dipanggil aplikasi Anda, baca dokumentasi referensi tersebut endpoint. 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 cara Anda mewakilinya kepada pengguna dalam tindakan aplikasi dan di kebijakan privasi kami.
  • Lihat dokumentasi API untuk mempelajari setiap cakupan lebih lanjut, termasuk potensinya sensitive or restricted status.
  • Deklarasikan semua cakupan yang digunakan oleh aplikasi Anda di API Console Layar izin OAuth halaman cakupan konfigurasi Google Cloud. Cakupan yang Anda tentukan dikelompokkan menjadi sensitif atau dibatasi kategori 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 verifikasi.

Pastikan untuk memperhitungkan waktu yang diperlukan guna menyelesaikan verifikasi dalam rencana peluncuran untuk atau fitur baru apa pun yang memerlukan ruang lingkup baru. Salah satu persyaratan tambahan ini terjadi jika aplikasi mengakses atau memiliki kemampuan untuk mengakses data pengguna Google dari atau melalui server. Di beberapa sistem harus menjalani pemeriksaan penilai keamanan dari penilai pihak ketiga independen yang disetujui oleh Google. Karena alasan ini, proses verifikasi cakupan yang dibatasi dapat mungkin memerlukan waktu beberapa minggu untuk diselesaikan. Perhatikan bahwa semua aplikasi harus menyelesaikan merek verifikasi langkah pertama, 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 pada model Halaman Developer Google (misalnya, Kebijakan Gmail API).

Anda bertanggung jawab untuk memahami dan menentukan jenis aplikasi. Namun, jika Anda benar-benar tidak yakin dengan jenis aplikasi aplikasi, Anda dapat memilih tidak opsi untuk pertanyaan Fitur apa 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 terbatas pengguna Google dan memiliki kemampuan untuk mengakses data dari atau melalui server pihak ketiga harus menjalani penilaian keamanan dari penilai keamanan yang dipilih Google. Penilaian ini membantu menjaga kepercayaan pengguna Google keamanan data dengan memverifikasi bahwa semua aplikasi yang mengakses data pengguna Google menunjukkan kemampuan untuk menangani data dengan aman dan untuk menghapus data pengguna atas permintaan pengguna.

Untuk menstandarkan penilaian keamanan, kami menggunakan App Defense Alliance dan framework penilaian keamanan aplikasi cloud (CASA).

Seperti yang disebutkan sebelumnya, untuk mempertahankan akses ke cakupan terbatas yang terverifikasi, aplikasi harus diverifikasi ulang untuk kepatuhan dan menyelesaikan penilaian keamanan setidaknya setiap 12 bulan setelah tanggal persetujuan Surat Penilaian (LOA) penilai. Jika aplikasi Anda menambahkan cakupan terbatas baru, aplikasi mungkin perlu dinilai ulang untuk mencakup cakupan tambahan jika tidak disertakan dalam penilaian keamanan.

Tim peninjauan Google akan mengirimkan email kepada Anda jika tiba waktunya untuk sertifikasi ulang aplikasi. Untuk memastikan bahwa anggota tim Anda yang benar akan diberi tahu tentang penegakan tahunan ini, mengaitkan Akun dengan project API Console Anda sebagai Pemilik atau Editor. Hal ini juga membantu untuk tetap {i>up-to-date<i} dukungan pengguna dan email kontak pengembang yang ditentukan di OAuth API Console Google Consent Screen page.

Langkah-langkah untuk mempersiapkan verifikasi

Semua aplikasi yang menggunakan Google API untuk meminta akses ke data harus melakukan langkah-langkah berikut untuk selesaikan verifikasi merek:

  1. Pastikan aplikasi Anda tidak termasuk dalam salah satu kasus penggunaan di bagian Pengecualian untuk persyaratan verifikasi.
  2. Pastikan aplikasi Anda mematuhi persyaratan branding API terkait atau Google. Misalnya, lihat pedoman branding untuk cakupan Login dengan Google.
  3. Verifikasi kepemilikan project Anda domain yang diotorisasi dalam Google Search Console. Gunakan Akun yang terkait dengan project API Console Anda sebagai Pemilik atau Editor.
  4. Pastikan semua informasi branding di layar izin OAuth, seperti nama aplikasi, dukungan email, URI halaman beranda, URI kebijakan privasi, dll., secara akurat merepresentasikan 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 ke situs Anda pelanggan.
  • 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 dipertimbangkan halaman beranda aplikasi yang valid.

Persyaratan link kebijakan privasi aplikasi

Pastikan kebijakan privasi aplikasi Anda memenuhi persyaratan berikut:

  • Kebijakan privasi harus terlihat oleh pengguna, dihosting dalam domain yang sama dengan halaman beranda aplikasi, dan ditautkan ke layar izin OAuth di Google API Console. Perhatikan bahwa laman beranda harus menyertakan deskripsi fungsi aplikasi, serta tautan ke kebijakan privasi dan persyaratan layanan opsional.
  • Kebijakan privasi harus mengungkapkan cara aplikasi Anda 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 praktik yang Anda publikasikan terungkap oleh kebijakan privasi.
  • Review example cases of privacy policies that don't meet the Limited Use requirements.

Cara mengirimkan aplikasi untuk verifikasi

Sebuah Google API Console project mengatur semua API Console . Sebuah proyek terdiri dari sekumpulan elemen yang saling terkait Akun Google yang memiliki izin untuk menjalankan operasi project, sekumpulan API yang diaktifkan, dan setelan penagihan, autentikasi, dan pemantauan untuk API tersebut. Misalnya, sebuah proyek dapat berisi satu atau beberapa klien OAuth, mengonfigurasi API untuk digunakan oleh klien tersebut, dan Layar izin OAuth yang ditampilkan kepada pengguna sebelum mereka mengizinkan akses ke aplikasi Anda.

Jika salah satu klien OAuth Anda belum siap untuk produksi, sebaiknya hapus klien tersebut dari proyek yang meminta verifikasi. Anda dapat melakukannya di Google API Console.

Untuk mengirimkan verifikasi, ikuti langkah-langkah berikut:

  1. Pastikan aplikasi Anda mematuhi Persyaratan Layanan Google API, dan Kebijakan Data Pengguna Layanan Google API.
  2. Pastikan peran pemilik dan editor untuk akun terkait project Anda tetap aktual, serta Email dukungan pengguna dan informasi kontak developer layar izin OAuth, di API Console. Hal ini memastikan bahwa anggota tim yang tepat diberi tahu tentang persyaratan baru.
  3. Buka API Console OAuth Consent Screen pageAnda.
  4. Klik tombol Project selector.

  5. Pada dialog Select from yang muncul, pilih project Anda. Jika Anda tidak dapat menemukan tetapi Anda tahu project ID-nya, Anda dapat membuat URL di browser dengan cara format:

    https://console.developers.google.com/apis/credentials/consent?project=[PROJECT_ID]

    Ganti [PROJECT_ID] dengan project ID yang ingin Anda gunakan.

  6. Pilih tombol Edit Aplikasi.
  7. Masukkan informasi yang diperlukan di halaman layar izin OAuth, lalu pilih tombol Simpan lalu lanjutkan.
  8. Gunakan tombol Tambahkan atau hapus cakupan untuk mendeklarasikan semua cakupan yang diminta oleh aplikasi Anda. Channel kumpulan cakupan awal yang diperlukan untuk Login dengan Google telah diisi sebelumnya dalam Cakupan tidak sensitif. Cakupan yang ditambahkan diklasifikasikan sebagai tidak sensitif, sensitive, or restricted.
  9. Berikan hingga tiga link ke dokumentasi yang relevan untuk fitur terkait di aplikasi Anda.

  10. Berikan informasi tambahan yang diminta tentang aplikasi Anda pada bagian berikutnya langkah.

    1. 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.
    2. Ensure your app is one of the allowed types specified in the Limited Use section of the Additional requirements for specific API scopes page.
    3. 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.

    4. 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.

      1. 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.
      2. Show that the OAuth consent screen correctly displays the App Name.
      3. Show that the browser address bar of the OAuth consent screen correctly includes your app's OAuth client ID.
      4. To show how the data will be used, demonstrate the functionality that's enabled by each sensitive and restricted scope that you request.
      5. If you use multiple clients, and therefore have multiple OAuth client IDs, show how the data is accessed on each OAuth client.
    5. Select your permitted application type from the "What features will you use?" list.
    6. Describe how you will use the restricted scopes in your app and why more limited scopes aren't sufficient.
  11. Jika konfigurasi aplikasi yang Anda berikan memerlukan verifikasi, Anda dapat mengirimkan aplikasi untuk verifikasi. Lengkapi kolom yang wajib diisi, lalu klik Kirim untuk memulai proses verifikasi Anda.

Setelah Anda mengirimkan aplikasi, tim Kepercayaan & Tim keselamatan menindaklanjuti melalui email dengan informasi tambahan yang mereka butuhkan atau langkah-langkah yang harus Anda selesaikan. Periksa alamat email Anda di Bagian Informasi kontak developer dan email dukungan izin OAuth Anda layar untuk permintaan informasi tambahan. Anda juga dapat melihat izin OAuth project Anda halaman layar untuk mengonfirmasi status tinjauan proyek Anda saat ini, termasuk apakah proses peninjauan dijeda sementara 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 Anda digunakan hanya oleh beberapa pengguna, yang mereka semua dikenal secara pribadi oleh Anda. Anda dan jumlah pengguna yang terbatas mungkin tidak keberatan melewati berbagai tahap aplikasi belum diverifikasi layar dan memberi akun pribadi Anda akses ke aplikasi.

Project yang digunakan dalam Pengembangan, Pengujian, atau Staging tingkatan

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 Anda ingin membuat aplikasi Anda tersedia untuk semua pengguna yang memiliki Akun Google. Oleh karena itu, jika aplikasi Anda sedang dalam tahap pengembangan, pengujian, atau staging, verifikasi tidak diperlukan.

Jika aplikasi berada dalam fase pengembangan atau pengujian, Anda dapat membiarkan Status Publikasi di pengaturan {i>default <i}dari Pengujian. Setelan ini berarti bahwa aplikasi Anda masih dalam pengembangan dan hanya untuk pengguna yang Anda tambahkan ke daftar pengguna uji coba. Anda harus mengelola daftar Akun Google yang terlibat dalam pengembangan atau pengujian aplikasi.

Pesan peringatan bahwa Google belum memverifikasi aplikasi yang sedang menjalani pengujian.
Gambar 1. Layar peringatan penguji

Khusus data milik layanan

Jika aplikasi Anda menggunakan akun layanan untuk mengakses datanya sendiri, dan tidak mengakses pengguna mana pun data (ditautkan ke Akun Google), maka Anda tidak perlu mengirimkannya untuk verifikasi.

Untuk memahami akun layanan, lihat Akun layanan di dokumentasi Google Cloud. Untuk petunjuk cara menggunakan akun layanan, lihat Menggunakan OAuth 2.0 untuk server ke server aplikasi.

Khusus penggunaan internal

Artinya, aplikasi hanya digunakan oleh pengguna Google Workspace atau Cloud Identity Anda organisasi. Project harus dimiliki oleh organisasi, dan layar izin OAuth-nya perlu dikonfigurasi untuk Pengguna Internal jenis iklan. Dalam hal ini, aplikasi Anda mungkin memerlukan persetujuan dari administrator organisasi. Sebagai informasi selengkapnya, lihat Tambahan untuk Google Workspace.

Penginstalan seluruh domain

Jika Anda berencana untuk membuat aplikasi yang hanya menargetkan pengguna organisasi Google Workspace atau Cloud Identity dan selalu menggunakan penginstalan di seluruh domain, aplikasi Anda tidak akan memerlukan verifikasi aplikasi. Hal ini karena domain di seluruh memungkinkan administrator domain memberikan akses kepada aplikasi internal dan pihak ketiga ke pengguna Anda layanan otomatis dan data skalabel. Administrator organisasi adalah satu-satunya akun yang dapat menambahkan aplikasi ke yang diizinkan untuk digunakan di domain mereka.

Pelajari cara membuat aplikasi Anda menjadi Penginstalan di Seluruh Domain dalam FAQ Ada pengguna di aplikasi saya akun perusahaan dari Domain Google Workspace lainnya.