На этой странице рассказывается, как использовать Google Workspace Marketplace SDK для настройки и управления приложением в Google Workspace Marketplace.
Чтобы приложение стало доступно для использования, его нужно настроить в Marketplace SDK. Marketplace SDK – это набор инструментов, который позволяет создавать приложения для каталога Marketplace и управлять ими. С помощью Marketplace SDK можно управлять настройками Marketplace, например:
- Доступно ли ваше приложение для определенной организации Google Workspace (частное приложение) или для всех пользователей Marketplace (общедоступное приложение).
- Типы пользователей Marketplace, которые могут установить ваше приложение.
- С какими приложениями Google Workspace интегрируется ваше приложение.
- Области действия OAuth, необходимые приложению.
- Информация о том, кто создал и поддерживает приложение
Независимо от того, публикуете вы приложение в частном или общедоступном режиме, для управления им в каталоге Marketplace необходимо использовать Marketplace SDK.
Как включить Marketplace SDK
Если вы ещё этого не сделали, включите Marketplace SDK в проекте Google Cloud.
Как открыть облачный проект в консоли Google Cloud
Если он ещё не открыт, откройте облачный проект, который вы хотите использовать для этого примера:
- В консоли Google Cloud перейдите на страницу Выбрать проект.
- Выберите проект Google Cloud, который хотите использовать. Или нажмите Создать проект и следуйте инструкциям на экране. Если вы создадите проект Google Cloud, вам может понадобиться включить для него платежные функции.
Как включить Marketplace SDK
Прежде чем использовать API Google, их нужно включить в облачном проекте Google Cloud. В одном облачном проекте Google Cloud можно включить один или несколько API.Включите Google Workspace Marketplace SDK в консоли Google Cloud.
Как определить настройки конфигурации для приложения
В приведенной ниже таблице описаны настройки, доступные на странице Конфигурация приложения в Marketplace SDK.
Как выбрать, кто может просматривать и устанавливать ваше приложение
При настройке приложения вы указываете пользователей, у которых будет доступ к нему, с помощью следующих параметров:
- Видимость приложения. Если вы публикуете приложение в организации Google Workspace, вы можете сделать его доступным только по ссылке, всем пользователям организации или всем, кто использует Google Workspace.
- Настройки установки – можно ли установить приложение только администраторам Google Workspace.
Независимо от настроек, указанных в описании приложения, пользователи, принадлежащие к организации Google Workspace, могут не иметь возможности найти, установить или использовать ваше приложение в зависимости от настроек, заданных их администраторами. Администраторы могут влиять на доступность приложения следующими способами:
- Управлять тем, могут ли пользователи просматривать приложения в каталоге Marketplace и устанавливать их от имени других пользователей.
- Используйте белый список, чтобы управлять приложениями для организации. Если вы разрабатываете приложение для организации, которая использует белые списки, обратитесь к администратору, чтобы он добавил приложение в белый список.
- Отключить определенные приложения Google Workspace, например запретить доступ к Google Chat, приложениям для Chat или и к тому, и к другому. В таких случаях пользователи не смогут установить ваше приложение из каталога Marketplace.
Чтобы узнать, как администраторы управляют доступом к Marketplace, ознакомьтесь с документацией по администрированию Marketplace.
Настройки видимости приложений
Параметр Видимость приложений доступен, если вы используете аккаунт Google Workspace (аккаунт, созданный вашей организацией или учебным заведением). Если вы используете обычный аккаунт (с адресом, заканчивающимся на @gmail.com), вы можете публиковать только общедоступные приложения.
- Общедоступное. Приложение могут найти и установить пользователи за пределами вашего домена. Если вы выберете общедоступность, Google проверит и одобрит страницу приложения перед публикацией.
- Частное. Найти и установить приложение могут только пользователи в вашем домене.
Если вы выберете вариант Не в списке, страница приложения не будет показываться в результатах поиска и при просмотре каталога. Пользователи могут перейти на страницу приложения в магазине только по прямой ссылке.
Если вы хотите ограничить доступность приложения по странам и регионам, это можно сделать в разделе Распространение при создании страницы приложения в магазине.
Настройки установки приложений
Параметр Настройки установки определяет, могут ли пользователи или администраторы Google Workspace устанавливать ваше приложение со страницы приложения на Marketplace.
- Установка пользователем и администратором (по умолчанию). Приложение могут установить отдельные пользователи или администраторы для домена, организационного подразделения или группы пользователей. Правила домена пользователя могут запрещать установку приложения, даже если индивидуальная установка разрешена.
- Установка только администратором. Приложение могут установить только администраторы для своего домена, организационного подразделения или группы пользователей. Ваше приложение будет показываться в результатах поиска в Google Workspace Marketplace только администраторам и пользователям, которые не вошли в аккаунт Google. Выберите этот вариант, если для вашего приложения требуется установка домена.
Распространенные настройки установки и видимости
В таблице ниже приведены некоторые распространенные варианты конфигурации приложений для установки и видимости:
| Целевая аудитория приложения | Настройка Видимость приложения | Настройка Установка приложений | Кто может устанавливать мое приложение? | Кто может пользоваться моим приложением? | |
|---|---|---|---|---|---|
| Для приложений, созданных для организации Google Workspace | |||||
| определенных пользователей в организации; | Ограниченный доступ и Доступ по ссылке | Индивидуальная установка и установка администратором | Если разрешено, любой сотрудник организации, у которого есть URL страницы приложения. | Если разрешено, любой сотрудник организации, у которого есть URL страницы приложения. | |
| Ваша организация | Личное | Индивидуальная установка и установка администратором | Если это разрешено, любой сотрудник организации. | Если это разрешено, любой сотрудник организации. | |
| Ваша организация | Личное | Только для администраторов | Администраторы | Пользователи, у которых приложение установлено администратором. | |
| Для приложений, доступных пользователям за пределами определенной организации Google Workspace | |||||
| Пользователи в организациях Google Workspace | Общедоступное | Только для администраторов | Администраторы | Пользователи, у которых приложение установлено администратором. | |
| Все пользователи Google Workspace | Общедоступное | Индивидуальная установка и установка администратором |
|
|
|
Как определить, с какими приложениями Google Workspace интегрировано ваше приложение
В разделе Интеграция приложений можно выбрать сервисы Google Workspace, с которыми будет работать ваше приложение или дополнение, например дополнение Google Workspace или приложение Google Chat. Необходимо выбрать хотя бы один вариант. В некоторых случаях на странице приложения в Google Play можно указать несколько интеграций. Подробнее о том, как вывести общий список интеграций для приложения…
На странице для каждого дополнения Google Workspace показывается статус публикации для каждого поддерживаемого им хост-продукта. Это поможет вам понять, какие интеграции доступны пользователям. Возможны следующие статусы интеграции приложений:
Unsaved: вы добавили или изменили интеграцию, но не сохранили изменения на вкладке "Конфигурация приложения".Draft– изменения сохранены, но не опубликованы.Under review: вы отправили на проверку обновленную интеграцию приложения.Published: интеграция приложения включена в описание в каталоге Marketplace.
В зависимости от того, какие интеграции приложений вы выберете, вам может потребоваться предоставить дополнительную информацию и включить нужные API в вашем облачном проекте Google Cloud. В таблице ниже описаны дополнительные настройки, необходимые для каждого из этих вариантов.
Дополнение Google Workspace
Чтобы опубликовать дополнение Google Workspace, необходимо указать идентификатор развертывания дополнения.
Чтобы найти идентификатор развертывания в Apps Script, выполните следующие действия:
- Откройте дополнение Google Workspace в редакторе Apps Script.
- Нажмите Развертывание > Управлять развертываниями.
- Под идентификатором развертывания нажмите Копировать.
Чтобы найти идентификатор развертывания для дополнения HTTP, выполните следующие действия:
- На странице "Настройки приложения" в разделе "Дополнение Google Workspace" нажмите Развертывания HTTP или другие > Выбрать развертывание.
- Выберите развертывание, которое хотите опубликовать.
- Нажмите Выбрать.
Дополнение для редактора (Документы, Таблицы, Презентации, Формы)
Чтобы опубликовать дополнение для редактора, необходимо указать идентификатор скрипта проекта и версию, которую вы хотите опубликовать.
Чтобы найти идентификатор скрипта проекта, выполните следующие действия:
- Откройте дополнение в редакторе Apps Script.
- Слева нажмите Настройки проекта .
- В разделе "Идентификаторы" скопируйте идентификатор скрипта.
Чтобы узнать версию, выполните следующие действия:
- Откройте дополнение в редакторе Apps Script.
- В правом верхнем углу нажмите Развертывание > Управление развертываниями.
- Номер версии указан в разделе "Конфигурация".
приложение Google Chat;
Чтобы опубликовать интерактивное приложение Google Chat, ознакомьтесь со следующей документацией:
- Чтобы настроить приложение Chat в Chat API, ознакомьтесь с разделом Настройка Chat API.
- Если вы создали приложение Chat, которое не является дополнением Google Workspace, вам необходимо настроить параметры событий взаимодействия в Chat API. Подробнее о том, как получать и обрабатывать запросы пользователей…
- Если вы создали приложение Chat с помощью автоматической конфигурации AppSheet, опубликуйте его, следуя инструкциям в документации AppSheet: Как поделиться приложением Chat с помощью автоматической конфигурации.
Приложение "Диск"
Чтобы опубликовать приложение Диска, необходимо включить и настроить Google Drive API.
Веб-приложение
Чтобы опубликовать веб-приложение, необходимо указать его универсальный URL навигации – URL, который ведет к веб-приложению из меню приложений Google . Ваше веб-приложение должно быть в рабочей версии и полностью функциональным.
На странице "Страница приложения в Google Play" вам нужно будет добавить дополнительные значки размером 96 x 96 и 48 x 48 пикселей.
Если вы создали веб-приложение в Apps Script, выполните следующие действия, чтобы получить URL универсальной навигации:
- Откройте дополнение Google Workspace в редакторе Apps Script.
- Нажмите Развернуть > Новое развертывание.
- В разделе "Выберите тип" нажмите Веб-приложение.
- Заполните поля и нажмите Развернуть.
- Нажмите Копировать.
Укажите уровень доступа, необходимый приложению
В разделе Области действия OAuth укажите полный список областей действия OAuth 2.0, которые требуются вашему приложению. Области действия OAuth, которые вы указываете здесь, должны совпадать с областями действия, которые вы показываете в окне запроса доступа OAuth и, если применимо, в манифесте Apps Script.
Если вы добавили несколько интеграций приложений, убедитесь, что добавили области действия из каждой из них на страницу конфигурации приложения Marketplace SDK и в окно запроса доступа OAuth.
Всегда используйте как можно более узкие области действия (например, не включайте полную область действия Диска, если вам нужна только область действия с доступом для чтения).
Подробнее об областях авторизации для проектов Apps Script…
Предоставьте информацию о разработчике приложения
В разделе Информация о разработчике укажите контактную информацию и другие сведения. Эти поля будут видны на странице приложения в Google Play.
| Поля | |
|---|---|
| Статус продавца |
Законы о защите прав потребителей обязывают нас информировать клиентов из Европейской экономической зоны (ЕЭЗ) о том, являются ли продавцами те лица, которые предлагают свои продукты на этой торговой площадке. В частности, мы должны сообщать, является ли продавец профессиональным или непрофессиональным.
Если вы не укажете статус, на странице приложения в магазине будет показываться статус "Статус продавца не указан". |
| Название компании-разработчика | Имя, которое будет указано в качестве автора приложения. Если вы трейдер, укажите свое торговое или юридическое название. |
| Почтовый адрес разработчика |
Обязательно для трейдеров. Не собирается для компаний, не являющихся продавцами. Местоположение вашей компании. Введите действительный почтовый адрес, по которому с вами можно связаться. |
| URL сайта разработчика | Сайт, на котором вы (или ваша организация) указаны как разработчик. |
| Адрес электронной почты разработчика |
Адрес электронной почты, который будет использоваться для связи. Она не показывается на странице приложения в Google Play. Следите за тем, чтобы этот адрес электронной почты был актуальным, поскольку он используется:
|
| URL сайта приложения | Необязательное поле. Сайт, на котором можно найти дополнительную информацию о приложении. |
Сохраните настройки конфигурации приложения в Marketplace SDK
Используя информацию из предыдущего раздела, сохраните конфигурацию приложения в Marketplace SDK:
В консоли Google Cloud перейдите на страницу Marketplace SDK > Конфигурация приложения:
Заполните каждый раздел, используя информацию, полученную на предыдущем этапе.
Нажмите Сохранить черновик.
При необходимости вы можете получать статистику использования приложений в Google Аналитике. Для этого добавьте идентификатор Google Аналитики в Marketplace SDK.
- Перейдите на вкладку Аналитика.
- Введите идентификатор Google Аналитики.
- Нажмите Сохранить.
Устранение неполадок
В этом разделе описаны распространенные проблемы, с которыми вы можете столкнуться.
При публикации приложений в каталоге Marketplace отсутствуют необходимые разрешения
Вы не можете опубликовать приложение в каталоге Marketplace, поскольку при попытке настроить приложение на странице "Конфигурация приложения" в Marketplace SDK возникает следующее сообщение об ошибке:
You are missing at least one of the following required permissions: Project workspacemarketplace.appconfiguration.view / workspacemarketplace.appconfiguration.update
Эта ошибка возникает, когда включен Marketplace SDK API и используется роль IAM, отличная от Editor или Owner.
Чтобы устранить ошибку, выполните одно из следующих действий:
Попросите владельца проекта назначить аккаунту с недостающими разрешениями роль
roles/appmetadata.workspaceMarketplaceAppConfigurationAdmin, чтобы он мог настраивать приложение и управлять им в Marketplace SDK.Попросите владельца проекта добавить недостающие разрешения в специальную роль на странице IAM и администрирование > Роли в консоли Google Cloud. Затем назначьте специальную роль аккаунту с недостающими разрешениями.
Для публикации приложений можно использовать примитивные роли
roles/editorилиroles/owner. Однако в документации Безопасное использование IAM это считается плохой практикой, поскольку сложно ограничить доступ на редактирование других ресурсов в проекте.