Если вы уже создали и опубликовали надстройку для расширения Gmail или Календаря, вы можете обновить ее до надстройки Google Workspace. В инструкциях на этой странице подробно описано, как добавить функциональность Google Workspace к существующим надстройкам Gmail или Календаря, а затем опубликовать обновленную надстройку, чтобы ее можно было обнаружить и установить.
Вы можете перенести новые функции в исходное дополнение, чтобы сохранить список, установки и пользователей Google Workspace Marketplace. Обновление также позволит вам воспользоваться новыми функциями надстройки Google Workspace, такими как домашние страницы .
Шаг 1. Создайте копию проекта Apps Script вашей надстройки.
В вашей обновленной надстройке используется тот же проект Google Cloud, что и в опубликованной надстройке, но важно создать и использовать копию базового проекта Apps Script, чтобы это не затронуло ваших существующих пользователей во время тестирования обновленной версии. . Обновление копии исходного проекта сценария также означает, что вы всегда можете получить доступ к исходному коду и при необходимости повторно развернуть его позже.
- Откройте существующую надстройку Gmail или проект Apps Script надстройки для конференций Календаря.
- Слева нажмите Обзор .
- Справа нажмите Создать копию .
- Слева нажмите «Настройки проекта» > «Изменить проект» .
- Нажмите «Номер проекта GCP» .
- Введите тот же номер проекта , который связан с существующим опубликованным проектом Apps Script надстройки.
- Нажмите Установить проект .
Шаг 2. Интегрируйте надстройку Google Workspace
Вы должны разработать и реализовать любые функции надстройки Google Workspace, которые вы хотите добавить в свою надстройку.
- Спланируйте, какой контент будет отображаться на карточках главной страницы вашего дополнения и должны ли они отображаться в Gmail, Календаре, Диске или в любой комбинации этих трех хостов. Если вам нужна домашняя страница более чем на одном хосте, решите, может ли это быть одна и та же домашняя страница или вам нужны специальные карточки домашней страницы для каждого хоста.
- В скопированном проекте Apps Script надстройки создайте карточки домашней страницы с помощью функций
homepageTrigger. Обязательно включите все вспомогательные функции или логику, необходимые для управления новыми интерфейсами домашней страницы. Рассмотрите возможность добавления контекстных карточек, вызываемых действием пользователя, например открытием цепочки сообщений Gmail или событием Календаря .
Обновите любой доступ к объектам событий в вашем дополнении (в функциях обратного вызова виджета или в функциях контекстного триггера), чтобы использовать обновленную структуру объекта события . Новая структура по-прежнему содержит те же поля объектов событий, которые используются надстройками для конференций Gmail и Calendar, но эти исходные поля устарели и в конечном итоге будут удалены.
Шаг 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 . 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), используя версию кода, которую вы хотите опубликовать. Не пытайтесь публиковать с помощью головного развертывания.
Если вы добавили новые области при обновлении надстройки, вам необходимо запросить проверку 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 и Календаря.
Если вы хотите перенести надстройку редактора в надстройку Google Workspace, вам необходимо переписать пользовательский интерфейс надстройки с HTML на интерфейс на основе карточек и обновить обработку JavaScript для службы карточек .
Некоторые услуги в существующем дополнении редактора могут быть недоступны в сервисе карт. Например, если ваша надстройка редактора включает в себя средство выбора файлов, в Службе карточек нет эквивалента для надстроек 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?
См. раздел Список интеграций приложений вместе .