Method: files.list

Отображает список файлов пользователя. Дополнительную информацию см. в разделе «Поиск файлов и папок» .

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

Этот метод по умолчанию возвращает все файлы, включая файлы в корзине. Если вы не хотите, чтобы файлы в корзине отображались в списке, используйте параметр запроса trashed=false чтобы удалить файлы из корзины из результатов.

HTTP-запрос

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

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

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

Параметры
corpora

string

Указывает набор элементов (файлов или документов), к которым применяется запрос. Поддерживаемые элементы включают:

  • user
  • domain
  • drive
  • allDrives

Для повышения эффективности отдавайте предпочтение user или drive вместо allDrives . По умолчанию для корпусов устанавливается значение user . Однако это может меняться в зависимости от фильтра, заданного параметром q . Для получения дополнительной информации см. раздел «Организация файлов» .

corpus
(deprecated)

enum ( Corpus )

Устарело: источник файлов для вывода списка. Используйте вместо него corpora .

driveId

string

Идентификатор общего диска для поиска.

includeItemsFromAllDrives

boolean

Следует ли включать в результаты как элементы "Мой диск", так и элементы общего диска?

includeTeamDriveItems
(deprecated)

boolean

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

orderBy

string

Список ключей сортировки, разделенных запятыми. Допустимые ключи:

  • createdTime : Время создания файла. Избегайте использования этого ключа для запросов к большим коллекциям элементов, так как это может привести к таймаутам или другим проблемам. Для сортировки по времени в больших коллекциях элементов используйте modifiedTime desc .
  • folder : Идентификатор папки. Это поле сортируется в алфавитном порядке.
  • 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

Максимальное количество файлов для возврата. Сервис может вернуть меньшее количество файлов.

Если параметр не указан, для общих дисков будет возвращено не более 100 файлов, а для необязательных дисков — весь список файлов.

Максимальное значение — 1000; значения выше 1000 будут принудительно уменьшены до 1000.

pageToken

string

Токен для продолжения предыдущего запроса списка на следующей странице. Его следует установить равным значению параметра nextPageToken из предыдущего ответа.

q

string

Запрос для фильтрации результатов поиска файлов. Поддерживаемый синтаксис см. в разделе «Поиск файлов и папок» .

spaces

string

Разделенный запятыми список пространств для запроса в рамках корпуса. Поддерживаемые значения: drive и appDataFolder . Для получения дополнительной информации см. раздел «Организация файлов» .

supportsAllDrives

boolean

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

supportsTeamDrives
(deprecated)

boolean

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

teamDriveId
(deprecated)

string

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

includePermissionsForView

string

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

includeLabels

string

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