Запросы и ответы

В этом руководстве представлены основные методы запросов и ответов, составляющие 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.batchUpdate принимает список объектов request , каждый из которых определяет один запрос для выполнения. Например, отформатируйте абзац, а затем добавьте встроенное изображение. Каждый запрос проверяется перед применением, и запросы обрабатываются в соответствии с порядком их появления в пакетном запросе.

Все запросы в пакетном обновлении применяются атомарно. То есть, если какой-либо запрос недействителен, то все обновление завершается неудачей и ни одно из (потенциально зависимых) изменений не применяется.

Некоторые методы documents.batchUpdate предоставляют ответы с информацией о примененных запросах. Эти методы возвращают тело ответа , содержащее список объектов response . Другие запросы не должны возвращать информацию и выдавать пустой ответ. Объекты в списке ответов занимают тот же порядок индексации, что и соответствующий запрос.

Популярный шаблон пакетных запросов выглядит следующим образом:

requests = []
requests.append(first request)
requests.append(second request)
...

body = ... & requests & ...

...batchUpdate(body)

Подробные сведения о том, как пакетировать вызовы API Документов, см. в рекомендациях по пакетным запросам , а также в справочной документации documents.batchUpdate для типов запросов и ответов.

Операции пакетного обновления

Существуют различные типы запросов на пакетное обновление. Вот разбивка типов запросов , сгруппированных по различным категориям.

Объект ДОБАВИТЬ/ВСТАВИТЬ ОБНОВЛЕНИЕ/ЗАМЕНА УДАЛИТЬ
Текст Вставитьтекстовый запрос ЗаменитьAllTextRequest
Стили CreateParagraphBulletsRequest UpdateTextStyleRequest
Запрос обновления абзаца стиля
UpdateTableCellStyleRequest
UpdateTableRowStyleRequest
ОбновлениеДокументСтильЗапрос
UpdateSectionStyleRequest
Удалить абзац. Запрос маркеров.
Именованные диапазоны CreateNamedRangeRequest Резаменамедранжеконтентрекуест Делетенамедранжерекуест
Удалеконтентранжерекуест
Изображения Инлайнимажерекуест ЗаменитьImageRequest
Таблицы Инсертаблерекуест
Инсертаблероврекуест
Инсертаблеколумнреквест
UpdateTableColumnPropertiesRequest
Запрос MergeTableCells
UnmergeTableCellsRequest
PinTableHeaderRowsRequest
Удалитьтаблероврекуест
Удалитьтаблеколонквест
Объекты страницы (включая верхние и нижние колонтитулы ) Вставитьпажебрекреквест
Создатьзаголовок запроса
Создать запрос нижнего колонтитула
Создать запрос сноски
InsertSectionBreakRequest
Запрос УдалитьПозиционедОбжект
Удалитьзаголовокзапрос
УдалитьFooterRequest
,

В этом руководстве представлены основные методы запросов и ответов, составляющие 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.batchUpdate принимает список объектов request , каждый из которых определяет один запрос для выполнения. Например, отформатируйте абзац, а затем добавьте встроенное изображение. Каждый запрос проверяется перед применением, и запросы обрабатываются в соответствии с порядком их появления в пакетном запросе.

Все запросы в пакетном обновлении применяются атомарно. То есть, если какой-либо запрос недействителен, то все обновление завершается неудачей и ни одно из (потенциально зависимых) изменений не применяется.

Некоторые методы documents.batchUpdate предоставляют ответы с информацией о примененных запросах. Эти методы возвращают тело ответа , содержащее список объектов response . Другие запросы не должны возвращать информацию и выдавать пустой ответ. Объекты в списке ответов занимают тот же порядок индексации, что и соответствующий запрос.

Популярный шаблон пакетных запросов выглядит следующим образом:

requests = []
requests.append(first request)
requests.append(second request)
...

body = ... & requests & ...

...batchUpdate(body)

Подробные сведения о том, как пакетировать вызовы API Документов, см. в рекомендациях по пакетным запросам , а также в справочной документации documents.batchUpdate для типов запросов и ответов.

Операции пакетного обновления

Существуют различные типы запросов на пакетное обновление. Вот разбивка типов запросов , сгруппированных по различным категориям.

Объект ДОБАВИТЬ/ВСТАВИТЬ ОБНОВЛЕНИЕ/ЗАМЕНА УДАЛИТЬ
Текст Вставитьтекстовый запрос ЗаменитьAllTextRequest
Стили CreateParagraphBulletsRequest UpdateTextStyleRequest
Запрос обновления абзаца стиля
UpdateTableCellStyleRequest
UpdateTableRowStyleRequest
ОбновлениеДокументСтильЗапрос
UpdateSectionStyleRequest
Удалить абзац. Запрос маркеров.
Именованные диапазоны CreateNamedRangeRequest Резаменамедранжеконтентрекуест Делетенамедранжерекуест
Удалеконтентранжерекуест
Изображения Инлайнимажерекуест ЗаменитьImageRequest
Таблицы Инсертаблерекуест
Инсертаблероврекуест
Инсертаблеколумнреквест
UpdateTableColumnPropertiesRequest
Запрос MergeTableCells
UnmergeTableCellsRequest
PinTableHeaderRowsRequest
Удалитьтаблероврекуест
Удалитьтаблеколонквест
Объекты страницы (включая верхние и нижние колонтитулы ) Вставитьпажебрекреквест
Создатьзаголовок запроса
Создать запрос нижнего колонтитула
Создать запрос сноски
InsertSectionBreakRequest
Запрос УдалитьПозиционедОбжект
Удалитьзаголовокзапрос
УдалитьFooterRequest
,

