На этой странице объясняется, как использовать SDK Google Workspace Marketplace для настройки и управления вашим приложением на платформе Google Workspace Marketplace .
Чтобы ваше приложение стало доступно для использования, его необходимо настроить в Marketplace SDK. Marketplace SDK — это набор инструментов, позволяющий создавать и управлять вашим приложением на Marketplace. Вы используете Marketplace SDK для управления настройками Marketplace, такими как следующие:
- Независимо от того, доступно ли ваше приложение для конкретной организации Google Workspace ( частное приложение) или для всех пользователей Marketplace ( общедоступное приложение),
- Типы пользователей Marketplace, которые могут установить ваше приложение.
- С какими приложениями Google Workspace интегрируется ваше приложение?
- Области действия OAuth, необходимые вашему приложению
- Информация о том, кто разработал и поддерживает приложение.
Независимо от того, публикуете ли вы свое приложение в частном или публичном режиме, для управления им на торговой площадке необходимо использовать SDK Marketplace.
Включите SDK Marketplace
Если вы еще этого не сделали, включите SDK Marketplace в своем проекте Google Cloud.
Откройте свой облачный проект в консоли Google Cloud.
Если проект Cloud, который вы собираетесь использовать в этом примере, еще не открыт, откройте его:
- В консоли Google Cloud перейдите на страницу «Выберите проект» .
- Выберите проект Google Cloud, который хотите использовать. Или нажмите «Создать проект» и следуйте инструкциям на экране. Если вы создаете проект Google Cloud, вам может потребоваться включить оплату для этого проекта .
Включите SDK Marketplace.
Перед использованием API Google необходимо включить их в проекте Google Cloud. В одном проекте Google Cloud можно включить один или несколько API.В консоли Google Cloud включите SDK Google Workspace Marketplace.
Определите параметры конфигурации для вашего приложения.
В следующем документе описаны настройки, доступные на странице «Конфигурация приложения» в SDK Marketplace.
Выберите, кто сможет просматривать и устанавливать ваше приложение.
При настройке приложения вы указываете пользователей, которые могут получить к нему доступ, используя следующие параметры:
- Видимость приложения : Если вы публикуете приложение в рамках организации Google Workspace, то его отображение может быть скрытым, видимым для всех пользователей вашей организации или для всех, кто использует Google Workspace.
- Настройки установки : Разрешить установку приложения только администраторами Google Workspace.
Независимо от настроек, указанных в описании вашего приложения, пользователи, входящие в организацию Google Workspace, могут не иметь возможности обнаружить, установить или использовать ваше приложение из-за настроек, установленных их администраторами. Администраторы могут влиять на доступность вашего приложения следующими способами:
- Контролируйте, могут ли их пользователи просматривать приложения в Marketplace, и устанавливайте приложения от имени своих пользователей.
- Используйте список разрешенных приложений для управления и отбора приложений для вашей организации. Если вы разрабатываете приложение для организации, которая использует списки разрешенных приложений, проконсультируйтесь с администратором о добавлении приложения в этот список.
- Отключите определенные приложения Google Workspace, например, заблокируйте доступ к Google Chat, приложениям Google 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 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.
- В левой части экрана нажмите проекта» .
- В поле "IDs" скопируйте идентификатор скрипта.
Чтобы узнать версию, выполните следующие шаги:
- Откройте дополнение в редакторе Apps Script.
- В правом верхнем углу нажмите «Развернуть» > «Управление развертываниями» .
- Номер версии указан в разделе «Конфигурация».
Приложение Google Чат
Для публикации интерактивного приложения Google Chat см. следующую документацию:
- Если вы создали приложение для чата как надстройку, вам необходимо настроить параметры надстройки в API чата. Инструкции см. в разделе «Настройка приложения для чата» в документации по надстройкам Google Workspace.
- Если вы создали приложение для чата с использованием событий взаимодействия, вам необходимо настроить параметры событий взаимодействия в API чата. Инструкции см. в разделе «Получение и обработка событий взаимодействия» в документации по API чата.
- Если вы создали приложение чата с использованием автоматической настройки AppSheet, опубликуйте его, следуя инструкциям, описанным в документации AppSheet: « Предоставьте доступ к приложению чата с помощью автоматической настройки» .
Приложение «Драйв»
Для публикации приложения в Google Диск необходимо включить и настроить API Google Диска .
Веб-приложение
Для публикации веб-приложения необходимо указать его универсальный URL-адрес навигации — URL-адрес, указывающий на веб-приложение в меню Google. Ваше веб-приложение должно находиться в рабочем режиме и быть полностью функциональным.
При заполнении страницы "Описание магазина" необходимо указать дополнительные значки размером 96x96 и 48x48 пикселей.
Если вы создали веб-приложение с помощью Apps Script, выполните следующие действия, чтобы получить универсальный URL-адрес навигации:
- Откройте надстройку Google Workspace в редакторе Apps Script.
- Нажмите «Развернуть» > «Новое развертывание» .
- В разделе «Выберите тип» нажмите «Веб-приложение ».
- Заполните поля и нажмите «Развернуть» .
- Нажмите «Копировать» .
Укажите уровень доступа, необходимый вашему приложению.
В разделе «Области действия OAuth» укажите полный список областей действия OAuth 2.0, необходимых вашему приложению. Указанные здесь области действия OAuth должны соответствовать тем, что отображаются на экране согласия OAuth и, если применимо, в манифесте Apps Script.
Если вы используете более одной интеграции приложений, обязательно добавьте области действия из каждой из них на страницу конфигурации приложения Marketplace SDK и на экран согласия OAuth.
Всегда используйте максимально узкие осциллографы (например, не включайте полный осциллограф привода, если вам нужен только осциллограф для чтения).
Для проектов Apps Script см. раздел «Области авторизации» для получения более подробной информации.
Предоставьте информацию о разработчике приложения.
В разделе «Информация о разработчике» заполните контактные данные и другую информацию. Эти поля отобразятся на странице вашего приложения в магазине приложений.
| Поля | |
|---|---|
| Статус трейдера | В соответствии с законодательством о защите прав потребителей, потребители, проживающие в Европейской экономической зоне (ЕЭЗ), должны быть проинформированы о том, является ли продавец на торговой площадке частным лицом или нет .
Если статус не указан, на странице вашего приложения в магазине отображается сообщение "Статус трейдера не указан". |
| Имя разработчика | Имя, которое будет отображаться в качестве автора приложения. Если вы являетесь трейдером, укажите свое торговое наименование или официальное название компании. |
| Почтовый адрес разработчика | Обязателен для трейдеров. Не взимается с лиц, не занимающихся трейдингом. Местонахождение вашей компании. Укажите действующий почтовый адрес, по которому с вами можно связаться. |
| URL веб-сайта разработчика | Веб-сайт, на котором вы (или ваша организация) указаны в качестве разработчика. |
| Электронная почта разработчика | Адрес электронной почты, который следует использовать в качестве контактного лица. Он не указан в описании вашего приложения. Убедитесь, что этот адрес электронной почты актуален по мере его использования:
|
| URL веб-сайта приложения | Необязательно. Веб-сайт, который более подробно описывает ваше приложение. |
Сохраните настройки конфигурации вашего приложения в Marketplace SDK.
Используя информацию из предыдущего раздела , сохраните конфигурацию вашего приложения в SDK Marketplace:
В консоли Google Cloud перейдите на страницу « Конфигурация приложения Marketplace SDK»:
Заполните каждый раздел, основываясь на том, что вы определили в предыдущем разделе .
Нажмите «Сохранить черновик» .
(Необязательно) Вы можете получить аналитику использования приложения в Google Analytics . Для этого добавьте идентификатор Google Analytics в SDK Marketplace.
- Перейдите на вкладку «Аналитика» .
- Введите свой идентификатор Google Analytics.
- Нажмите « Сохранить ».
Устранение неполадок
В этом разделе описаны распространенные проблемы, с которыми вы можете столкнуться.
При публикации приложений в Marketplace отсутствуют необходимые разрешения.
Вы не можете публиковать приложения в Marketplace, поскольку попытки настроить приложение на странице конфигурации приложения в SDK Marketplace завершаются с ошибкой, указанной ниже:
You are missing at least one of the following required permissions: Project workspacemarketplace.appconfiguration.view / workspacemarketplace.appconfiguration.update
Эта ошибка возникает, когда включен API Marketplace SDK и используется роль IAM, отличная от Editor или Owner .
Для устранения ошибки воспользуйтесь одним из следующих решений:
Попросите владельца проекта назначить роль
roles/appmetadata.workspaceMarketplaceAppConfigurationAdminучетной записи с недостающими разрешениями, чтобы она могла настраивать и управлять приложением в Marketplace SDK .Попросите владельца проекта добавить недостающие разрешения к пользовательской роли через страницу IAM & Admin > Roles в консоли Google Cloud. Затем назначьте пользовательскую роль учетной записи с недостающими разрешениями.
Для публикации приложений можно использовать примитивные
roles/editorилиroles/owner. Однако в документации по безопасному использованию IAM это считается плохой практикой, поскольку сложно ограничить доступ к редактированию других ресурсов в проекте.