Dokumen ini berisi informasi otorisasi dan autentikasi khusus Google Drive API. Sebelum membaca dokumen ini, pastikan Anda membaca informasi autentikasi dan otorisasi umum Google Workspace di Mempelajari autentikasi dan otorisasi.
Mengonfigurasi OAuth 2.0 untuk otorisasi
Mengonfigurasi layar izin OAuth dan memilih cakupan untuk menentukan informasi yang ditampilkan kepada pengguna dan peninjau aplikasi, serta mendaftarkan aplikasi Anda agar dapat dipublikasikan nanti.
Cakupan Drive API
Untuk menentukan tingkat akses yang diberikan ke aplikasi Anda, 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 akses. 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. Secara umum, Anda harus memilih cakupan yang paling berfokus dan menghindari permintaan cakupan yang tidak diperlukan aplikasi Anda. Pengguna lebih bersedia memberikan akses ke cakupan terbatas yang dijelaskan dengan jelas.
Jika memungkinkan, sebaiknya gunakan cakupan tidak 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 |
Membuat file Drive baru, atau mengubah file yang ada, yang Anda buka dengan aplikasi atau yang dibagikan pengguna dengan aplikasi saat menggunakan Google Picker API atau pemilih file aplikasi. | Direkomendasikan Tidak sensitif |
https://www.googleapis.com/auth/drive.apps.readonly |
Melihat 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 Anda. | Dibatasi |
https://www.googleapis.com/auth/drive.activity.readonly |
Melihat catatan aktivitas file di Drive Anda. | Dibatasi |
https://www.googleapis.com/auth/drive.meet.readonly |
Melihat file Drive yang dibuat atau diedit oleh Google Meet. | Dibatasi |
https://www.googleapis.com/auth/drive.metadata |
Melihat dan mengelola metadata file di Drive Anda. | Dibatasi |
https://www.googleapis.com/auth/drive.metadata.readonly |
Melihat metadata file di Drive Anda. | Dibatasi |
https://www.googleapis.com/auth/drive.scripts |
Mengubah fungsi skrip Google Apps Script. | Dibatasi |
Kolom Penggunaan dalam 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 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. Anda harus menjalani verifikasi aplikasi tambahan. Untuk mengetahui informasi tentang persyaratan ini, lihat Persyaratan Cakupan Sensitif dan Terlarang.
Dibatasi: Cakupan ini memberikan akses luas ke Data Pengguna Google dan mengharuskan Anda menjalani proses verifikasi cakupan yang dibatasi. Untuk informasi tentang persyaratan ini, lihat Kebijakan Data Pengguna Layanan Google API dan Persyaratan Tambahan untuk Cakupan API Tertentu. Jika Anda menyimpan data cakupan terbatas di server (atau mengirimkan), Anda harus menjalani penilaian keamanan.
Jika aplikasi Anda memerlukan akses ke Google API lainnya, Anda juga dapat menambahkan cakupan tersebut. Untuk mengetahui informasi selengkapnya tentang cakupan Google API, lihat Menggunakan OAuth 2.0 untuk Mengakses Google API.
Untuk mengetahui 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 melalui Pusat Bantuan Verifikasi Aplikasi OAuth. Baca FAQ aplikasi OAuth untuk menentukan kapan aplikasi Anda harus melalui verifikasi dan jenis verifikasi yang diperlukan. Lihat juga Persyaratan Layanan Google Drive.
Kapan harus menggunakan cakupan terbatas
Untuk Drive, hanya jenis aplikasi berikut yang dapat mengakses cakupan terbatas:
- 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). Aplikasi produktivitas mencakup aplikasi pengelolaan tugas, pencatatan, komunikasi grup kerja, dan kolaborasi kelas.
- Aplikasi pelaporan dan keamanan yang memberikan insight pengguna atau pelanggan tentang cara file dibagikan atau diakses.
Untuk terus menggunakan cakupan terbatas, Anda harus menyiapkan aplikasi untuk verifikasi cakupan terbatas.
Memigrasikan aplikasi yang ada dari cakupan terbatas
Jika Anda telah mengembangkan aplikasi Drive menggunakan cakupan yang dibatasi, sebaiknya migrasikan aplikasi Anda untuk menggunakan cakupan yang tidak sensitif karena cakupan tersebut 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 cakupan yang berbeda.
Manfaat cakupan OAuth drive.file
Penggunaan cakupan OAuth drive.file
dan Google Picker API mengoptimalkan pengalaman
pengguna dan keamanan aplikasi Anda.
Cakupan OAuth drive.file
memungkinkan pengguna memilih file yang ingin mereka bagikan ke aplikasi Anda. Hal ini memberi mereka kontrol dan keyakinan yang lebih besar bahwa akses aplikasi Anda ke file mereka terbatas dan lebih aman. Sebaliknya, mewajibkan akses luas ke semua file Drive dapat membuat pengguna enggan berinteraksi dengan aplikasi Anda. Berikut 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 saat Anda 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.
Kemudahan: Aplikasi dapat menerapkan filter untuk jenis file Drive tertentu (seperti Google Dokumen, Spreadsheet, dan foto) saat menggunakan filter pada file Google Picker.
Selain itu, karena drive.file
tidak sensitif, proses verifikasi menjadi lebih lancar.
Menyimpan token refresh
Simpan token refresh di penyimpanan jangka panjang yang aman dan terus gunakan selama token tersebut tetap valid.