Method: files.list

列出使用者的檔案。

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

HTTP 要求

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

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

查詢參數

參數
corpora

string

查詢所套用項目 (檔案/文件) 的主體。支援的主體為「user」、「domain」、「drive」和「allDrives」。為了提高效率，最好使用「使用者」或「雲端硬碟」。根據預設，語料庫會設為「user」。不過，視透過「q」參數設定的篩選器而定，這個值會有所不同。
corpus
(deprecated)

enum (Corpus)

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

string

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

boolean

搜尋結果是否應包含「我的雲端硬碟」和「共用雲端硬碟」項目。
includeTeamDriveItems
(deprecated)

boolean

已淘汰：請改用 includeItemsFromAllDrives。
orderBy

string

以逗號分隔的排序鍵清單。有效索引鍵為「createTime」、「folder」、「modifiedByMeTime」、「modifiedTime」、「name」、「name_natural」、「'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

要包含在回應的 labelInfo 部分中的標籤 ID 清單 (以半形逗號分隔)。

要求主體

要求主體必須為空白。

回應主體

檔案清單。

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

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

string

下一頁檔案的網頁權杖。如果已達檔案清單的結尾，則不會顯示這個 ID。如果權杖因任何原因遭拒，則應捨棄權杖，且應從結果的第一頁重新開始分頁。網頁權杖通常在幾小時內有效。不過，如果新增或移除新項目，預期結果可能會有所不同。
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.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 與使用者網域共用的檔案。