Если вы хотите создать новое дополнение Google Workspace, выполните следующую общую процедуру:
- Настройте проекты своего дополнения и выберите владельца и соавторов.
- Спроектируйте внешний вид и поведение надстройки.
- Настройте манифест проекта надстройки или ресурс развертывания.
- Напишите код, определяющий внешний вид и поведение надстройки.
- Проверьте области действия OAuth надстройки.
- Протестируйте надстройку в хост-приложениях, которые она расширяет.
- Опубликуйте дополнение.
Настройте проекты своего дополнения и выберите владельца и соавторов
Если вы создадите надстройку в Apps Script, вы создадите как проект Apps Script, так и проект Google Cloud. Если вы создаете надстройку на языке, отличном от Apps Script, вам нужно будет только создать проект Google Cloud.
Перед началом разработки дополнений выберите одну учетную запись пользователя, которая будет владеть проектами, и решите, какие другие учетные записи будут соавторами. Владелец проектов создает и управляет файлами проекта и связанными настройками, а соавторы могут помочь с кодированием и тестированием.
Проекты сценариев приложений
Вы можете создать файлы проекта Apps Script надстройки на общем диске , чтобы ни одна учетная запись не была единоличным владельцем. Размещение файла сценария надстройки на общем диске позволяет легко гарантировать, что несколько соавторов всегда будут иметь доступ к проекту сценария.
Когда вы публикуете надстройку, одна учетная запись пользователя выступает в качестве издателя. Учетная запись публикации должна иметь права на редактирование проекта скрипта, но не обязательно быть владельцем.
Облачные проекты Google
Мы рекомендуем добавить соавторов в облачный проект надстройки . Это помогает гарантировать, что кто-то из вашей команды всегда может получить доступ к облачным настройкам надстройки.
Создайте внешний вид и поведение надстройки
Решите, как должно выглядеть ваше дополнение и как оно должно себя вести, прежде чем приступить к его созданию. Подумайте, для каких вариантов использования надстройка должна попытаться предоставить решения. Начните с простого дизайна, чтобы сначала начать работать, а затем добавляйте больше уточнений.
Обратитесь к руководству по стилю надстройки Google Workspace, чтобы узнать, как спроектировать взаимодействие с пользователем надстройки.
Настройте манифест проекта надстройки
В проектах Apps Script манифест проекта представляет собой специальный файл JSON. Он указывает различные сведения о проекте, такие как его зависимости от библиотек. Для надстроек Google Workspace манифест также предоставляет основную информацию, необходимую хост-приложению для правильного отображения надстройки.
См. Манифесты для получения подробной информации о том, как настроить манифест надстройки в Apps Script.
Добавляя код и функции в надстройку, редактируйте манифест по мере необходимости, чтобы обеспечить требуемый внешний вид и поведение надстройки.
Закодируйте надстройку
Вы должны реализовать карточный интерфейс для надстройки. Используйте службу карточек Apps Script или, если вы пишете на другом языке кода, верните правильно отформатированный JSON, чтобы интерфейс отображался в виде карточек.
Вы также должны реализовать любые триггерные функции , указанные в манифесте надстройки. Если ваше дополнение подключается к сторонней службе, отличной от Google, с помощью OAuth, вы также должны настроить OAuth для этой службы .
Создание карт
Вы определяете дополнительный пользовательский интерфейс, создавая объекты Card и заполняя их виджетами . Триггерные функции, указанные в вашем манифесте, должны возвращать либо один объект Card , либо массив объектов Card , которые представляют разные «страницы» интерфейса надстройки. Ваше дополнение также может создавать и отображать новые карточки в ответ на действия пользователя.
В Apps Script вы создаете карточки с помощью класса CardBuilder . Для каждой карточки требуется CardHeader и один или несколько CardSections . Вы должны заполнить каждый раздел карты отдельными виджетами, составляющими интерфейс надстройки. Виджеты взаимодействия обычно связаны с действиями , чтобы определить их взаимодействие.
После того, как вы добавили все разделы и виджеты на свою карту через CardBuilder , вы должны вызвать CardBuilder.build() для создания соответствующего объекта Card .
Вы можете использовать другие встроенные службы сценариев приложений, такие как CalendarApp для получения информации, которая будет отображаться на карточках дополнений, которые вы создаете. Вы можете использовать данные, полученные из сторонних сервисов.
Если надстройкам Google Workspace требуется доступ к сторонним API, для которых требуется OAuth, вы должны настроить и подключиться к этой службе. Дополнительные сведения см. в руководстве по подключению к службам, не относящимся к Google .
Порядок строительства
При построении карты вы должны строить сверху вниз. То есть вы должны использовать такой порядок построения:
- Создайте виджет.
- Добавьте виджет в раздел карточек.
- Повторяйте, пока в разделе карточек не появятся все виджеты.
- Добавьте раздел карточки в карточку.
Это необходимо, потому что когда вы добавляете виджет в карточку или раздел карточки, вы фактически добавляете копию этого виджета. Любые изменения, которые вы вносите в объект виджета после его добавления, не отражаются в окончательной карточке.
Универсальные действия
Вы можете использовать универсальные действия , чтобы обеспечить независимую от контекста функциональность. Универсальные действия — это пункты меню, доступные в пользовательском интерфейсе надстройки независимо от того, какая карточка отображается в данный момент. Все определенные универсальные действия всегда отображаются в карточном меню модуля.
Дополнительные сведения см. в разделе Универсальные действия .
Проверьте дополнительные области действия OAuth.
Области определяют, какие действия разрешено выполнять надстройке от имени пользователя. Для надстроек рекомендуется иметь области действия только для действий, которые они должны иметь для функционирования по порядку, и ничего более.
В проектах надстройки явно задайте области надстройки , чтобы надстройка использовала набор областей с наименьшими разрешениями. Вы определяете, какие области видимости использует ваша надстройка в манифесте надстройки.
Смотрите Области для более подробной информации.
Протестируйте надстройку
Вы можете протестировать неопубликованные надстройки, сначала установив неопубликованную надстройку . После установки и авторизации вы можете использовать надстройку в своей учетной записи и протестировать ее внешний вид и поведение в хост-приложениях, которые она расширяет. Вы должны убедиться, что надстройка ведет себя должным образом для контекстов и действий пользователя.
Дополнительные сведения см. в разделе Тестирование надстроек Google Workspace .
Опубликовать дополнение
Публикация вашего дополнения делает его доступным для других, либо общедоступных, либо только пользователей в вашем домене. Прежде чем начать процесс публикации, обязательно ознакомьтесь с обзором публикации . Публикация — сложный процесс, требующий подготовки и времени.
Дополнения Google Workspace публикуются в Google Workspace Marketplace . Общедоступные надстройки перед публикацией должны пройти проверку приложения .
Дополнительные сведения см. в разделе Публикация надстройки Google Workspace .
Пример надстройки Google Workspace
Чтобы помочь вам понять, как создаются дополнения Google Workspace, в кратком руководстве по дополнению Google Workspace "Cats" показано, как создать простое дополнение Google Workspace, включая домашние страницы, карточную навигацию и подключение к сторонней службе. Выполнив краткое руководство, вы можете установить надстройку и поэкспериментировать с кодом.