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

На этой странице представлен обзор разработки, создания и публикации дополнений Google Workspace. В этом обзоре описываются следующие этапы:

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

Вы можете создать дополнение с помощью Apps Script или HTTP. Для сравнения посмотрите видео «Apps Script или конечные точки HTTP: что выбрать? 🤔».

Выберите хост-приложения Google Workspace

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

  • Gmail
  • Google Календарь
  • Google Чат
  • Google Документы
  • Google Диск
  • Google Встреча
  • 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, см. раздел Проекты Script .

Проекты Google Cloud

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

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

Разработайте и настройте внешний вид и поведение вашего дополнения

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

Инструкции по оформлению пользовательского интерфейса надстройки см. в руководстве по стилю надстройки Google Workspace .

Настройте манифест дополнения

После разработки дополнения вы можете начать реализовывать его дизайн в манифесте. Именно в манифесте настраивается большая часть внешнего вида и поведения дополнения, включая хост-приложения Google Workspace, которые оно расширяет.

Подробную информацию см. в разделе Манифесты для дополнения Google Workspace .

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

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

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

Создайте дополнение

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

Вам также необходимо реализовать все триггерные функции, указанные в манифесте дополнения. Если ваше дополнение подключается к стороннему сервису (не Google) по протоколу 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 .