Panduan ini menjelaskan cara Google Drive API mendukung beberapa cara untuk menelusuri file dan folder.
Anda dapat menggunakan metode list pada resource
files untuk menampilkan semua atau sebagian file dan folder pengguna
Drive. Metode list juga dapat di
gunakan untuk mengambil fileId yang diperlukan untuk beberapa metode resource (seperti metode
get dan metode update).
Menggunakan parameter kolom
Jika ingin menentukan kolom yang akan ditampilkan dalam respons, Anda dapat menetapkan
fields parameter sistem
dengan metode apa pun dari resource files. Jika Anda menghapus parameter fields, server akan menampilkan kumpulan kolom default yang khusus untuk metode tersebut. Misalnya, metode
list hanya menampilkan kolom kind, id,
name, mimeType, dan resourceKey untuk setiap file. Untuk menampilkan kolom yang berbeda, lihat Menampilkan kolom tertentu.
Mendapatkan file
Untuk mendapatkan file, gunakan metode get pada resource
files dengan parameter jalur fileId.
Jika tidak mengetahui ID file, Anda dapat mencantumkan semua file menggunakan list
metode.
Metode ini menampilkan file sebagai instance resource files. Jika Anda memberikan parameter kueri alt=media, respons akan menyertakan konten file dalam isi respons. Untuk mendownload atau mengekspor file, lihat Mendownload dan mengekspor
file.
Untuk mengakui risiko mendownload malware yang diketahui atau file lain yang
melanggar, tetapkan parameter kueri
acknowledgeAbuse ke true. Kolom ini hanya berlaku jika parameter alt=media ditetapkan dan pengguna adalah pemilik file atau penyelenggara drive bersama tempat file berada.
Menelusuri semua file dan folder di Drive Saya pengguna saat ini
Gunakan metode list tanpa parameter apa pun untuk menampilkan semua file dan folder.
GET https://www.googleapis.com/drive/v3/files
Menelusuri file atau folder tertentu di Drive Saya pengguna saat ini
Untuk menelusuri kumpulan file atau folder tertentu, gunakan kolom string kueri q field
dengan metode list untuk memfilter file yang akan
ditampilkan dengan menggabungkan satu atau beberapa istilah penelusuran.
Sintaksis string kueri berisi tiga bagian berikut:
query_term operator values
Dengan:
query_termadalah istilah atau kolom kueri yang akan ditelusuri.operatormenentukan kondisi untuk istilah kueri.valuesadalah nilai tertentu yang ingin Anda gunakan untuk memfilter hasil penelusuran.
Misalnya, string kueri berikut memfilter penelusuran untuk hanya menampilkan folder dengan menetapkan jenis MIME:
q: mimeType = 'application/vnd.google-apps.folder'
Untuk melihat semua istilah kueri file, lihat Istilah kueri khusus file.
Untuk melihat semua operator kueri yang dapat Anda gunakan untuk membuat kueri, lihat Operator kueri.
Contoh string kueri
Tabel berikut mencantumkan contoh beberapa string kueri dasar. Kode sebenarnya berbeda, bergantung pada library klien yang Anda gunakan untuk penelusuran.
Anda juga harus mengonversi karakter khusus dalam nama file untuk memastikan kueri berfungsi dengan benar. Misalnya, jika nama file berisi karakter apostrof
(') dan garis miring terbalik ("\"), gunakan garis miring terbalik untuk mengonversinya: name
contains 'quinn\'s paper\\essay'.
| Yang ingin Anda kueri | Contoh |
|---|---|
| File dengan nama "hello" | name = 'hello' |
| File dengan nama yang berisi kata "hello" dan "goodbye" | name contains 'hello' and name contains 'goodbye' |
| File dengan nama yang tidak berisi kata "hello" | not name contains 'hello' |
| File yang berisi teks "important" dan di sampah | fullText contains 'important' and trashed = true |
| File yang berisi kata "hello" | fullText contains 'hello' |
| File yang tidak memiliki kata "hello" | not fullText contains 'hello' |
| File yang berisi frasa persis "hello world" | fullText contains '"hello world"' |
| File dengan kueri yang berisi karakter "\" (misalnya, "\authors") | fullText contains '\\authors' |
| File yang berupa folder | mimeType = 'application/vnd.google-apps.folder' |
| File yang bukan folder | mimeType != 'application/vnd.google-apps.folder' |
| File yang diubah setelah tanggal tertentu (zona waktu default adalah UTC) | modifiedTime > '2012-06-04T12:00:00' |
| File gambar atau video yang diubah setelah tanggal tertentu | modifiedTime > '2012-06-04T12:00:00' and (mimeType contains 'image/' or mimeType contains 'video/') |
| File yang diberi bintang | starred = true |
File dalam koleksi (misalnya, ID folder dalam koleksi parents) |
'1234567' in parents |
| File dalam folder data aplikasi dalam koleksi | 'appDataFolder' in parents |
| File yang pemiliknya adalah pengguna "test@example.org" | 'test@example.org' in owners |
| File yang izin tulisnya dimiliki pengguna "test@example.org" | 'test@example.org' in writers |
| File yang izin tulisnya dimiliki anggota grup "group@example.org" | 'group@example.org' in writers |
| File yang dibagikan kepada pengguna yang diberi otorisasi dengan "hello" dalam nama | sharedWithMe and name contains 'hello' |
| File dengan properti file kustom yang terlihat oleh semua aplikasi | properties has { key='mass' and value='1.3kg' } |
| File dengan properti file kustom yang bersifat pribadi untuk aplikasi yang meminta | appProperties has { key='additionalID' and value='8e8aceg2af2ge72e78' } |
| File yang belum dibagikan kepada siapa pun atau domain (hanya pribadi, atau dibagikan kepada pengguna atau grup tertentu) | visibility = 'limited' |
Memfilter hasil penelusuran dengan library klien
Contoh kode berikut menunjukkan cara menggunakan library klien untuk memfilter hasil penelusuran ke nama file dan ID file JPEG. Contoh ini menggunakan istilah kueri mimeType untuk mempersempit hasil ke file berjenis image/jpeg. Contoh ini juga menetapkan
spaces ke drive untuk lebih mempersempit penelusuran ke Drive
ruang. Jika nextPageToken menampilkan null, tidak ada lagi hasil.
Java
Python
Node.js
PHP
Menelusuri file dengan properti file kustom
Untuk menelusuri file dengan properti file kustom, gunakan istilah kueri penelusuran properties atau appProperties dengan kunci dan nilai. Misalnya, untuk menelusuri properti file kustom yang bersifat pribadi untuk aplikasi yang meminta bernama additionalID dengan nilai 8e8aceg2af2ge72e78:
appProperties has { key='additionalID' and value='8e8aceg2af2ge72e78' }
Untuk mengetahui informasi selengkapnya, lihat Menambahkan properti file kustom.
Menelusuri file dengan label atau nilai kolom tertentu
Untuk menelusuri file dengan label tertentu, gunakan istilah kueri penelusuran labels dengan ID label tertentu. Misalnya: 'labels/LABEL_ID' in
labels. Jika berhasil, isi respons akan berisi semua instance file tempat label diterapkan.
Untuk menelusuri file tanpa ID label tertentu: Not
'labels/LABEL_ID' in labels.
Anda juga dapat menelusuri file berdasarkan nilai kolom tertentu. Misalnya, untuk
menelusuri file dengan nilai teks:
labels/LABEL_ID.text_field_id ='TEXT'.
Untuk mengetahui informasi selengkapnya, lihat Menelusuri file dengan label atau nilai kolom tertentu.
Menelusuri set data
Secara default, kumpulan item user ditetapkan pada parameter kueri corpora
saat metode list digunakan. Untuk menelusuri kumpulan item lainnya, seperti yang dibagikan dengan domain, Anda harus menetapkan parameter corpora secara eksplisit.
Anda dapat menelusuri beberapa set data dalam satu kueri; namun, jika set data gabungan terlalu besar, API mungkin menampilkan hasil yang tidak lengkap. Periksa
incompleteSearch
kolom di isi respons. Jika true, beberapa dokumen akan dihilangkan. Untuk mengatasi hal ini, persempit corpora untuk menggunakan user atau drive.
Saat menggunakan parameter kueri pada metode list, hindari penggunaan kunci createdTime untuk kueri pada kumpulan item besar karena memerlukan pemrosesan tambahan dan dapat menyebabkan waktu tunggu habis atau masalah lainnya.orderBy Untuk pengurutan terkait waktu pada kumpulan item besar, Anda dapat menggunakan modifiedTime sebagai gantinya karena dioptimalkan untuk menangani kueri ini.
Misalnya, ?orderBy=modifiedTime.
Jika Anda menghapus parameter kueri orderBy, tidak ada urutan pengurutan default dan item akan ditampilkan secara acak.
Topik terkait
- Menelusuri drive bersama
- Istilah dan operator kueri penelusuran
- Jenis MIME yang didukung Google Workspace dan Google Drive
- Peran dan izin
- Menelusuri file dengan label atau nilai kolom tertentu