Рекомендации

Улучшите общее впечатление пользователей, следуя этим руководствам по разработке дополнений для 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 можно настроить так, чтобы он показывал всем участникам вызова баннер с предложением установить или использовать соответствующее дополнение Meet. Подробнее см. в статье «Продвижение вашего дополнения с помощью демонстрации экрана» .

Руководство по дизайну логотипа

Следуйте этим рекомендациям при разработке логотипа для мероприятия Meet, чтобы он выглядел наилучшим образом сейчас и в будущем:

Используйте формат файла PNG размером 256 x 256 пикселей.

Используйте прозрачность.

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

Убедитесь, что ваш логотип (и другие графические ресурсы ) хорошо выглядят в режиме высокой контрастности, воспользовавшись средством проверки контрастности, например Contrast Checker от Web Accessibility In Mind (WebAIM).

Соблюдайте графические требования для интеграции конкретных приложений .

Не добавляйте отступы к изображению. Вместо этого расширьте изображение до границ файла.

,

Улучшите общее впечатление пользователей, следуя этим руководствам по разработке дополнений для 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 можно настроить так, чтобы он показывал всем участникам вызова баннер с предложением установить или использовать соответствующее дополнение Meet. Подробнее см. в статье «Продвижение вашего дополнения с помощью демонстрации экрана» .

Руководство по дизайну логотипа

Следуйте этим рекомендациям при разработке логотипа для мероприятия Meet, чтобы он выглядел наилучшим образом сейчас и в будущем:

Используйте формат файла PNG размером 256 x 256 пикселей.

Используйте прозрачность.

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

Убедитесь, что ваш логотип (и другие графические ресурсы ) хорошо выглядят в режиме высокой контрастности, воспользовавшись средством проверки контрастности, например Contrast Checker от Web Accessibility In Mind (WebAIM).

Соблюдайте графические требования для интеграции конкретных приложений .

Не добавляйте отступы к изображению. Вместо этого расширьте изображение до границ файла.