Pilih cakupan Google Drive API

Dokumen ini berisi otorisasi khusus Google Drive API dan informasi autentikasi. Sebelum membaca dokumen ini, pastikan Anda membaca Informasi autentikasi umum dan otorisasi Google Workspace di Pelajari autentikasi dan otorisasi.

Mengonfigurasi OAuth 2.0 untuk otorisasi

Mengonfigurasi layar izin OAuth dan memilih cakupan untuk menentukan informasi yang akan ditampilkan kepada pengguna dan peninjau aplikasi, dan mendaftarkan aplikasi Anda sehingga Anda dapat memublikasikannya nanti.

Cakupan API Drive

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 level akses. Cakupan adalah permintaan aplikasi Anda untuk bekerja dengan data Google Workspace, termasuk pengguna data Akun Google.

Saat aplikasi Anda diinstal, pengguna akan diminta untuk memvalidasi cakupan yang digunakan oleh aplikasi. Umumnya, Anda harus memilih ruang lingkup dengan fokus yang paling sempit mungkin dan menghindari permintaan cakupan yang tidak diperlukan aplikasi Anda. Pengguna lainnya langsung memberikan akses ke cakupan yang terbatas dan dijelaskan dengan jelas.

Jika memungkinkan, sebaiknya gunakan cakupan yang tidak sensitif karena cakupan tersebut memberikan per file akses ke ruang lingkup dan mempersempit akses ke fitur tertentu yang dibutuhkan oleh aplikasi.

Drive API mendukung cakupan berikut:

Kode cakupan Deskripsi Penggunaan
https://www.googleapis.com/auth/drive.appdata
https://www.googleapis.com/auth/drive.appfolder
Melihat dan mengelola data konfigurasi aplikasi itu sendiri di Google Drive Anda. Direkomendasikan
Tidak sensitif
https://www.googleapis.com/auth/drive.install Izinkan aplikasi muncul sebagai opsi di "Buka dengan" atau tombol "Baru" Google Spreadsheet. Direkomendasikan
Tidak sensitif
https://www.googleapis.com/auth/drive.file Buat file Drive baru, atau ubah file yang ada, yang Anda buka dengan aplikasi atau yang dibagikan pengguna ke aplikasi saat menggunakan Google Picker API atau pemilih file aplikasi. Direkomendasikan
Tidak sensitif
https://www.googleapis.com/auth/drive.apps.readonly Lihat aplikasi yang diberi otorisasi untuk mengakses Drive Anda. Sensitif
https://www.googleapis.com/auth/drive Melihat dan mengelola semua file Drive Anda. Dibatasi
https://www.googleapis.com/auth/drive.readonly Melihat dan mendownload semua file Drive Anda. Dibatasi
https://www.googleapis.com/auth/drive.activity Melihat dan menambahkan ke catatan aktivitas file di Drive. Dibatasi
https://www.googleapis.com/auth/drive.activity.readonly Lihat catatan aktivitas file di Drive Anda. Dibatasi
https://www.googleapis.com/auth/drive.meet.readonly Lihat file Drive yang dibuat atau diedit oleh Google Meet. Dibatasi
https://www.googleapis.com/auth/drive.metadata Melihat dan mengelola metadata file di Drive. Dibatasi
https://www.googleapis.com/auth/drive.metadata.readonly Melihat metadata berbagai file di Drive. Dibatasi
https://www.googleapis.com/auth/drive.scripts Mengubah skrip Google Apps Script perilaku model. Dibatasi

Kolom {i> Usage<i} di tabel di atas menunjukkan sensitivitas setiap ruang lingkup, menurut definisi berikut:

  • Direkomendasikan / Tidak sensitif: Cakupan ini memberikan cakupan terkecil dari akses otorisasi dan hanya membutuhkan verifikasi aplikasi dasar. Sebagai informasi tentang persyaratan ini, lihat Verifikasi persyaratan.

  • Direkomendasikan / Sensitif: Cakupan ini memberikan akses ke informasi Google Data Pengguna yang diotorisasi oleh pengguna untuk aplikasi Anda. Ini mengharuskan Anda untuk melalui verifikasi aplikasi tambahan. Untuk mengetahui informasi tentang persyaratan ini, lihat Cakupan Sensitif dan Dibatasi Persyaratan.

  • Dibatasi: Cakupan ini memberikan akses yang luas ke Data Pengguna Google dan mengharuskan Anda melalui proses verifikasi cakupan yang dibatasi. Sebagai informasi tentang persyaratan ini, lihat Data Pengguna Layanan Google API Kebijakan dan Persyaratan Tambahan untuk API Tertentu Cakupan. Jika Anda menyimpan data cakupan terbatas di server (atau mentransmisikan), Anda harus melakukan penilaian keamanan.

