Method: files.list

列出使用者的檔案。

這個方法可接受 q 參數，也就是結合一或多個搜尋字詞的搜尋查詢。詳情請參閱「搜尋檔案和資料夾」指南。

HTTP 要求

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

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

查詢參數

參數
corpora

string

查詢適用的項目 (檔案/文件) 內容。支援的內容主體包括「user」、「domain」、「drive」和「allDrives」。為提升效率，請優先使用「user」或「drive」，而非「allDrives」。根據預設，corpora 會設為「user」。不過，這可能會因透過「q」參數設定的篩選器而異。
corpus
(deprecated)

enum (Corpus)

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

string

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

boolean

是否要將「我的雲端硬碟」和共用雲端硬碟的項目納入搜尋結果。
includeTeamDriveItems
(deprecated)

boolean

已淘汰：請改用 includeItemsFromAllDrives。
orderBy

string

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

  • createdTime：檔案建立的時間。
  • 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

指定要納入回應的其他檢視畫面權限。僅支援「已發布」。
includeLabels

string

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

要求主體

要求主體必須為空白。

回應主體

檔案清單。

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

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

string

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

string

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

object (File)

檔案清單。如果填入 nextPageToken，則這份清單可能不完整，因此應擷取其他結果頁面。

授權範圍

需要下列其中一種 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 共用至使用者網域的檔案。