Method: files.list

列出使用者的檔案。詳情請參閱「搜尋檔案和資料夾」。

這個方法會接受 q 參數，也就是結合一或多個搜尋字詞的搜尋查詢。

這個方法預設會傳回所有檔案，包括已刪除的檔案。如不想在清單中看到已刪除的檔案，請使用 trashed=false 查詢參數，從結果中移除已刪除的檔案。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

查詢參數

參數
corpora

string

指定查詢適用的項目 (檔案或文件) 集合。支援的項目包括：

  • user
  • domain
  • drive
  • allDrives

為提高效率，請優先使用 user 或 drive，而非 allDrives。根據預設，語料庫會設為 user。不過，這項設定可能會因透過 q 參數設定的篩選條件而異。詳情請參閱「檔案整理」。
corpus
(deprecated)

enum (Corpus)

已淘汰：要列出檔案的來源。請改用 corpora。
driveId

string

要搜尋的共用雲端硬碟 ID。
includeItemsFromAllDrives

boolean

是否要在結果中同時納入「我的雲端硬碟」和共用雲端硬碟中的項目。
includeTeamDriveItems
(deprecated)

boolean

已淘汰：請改用 includeItemsFromAllDrives。
orderBy

string

以半形逗號分隔的排序鍵清單。有效鍵包括：

  • createdTime：檔案建立時間。請勿使用這個鍵查詢大型項目集合，否則可能會導致逾時或其他問題。如要針對大型項目集合依時間排序，請改用 modifiedTime。
  • folder：資料夾 ID。這個欄位會依字母順序排序。
  • modifiedByMeTime：使用者上次修改檔案的時間。
  • modifiedTime：上次任何人修改檔案的時間。
  • name：檔案名稱。這個欄位會依字母順序排序，因此會顯示 1、12、2、22。
  • name_natural：檔案名稱。這個欄位會使用自然排序順序排序，因此會是 1、2、12、22。
  • quotaBytesUsed：檔案使用的儲存空間配額位元組數。
  • recency：檔案日期時間欄位的最新時間戳記。
  • sharedWithMeTime：檔案與使用者共用的時間 (如適用)。
  • starred：使用者是否為檔案加上星號。
  • viewedByMeTime：使用者上次查看檔案的時間。

每個鍵預設會以遞增排序，但可使用 desc 修飾符反向排序。使用範例：?orderBy=folder,modifiedTime desc,name。
pageSize

integer

每頁傳回的檔案數上限。即使尚未到達檔案清單結尾，也可能會出現部分或空白的結果頁面。
pageToken

string

這個符記可用於接續下一頁的先前清單要求。這應設為前一個回應中的 nextPageToken 值。
q

string

用於篩選檔案結果的查詢。如需支援的語法，請參閱「搜尋檔案和資料夾」。
spaces

string

以半形逗號分隔的清單，列出要在語料庫中查詢的空間。支援的值為 drive 和 appDataFolder。詳情請參閱「檔案整理」。
supportsAllDrives

boolean

要求存取的應用程式是否同時支援「我的雲端硬碟」和共用雲端硬碟。
supportsTeamDrives
(deprecated)

boolean

已淘汰：請改用 supportsAllDrives。
teamDriveId
(deprecated)

string

已淘汰：請改用 driveId。
includePermissionsForView

string

指定要在回應中加入哪些額外檢視畫面的權限。系統僅支援 published。
includeLabels

string

以半形逗號分隔的標籤 ID 清單，用於在回應的 labelInfo 部分中加入標籤。

要求主體

要求主體必須為空白。

回應主體

檔案清單。

如果成功，回應主體會含有以下結構的資料：

JSON 表示法 
{
  "files": [
    {
      object (File)
    }
  ],
  "nextPageToken": string,
  "kind": string,
  "incompleteSearch": boolean
}
欄位
files[]

object (File)

檔案清單。如果 nextPageToken 已填入值，則這份清單可能不完整，應擷取額外的結果頁面。
nextPageToken

string

下一頁檔案的頁面符記。如果已到達檔案清單結尾，則不會顯示這個按鈕。如果系統基於任何原因拒絕符記，就應捨棄該符記，並從第一頁結果重新開始分頁。網頁權杖的有效期通常為數小時。不過，如果新增或移除項目，預期結果可能會有所不同。
kind

string

表示資源的種類。值：固定字串 "drive#fileList"。

授權範圍

需要下列其中一種 OAuth 範圍：

  • 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

詳情請參閱授權指南。

語料庫

列舉
user 使用者擁有或與他人共用的檔案。
domain 與使用者網域共用的檔案。