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 . По умолчанию для corpora задано значение user . Однако это может измениться в зависимости от фильтра, заданного параметром q . Подробнее см. в разделе «Организация файлов» .

corpus
(deprecated)

enum ( Corpus )

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

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

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