Method: files.list

Список файлов пользователя.

Этот метод принимает параметр q , который представляет собой поисковый запрос, объединяющий одно или несколько условий поиска. Дополнительные сведения см. в руководстве по поиску файлов и папок .

HTTP-запрос

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

URL-адрес использует синтаксис транскодирования gRPC .

Параметры запроса

Параметры
corpora

string

Тела элементов (файлов/документов), к которым применяется запрос. Поддерживаемые тела: «пользователь», «домен», «диск» и «все диски». Для эффективности предпочитайте «пользователь» или «диск», а не «все диски». По умолчанию для корпусов установлено значение «пользователь». Однако это может измениться в зависимости от фильтра, установленного с помощью параметра 'q'.

corpus
(deprecated)

enum ( Corpus )

Устарело: источник файлов для списка. Вместо этого используйте «корпус».

driveId

string

ID общего диска для поиска.

includeItemsFromAllDrives

boolean

Должны ли элементы «Мой диск» и общего диска включаться в результаты.

includeTeamDriveItems
(deprecated)

boolean

Устарело: вместо этого используйте includeItemsFromAllDrives .

orderBy

string

Список ключей сортировки, разделенных запятыми. Допустимыми ключами являются «createdTime», «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

Разделенный запятыми список пробелов для запроса внутри корпусов. Поддерживаемые значения: «диск» и «appDataFolder».

supportsAllDrives

boolean

Поддерживает ли запрашивающее приложение как «Мои диски», так и общие диски.

supportsTeamDrives
(deprecated)

boolean

Устарело: используйте вместо этого supportsAllDrives .

teamDriveId
(deprecated)

string

Устарело: вместо этого используйте driveId .

includePermissionsForView

string

Указывает, какие дополнительные разрешения представления следует включить в ответ. Поддерживается только «опубликовано».

includeLabels

string

Разделенный запятыми список идентификаторов меток для включения в часть 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.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 Файлы, опубликованные в домене пользователя.