Pilih cakupan Google Drive API

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

Untuk memberi otorisasi pada aplikasi Anda, Google Drive API mengharuskan Anda menentukan cakupan OAuth di dua tempat: konsol Google Cloud dan aplikasi Anda.

Di Konsol Google Cloud, Anda harus mendeklarasikan cakupan yang dibutuhkan aplikasi Anda dalam konfigurasi layar izin OAuth-nya. Ini adalah tingkat izin tertinggi yang dapat diminta oleh aplikasi Anda. Hal ini berfungsi sebagai permintaan formal kepada Google, dan cakupan yang dinyatakan adalah cakupan yang ditampilkan Google kepada pengguna di layar izin. Dialog ini memungkinkan pengguna memahami secara persis data dan tindakan yang diminta aksesnya oleh aplikasi Anda.

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.

Di aplikasi, saat memulai API, Anda harus secara eksplisit meminta cakupan tertentu yang Anda butuhkan untuk sesi tersebut. Meskipun konsol Google Cloud menentukan tingkat izin tertinggi yang diizinkan untuk diminta aplikasi Anda, kode menentukan izin sebenarnya untuk pengguna tertentu. Hal ini membantu memastikan aplikasi hanya meminta izin yang diperlukan untuk tugas tertentu.

Anda dapat mendeklarasikan satu atau beberapa cakupan OAuth sekaligus dalam kode aplikasi sebagai array.

Contoh kode berikut menunjukkan cara mendeklarasikan beberapa cakupan OAuth:

Java

List<String> SCOPES = Arrays.asList(
  DriveScopes.DRIVE_FILE,
  DriveScopes.DRIVE_METADATA_READONLY
);

Python

SCOPES = [
  "https://www.googleapis.com/auth/drive.file",
  "https://www.googleapis.com/auth/drive.metadata.readonly",
]

Node.js

const SCOPES = [
  'https://www.googleapis.com/auth/drive.file',
  'https://www.googleapis.com/auth/drive.metadata.readonly'
];

Untuk melihat cara mendeklarasikan dan menggunakan cakupan dalam contoh kode lengkap, lihat Panduan memulai.

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 bekerja dengan 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, gunakan cakupan yang tidak sensitif karena cakupan tersebut memberikan akses per file dan mempersempit akses ke fitur tertentu yang diperlukan oleh aplikasi.

Cakupan tidak sensitif

Cakupan Drive API berikut direkomendasikan untuk sebagian besar kasus penggunaan:

Kode cakupan Deskripsi
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.
https://www.googleapis.com/auth/drive.install Izinkan aplikasi muncul sebagai opsi di menu "Buka dengan" atau "Baru".
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 ke aplikasi saat menggunakan Google Picker API atau pemilih file aplikasi.

Cakupan sensitif

Kode cakupan Deskripsi
https://www.googleapis.com/auth/drive.apps.readonly Melihat aplikasi yang diberi otorisasi untuk mengakses Drive Anda.

Cakupan yang dibatasi

Kode cakupan Deskripsi
https://www.googleapis.com/auth/drive Melihat dan mengelola semua file Drive Anda.
https://www.googleapis.com/auth/drive.readonly Melihat dan mendownload semua file Drive Anda.
https://www.googleapis.com/auth/drive.activity Melihat dan menambahkan ke catatan aktivitas file di Drive Anda.
https://www.googleapis.com/auth/drive.activity.readonly Melihat catatan aktivitas file di Drive Anda.
https://www.googleapis.com/auth/drive.meet.readonly Melihat file Drive yang dibuat atau diedit oleh Google Meet.
https://www.googleapis.com/auth/drive.metadata Melihat dan mengelola metadata file di Drive Anda.
https://www.googleapis.com/auth/drive.metadata.readonly Melihat metadata file di Drive Anda.
https://www.googleapis.com/auth/drive.scripts Mengubah fungsi skrip Google Apps Script.

Cakupan dalam tabel sebelumnya menunjukkan sensitivitasnya, menurut definisi berikut:

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.

Kualifikasi untuk cakupan yang dibatasi

Hanya jenis aplikasi tertentu yang diizinkan untuk menggunakan cakupan terbatas untuk Google Drive. Agar memenuhi syarat, aplikasi Anda harus termasuk dalam salah satu kategori berikut:

  1. Pencadangan dan sinkronisasi: Aplikasi web dan khusus platform yang menyediakan sinkronisasi lokal atau pencadangan otomatis file Drive pengguna.

  2. Produktivitas dan pendidikan: Aplikasi dengan antarmuka pengguna utama yang mungkin melibatkan interaksi dengan file, metadata, atau izin Drive. Aplikasi ini mencakup aplikasi pengelolaan tugas, pencatatan, komunikasi grup kerja, dan kolaborasi kelas.

  3. Pelaporan dan keamanan: Aplikasi 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 aplikasi Drive Anda menggunakan cakupan terbatas, sebaiknya migrasikan ke cakupan Drive API yang tidak sensitif. Dengan menggunakan cakupan yang tidak sensitif, seperti drive.file, aplikasi dapat memberikan akses per file dan akses terbatas ke fitur tertentu yang dibutuhkan oleh aplikasi.

Banyak aplikasi dapat bertransisi ke akses per file tanpa perubahan apa pun.

Jika Anda menggunakan pemilih file Anda sendiri, sebaiknya beralih ke Google Picker API yang sepenuhnya mendukung cakupan yang berbeda.

Manfaat cakupan file Drive

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

Cakupan OAuth drive.file memungkinkan pengguna memilih file yang ingin mereka bagikan 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, mewajibkan 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 REST Resource 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. 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.

  • Verifikasi langsung: Karena drive.file tidak sensitif, proses verifikasi dapat dilakukan dengan lebih lancar.

Menyimpan token refresh dengan aman

Untuk mengakses data pribadi menggunakan Drive API, aplikasi Anda harus mendapatkan token akses yang memberikan akses ke API tersebut. Satu token akses dapat memberikan berbagai tingkat akses ke beberapa API, yang diatur oleh cakupan yang Anda minta.

Karena token akses memiliki masa aktif singkat, Anda harus menggunakan token refresh untuk akses jangka panjang ke Drive API. Token refresh memungkinkan aplikasi Anda meminta token akses baru.

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

Untuk mengetahui informasi selengkapnya, lihat Menggunakan OAuth 2.0 untuk Mengakses Google API.