Этот справочник API организован по типу ресурса. Каждый тип ресурса имеет одно или несколько представлений данных и один или несколько методов.
Типы ресурсов
О
Сведения о ресурсах см. на странице представления ресурсов .
Метод | HTTP-запрос | Описание |
---|---|---|
URI относительно https://www.googleapis.com/drive/v3, если не указано иное. | ||
получать | GET /about | Получает информацию о пользователе, Диске пользователя и возможностях системы. Обязательные параметры запроса: fields |
Изменения
Сведения о ресурсе изменений см. на странице представления ресурса .
Метод | HTTP-запрос | Описание |
---|---|---|
URI относительно https://www.googleapis.com/drive/v3, если не указано иное. | ||
getStartPageToken | GET /changes/startPageToken | Получает начальную страницуToken для перечисления будущих изменений. |
список | GET /changes | Список изменений для пользователя или общего диска. Обязательные параметры запроса: pageToken |
смотреть | POST /changes/watch | Подписывается на изменения для пользователя. Чтобы использовать этот метод, необходимо включить параметр запроса pageToken . |
каналы
Подробную информацию о ресурсах каналов см. на странице представления ресурсов .
Метод | HTTP-запрос | Описание |
---|---|---|
URI относительно https://www.googleapis.com/drive/v3, если не указано иное. | ||
останавливаться | POST /channels/stop | Прекратить смотреть ресурсы через этот канал |
Комментарии
Подробную информацию о ресурсах комментариев см. на странице представления ресурсов .
Метод | HTTP-запрос | Описание |
---|---|---|
URI относительно https://www.googleapis.com/drive/v3, если не указано иное. | ||
создавать | POST /files/ fileId /comments | Создает комментарий к файлу. Обязательные параметры запроса: fields |
удалить | DELETE /files/ fileId /comments/ commentId | Удаляет комментарий. |
получать | GET /files/ fileId /comments/ commentId | Получает комментарий по ID. Обязательные параметры запроса: fields |
список | GET /files/ fileId /comments | Список комментариев к файлу. Обязательные параметры запроса: fields |
обновлять | PATCH /files/ fileId /comments/ commentId | Обновляет комментарий с помощью семантики исправления. Обязательные параметры запроса: fields |
Файлы
Сведения о файловом ресурсе см. на странице представления ресурса .
Метод | HTTP-запрос | Описание |
---|---|---|
URI относительно https://www.googleapis.com/drive/v3, если не указано иное. | ||
копировать | POST /files/ fileId /copy | Создает копию файла и применяет любые запрошенные обновления с семантикой исправления. Папки не могут быть скопированы. |
создавать | POST и POST /files | Создает файл. |
удалить | DELETE /files/ fileId | Безвозвратно удаляет файл, принадлежащий пользователю, не перемещая его в корзину. Если файл принадлежит общему диску, пользователь должен быть организатором родительского диска. Если целью является папка, все потомки, принадлежащие пользователю, также удаляются. |
Очистить корзину | DELETE /files/trash | Безвозвратно удаляет все файлы пользователя, находящиеся в корзине. |
экспорт | GET /files/ fileId /export | Экспортирует документ Google Workspace в запрошенный тип MIME и возвращает экспортированное байтовое содержимое. Обратите внимание, что экспортируемый контент ограничен 10 МБ. Обязательные параметры запроса: mimeType |
генерировать идентификаторы | GET /files/generateIds | Создает набор идентификаторов файлов, которые можно указать в запросах на создание или копирование. |
получать | GET /files/ fileId | Получает метаданные или содержимое файла по идентификатору. |
список | GET /files | Перечисляет или ищет файлы. |
обновлять | PATCH и PATCH /files/ fileId | Обновляет метаданные и/или содержимое файла. При вызове этого метода заполняйте только те поля в запросе, которые вы хотите изменить. При обновлении полей некоторые поля могут измениться автоматически, например,modifiedDate. Этот метод поддерживает семантику исправления. |
смотреть | POST /files/ fileId /watch | Подписывается на изменения в файле. Хотя вы можете установить канал для изменений в файле на общем диске, изменение файла на общем диске не приведет к созданию уведомления. |
listLabels | GET /files/ fileId /listLabels | Список меток в файле. |
изменить метки | POST /files/ fileId /modifyLabels | Изменяет набор меток в файле. |
Разрешения
Сведения о ресурсе разрешений см. на странице представления ресурса .
Метод | HTTP-запрос | Описание |
---|---|---|
URI относительно https://www.googleapis.com/drive/v3, если не указано иное. | ||
создавать | POST /files/ fileId /permissions | Создает разрешение для файла или общего диска. Дополнительные сведения о создании разрешений см. в разделе Общий доступ к файлам, папкам и дискам . |
удалить | DELETE /files/ fileId /permissions/ permissionId | Удаляет разрешение. |
получать | GET /files/ fileId /permissions/ permissionId | Получает разрешение по ID. |
список | GET /files/ fileId /permissions | Список прав доступа к файлу или общему диску. |
обновлять | PATCH /files/ fileId /permissions/ permissionId | Обновляет разрешение с помощью семантики исправления. |
Ответы
Сведения о ресурсе ответов см. на странице представления ресурса .
Метод | HTTP-запрос | Описание |
---|---|---|
URI относительно https://www.googleapis.com/drive/v3, если не указано иное. | ||
создавать | POST /files/ fileId /comments/ commentId /replies | Создает ответ на комментарий. Обязательные параметры запроса: fields |
удалить | DELETE /files/ fileId /comments/ commentId /replies/ replyId | Удаляет ответ. |
получать | GET /files/ fileId /comments/ commentId /replies/ replyId | Получает ответ по ID. Обязательные параметры запроса: fields |
список | GET /files/ fileId /comments/ commentId /replies | Список ответов на комментарий. Обязательные параметры запроса: fields |
обновлять | PATCH /files/ fileId /comments/ commentId /replies/ replyId | Обновляет ответ с помощью семантики исправления. Обязательные параметры запроса: fields |
Редакции
Сведения о ресурсе ревизий см. на странице представления ресурса .
Метод | HTTP-запрос | Описание |
---|---|---|
URI относительно https://www.googleapis.com/drive/v3, если не указано иное. | ||
удалить | DELETE /files/ fileId /revisions/ revisionId | Безвозвратно удаляет версию файла. Вы можете удалять версии только для файлов с двоичным содержимым на Google Диске, таких как изображения или видео. Невозможно удалить версии других файлов, например Google Docs или Sheets, а также последнюю оставшуюся версию файла. |
получать | GET /files/ fileId /revisions/ revisionId | Получает метаданные или содержимое редакции по идентификатору. |
список | GET /files/ fileId /revisions | Перечисляет ревизии файла. |
обновлять | PATCH /files/ fileId /revisions/ revisionId | Обновляет ревизию с помощью семантики исправления. |
Диски
Сведения о ресурсах Drives см. на странице представления ресурсов .
Метод | HTTP-запрос | Описание |
---|---|---|
URI относительно https://www.googleapis.com/drive/v3, если не указано иное. | ||
создавать | POST /drives | Создает общий диск. Обязательные параметры запроса: requestId |
удалить | DELETE /drives/ driveId | Безвозвратно удаляет общий диск, организатором которого является пользователь. На общем диске не должно быть неубранных элементов. |
получать | GET /drives/ driveId | Получает метаданные общего диска по идентификатору. |
скрывать | POST /drives/ driveId /hide | Скрывает общий диск от представления по умолчанию. |
список | GET /drives | Список общих дисков пользователя. |
показывать | POST /drives/ driveId /unhide | Восстанавливает вид общего диска по умолчанию. |
обновлять | PATCH /drives/ driveId | Обновляет метаданные для общего диска. |