Каталог решений - Формирование документа Google Docs из шаблона используя Google Apps Script

Вводные

• Нужно сформировать документ со сложной версткой на основе шаблона.
• Нужно дать возможность пользователям самим менять шаблоны
• При возможности на использовать локально установленные программы

К написанию статьи подтолкнула статья по формированию договоров //sale.itcity.ru/public/1132491/, в которой отсутствовал код скрипта и в самой обработке присутствовали ключи аутентификации "по умолчанию".

Решение

Общая схема

В качестве платформы использовал Google Docs потому что он доступен бесплатно для пользователей и у него есть API. Локальной альтернативой является ONLYOFFICE + OwnCloud, но в их API не разбирался.

Функциональное решение

Формирование документа по шаблону может быть реализовано вариантами

• Копированием шаблона и замены строк (replace) определенного формата например {v8 …} на нужные значения. В рамках Google Doc разобрался как менять на текст и на картинки.
• Созданием пустого файла и объединением в нем элементов взятых из шаблона (merge), с дальнейшей заменой строк. Применяется если присутствует составные элементы таблицы и списки. В рамках Google Doc разобрался с таблицами, списки для первой версии реализации не критичны.
  • В рамках анализа решений просматривал вариант реализованный для word с применением переменных (1С:УНФ), но как выделяются области не вникал, если знаете как работает — пишите в комментарии, дополню статью для полноты картины.
• Собрать кодом из элементов, но даже в документации рекомендуют собирать из элементов шаблона.

Запрос отправляю на фиксированный URL, POST запросом со списком замен или списком элементов и замен. Для получения структуры шаблона отправляю GET запрос на тот же URL.

Результатом работы будет на выбор:

• индентификатор объекта с которым дальше взаимодействую через REST API
• base64 кодированные бинарные данные PDF формата. Он нормально открывается MS Word и преобразуется в DOCX.

Описание работы со стороны Google

Документы Google Docs (как и скрипты) являются объектами в Google Drive, часть операций производятся через его API.

Нужно различать REST API к сервису и API предоставляемое сервисом для Google Script App, у второго функционал существенно шире.

Google Script App можно опубликовать в качестве web приложения или в рамках Google Cloud Platform (GCP), после неудачных попыток вызвать скрипт через Google Script App REST API (на сколько понял для нормальной работы нужно GSuite которого у меня нет) остановился на варианте с web приложением.

Публикуется версия приложения, если после публикации изменен код то он доступен только в dev режиме. Для публикации измененного кода формируется новая версия и публикуется она. Требуемые права доступа (scopes) приложения анализируются при публикации и устанавливаются в её свойствах. При публикации скрипта указываю что он запускается от имени пользователя запускающего скрипт и доступен для всех пользователей на запуск, в скрипте использую только данные полученные из запроса.

Права доступа

Работа со скриптом ведется под правами пользователя Google. Аутентификация может пройти через cookie или через токен доступа который формируется через Oauth запрос.  Для использования приложения нужно делегировать права пользователя web-приложению и Oauth приложению от которого выдан ключ на формирование токена.

Получение Auth0 токена описано в документации к УНФ https://its.1c.ru/db/metod81#content:7551:hdoc техническая составляющая в статье //sale.itcity.ru/1c/articles/1247448/, для делегирования прав web приложению нужно запустить из браузера GET https://script.google.com/macros/s/{{script_id}}/exec и пройти процесс делегирования.