Pilih cakupan Google Drive API

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

Mengonfigurasi OAuth 2.0 untuk otorisasi

Konfigurasi layar izin OAuth dan pilih cakupan untuk menentukan informasi yang akan ditampilkan kepada pengguna dan peninjau aplikasi, serta 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 tingkat aksesnya. Cakupan adalah permintaan aplikasi Anda untuk menggunakan data Google Workspace, termasuk data Akun Google pengguna.

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

Jika memungkinkan, sebaiknya gunakan cakupan yang tidak sensitif karena akan memberikan cakupan akses per file 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 menu "Buka dengan" atau "Baru". 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 Ubah perilaku skrip Google Apps Script Anda. Dibatasi

Kolom Usage pada tabel di atas menunjukkan sensitivitas setiap cakupan, sesuai dengan definisi berikut:

  • Direkomendasikan / Tidak sensitif: Cakupan ini memberikan cakupan akses otorisasi terkecil dan hanya memerlukan verifikasi aplikasi dasar. Untuk mengetahui informasi tentang persyaratan ini, lihat Persyaratan verifikasi.

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

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

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

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

Verifikasi OAuth

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

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 untuk file Drive pengguna.
  2. Aplikasi produktivitas dan pendidikan yang antarmuka penggunanya mungkin melibatkan interaksi dengan file Drive (atau metadata atau izinnya). Aplikasi produktivitas mencakup pengelolaan tugas, pencatatan, komunikasi kelompok kerja, dan aplikasi kolaborasi kelas.
  3. Aplikasi pelaporan dan keamanan yang memberikan insight kepada pengguna atau pelanggan tentang cara file dibagikan atau diakses.

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

Memigrasikan aplikasi yang ada dari cakupan yang dibatasi

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

Manfaat cakupan OAuth drive.file

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

Cakupan OAuth drive.file memungkinkan pengguna memilih file yang ingin dibagikan dengan aplikasi Anda. Hal ini memberi mereka kontrol dan keyakinan yang lebih besar bahwa akses aplikasi Anda ke file mereka terbatas dan lebih aman. Sebaliknya, memerlukan akses luas ke semua file Drive dapat membuat pengguna enggan berinteraksi dengan aplikasi Anda. Berikut adalah beberapa alasan mengapa Anda harus menggunakan cakupan drive.file:

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

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

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

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

Simpan token refresh

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