Method: files.list

Liệt kê các tệp của người dùng.

Phương thức này chấp nhận tham số q. Đây là một cụm từ tìm kiếm kết hợp một hoặc nhiều cụm từ tìm kiếm. Để biết thêm thông tin, hãy xem hướng dẫn Tìm kiếm tệp và thư mục.

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số truy vấn

Thông số
corpora

string

Nội dung của các mục (tệp/tài liệu) mà truy vấn áp dụng. Các phần nội dung được hỗ trợ là "user", "domain", "drive" và "allDrives". Ưu tiên "người dùng" hoặc "ổ đĩa" hơn "allDrives" để tăng hiệu quả. Theo mặc định, corpora được đặt thành "user". Tuy nhiên, điều này có thể thay đổi tuỳ thuộc vào bộ lọc được đặt thông qua "q" .
corpus
(deprecated)

enum (Corpus)

Không dùng nữa: Nguồn của các tệp cần liệt kê. Sử dụng "corpora" thay thế.
driveId

string

Mã của bộ nhớ dùng chung cần tìm kiếm.
includeItemsFromAllDrives

boolean

Liệu cả hai mục trên Drive của tôi và bộ nhớ dùng chung có được đưa vào kết quả hay không.
includeTeamDriveItems
(deprecated)

boolean

Không dùng nữa: Thay vào đó, hãy sử dụng includeItemsFromAllDrives.
orderBy

string

Danh sách các khoá sắp xếp được phân tách bằng dấu phẩy. Các khoá hợp lệ là:

  • createdTime: Thời điểm tạo tệp.
  • folder: Mã thư mục. Trường này được sắp xếp theo thứ tự bảng chữ cái.
  • modifiedByMeTime: Lần gần đây nhất tệp được người dùng sửa đổi.
  • modifiedTime: Lần gần đây nhất bất kỳ ai sửa đổi tệp.
  • name: Tên tệp. Trường này được sắp xếp theo thứ tự bảng chữ cái, do đó, 1, 12, 2, 22.
  • name_natural: Tên tệp. Trường này được sắp xếp theo thứ tự sắp xếp tự nhiên, vì vậy, 1, 2, 12, 22.
  • quotaBytesUsed: Số byte hạn mức bộ nhớ mà tệp sử dụng.
  • recency: Dấu thời gian gần đây nhất từ các trường ngày giờ của tệp.
  • sharedWithMeTime: Thời điểm tệp được chia sẻ với người dùng, nếu có.
  • starred: Liệu người dùng đã gắn dấu sao cho tệp hay chưa.
  • viewedByMeTime: Lần gần đây nhất người dùng xem tệp.

Theo mặc định, mỗi khoá sẽ sắp xếp tăng dần, nhưng bạn có thể đảo ngược giá trị bằng thuộc tính "description" đối tượng sửa đổi. Ví dụ về cách sử dụng: ?orderBy=folder,modifiedTime desc,name.
pageSize

integer

Số tệp tối đa cần trả về trên mỗi trang. Các trang kết quả có thể chỉ hiển thị một phần hoặc trống ngay cả trước khi danh sách tệp kết thúc.
pageToken

string

Mã thông báo để tiếp tục yêu cầu danh sách trước đó trên trang tiếp theo. Bạn phải đặt thuộc tính này thành giá trị của "nextPageToken" từ câu trả lời trước.
q

string

Truy vấn để lọc kết quả tệp. Hãy xem hướng dẫn "Tìm kiếm tệp và thư mục" để biết cú pháp được hỗ trợ.
spaces

string

Danh sách dấu cách được phân tách bằng dấu phẩy để truy vấn trong tập sao lục. Các giá trị được hỗ trợ là "drive" và "appDataFolder".
supportsAllDrives

boolean

Liệu ứng dụng yêu cầu có hỗ trợ cả Bộ nhớ của tôi và bộ nhớ dùng chung hay không.
supportsTeamDrives
(deprecated)

boolean

Không dùng nữa: Thay vào đó, hãy sử dụng supportsAllDrives.
teamDriveId
(deprecated)

string

Không dùng nữa: Thay vào đó, hãy sử dụng driveId.
includePermissionsForView

string

Chỉ định quyền của thành phần hiển thị bổ sung cần đưa vào phản hồi. Chỉ hỗ trợ trạng thái "đã xuất bản".
includeLabels

string

Danh sách mã nhận dạng của các nhãn được phân tách bằng dấu phẩy để đưa vào phần labelInfo của phản hồi.

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Nội dung phản hồi

Danh sách tệp.

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "nextPageToken": string,
  "kind": string,
  "incompleteSearch": boolean,
  "files": [
    {
      object (File)
    }
  ]
}
Trường
nextPageToken

string

Mã thông báo trang cho trang tệp tiếp theo. Tính năng này sẽ không tồn tại nếu đã đến cuối danh sách tệp. Nếu mã thông báo bị từ chối vì bất kỳ lý do gì, bạn phải loại bỏ mã thông báo đó và bắt đầu lại quá trình phân trang từ trang kết quả đầu tiên. Mã thông báo của trang thường có hiệu lực trong vài giờ. Tuy nhiên, nếu bạn thêm hoặc xoá các mục mới, kết quả dự kiến có thể khác.
kind

string

Xác định loại tài nguyên này. Giá trị: chuỗi cố định "drive#fileList".
files[]

object (File)

Danh sách tệp. Nếu bạn điền mã nextPageToken, thì danh sách này có thể chưa hoàn chỉnh và hệ thống sẽ tìm nạp một trang kết quả khác.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

  • 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

Một số phạm vi bị hạn chế và yêu cầu đánh giá bảo mật để ứng dụng của bạn có thể sử dụng các phạm vi đó. Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.

Chính

Enum
user Tệp thuộc quyền sở hữu của người dùng hoặc được chia sẻ với người dùng.
domain Tệp được chia sẻ với miền của người dùng.