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

25.08.20

Интеграция - WEB-интеграция

В статье опишу работу скрипта для формирования документа с публикацией по HTTP.

Вводные

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

К написанию статьи подтолкнула статья по формированию договоров //infostart.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 техническая составляющая в статье //infostart.ru/1c/articles/1247448/, для делегирования прав web приложению нужно запустить из браузера GET https://script.google.com/macros/s/{{script_id}}/exec и пройти процесс делегирования.

 
 Скриншот результата делегирования прав

 

В рабочих запросах указываю Bearer токен, полученный при POST https://www.googleapis.com//oauth2/v4/token c grant_type=authorization_code

 

Инструменты

  • Консоль управления скриптами с возможностью редактировать код https://script.google.com/
  • Тестировал с помощью Postman

 

Реализация скрипта

 
 Код скрипта

 

При публикации скрипта как web приложения можно использовать две точки входа, функции doGet и doPost  (документация), doGet отвечает за получение структуры шаблона по id, doPost за формирование файла из шаблона.

Ответ формируется через "ContentService.createTextOutput", он не поддерживает коды состояния HTTP, поэтому они вынесены в тело запроса, реализовано в обертке createResponse().

Создание файлов реализовано в

  • createDocFromTemplate() - создание через копию и замену
  • mergeDocFromTemplate() - создание нового и объединение

Замена реализована в функции replacesInElement(), .replaceText() и .findText() применим как к всему телу документа, так и к его элементам.

Масштабирование картинки под нужный размер реализовано в функции replaceTextToImageInElement(), картинка вставляется как addPositionedImage, есть вариант (не реализовывал) с вставкой в отдельную линию.

Для вставки картинок используется тип Blob для которого указывается MIMEType двоичных данных.

Объединение элементов реализовано в mergeElementsFromTemplate(), ограничения:

  • не реализовывал работу со списками и разделителями строк
  • не реализовывал работу с заголовком и подвалом

Для экспорта документа в PDF используется doc.getAs("application/pdf"), реализовано в base64ToBlob().

 

Варианты использования

Для формирования через копирование и замену:

Отправляю запрос POST https://script.google.com/macros/s/{{script_id}}/exec

 
 Пример тела запроса, в {{}} переменные Postman

 

Для формирования через объединение и замену:

Получаю структуру документа через GET https://script.google.com/macros/s/{{script_id}}/exec?templateDocId={{template_doc_id}}

 
 Пример ответа

 

Отправляю запрос POST https://script.google.com/macros/s/{{script_id}}/exec

 
 Пример тела запроса

 

