Если вы уже создали и опубликовали дополнение для Gmail или Календаря, вы можете обновить его до дополнения Google Workspace. Инструкции на этой странице подробно описывают, как добавить функции Google Workspace к существующим дополнениям Gmail или Календаря, а затем опубликовать обновлённое дополнение, чтобы его можно было найти и установить.
Вы можете перенести новые функции в исходное дополнение, чтобы сохранить свою позицию в Google Workspace Marketplace, установки и пользователей. Обновление также позволит вам воспользоваться новыми функциями дополнений Google Workspace, такими как домашние страницы .
Шаг 1: Создайте копию проекта Apps Script вашего дополнения.
Ваше обновлённое дополнение использует тот же проект Google Cloud, что и опубликованное дополнение, но важно создать и использовать копию базового проекта Apps Script, чтобы тестирование обновлённой версии не затронуло ваших существующих пользователей. Обновление копии исходного проекта скрипта также означает, что вы всегда сможете получить доступ к исходному коду и при необходимости повторно развернуть его позже.
- Откройте существующий проект скрипта приложений для надстройки Gmail или надстройки конференц-связи «Календарь».
- Слева нажмите Обзор .
- Справа нажмите Сделать копию .
- Слева нажмите Настройки проекта > Изменить проект .
- Нажмите «Номер проекта GCP» .
- Введите тот же номер проекта , который связан с вашим существующим опубликованным проектом надстройки Apps Script.
- Нажмите Установить проект .
Шаг 2: Интеграция надстройки Google Workspace
Вам необходимо разработать и реализовать все функции надстройки Google Workspace, которые вы хотите добавить в свое дополнение.
- Определите, какой контент будет отображаться на карточках главной страницы вашего дополнения, и будут ли они отображаться в Gmail, Календаре, Диске или любой комбинации этих трёх хостов. Если вам нужна главная страница на нескольких хостах, определите, будет ли это одна и та же главная страница или же вы захотите создавать индивидуальные карточки главной страницы для каждого хоста.
- В скопированном проекте Apps Script надстройки создайте карточки домашней страницы с функциями
homepageTrigger. Обязательно включите все вспомогательные функции и логику, необходимые для управления интерфейсами новой домашней страницы. Рассмотрите возможность добавления контекстных карточек, активируемых действием пользователя, например открытием ветки сообщений Gmail или события в Календаре .
Обновите все доступы к объектам событий в вашем дополнении (в функциях обратного вызова виджета или в функциях контекстного триггера), чтобы использовать обновлённую структуру объектов событий . Новая структура по-прежнему содержит те же поля объектов событий, которые используются дополнениями для конференций Gmail и Календаря, но эти исходные поля устарели и в конечном итоге будут удалены.
Шаг 3: Обновите манифест вашего дополнения.
Способ хранения информации о конфигурации в структуре манифеста дополнений Google Workspace значительно отличается от структуры, используемой в дополнениях Gmail и дополнениях для конференций Календаря. При обновлении дополнения необходимо обновить поля манифеста проекта Apps Script дополнения в соответствии с таблицами ниже. Необходимо обновить все соответствующие подсвойства, указав новое свойство addOns .
Не забудьте также обновить поле oauthScopes вашего манифеста по мере необходимости, чтобы отразить разрешения, требуемые вашим обновленным дополнением.
Дополнительную информацию о манифестах дополнений Google Workspace см. в разделе Манифесты .
Дополнения Gmail
| Исходное поле манифеста | Требуется действие |
|---|---|
gmail.composeTrigger | Перейти к addOns.gmail.composeTrigger . |
gmail.contextualTriggers[] | Переместите список в addOns.gmail.contextualTriggers[] . |
gmail.logoUrl | Перейти к addOns.common.logoUrl . |
gmail.name | Перейти к addOns.common.name . |
gmail.openLinkUrlPrefixes[] | Переместите список в addOns.common.openLinkUrlPrefixes[] . |
gmail.primaryColor | Перейти к addOns.common.layoutProperties.primaryColor . |
gmail.secondaryColor | Перейти к addOns.common.layoutProperties.secondaryColor . |
gmail.universalActions[] | Переместите список в addOns.common.universalActions[] . |
gmail.universalActions[].text | Переместите каждое поле gmail.universalActions[].text в соответствующее поле addOns.common.universalActions[].label . |
gmail.useLocalFromApp | Перейти к addOns.common.useLocaleFromApp . |
Дополнения к календарю конференций
| Исходное поле манифеста | Требуется действие |
|---|---|
calendar.createSettingsUrlFunction | Перейти к addOns.calendar.createSettingsUrlFunction . |
calendar.conferenceSolution[] | Перейти к addOns.calendar.conferenceSolution[] . |
calendar.logoUrl | Перейти к addOns.common.logoUrl . |
calendar.name | Перейти к addOns.common.name . |
Шаг 4: протестируйте обновленное дополнение
Чтобы протестировать обновленное дополнение перед публикацией, см. раздел Тестирование дополнений Google Workspace .
Шаг 5: Запросите отзывы о вашем обновленном дополнении
Все надстройки Google Workspace, будь то обновленные надстройки или созданные с нуля, должны быть одобрены, прежде чем они будут размещены в Google Workspace Marketplace.
Чтобы отправить дополнение на рассмотрение, выполните следующие действия:
Убедитесь, что ваше дополнение соответствует всем требованиям к публикации дополнений .
Создайте версионное развертывание вашего дополнения Google Workspace (в новом проекте Apps Script), используя ту версию кода, которую вы хотите опубликовать. Не пытайтесь публиковать с помощью развёртывания head.
Если вы добавили новые области действия при обновлении дополнения, необходимо запросить проверку OAuth . Например, если ваше дополнение Gmail использует новые области действия Диска или Календаря в версии дополнения Google Workspace, необходимо отправить эти новые области действия на проверку. Проверка обычно занимает несколько дней, поэтому начните процесс как можно раньше. Убедитесь, что ваше дополнение проверено, прежде чем переходить к шагу 6.
Шаг 6: Сделайте обновленное дополнение доступным
Откройте SDK Google Workspace Marketplace.
Слева нажмите «Конфигурация» . Эта панель содержит форму, в которой вы можете указать информацию о вашем дополнении.
Обновите краткое описание, подробное описание и снимки экрана вашего листинга, чтобы отразить новые функции надстройки Google Workspace.
В разделе «Расширения» нажмите кнопку «Обновить до Google Workspace» . В открывшемся текстовом поле введите новый идентификатор развертывания , созданный для дополнения Google Workspace на предыдущем шаге. Если ваш идентификатор развертывания действителен, появится список поддерживаемых хостов.
Если вы добавили новые области действия в дополнение Google Workspace, убедитесь, что вы добавили их в раздел « Области действия OAuth 2.0» на странице «Конфигурация» . Перечисленные в этом разделе области действия должны полностью соответствовать областям действия, указанным в манифесте вашего дополнения.
Проверьте правильность введённой вами информации в форме. Затем нажмите «Сохранить изменения» .
Если у вас возникли вопросы или проблемы в процессе обновления дополнения Google Workspace, свяжитесь с нами .
Часто задаваемые вопросы
Ниже приведены часто задаваемые вопросы относительно обновлений надстроек:
Могу ли я обновить свой редактор?
Большинство дополнений Редактора можно перенести в дополнения Google Workspace. Однако их не так просто обновить до дополнений Google Workspace, как дополнения для Gmail и Календаря.
Если вы хотите перенести дополнение Editor в дополнение Google Workspace, вам необходимо переписать пользовательский интерфейс дополнения с HTML на интерфейс на основе карт и обновить обработку JavaScript для службы карт .
Некоторые сервисы в вашем существующем дополнении «Редактор» могут быть недоступны в сервисе Card Service. Например, если в вашем дополнении «Редактор» есть средство выбора файлов, то в сервисе Card Service для дополнений Google Workspace аналога нет.
Могу ли я создать отдельное дополнение Google Workspace и сохранить существующее дополнение?
Вы можете создавать дополнительные дополнения для Google Workspace под другими брендами, но мы не разрешаем создавать отдельные дополнения для конференций Gmail или Календаря под тем же брендом, что и ваше дополнение для Google Workspace. Если у вас есть вопросы или вы хотите запросить исключение, свяжитесь с нами .
Нужно ли будет моим пользователям повторно авторизовать дополнение после его обновления?
Пока ваше дополнение Google Workspace использует тот же базовый проект Cloud Platform (GCP) с соответствующим идентификатором клиента OAuth, вашим пользователям не потребуется повторно авторизовать разрешения, которые они ранее предоставили для вашего исходного дополнения. Однако, если вы добавите новые области действия в процессе обновления, пользователям необходимо будет авторизовать их при первом использовании версии дополнения для Google Workspace.
Могу ли я обновить свое расширение Chrome до дополнения Google Workspace и перенести пользователей?
Нет. Вы не можете перенести пользователей, установки и отзывы о расширении Chrome. Вам необходимо создать новое дополнение Google Workspace и направить пользователей вашего расширения Chrome в Google Workspace Marketplace.
Могу ли я объединить несколько дополнений с моим дополнением Google Workspace?
См. раздел Список интеграций приложений вместе .