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 phầ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 phần tử được hỗ trợ là default, domain, drive và allDrives. Ưu tiên default hoặc drive thành allDrives để đảm bảo tính hiệu quả.
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ã 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: Chuyển sang dùng includeItemsFromAllDrives.
maxResults

integer

Số tệp tối đa cần trả về trên mỗi trang. Bạn có thể hiển thị một phần hoặc trang kết quả trống ngay cả trước khi đế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, folder, lastViewedByMeDate, modifiedByMeDate, modifiedDate, quotaBytesUsed, recency, sharedWithMeDate, starred, title và title_natural. 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 đối tượng sửa đổi desc. Ví dụ về cách sử dụng: ?orderBy=folder,modifyDate desc,title. Xin lưu ý rằng hiện tại chúng tôi có giới hạn đối với những người dùng có khoảng 1 triệu tệp bị bỏ qua thứ tự sắp xếp theo yêu cầu.
pageToken

string

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

enum (Projection)

Không dùng nữa: Tham số này không có hàm.
q

string

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

string

Danh sách dấu cách được phân tách bằng dấu phẩy để truy vấn. 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: Chuyển sang dùng supportsAllDrives.
teamDriveId
(deprecated)

string

Không dùng nữa: Chuyển sang dùng driveId.
includePermissionsForView

string

Chỉ định các quyền bổ sung của chế độ xem cần đưa vào phản hồi. Chỉ hỗ trợ published.
includeLabels

string

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

string

Mã thông báo của 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ì, thì bạn nên loại bỏ mã đó và bắt đầu lại quá trình phân trang từ trang kết quả đầu tiên.
kind

string

Hàm này luôn là drive#fileList.
etag

string

ETag của danh sách.
items[]

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/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 đá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 Các 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.