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 thông 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

Các tham số
corpora

string

Thân của các mục (tệp/tài liệu) áp dụng cụm từ tìm kiếm. Các nội dung được hỗ trợ là default, domain, driveallDrives. Hãy ưu tiên default hoặc drive thay vì allDrives để tăng tính hiệu quả.

corpus
(deprecated)

enum (Corpus)

Không dùng nữa: Phần nội dung (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

Có cần đưa cả các mục trên 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 dùng includeItemsFromAllDrives.

maxResults

integer

Số lượng tệp tối đa cần trả về trên mỗi trang. Có thể một phần hoặc không có trang kết quả trống, thậm chí 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, titletitle_natural. Theo mặc định, mỗi phím sẽ sắp xếp theo thứ tự tăng dần, nhưng có thể đảo ngược bằng đối tượng sửa đổi desc. Ví dụ về cách sử dụng: ?orderBy=folder,ModifiedDate Thông điệp vào tiêu đề. Xin lưu ý rằng hiện tại đang có giới hạn đối với người dùng có khoảng một triệu tệp mà thứ tự sắp xếp được yêu cầu bị bỏ qua.

pageToken

string

Mã thông báo trang cho các tệp.

projection
(deprecated)

enum (Projection)

Ngừng sử dụng: 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 các dấu cách được phân tách bằng dấu phẩy mà bạn muốn truy vấn. Giá trị được hỗ trợ là driveappDataFolder.

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 dùng supportsAllDrives.

teamDriveId
(deprecated)

string

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

includePermissionsForView

string

Chỉ định quyền của khung hiển thị bổ sung để đưa vào phản hồi. Chỉ hỗ trợ giá trị published.

includeLabels

string

Danh sách mã 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,
  "etag": string,
  "selfLink": string,
  "incompleteSearch": boolean,
  "nextLink": string,
  "items": [
    {
      object (File)
    }
  ]
}
Các trường
nextPageToken

string

Mã thông báo trang cho trang tiếp theo của tệp. Tệp này sẽ không xuất hiện nếu đến cuối danh sách tệp. Nếu bị từ chối vì bất kỳ lý do gì, mã thông báo sẽ bị loại bỏ và bạn nên bắt đầu lại quá trình phân trang từ trang kết quả đầu tiên.

kind

string

Giá trị 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 nextPageToken được điền, thì danh sách này có thể chưa đầy đủ và bạn nên tìm nạp một trang kết quả bổ sung.

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.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à cần phải được đánh giá bảo mật thì ứng dụng của bạn mới có thể sử dụng những 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.