Jika aplikasi Anda memerlukan akses ke Google API lainnya, Anda dapat menambahkan cakupan tersebut juga. Untuk informasi selengkapnya tentang cakupan Google API, lihat Menggunakan OAuth 2.0 untuk Mengakses Google API.

Untuk informasi selengkapnya tentang cakupan OAuth 2.0 spesifik, lihat Cakupan OAuth 2.0 untuk Google API.

Verifikasi OAuth

Penggunaan cakupan OAuth tertentu mungkin mengharuskan aplikasi Anda melanjutkan melalui OAuth Pusat Bantuan Verifikasi Aplikasi. Baca FAQ aplikasi OAuth untuk menentukan kapan aplikasi harus menjalani verifikasi dan jenis verifikasi diperlukan. Lihat juga Persyaratan Layanan Google Drive Layanan.

Kapan harus menggunakan cakupan yang dibatasi

Untuk Drive, hanya jenis aplikasi berikut yang dapat mengakses cakupan yang dibatasi:

  1. Aplikasi web dan khusus platform yang menyediakan sinkronisasi lokal atau pencadangan otomatis pengguna File Drive.
  2. Aplikasi produktivitas dan pendidikan yang antarmuka penggunanya mungkin melibatkan interaksi dengan file Drive (atau metadata atau ). Aplikasi produktivitas mencakup pengelolaan tugas, catatan pekerjaan, komunikasi kelompok kerja, dan aplikasi kolaborasi kelas.
  3. Aplikasi pelaporan dan keamanan yang memberikan insight pengguna atau pelanggan bagaimana file dibagikan atau diakses.

Untuk terus menggunakan cakupan yang dibatasi, Anda harus menyiapkan aplikasi untuk pembatasan ruang lingkup verifikasi.

Memigrasikan aplikasi yang ada dari cakupan yang dibatasi

Jika Anda telah mengembangkan aplikasi Drive menggunakan salah satu cakupan, sebaiknya migrasikan aplikasi Anda ke cakupan yang tidak sensitif karena memberikan cakupan akses per file dan mempersempit akses ke fitur tertentu yang dibutuhkan oleh aplikasi. Banyak aplikasi berfungsi dengan akses per file tanpa perubahan apa pun. Jika Anda menggunakan pemilih file Anda sendiri, sebaiknya beralih ke API Google Picker yang mendukung cakupan yang berbeda.

Manfaat cakupan OAuth drive.file

Penggunaan cakupan OAuth drive.file dan Google Picker API mengoptimalkan penggunaan pengalaman dan keamanan untuk aplikasi Anda.

Cakupan OAuth drive.file memungkinkan pengguna memilih file yang ingin mereka bagikan dengan aplikasi Anda. Hal ini memberi mereka lebih banyak kontrol dan keyakinan bahwa aplikasi Anda akses ke file mereka menjadi terbatas dan lebih aman. Sebaliknya, memerlukan akses ke semua file Drive dapat menghambat pengguna untuk berinteraksi dengan aplikasi Anda. Berikut beberapa alasan Anda harus menggunakan drive.file ruang lingkup:

  • Kegunaan: Cakupan drive.file berfungsi dengan semua Drive API Resource REST yang berarti Anda dapat menggunakannya dengan cara yang sama seperti Anda menggunakan cakupan OAuth yang lebih luas.

  • Fitur: Google Picker API menyediakan antarmuka yang mirip dengan UI Drive. Ini mencakup beberapa tampilan yang menunjukkan pratinjau dan thumbnail file Drive, dan jendela modal inline, sehingga pengguna tidak pernah meninggalkan aplikasi utama.

  • Kepraktisan: Aplikasi dapat menerapkan filter untuk Drive tertentu jenis file (seperti Google Dokumen, Spreadsheet, dan foto) saat menggunakan filter di Alat Pilih Google Anda.

Selain itu, karena tidak sensitif, drive.file memungkinkan proses yang lebih sederhana proses verifikasi Anda.

Simpan token refresh

Simpan token refresh di penyimpanan jangka panjang yang aman, dan terus gunakan sebagai asalkan tetap valid.