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

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

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

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

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

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

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

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

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

Документ Google Workspace

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

Индекс

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

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

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

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

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

Сегмент

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

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

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

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

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

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