Создание дополнений Google Workspace

Узнайте, как разрабатывать и публиковать дополнения Google Workspace:

  1. Определите, в каких приложениях Google Workspace дополнение должно быть доступно пользователям.
  2. Настройте проекты дополнения и выберите владельца и соавторов.
  3. Настройте внешний вид и поведение дополнения.
  4. Создайте дополнение.
  5. Проверьте области действия OAuth дополнения.
  6. Протестируйте дополнение в одном или нескольких приложениях Google Workspace.
  7. Опубликуйте дополнение.

Создайте дополнение с помощью Apps Script или HTTP. Чтобы сравнить эти два варианта, посмотрите видео "Apps Script vs. HTTP endpoints: Which should you choose?" (Apps Script и конечные точки HTTP: что выбрать?). 🤔".

Как выбрать размещаемые приложения Google Workspace

Вы можете настроить дополнения Google Workspace так, чтобы они появлялись в следующих размещаемых приложениях Google Workspace:

  • Gmail
  • Google Календарь
  • Google Chat
  • Google Документы
  • Google Диск
  • Google Meet
  • Google Таблицы
  • Google Презентации

Чтобы создавать приложения для Google Workspace, ознакомьтесь со статьей Как расширить интерфейс Google Workspace.

Настройте проекты дополнения и выберите владельца и соавторов

Если вы создаете дополнение в Apps Script, то создаете как проект Apps Script, так и облачный проект Google Cloud. Если вы создаете дополнение не на языке Apps Script, вам нужно только создать проект Google Cloud.

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

Прежде чем начать разработку дополнения, выберите один аккаунт, который будет владельцем проектов, и укажите, какие другие аккаунты будут соавторами. Владелец проекта создает файлы проекта и управляет ими, а также связанными настройками, а соавторы могут помогать с кодированием и тестированием.

проекты Apps Script;

Прежде чем создавать дополнение, ознакомьтесь с квотами и ограничениями Apps Script, чтобы учесть их при проектировании. Apps Script лучше всего подходит для разработки простых личных или внутренних дополнений с небольшой пользовательской базой. Если вашему дополнению требуется поддержка большого количества пользователей, низкая задержка или полный контроль над инфраструктурой, рассмотрите возможность использования другой среды выполнения.

Создавайте файлы проекта Apps Script для дополнения на общем диске, чтобы ни у одного аккаунта не было исключительных прав собственности. Если разместить файл скрипта дополнения на общем диске, все соавторы получат доступ к проекту скрипта.

При публикации дополнения издателем считается один аккаунт пользователя. У аккаунта, с которого выполняется публикация, должен быть доступ к проекту скрипта с правом на редактирование, но не обязательно быть его владельцем.

Чтобы создать проект Apps Script, ознакомьтесь с разделом Проекты скриптов.

Проекты Google Cloud

Добавьте соавторов в облачный проект дополнения. Это гарантирует, что у вашей команды всегда будет доступ к облачным настройкам дополнения.

Чтобы создать облачный проект Google Cloud, см. Создание облачного проекта Google Cloud.

Как настроить внешний вид и поведение дополнения

Прежде чем создавать дополнение, определите, как оно будет выглядеть и работать. Определите, какие задачи решает дополнение. Сначала создайте базовый дизайн, а затем добавьте улучшения.

Ознакомьтесь с руководством по стилю дополнений Google Workspace, чтобы узнать, как создать удобный интерфейс дополнения.

Как настроить манифест дополнения

Реализуйте дизайн в манифесте дополнения. Настройте внешний вид и поведение дополнения в манифесте, в том числе размещаемые приложения Google Workspace, которые оно расширяет.

Подробнее о манифестах для дополнений Google Workspace…

По мере добавления кода и функций обновляйте манифест, чтобы определить внешний вид и поведение дополнения.

Как настроить внешний вид и поведение приложения Google Chat

Если вы разрабатываете дополнение, расширяющее возможности Google Chat, используйте Google Chat API, чтобы настроить внешний вид и поведение приложения Chat. Инструкции приведены в статье Как использовать Google Chat API.

Как создать дополнение

Реализуйте интерфейс дополнения на основе карточек. Используйте сервис карточек или, если вы используете другой язык программирования, возвращайте отформатированный JSON, чтобы интерфейс отображался в виде карточек.

Реализуйте все функции триггеров, указанные в манифесте дополнения. Если ваше дополнение подключается к стороннему сервису с помощью OAuth, настройте OAuth для этого сервиса.

Создание карточек

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

В Apps Script создайте карточки, используя класс CardBuilder. Для каждой карточки требуется CardHeader и один или несколько элементов CardSections. Заполните каждый раздел карточки отдельными виджетами, которые составляют интерфейс. Интерактивные виджеты обычно связаны с действиями, которые определяют их поведение.

После того как вы добавили все разделы и виджеты на карточку с помощью объекта CardBuilder, вызовите метод CardBuilder.build, чтобы создать соответствующий объект Card.

Используйте встроенные сервисы Apps Script, например CalendarApp, чтобы получать информацию для показа на карточках дополнения. использовать данные из сторонних сервисов;

Если вашему дополнению требуется доступ к API сторонних сервисов, для которых необходим протокол OAuth, настройте подключение к этим сервисам. Подробнее о подключении к сторонним сервисам…

Заказ на строительство

При создании карточки начните с верхней части. Используйте следующий порядок:

  1. Создайте виджет.
  2. Добавьте виджет в раздел с карточками.
  3. Повторяйте эти действия, пока не добавите все нужные виджеты.
  4. Добавьте в карточку раздел с картой.

Это связано с тем, что при добавлении виджета на карточку или в раздел карточки вы фактически добавляете копию этого виджета. Изменения, внесенные в объект виджета после его добавления, не будут отражены на конечной карточке.

Универсальные действия

Используйте универсальные действия, чтобы предоставить функции, не зависящие от контекста. Универсальные действия – это пункты меню, доступные в интерфейсе дополнения независимо от карточки. Все определенные универсальные действия будут показаны в меню карточки дополнения.

Подробнее о универсальных действиях…

Проверьте области действия OAuth дополнения

Области действия определяют, какие действия дополнение может выполнять от имени пользователя. У дополнений должны быть только те области действия, которые необходимы для их работы.

В проектах дополнений настройте области действия дополнения, чтобы оно использовало минимально необходимые области действия. Определите области действия в манифесте дополнения.

Подробнее об областях действия…

Как протестировать дополнение

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

Чтобы начать тестирование дополнения, ознакомьтесь со следующими руководствами:

Как опубликовать дополнение

После публикации дополнение станет доступно другим пользователям. Перед публикацией проверьте обзор публикации. Публикация – это сложный процесс, требующий подготовки.

Дополнения Google Workspace публикуются в Google Workspace Marketplace. Общедоступные дополнения должны пройти проверку приложения перед публикацией.

Подробнее о публикации дополнений Google Workspace…