Перечисляет файлы пользователя.
Этот метод принимает параметр q
, который представляет собой поисковый запрос, объединяющий один или несколько поисковых запросов. Дополнительную информацию см. в руководстве «Поиск файлов и папок» .
HTTP-запрос
GET https://www.googleapis.com/drive/v3/files
URL-адрес использует синтаксис транскодирования gRPC .
Параметры запроса
Параметры | |
---|---|
corpora | Тела элементов (файлов/документов), к которым применяется запрос. Поддерживаемые тела: «пользователь», «домен», «диск» и «allDrives». Для повышения эффективности предпочитайте «пользователь» или «диск» вместо «allDrives». По умолчанию для корпуса установлено значение «пользователь». Однако это может измениться в зависимости от фильтра, установленного с помощью параметра «q». |
corpus | Устарело: источник файлов для вывода в список. Вместо этого используйте слово «corpora». |
driveId | Идентификатор общего диска для поиска. |
includeItemsFromAllDrives | Следует ли включать в результаты как «Мой диск», так и объекты общего диска. |
includeTeamDriveItems | Устарело: вместо этого используйте |
orderBy | Список ключей сортировки, разделенный запятыми. Действительные ключи:
По умолчанию каждый ключ сортируется по возрастанию, но его можно изменить с помощью модификатора desc. Пример использования: |
pageSize | Максимальное количество файлов, возвращаемых на страницу. Частичные или пустые страницы результатов возможны даже до того, как будет достигнут конец списка файлов. |
pageToken | Токен для продолжения предыдущего запроса списка на следующей странице. Должно быть установлено значение nextPageToken из предыдущего ответа. |
q | Запрос для фильтрации результатов файла. Поддерживаемый синтаксис см. в руководстве «Поиск файлов и папок». |
spaces | Разделенный запятыми список пространств для запроса в корпусе. Поддерживаемые значения: «диск» и «appDataFolder». |
supportsAllDrives | Поддерживает ли запрашивающее приложение как «Мои диски», так и общие диски. |
supportsTeamDrives | Устарело: вместо этого используйте |
teamDriveId | Устарело: вместо этого используйте |
includePermissionsForView | Указывает, какие дополнительные разрешения представления следует включить в ответ. Поддерживается только «опубликовано». |
includeLabels | Список идентификаторов меток, разделенных запятыми, которые необходимо включить в часть ответа |
Тело запроса
Тело запроса должно быть пустым.
Тело ответа
Список файлов.
В случае успеха тело ответа содержит данные следующей структуры:
JSON-представление |
---|
{
"nextPageToken": string,
"kind": string,
"incompleteSearch": boolean,
"files": [
{
object ( |
Поля | |
---|---|
nextPageToken | Токен страницы для следующей страницы файлов. Этого не будет, если достигнут конец списка файлов. Если токен отклонен по какой-либо причине, его следует отбросить и перезапустить нумерацию страниц с первой страницы результатов. Токен страницы обычно действителен в течение нескольких часов. Однако если новые элементы добавляются или удаляются, ожидаемые результаты могут отличаться. |
kind | Определяет, что это за ресурс. Значение: фиксированная строка |
incompleteSearch | Был ли процесс поиска незавершенным. Если это правда, то некоторые результаты поиска могут отсутствовать, поскольку не все документы были найдены. Это может произойти при поиске нескольких дисков с помощью корпусов allDrives, но поиск по всем корпусам невозможен. В этом случае клиентам предлагается сузить свой запрос, выбрав другой корпус, например «пользователь» или «диск». |
files[] | Список файлов. Если параметр nextPageToken заполнен, этот список может быть неполным и необходимо получить дополнительную страницу результатов. |
Области авторизации
Требуется одна из следующих областей 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 | Файлы, доступные в домене пользователя. |