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, 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/v2/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 cơ quan được hỗ trợ là default, domain, drive và allDrives. Ưu tiên chế độ default hoặc drive hơn chế độ allDrives để tiết kiệm năng lượng.
corpus
(deprecated)

enum (Corpus)

Không dùng nữa: Nội dung của các mục (tệp/tài liệu) mà truy vấn áp dụng. Thay vào đó, hãy sử dụng corpora.
driveId

string

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

boolean

Có nên đưa cả các mục trong Drive của tôi và bộ nhớ dùng chung 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.
maxResults

integer

Số lượng tệp tối đa cần trả về trên mỗi trang. Các trang kết quả không đầy đủ hoặc trống có thể xuất hiện ngay cả trước khi đạt đến cuối danh sách tệp.
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à:

  • createdDate: Thời điểm tệp được tạo.
  • folder: Mã thư mục. Trường này được sắp xếp theo thứ tự bảng chữ cái.
  • lastViewedByMeDate: Lần gần đây nhất người dùng xem tệp.
  • modifiedByMeDate: Lần gần đây nhất người dùng sửa đổi tệp.
  • modifiedDate: Lần gần đây nhất tệp được sửa đổi bởi bất kỳ ai.
  • 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 trong các trường ngày giờ của tệp.
  • sharedWithMeDate: Thời điểm tệp được chia sẻ với người dùng (nếu có).
  • starred: Người dùng có gắn dấu sao cho tệp hay không.
  • title: Tiêu đề của tệp. Trường này được sắp xếp theo thứ tự bảng chữ cái, tức là 1, 12, 2, 22.
  • title_natural: Tiêu đề của tệp. Trường này được sắp xếp theo thứ tự sắp xếp tự nhiên, chẳng hạn như 1, 2, 12, 22.

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 bằng cách dùng giá trị sửa đổi "desc". Ví dụ về cách sử dụng: ?orderBy=folder,modifiedDate desc,title.

Xin lưu ý rằng hiện tại, người dùng có khoảng một triệu tệp sẽ không thể sắp xếp theo yêu cầu.
pageToken

string

Mã thông báo trang cho tệp.
projection
(deprecated)

enum (Projection)

Không dùng nữa: Tham số này không có chức năng.
q

string

Chuỗi truy vấn để tìm kiếm tệp.
spaces

string

Danh sách các không gian cần truy vấn, được phân tách bằng dấu phẩy. Giá trị được hỗ trợ là drive và appDataFolder.
supportsAllDrives

boolean

Liệu ứng dụng yêu cầu có hỗ trợ cả Drive 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 những quyền xem bổ sung cần đưa vào phản hồi. Chỉ hỗ trợ published.
includeLabels

string

Danh sách mã nhận dạng được phân tách bằng dấu phẩy của các nhãn cần đư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 
{
  "items": [
    {
      object (File)
    }
  ],
  "nextPageToken": string,
  "kind": string,
  "etag": string,
  "selfLink": string,
  "incompleteSearch": boolean,
  "nextLink": string
}
Trường
items[]

object (File)

Danh sách tệp. Nếu nextPageToken được điền sẵn, thì danh sách này có thể chưa đầy đủ và bạn nên tìm nạp thêm một trang kết quả.
nextPageToken

string

Mã thông báo trang cho trang tiếp theo của tệp. Tham số này sẽ không xuất hiện nếu bạn đã đế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 nào, mã thông báo đó sẽ bị loại bỏ và việc phân trang sẽ được bắt đầu lại từ trang kết quả đầu tiên.
kind

string

Trạng thái này luôn là drive#fileList.
etag

string

ETag của danh sách.

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/docs
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.appdata
  • https://www.googleapis.com/auth/drive.apps.readonly
  • 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 bạn phải đá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
DEFAULT Những mục mà người dùng đã truy cập.
DOMAIN Các mục được chia sẻ với miền của người dùng.