В этом руководстве представлены основные методы запросов и ответов, составляющие API Документов Google, а также способы пакетного обновления документа.
Вы можете вызвать API Документов Google с помощью HTTP-запроса или с помощью вызова метода в клиентской библиотеке для конкретного языка. В целом они эквивалентны.
API Документов Google возвращает ответ HTTP, который обычно включает результат вызова запроса. При использовании клиентской библиотеки для выполнения запросов ответы возвращаются в зависимости от языка.
Методы запроса
API Документов поддерживает следующие методы:
documents.create: Создайте пустой документ Google Docs.documents.get: Возвращает полный экземпляр указанного документа. Вы можете проанализировать возвращенный JSON, чтобы извлечь содержимое документа, форматирование и другие функции.documents.batchUpdate: отправьте список запросов на редактирование для атомарного применения к документу и верните список результатов.
Методы documents.get и documents.batchUpdate требуют documentId в качестве параметра для указания целевого документа. Метод documents.create возвращает экземпляр созданного документа, из которого можно прочитать documentId . Дополнительные сведения о documentId см. в разделе Document ID .
Обратите внимание, что вы не можете использовать метод documents.get для получения опубликованных документов. После публикации общедоступные документы используют другой формат URL. Попытки использовать новый documentId URL-адреса с методом documents.get возвращают ответ с кодом состояния HTTP 404 . Не существует способов получить исходный documentId из опубликованного URL-адреса. Чтобы обойти эту проблему, вы можете использовать Drive API, чтобы скопировать опубликованный документ в общий документ, а затем вместо этого получить доступ к этому файлу. Дополнительную информацию см. в разделе Открытие общего доступа к документам, таблицам, слайдам и формам Google .
Пакетные обновления
Метод documents.batchUpdate принимает список объектов request , каждый из которых определяет один запрос для выполнения. Например, отформатируйте абзац, а затем добавьте встроенное изображение. Каждый запрос проверяется перед применением, и запросы обрабатываются в соответствии с порядком их появления в пакетном запросе.
Все запросы в пакетном обновлении применяются атомарно. То есть, если какой-либо запрос недействителен, то все обновление завершается неудачей и ни одно из (потенциально зависимых) изменений не применяется.
Некоторые методы documents.batchUpdate предоставляют ответы с информацией о примененных запросах. Эти методы возвращают тело ответа , содержащее список объектов response . Другие запросы не должны возвращать информацию и выдавать пустой ответ. Объекты в списке ответов занимают тот же порядок индексации, что и соответствующий запрос.
Популярный шаблон пакетных запросов выглядит следующим образом:
requests = []
requests.append(first request)
requests.append(second request)
...
body = ... & requests & ...
...batchUpdate(body)
Подробные сведения о пакетной обработке вызовов API Документов см. в рекомендациях по пакетному запросу , а также в справочной документации по типам запросов и ответов documents.batchUpdate .
Операции пакетного обновления
Существуют различные типы запросов на пакетное обновление. Вот разбивка типов запросов , сгруппированных по различным категориям.