Method: files.list

Mencantumkan file pengguna. Untuk mengetahui informasi selengkapnya, lihat Menelusuri file dan folder.

Metode ini menerima parameter q, yang merupakan kueri penelusuran yang menggabungkan satu atau beberapa istilah penelusuran.

Secara default, metode ini menampilkan semua file, termasuk file yang ada di sampah. Jika Anda tidak ingin file yang ada di sampah muncul dalam daftar, gunakan parameter kueri trashed=false untuk menghapus file yang ada di sampah dari hasil.

Permintaan HTTP

GET https://www.googleapis.com/drive/v3/files

URL ini menggunakan sintaksis gRPC Transcoding.

Parameter kueri

Parameter
corpora

string

Menentukan kumpulan item (file atau dokumen) yang berlaku untuk kueri. Item yang didukung meliputi:

  • user
  • domain
  • drive
  • allDrives

Sebaiknya gunakan user atau drive daripada allDrives untuk efisiensi. Secara default, korpus ditetapkan ke user. Namun, hal ini dapat berubah bergantung pada kumpulan filter melalui parameter q. Untuk mengetahui informasi selengkapnya, lihat Pengaturan file.

corpus
(deprecated)

enum (Corpus)

Tidak digunakan lagi: Sumber file yang akan dicantumkan. Sebagai gantinya, gunakan corpora.

driveId

string

ID drive bersama yang akan ditelusuri.

includeItemsFromAllDrives

boolean

Apakah item Drive Saya dan drive bersama harus disertakan dalam hasil.

includeTeamDriveItems
(deprecated)

boolean

Tidak digunakan lagi: Sebagai gantinya, gunakan includeItemsFromAllDrives.

orderBy

string

Daftar kunci pengurutan yang dipisahkan koma. Kunci yang valid adalah:

  • createdTime: Waktu file dibuat. Hindari penggunaan kunci ini untuk kueri pada koleksi item besar karena dapat menyebabkan waktu tunggu habis atau masalah lainnya. Untuk pengurutan terkait waktu pada koleksi item besar, gunakan modifiedTime desc sebagai gantinya.
  • folder: ID folder. Kolom ini diurutkan menggunakan urutan abjad.
  • modifiedByMeTime: Terakhir kali file diubah oleh pengguna.
  • modifiedTime: Terakhir kali file diubah oleh siapa pun.
  • name: Nama file. Kolom ini diurutkan menggunakan urutan abjad, jadi 1, 12, 2, 22.
  • name_natural: Nama file. Kolom ini diurutkan menggunakan urutan pengurutan alami, jadi 1, 2, 12, 22.
  • quotaBytesUsed: Jumlah byte kuota penyimpanan yang digunakan oleh file.
  • recency: Stempel waktu terbaru dari kolom tanggal-waktu file.
  • sharedWithMeTime: Waktu file dibagikan kepada pengguna, jika berlaku.
  • starred: Apakah pengguna telah memberi bintang pada file.
  • viewedByMeTime: Terakhir kali file dilihat oleh pengguna.

Setiap kunci diurutkan secara menaik secara default, tetapi dapat dibalik dengan pengubah desc. Contoh penggunaan: ?orderBy=folder,modifiedTime desc,name.

pageSize

integer

Jumlah maksimum file yang akan ditampilkan per halaman. Halaman mungkin sebagian atau kosong bahkan sebelum mencapai akhir daftar file.

Jika tidak ditentukan, paling banyak 100 file akan ditampilkan untuk drive bersama, dan seluruh daftar file untuk drive non-bersama.

Nilai maksimum adalah 100; nilai di atas 100 akan diubah menjadi 100.

pageToken

string

Token untuk melanjutkan permintaan daftar sebelumnya di halaman berikutnya. Token ini harus ditetapkan ke nilai nextPageToken dari respons sebelumnya.

q

string

Kueri untuk memfilter hasil file. Untuk mengetahui sintaksis yang didukung, lihat Menelusuri file dan folder.

spaces

string

Daftar ruang yang dipisahkan koma untuk dikueri dalam korpus. Nilai yang didukung adalah drive dan appDataFolder. Untuk mengetahui informasi selengkapnya, lihat Pengaturan file.

supportsAllDrives

boolean

Apakah aplikasi yang meminta mendukung Drive Saya dan drive bersama.

supportsTeamDrives
(deprecated)

boolean

Tidak digunakan lagi: Sebagai gantinya, gunakan supportsAllDrives.

teamDriveId
(deprecated)

string

Tidak digunakan lagi: Sebagai gantinya, gunakan driveId.

includePermissionsForView

string

Menentukan izin tampilan tambahan yang akan disertakan dalam respons. Hanya published yang didukung.

includeLabels

string

Daftar yang dipisahkan koma untuk ID label yang akan disertakan di bagian labelInfo respons.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Daftar file.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON
{
  "files": [
    {
      object (File)
    }
  ],
  "nextPageToken": string,
  "kind": string,
  "incompleteSearch": boolean
}
Kolom
files[]

object (File)

Daftar file. Jika nextPageToken diisi, daftar ini mungkin tidak lengkap dan halaman hasil tambahan harus diambil.

nextPageToken

string

Token halaman untuk halaman file berikutnya. Token ini tidak akan ada jika akhir daftar file telah tercapai. Jika token ditolak karena alasan apa pun, token tersebut harus dibuang, dan penomoran halaman harus dimulai ulang dari halaman hasil pertama. Token halaman biasanya berlaku selama beberapa jam. Namun, jika item baru ditambahkan atau dihapus, hasil yang diharapkan mungkin berbeda.

kind

string

Mengidentifikasi jenis resource ini. Nilai: string tetap "drive#fileList".

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.meet.readonly
  • 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 mengetahui informasi selengkapnya, lihat Panduan otorisasi.

Korpus

Enum
user File yang dimiliki oleh atau dibagikan kepada pengguna.
domain File yang dibagikan ke domain pengguna.