Method: files.list

Перечисляет файлы пользователя.

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

HTTP-запрос

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

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

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

Параметры
corpora

string

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

corpus
(deprecated)

enum ( Corpus )

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

driveId

string

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

includeItemsFromAllDrives

boolean

Следует ли включать в результаты как «Мой диск», так и объекты общего диска.

includeTeamDriveItems
(deprecated)

boolean

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

orderBy

string

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

  • createdTime : Когда файл был создан.
  • 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

Максимальное количество файлов, возвращаемых на страницу. Частичные или пустые страницы результатов возможны даже до того, как будет достигнут конец списка файлов.

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.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 Файлы, доступные в домене пользователя.