Эта страница переведена с помощью Cloud Translation API.

Лучшие практики

Улучшите общее впечатление своих пользователей, следуя этим руководствам по разработке надстроек Google Meet.

Рекомендации по авторизации

Вам рекомендуется использовать следующие рекомендации для любых дополнений Google Meet, требующих аутентификации или авторизации.

Используйте вход в Google

Многие пользователи дополнений Google Workspace уже вошли в Google, прежде чем присоединиться к встрече. Таким образом, наличие Google One Tap в качестве опции может сэкономить вашим пользователям несколько кликов при входе в систему. Дополнительные сведения см. в разделе Управление методами входа для вашей надстройки .

Открыть стороннюю страницу входа в новом окне

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

Правильно запрашивайте области для API Google

Если ваша надстройка Meet вызывает API Google, вы должны предоставить полный список областей OAuth, необходимых вашей надстройке. Это делается на странице конфигурации приложения Google Workspace Marketplace. После добавления этих областей при установке дополнения Meet вашим пользователям будет показано сообщение, в котором сообщается, к каким данным они разрешают доступ вашему приложению.

Прежде чем публиковать дополнение, вам также необходимо настроить экран согласия OAuth . Для этого необходимо добавить точно такие же области авторизации из конфигурации приложения Google Workspace Marketplace. Настройка экрана согласия OAuth также требует настройки информации о торговой марке, политики конфиденциальности и условий обслуживания, которые отображаются при запросе областей. Для публикации в открытом доступе всю эту информацию необходимо отправить на проверку .

При написании кода для вызова API-интерфейсов Google Workspace проще всего начать работу с кратким руководством по JavaScript . Этот подход соответствует рекомендациям по использованию входа в Google и диалоговых окон. Обратите внимание, что инициализация клиента токена в JavaScript требует отдельного запроса областей, которые приложение фактически использует во время выполнения. Для лучшего взаимодействия с пользователем эти запрошенные области должны совпадать с теми, которые указаны на странице конфигурации приложения Google Workspace Marketplace. Эта избыточность обеспечивает запасной вариант для обработки случая, когда пользователь отозвал области действия .

Рекомендации по техническому обслуживанию

Следующие рекомендации предназначены для написания удобных в обслуживании веб-приложений, но они особенно важны при написании любых надстроек Meet.

Используйте последнюю версию SDK надстроек Google Meet.

SDK дополнений Meet регулярно обновляется. SDK придерживается семантического управления версиями . Чтобы найти последнюю версию:

При использовании gstatic : последняя версия SDK содержится в URL-адресе gstatic, указанном в инструкциях по использованию SDK .
При использовании npm : запустите npm update @googleworkspace/meet-add-ons из каталога, содержащего package.json для веб-сайта, на котором размещено ваше дополнение Meet.

Создайте промежуточный проект Google Cloud.

Как только ваше дополнение Google Meet будет опубликовано на Google Workspace Marketplace , любые новые развертывания вашего дополнения Google Meet мгновенно станут доступны пользователям Meet. Пользователи увидят эти обновления, как только опустошат свои кеши или истечет срок их действия. Поэтому мы рекомендуем не вносить изменения на рабочий сайт до тех пор, пока они не будут тщательно протестированы.

Чтобы избежать развертывания сразу в рабочей среде, мы рекомендуем создать отдельный проект Google Cloud , который будет опубликован в частном порядке для вашей организации. В этом облачном проекте будут размещены как промежуточные среды, так и среды разработки для вашего дополнения Meet. Доступ к этому облачному проекту должен быть ограничен небольшой командой, которая непосредственно работает над разработкой вашего дополнения.

Чтобы создать эти альтернативные среды для вашей надстройки, вам сначала необходимо разместить альтернативные среды вашего веб-приложения, содержащего вашу надстройку, в принадлежащем вам домене. Затем вы можете создать альтернативные среды для своего дополнения Meet, добавив дополнительные развертывания в свой промежуточный проект Google Cloud. Эти новые развертывания должны иметь манифесты, указывающие на альтернативные среды вашего веб-приложения. Затем мы рекомендуем вам установить каждую дополнительную среду следующим образом:

Промежуточная версия : опубликуйте промежуточную версию конфиденциально , чтобы любой сотрудник вашей организации мог помочь с тестированием.
Разработка . Нажмите «Установить» в столбце « Действия» , чтобы установить разрабатываемую версию дополнения Meet только для вашей учетной записи.

Написание тестов

Прежде чем развертывать надстройку Meet в среде разработки, мы рекомендуем написать модульные тесты. Ваши модульные тесты должны включать в себя:

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

Лучшие практики взаимодействия с пользователем

Следующие рекомендации помогут сделать надстройку Meet более интуитивно понятной и усовершенствованной.

Управляйте всеми стартовыми состояниями на боковой панели.

Мы настоятельно рекомендуем настраивать дополнение на основе действий пользователя, выполняемых на боковой панели . Это делается путем установки состояния начала активности в JavaScript. Все данные, которые входят в ActivityStartingState должны быть установлены инициатором надстройки (обычно организатором собрания) на боковой панели. Вы можете думать о первом представлении боковой панели как о форме, которая управляет настройкой вашего дополнения.

Закрывайте боковую панель, когда она не используется

После запуска действия путем вызова метода startActivity() вам следует оставлять боковую панель открытой только в том случае, если она является важной частью пользовательского интерфейса вашего дополнения Google Meet. Вы можете закрыть боковую панель после открытия основной сцены , вызвав метод unloadSidePanel() .

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