Method: files.list

Mencantumkan file pengguna.

Metode ini menerima parameter q, yaitu kueri penelusuran yang menggabungkan satu atau beberapa istilah penelusuran. Untuk informasi selengkapnya, lihat Menelusuri file & folder.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter kueri

Parameter
corpora

string

Isi item (file/dokumen) tempat kueri diterapkan. Isi yang didukung adalah 'user', 'domain', 'drive', dan 'allDrives'. Pilih 'user' atau 'drive' daripada 'allDrives' untuk efisiensi. Secara default, korpus disetel ke 'user'. Namun, hal ini dapat berubah bergantung pada filter yang disetel melalui perintah 'q' .

corpus
(deprecated)

enum (Corpus)

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

driveId

string

ID drive bersama yang akan ditelusuri.

includeItemsFromAllDrives

boolean

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

includeTeamDriveItems
(deprecated)

boolean

Tidak digunakan lagi: Gunakan includeItemsFromAllDrives sebagai gantinya.

orderBy

string

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

  • createdTime: Saat file dibuat.
  • 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 pengurutan alami, yaitu 1, 2, 12, 22.
  • quotaBytesUsed: Jumlah byte kuota penyimpanan yang digunakan oleh file.
  • recency: Stempel waktu terbaru dari kolom tanggal-waktu file.
  • sharedWithMeTime: Kapan file dibagikan kepada pengguna, jika ada.
  • starred: Apakah pengguna telah memberi bintang pada file.
  • viewedByMeTime: Terakhir kali file dilihat oleh pengguna.

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

pageSize

integer

Jumlah maksimum file yang akan ditampilkan per halaman. Halaman hasil sebagian atau kosong dapat terjadi bahkan sebelum akhir daftar file tercapai.

pageToken

string

Token untuk melanjutkan permintaan daftar sebelumnya di halaman berikutnya. Ini harus disetel ke nilai 'nextPageToken' dari respons sebelumnya.

q

string

Kueri untuk memfilter hasil file. Lihat panduan "Menelusuri file & folder" untuk mengetahui sintaksis yang didukung.

spaces

string

Daftar spasi yang dipisahkan koma untuk dikueri dalam korpora. Nilai yang didukung adalah 'drive' dan 'appDataFolder'.

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: Gunakan driveId sebagai gantinya.

includePermissionsForView

string

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

includeLabels

string

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

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 (File)
    }
  ]
}
Kolom
nextPageToken

string

Token halaman untuk halaman file berikutnya. Fungsi 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 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".

files[]

object (File)

Daftar file. Jika nextPageToken diisi, daftar ini mungkin tidak lengkap dan halaman hasil tambahan 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.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 informasi selengkapnya, lihat Panduan otorisasi.

Korpus

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