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

object ( File )

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

nextPageToken

string

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

kind

string

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

etag

string

ETag списка.

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

Требуется одна из следующих областей 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 Элементы, размещенные в домене пользователя.