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

ID общего диска для поиска.

includeItemsFromAllDrives

boolean

Должны ли элементы «Мой диск» и общего диска включаться в результаты.

includeTeamDriveItems
(deprecated)

boolean

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

maxResults

integer

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

orderBy

string

Список ключей сортировки, разделенных запятыми. Допустимые ключи: createdDate , folder , lastViewedByMeDate , modifiedByMeDate , modifiedDate , quotaBytesUsed , recency , sharedWithMeDate , starred , title и title_natural . По умолчанию каждый ключ сортируется по возрастанию, но его можно изменить с помощью модификатора 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.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 Элементы, опубликованные в домене пользователя.