Mencantumkan file pengguna.
Metode ini menerima parameter q
, yang merupakan kueri penelusuran yang menggabungkan satu atau beberapa istilah penelusuran. Untuk mendapatkan informasi selengkapnya, lihat panduan Menelusuri file & folder.
Permintaan HTTP
GET https://www.googleapis.com/drive/v3/files
URL menggunakan sintaksis gRPC Transcoding.
Parameter kueri
Parameter | |
---|---|
corpora |
Badan item (file/dokumen) tempat kueri diterapkan. Isi yang didukung adalah 'user', 'domain', 'drive', dan 'allDrives'. Pilih 'user' atau 'drive' ke 'allDrive' untuk efisiensi. Secara default, korpora ditetapkan ke 'user'. Namun, hal ini dapat berubah bergantung pada filter yang ditetapkan melalui parameter 'q'. |
corpus |
Tidak digunakan lagi: Sumber file yang akan dicantumkan. Sebagai gantinya, gunakan 'corpora'. |
driveId |
ID drive bersama yang akan ditelusuri. |
includeItemsFromAllDrives |
Apakah item Drive Saya dan drive bersama harus disertakan dalam hasil. |
includeTeamDriveItems |
Tidak digunakan lagi: Sebagai gantinya, gunakan |
orderBy |
Daftar kunci pengurutan yang dipisahkan koma. Kunci yang valid adalah 'createdTime', 'folder', 'modifyByMeTime', ' modifiedTime', 'name', 'name_natural', 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred', dan 'viewedByMeTime'. Setiap kunci diurutkan naik secara default, tetapi dapat dikembalikan dengan pengubah 'desc'. Contoh penggunaan: ?orderBy=folder,modifyTime desc,name. |
pageSize |
Jumlah file maksimum yang akan dikembalikan per halaman. Halaman hasil yang kosong atau sebagian dapat ditampilkan bahkan sebelum akhir daftar file tercapai. |
pageToken |
Token untuk melanjutkan permintaan daftar sebelumnya di halaman berikutnya. Nilai ini harus ditetapkan ke nilai 'nextPageToken' dari respons sebelumnya. |
q |
Kueri untuk memfilter hasil file. Lihat panduan "Menelusuri file & folder" untuk mengetahui sintaksis yang didukung. |
spaces |
Daftar spasi yang dipisahkan koma untuk membuat kueri dalam korpora. Nilai yang didukung adalah 'drive' dan 'appDataFolder'. |
supportsAllDrives |
Apakah aplikasi yang meminta mendukung Drive Saya dan drive bersama. |
supportsTeamDrives |
Tidak digunakan lagi: Sebagai gantinya, gunakan |
teamDriveId |
Tidak digunakan lagi: Sebagai gantinya, gunakan |
includePermissionsForView |
Menentukan izin tampilan tambahan yang akan disertakan dalam respons. Hanya mendukung 'dipublikasikan'. |
includeLabels |
Daftar ID label yang dipisahkan koma untuk disertakan di bagian |
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Daftar file.
Jika berhasil, isi respons memuat data dengan struktur berikut:
Representasi JSON |
---|
{
"nextPageToken": string,
"kind": string,
"incompleteSearch": boolean,
"files": [
{
object ( |
Kolom | |
---|---|
nextPageToken |
Token halaman untuk halaman file berikutnya. Fitur ini tidak akan ada jika akhir daftar file telah tercapai. Jika ditolak karena alasan apa pun, token harus dihapus, dan penomoran halaman harus dimulai ulang dari halaman pertama hasil. Token halaman biasanya valid selama beberapa jam. Namun, jika item baru ditambahkan atau dihapus, hasil yang Anda harapkan mungkin berbeda. |
kind |
Mengidentifikasi jenis resource ini. Nilai: string tetap |
incompleteSearch |
Apakah proses penelusuran tidak lengkap. Jika true (benar), beberapa hasil penelusuran mungkin tidak ada, karena semua dokumen tidak ditelusuri. Error ini dapat terjadi saat menelusuri beberapa perjalanan dengan korpora 'allDrive', tetapi semua korpora tidak dapat ditelusuri. Saat hal ini terjadi, sebaiknya klien mempersempit kueri mereka dengan memilih korpus lain seperti 'user' atau 'drive'. |
files[] |
Daftar file. Jika nextPageToken diisi, daftar ini mungkin tidak lengkap dan halaman tambahan hasil harus diambil. |
Cakupan otorisasi
Memerlukan salah satu cakupan OAuth berikut:
https://www.googleapis.com/auth/drive
https://www.googleapis.com/auth/drive.appdata
https://www.googleapis.com/auth/drive.file
https://www.googleapis.com/auth/drive.metadata
https://www.googleapis.com/auth/drive.metadata.readonly
https://www.googleapis.com/auth/drive.photos.readonly
https://www.googleapis.com/auth/drive.readonly
Beberapa cakupan dibatasi dan memerlukan penilaian keamanan agar aplikasi Anda dapat menggunakannya. Untuk informasi selengkapnya, lihat Panduan otorisasi.
Korpus
Enum | |
---|---|
user |
File yang dimiliki oleh atau dibagikan kepada pengguna. |
domain |
File yang dibagikan ke domain pengguna. |