Method: files.list

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

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

HTTP-запрос

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

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

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

Параметры
corpora

string

Тела элементов (файлов/документов), к которым применяется запрос. Поддерживаются тела default , domain , drive и allDrives . Для повышения эффективности выберите default или drive allDrives .

corpus
(deprecated)

enum ( Corpus )

Устарело: тело элементов (файлов/документов), к которым применяется запрос. Вместо этого используйте corpora .

driveId

string

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

includeItemsFromAllDrives

boolean

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

includeTeamDriveItems
(deprecated)

boolean

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

maxResults

integer

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

orderBy

string

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

  • createdDate : дата создания файла.
  • folder : идентификатор папки. Это поле отсортировано в алфавитном порядке.
  • lastViewedByMeDate : время последнего просмотра файла пользователем.
  • modifiedByMeDate : последний раз, когда файл был изменен пользователем.
  • modifiedDate : дата последнего изменения файла кем-либо.
  • quotaBytesUsed : количество байтов квоты хранилища, используемых файлом.
  • recency : Самая последняя временная метка из полей даты и времени файла.
  • sharedWithMeDate : когда файл был предоставлен пользователю совместно, если применимо.
  • starred : отметил ли пользователь файл звездочкой.
  • title : Название файла. Это поле отсортировано в алфавитном порядке, то есть 1, 12, 2, 22.
  • title_natural : заголовок файла. Это поле отсортировано с использованием естественного порядка сортировки, то есть 1, 2, 12, 22.

По умолчанию каждый ключ сортируется по возрастанию, но его можно изменить с помощью модификатора desc. Пример использования: ?orderBy=folder,modifiedDate desc,title .

Обратите внимание, что в настоящее время существует ограничение для пользователей с примерно одним миллионом файлов, в которых запрошенный порядок сортировки игнорируется.

pageToken

string

Токен страницы для файлов.

projection
(deprecated)

enum ( Projection )

Устарело: этот параметр не имеет функции.

q

string

Строка запроса для поиска файлов.

spaces

string

Список пробелов, разделенных запятыми, для запроса. Поддерживаемые значения: drive и appDataFolder .

supportsAllDrives

boolean

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

supportsTeamDrives
(deprecated)

boolean

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

teamDriveId
(deprecated)

string

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

includePermissionsForView

string

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

includeLabels

string

Список идентификаторов меток, разделенных запятыми, которые нужно включить в часть ответа labelInfo .

Тело запроса

Тело запроса должно быть пустым.

Тело ответа

Список файлов.

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление 
{
  "nextPageToken": string,
  "kind": string,
  "etag": string,
  "selfLink": string,
  "incompleteSearch": boolean,
  "nextLink": string,
  "items": [
    {
      object (File)
    }
  ]
}
Поля
nextPageToken

string

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

kind

string

Это всегда drive#fileList .

etag

string

ETag списка.

items[]

object ( File )

Список файлов. Если параметр nextPageToken заполнен, этот список может быть неполным и необходимо получить дополнительную страницу результатов.

Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/docs
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.appdata
  • https://www.googleapis.com/auth/drive.apps.readonly
  • 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

Некоторые области ограничены, и для их использования требуется оценка безопасности вашего приложения. Дополнительную информацию см. в руководстве по авторизации .

Корпус

Перечисления
DEFAULT Элементы, к которым имел доступ пользователь.
DOMAIN Элементы, доступные в домене пользователя.