В этом руководстве представлены основные методы запросов и ответов, составляющие 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.batchUpdate принимает список объектов request , каждый из которых определяет один запрос для выполнения. Например, отформатируйте абзац, а затем добавьте встроенное изображение. Каждый запрос проверяется перед применением, и запросы обрабатываются в соответствии с порядком их появления в пакетном запросе.

Все запросы в пакетном обновлении применяются атомарно. То есть, если какой-либо запрос недействителен, то все обновление завершается неудачей и ни одно из (потенциально зависимых) изменений не применяется.

Некоторые методы documents.batchUpdate предоставляют ответы с информацией о примененных запросах. Эти методы возвращают тело ответа , содержащее список объектов response . Другие запросы не должны возвращать информацию и выдавать пустой ответ. Объекты в списке ответов занимают тот же порядок индексации, что и соответствующий запрос.

Популярный шаблон пакетных запросов выглядит следующим образом:

requests = []
requests.append(first request)
requests.append(second request)
...

body = ... & requests & ...

...batchUpdate(body)

Подробные сведения о том, как пакетировать вызовы API Документов, см. в рекомендациях по пакетным запросам , а также в справочной документации documents.batchUpdate для типов запросов и ответов.

Операции пакетного обновления

Существуют различные типы запросов на пакетное обновление. Вот разбивка типов запросов , сгруппированных по различным категориям.

Объект ДОБАВИТЬ/ВСТАВИТЬ ОБНОВЛЕНИЕ/ЗАМЕНА УДАЛИТЬ
Текст Вставитьтекстовый запрос ЗаменитьAllTextRequest
Стили CreateParagraphBulletsRequest UpdateTextStyleRequest
Запрос обновления абзаца стиля
UpdateTableCellStyleRequest
UpdateTableRowStyleRequest
ОбновлениеДокументСтильЗапрос
UpdateSectionStyleRequest
Удалить абзац. Запрос маркеров.
Названные диапазоны CreatenAdedRangerequest Резаменамедранжеконтентрекуест DeleteNamedRangerequest
Удалеконтентранжерекуест
Изображения Insertinlineimagerequest Заменить
Таблицы INSERTTABLEREQUEST
INSERTTABLEROWREQUEST
INSERTTABLECOLUMNREQUEST
UpdateTableColumnPropertiesRequest
Запрос MergeTableCells
UnmergeTableCellsRequest
PinTableHeaderRowsRequest
DeletetTableRowRequest
DeletetAbleColumnRequest
Объекты страницы (включая верхние и нижние колонтитулы ) INSERTPAGEBREAKREQUEST
CreateHeaderRequest
Создать запрос нижнего колонтитула
Создать запрос сноски
InsertSectionBreakRequest
Запрос УдалитьПозиционедОбжект
Удалитьзаголовокзапрос
УдалитьFooterRequest
,

В этом руководстве представлены основные методы запросов и ответов, составляющие 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.batchUpdate принимает список объектов request , каждый из которых определяет один запрос для выполнения. Например, отформатируйте абзац, а затем добавьте встроенное изображение. Каждый запрос проверяется перед применением, и запросы обрабатываются в соответствии с порядком их появления в пакетном запросе.

Все запросы в пакетном обновлении применяются атомарно. То есть, если какой-либо запрос недействителен, то все обновление завершается неудачей и ни одно из (потенциально зависимых) изменений не применяется.

Некоторые методы documents.batchUpdate предоставляют ответы с информацией о примененных запросах. Эти методы возвращают тело ответа , содержащее список объектов response . Другие запросы не должны возвращать информацию и выдавать пустой ответ. Объекты в списке ответов занимают тот же порядок индексации, что и соответствующий запрос.

Популярный шаблон пакетных запросов выглядит следующим образом:

requests = []
requests.append(first request)
requests.append(second request)
...

body = ... & requests & ...

...batchUpdate(body)

Подробные сведения о том, как пакетировать вызовы API Документов, см. в рекомендациях по пакетным запросам , а также в справочной документации documents.batchUpdate для типов запросов и ответов.

Операции пакетного обновления

Существуют различные типы запросов на пакетное обновление. Вот разбивка типов запросов , сгруппированных по различным категориям.

Объект ДОБАВИТЬ/ВСТАВИТЬ ОБНОВЛЕНИЕ/ЗАМЕНА УДАЛИТЬ
Текст Вставитьтекстовый запрос ЗаменитьAllTextRequest
Стили CreateParagraphBulletsRequest UpdateTextStyleRequest
Запрос обновления абзаца стиля
UpdateTableCellStyleRequest
UpdateTableRowStyleRequest
ОбновлениеДокументСтильЗапрос
UpdateSectionStyleRequest
Удалить абзац. Запрос маркеров.
Названные диапазоны CreatenAdedRangerequest Резаменамедранжеконтентрекуест DeleteNamedRangerequest
Удалитьконтентранжерекуест
Изображения Инлайнимажерекуест ЗаменитьImageRequest
Таблицы Инсертаблерекуест
Инсертаблероврекуест
Инсертаблеколумнреквест
UpdateTableColumnPropertiesRequest
Запрос MergeTableCells
UnmergeTableCellsRequest
PinTableHeaderRowsRequest
Удалитьтаблероврекуест
Удалитьтаблеколонквест
Объекты страницы (включая верхние и нижние колонтитулы ) Вставитьпажебрекреквест
Создатьзаголовок запроса
Создать запрос нижнего колонтитула
Создать запрос сноски
InsertSectionBreakRequest
Запрос УдалитьПозиционедОбъектрекуест
Удалитьзаголовокзапрос
УдалитьFooterRequest