Обзор API Документов Google

API Google Docs позволяет создавать и изменять документы в Google Docs.

Приложения могут интегрироваться с API Docs для создания качественных документов на основе данных, предоставленных как пользователями, так и системой. API Docs позволяет:

  • Автоматизировать процессы
  • Массовое создание документации
  • Форматировать документы
  • Генерация счетов-фактур или контрактов
  • Извлекать определенные атрибуты объектов

Ниже приведен список общих терминов, используемых в API Docs:

Идентификатор документа

Уникальный идентификатор документа. Это определённая строка, содержащая буквы, цифры и некоторые специальные символы, которая ссылается на документ и может быть получена из URL-адреса документа. Идентификаторы документов остаются неизменными, даже если меняется название документа. Подробнее о том, как найти идентификатор, см. в разделе «Идентификатор документа» .

https://docs.google.com/document/d/DOCUMENT_ID/edit
Элемент

Структура документа. К элементам верхнего уровня документа относятся Body , DocumentStyle и List .

Документ Google Workspace

Файл, создаваемый приложением Google Workspace, например Google Docs. Формат типа MIME для Docs — application/vnd.google-apps.document . Список типов MIME см. в разделе «Поддерживаемые типы MIME для Google Workspace и Google Drive» .

Индекс

Большинство элементов в теле контента имеют свойства startIndex и endIndex . Они указывают смещение начала и конца элемента относительно начала его окружающего сегмента .

Встроенное изображение

Изображение, которое отображается в тексте документа. Не является вложением.

Именованный диапазон

Непрерывный диапазон текста. NamedRange — это коллекция диапазонов с одинаковым namedRangeId . Именованные диапазоны позволяют разработчикам связывать части документа с произвольной пользовательской меткой, чтобы их содержимое можно было программно читать или редактировать позже. Документ может содержать несколько именованных диапазонов с одинаковым именем, но каждый именованный диапазон имеет уникальный идентификатор.

Сегмент

Body , Header , Footer или Footnote , содержащие структурные или содержательные элементы . Индексы элементов внутри сегмента отсчитываются относительно начала этого сегмента.

Предположение

Внесение изменений в документ без изменения исходного текста. Если владелец одобрит ваши предложения, исходный текст будет заменен.

  • Информацию о разработке с использованием API Google Workspace, включая обработку аутентификации и авторизации, см. в разделе Разработка в Google Workspace .

  • Чтобы получить концептуальный обзор документа, см. Документ .

  • Чтобы узнать, как настроить и запустить приложение Docs API, попробуйте быстрый старт JavaScript .