При формировании списка идентификаторов элементов беру идентификаторы между элементами с "match": ["{v8 Область ..., подход аналогичен формированию по шаблону Word из УТ 11.

 

Итог

Получился универсальный с точки зрения места запуска и вариантов использования инструмент.

Репозиторий на GitHub (ссылка) \scripts\ReplaceDoc.js

Благодарю за внимание.

Google

См. также

Интеграция 1С — Битрикс24. Обмен задачами

Сайты и интернет-магазины Интеграция WEB-интеграция Платформа 1С v8.3 Конфигурации 1cv8 Управленческий учет Платные (руб)

Интеграция 1С и Битрикс24. Разработка имеет двухстороннюю синхронизацию 1С и Битрикс24 задачами. Решение позволяет создавать пользователя в 1С из Битрикс24 и наоборот. Данная разработка технически подходит под все основные конфигурации линейки продуктов 1С:Предприятие 8.3 (8.3.18.1289). При приобретении предоставляется 1 месяц бесплатных обновлений разработки. Доступна демо-версия продукта с подключением Вашего Битрикс24

5040 руб.

04.05.2021    17851    6    15    

13

[Расширение] БОР-Навигатор.Культура

Зарплата Бюджетный учет WEB-интеграция Обмен с ГосИС Платформа 1С v8.3 Сложные периодические расчеты 1С:Зарплата и кадры государственного учреждения 3 Государственные, бюджетные структуры Россия Бюджетный учет Платные (руб)

Расширение конфигурации, включающее в себя объекты, необходимые для подготовки и сдачи отчета "Штатная численность" системы "БОР-Навигатор.Культура" в программе "1С:Зарплата и кадры государственного учреждения", редакция 3.1.

8400 руб.

01.02.2019    25856    9    0    

7

Заполнение по ИНН или наименованию реквизитов контрагента по данным сайта ФНС

Обмен с ГосИС WEB-интеграция Платформа 1С v8.3 Управляемые формы 1С:Комплексная автоматизация 1.х 1С:Бухгалтерия 2.0 1С:Управление торговлей 10 1С:Управление производственным предприятием 1С:Управление нашей фирмой 1.6 1С:Бухгалтерия государственного учреждения 1С:Документооборот 1С:ERP Управление предприятием 2 1С:Бухгалтерия 3.0 1С:Управление торговлей 11 1С:Комплексная автоматизация 2.х Платные (руб)

Обработка является альтернативой механизму, разработанному фирмой 1С и заполняющему реквизиты контрагента по ИНН или наименованию. Не требуется действующей подписки ИТС. Вызывается как внешняя дополнительная обработка, т.е. используется, непосредственно, из карточки контрагента. Заполнение по ИНН или наименованию реквизитов контрагента по данным сайта ФНС (egrul.nalog.ru) для БП 2.0, БП 3.0, БГУ 1.0, БГУ 2.0, УТ 10.3, УТ 11.x, КА 1.1, КА 2.x, УПП 1.x, ERP 2.x, УНФ 1.5, УНФ 1.6, УНФ 3.0, ДО 2.1

2400 руб.

28.04.2016    88878    162    216    

318

Интеграция с сервисом vetmanager

WEB-интеграция Платформа 1С v8.3 Бухгалтерский учет 1С:Бухгалтерия 3.0 Бытовые услуги, сервис Платные (руб)

Внешняя обработка разрабатывалась для загрузки документов из Ветменеджер в 1С: Бухгалтерия 3.0

12000 руб.

02.02.2021    16466    42    49    

23

Merlion Commander Версия 1.3.9.2 - июль 2022 г. (Интеграция с 1С: УT, редакция 11.4, 1С:Розница 2.3,1С:ERP Управление предприятием 2, УТ 10.3, редакция веб-сервиса MERLION API 3.0 от 18.08.2021)

Оптовая торговля Розничная торговля WEB-интеграция Платформа 1С v8.3 1С:Управление торговлей 11 Россия Платные (руб)

Расширении конфигурации "Управление торговлей, редакция 11" для работы с веб-сервисом Мерлион с помощью Merlion API. Расширение и набор подключаемых дополнительных обработок позволяет без изменения конфигурации получить возможность работы с API крупнейшего российского дистрибьютора http://merlion.com. Логика работы максимально приближена к работе веб-сервиса b2b. Вы сможете создать и исправить заказ, зарезервировать товар прямо из 1С, посмотреть актуальные остатки и цены, импортировать штрихкода EAN13 товаров, загружать заказ c автоматическим созданием номенклатуры в 1С и корректности создания. Можно выбирать характеристики по товарным группам и загружать товар с выбранными характеристиками, загружать изображения товара. Не требуется установки дополнительного ПО для работы с веб-сервисом. Кроссплатформенное решение для ОС Windows и Linux. Весь код модулей открыт и доступен для просмотра и внесения изменений.

8280 руб.

02.05.2017    40958    43    64    

50
Комментарии
Подписаться на ответы Сортировка: Древо развёрнутое
Свернуть все
1. O_W 14.05.21 17:51 Сейчас в теме
Пожалуйста исправьте ошибку в заголовке на Google Docs
2. malikov_pro 1293 14.05.21 19:54 Сейчас в теме
(1) Не понял в чем ошибка.
3. xlmel 20.07.21 15:34 Сейчас в теме
Замечательная работа.
Оставьте свое сообщение