Dokumen ini berisi informasi otorisasi dan autentikasi khusus Google Drive API. Sebelum membaca dokumen ini, pastikan Anda membaca informasi otorisasi dan autentikasi 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 ditampilkan kepada pengguna dan peninjau aplikasi, serta daftarkan aplikasi agar 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 menangani data Google Workspace, termasuk data Akun Google pengguna.
Saat aplikasi diinstal, pengguna akan diminta untuk memvalidasi cakupan yang digunakan oleh aplikasi. Umumnya, Anda harus memilih cakupan yang paling terfokus dan menghindari permintaan cakupan yang tidak diperlukan aplikasi. Pengguna lebih mudah memberikan akses ke cakupan yang terbatas dan dijelaskan dengan jelas.
Jika memungkinkan, sebaiknya gunakan cakupan yang tidak bersifat sensitif karena memberikan cakupan akses per file dan mempersempit akses ke fitur tertentu yang diperlukan oleh aplikasi.
Drive API mendukung cakupan berikut:
| Kode cakupan | Deskripsi | Penggunaan |
|---|---|---|
https://www.googleapis.com/auth/drive.appdata |
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 sudah 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/auth/drive.apps.readonly |
Melihat aplikasi yang diizinkan untuk mengakses Drive Anda. | Sensitif |
https://www.googleapis.com/auth/drive |
Melihat dan mengelola semua file Drive Anda. | Restricted |
https://www.googleapis.com/auth/drive.readonly |
Lihat dan download semua file Drive Anda. | Restricted |
https://www.googleapis.com/auth/drive.activity | Melihat dan menambahkan ke catatan aktivitas file di Drive Anda. | Restricted |
https://www.googleapis.com/auth/drive.activity.readonly | Melihat catatan aktivitas file di Drive. | Restricted |
https://www.googleapis.com/auth/drive.metadata |
Melihat dan mengelola metadata file di Drive. | Restricted |
https://www.googleapis.com/auth/drive.metadata.readonly |
Melihat metadata untuk file di Drive. | Restricted |
https://www.googleapis.com/auth/drive.scripts |
Ubah perilaku skrip Google Apps Script Anda. | Restricted |
Kolom Usage pada tabel di atas menunjukkan sensitivitas setiap cakupan, sesuai dengan definisi berikut:
Direkomendasikan / Tidak sensitif—Cakupan ini memberikan cakupan terkecil akses otorisasi dan hanya memerlukan verifikasi aplikasi dasar. Untuk mengetahui informasi tentang persyaratan ini, lihat Langkah-langkah untuk menyiapkan verifikasi.
Direkomendasikan / Sensitif—Cakupan ini memberikan akses ke Data Pengguna Google tertentu yang telah diberi otorisasi oleh pengguna untuk aplikasi Anda. Anda harus melakukan verifikasi aplikasi tambahan. Untuk informasi tentang persyaratan ini, lihat Langkah-langkah untuk aplikasi yang meminta cakupan sensitif
Dibatasi—Cakupan ini memberikan akses 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 dikirimkan), Anda harus menjalani penilaian keamanan.
Jika aplikasi memerlukan akses ke Google API lain, 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 proses verifikasi OAuth Google. Baca FAQ verifikasi OAuth API untuk menentukan kapan aplikasi Anda harus melalui verifikasi dan jenis verifikasi yang diperlukan. Lihat juga Persyaratan Layanan Google Drive.
Kapan harus menggunakan cakupan yang dibatasi
s Untuk Drive, hanya jenis aplikasi berikut yang dapat mengakses cakupan yang dibatasi:
- Aplikasi web dan khusus platform yang menyediakan sinkronisasi lokal atau pencadangan otomatis file Drive pengguna.
- Aplikasi produktivitas dan pendidikan yang antarmuka penggunanya mungkin melibatkan interaksi dengan file Drive (atau metadata atau izinnya). Penerapan produktivitas meliputi pengelolaan tugas, pencatatan, komunikasi kelompok kerja, dan aplikasi kolaborasi kelas.
- Aplikasi keamanan dan pelaporan 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 mengembangkan aplikasi Drive menggunakan salah satu cakupan yang dibatasi, sebaiknya migrasikan aplikasi untuk menggunakan cakupan yang tidak sensitif karena memberikan cakupan akses per file dan mempersempit akses ke fitur tertentu yang diperlukan oleh aplikasi. Banyak aplikasi berfungsi dengan akses per file tanpa perubahan apa pun. Jika Anda menggunakan pemilih file sendiri, sebaiknya beralih ke Google Picker API yang sepenuhnya mendukung berbagai cakupan.
Manfaat cakupan OAuth drive.file
Menggunakan 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 mereka bagikan
dengan aplikasi Anda. Hal ini memberi mereka kontrol dan keyakinan lebih bahwa akses
aplikasi Anda ke file mereka terbatas dan lebih aman. Sebaliknya, mewajibkan akses secara luas ke semua file Drive dapat membuat pengguna enggan berinteraksi dengan aplikasi Anda. Berikut ini beberapa alasan mengapa Anda harus menggunakan cakupan drive.file:
Kegunaan: Cakupan
drive.fileberfungsi dengan semua Resource REST Drive API, sehingga Anda dapat menggunakannya dengan cara yang sama seperti menggunakan cakupan OAuth yang lebih luas.Fitur: Google Picker API menyediakan antarmuka yang serupa dengan UI Drive. Hal ini mencakup beberapa tampilan yang menampilkan 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 drive.file tidak bersifat sensitif, metode ini memungkinkan proses verifikasi yang lebih sederhana.
Menyimpan token refresh
Simpan token refresh di penyimpanan jangka panjang yang aman dan terus gunakan selama token tersebut tetap valid.