Method: files.list

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

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

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

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