Настройте свое приложение в SDK Google Workspace Marketplace.

На этой странице объясняется, как использовать 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

Если вы еще этого не сделали, в своем проекте Google Cloud включите Marketplace SDK .

Откройте свой облачный проект в консоли Google Cloud.

Если проект Cloud, который вы собираетесь использовать для этого примера, еще не открыт, откройте его:

  1. В консоли Google Cloud перейдите на страницу выбора проекта .

    Выберите облачный проект

  2. Выберите нужный проект Google Cloud. Или нажмите «Создать проект» и следуйте инструкциям на экране. При создании проекта Google Cloud может потребоваться включить для него оплату .

Включите Marketplace SDK

Перед использованием API Google вам необходимо включить их в проекте Google Cloud. Вы можете включить один или несколько API в одном проекте Google Cloud.

  • В консоли Google Cloud включите Google Workspace Marketplace SDK.

    Включить SDK

Определите параметры конфигурации для вашего приложения

В следующей справке описываются настройки, доступные на странице конфигурации приложения Marketplace SDK.

Выберите, кто может просматривать и устанавливать ваше приложение

При настройке приложения вы указываете пользователей, которые могут получить к нему доступ, используя следующие параметры:

  • Видимость приложения : если вы публикуете приложение в организации Google Workspace, независимо от того, является ли ваше приложение частным, видимым для всех пользователей вашей организации или для любого, кто использует Google Workspace.
  • Настройки установки : могут ли приложение устанавливать только администраторы Google Workspace.

Независимо от настроек, указанных в описании приложения, пользователи, принадлежащие организации Google Workspace, могут не иметь возможности обнаружить, установить или использовать ваше приложение в соответствии с настройками, заданными их администраторами. Администраторы могут влиять на доступность вашего приложения следующими способами:

  • Контролировать, могут ли их пользователи просматривать приложения на Marketplace, а также устанавливать приложения от имени своих пользователей.
  • Используйте белый список для управления и отбора приложений для своей организации. Если вы разрабатываете приложение для организации, использующей белый список, обратитесь к администратору, чтобы узнать о добавлении приложения в белый список.
  • Отключите некоторые приложения Google Workspace, например, запретите доступ к Google Chat, приложениям Google Chat или к обоим. В этих случаях пользователи не смогут установить ваше приложение из Marketplace.

Чтобы узнать, как администраторы управляют доступом к Marketplace, см. документацию Marketplace Admin Help .

Настройки видимости приложения

Параметр «Видимость приложения» отображается, если вы используете учётную запись Google Workspace (учётную запись, созданную вашей рабочей или учебной организацией). Если вы используете учётную запись для обычных пользователей (учётную запись, заканчивающуюся на «@gmail.com»), вы можете публиковать сообщения только публично.

  • Публичное : приложение могут найти и установить люди за пределами вашего домена. Если вы выберете публичный доступ, Google проверит и одобрит ваше приложение перед публикацией.
  • Частное : найти и установить ваше приложение смогут только пользователи вашего домена.

Если вы выберете публикацию в категории «Не в списке» , приложение не будет отображаться в результатах поиска и обзора. Пользователи смогут перейти на страницу приложения в магазине только по прямому URL-адресу.

Если вы хотите ограничить страны и регионы, в которых доступно ваше приложение, вы можете указать это в разделе «Распространение» при создании листинга приложения в магазине .

Настройки установки приложения

Параметр «Настройки установки» определяет, смогут ли пользователи или администраторы Google Workspace установить ваше приложение со страницы описания вашего приложения в Marketplace.

  • Индивидуальная установка + установка администратором (по умолчанию) : приложение может быть установлено отдельными пользователями или администраторами домена, подразделения или группы пользователей. Политики домена пользователя могут запрещать установку приложения, даже если разрешена индивидуальная установка.
  • Установка только администратором : приложение могут установить только администраторы своего домена, организационного подразделения или группы пользователей. Ваше приложение отображается в результатах поиска Google Workspace Marketplace только для администраторов и пользователей, не вошедших в свою учетную запись Google. Выберите этот вариант, если для вашего приложения требуется установка в домене.

Общие настройки установки и видимости

В следующей таблице приведены некоторые общие параметры конфигурации приложения для установки и видимости:

Предполагаемые пользователи приложения Настройка видимости приложения Настройка установки приложения Кто может установить мое приложение? Кто может использовать мое приложение?
Для приложений, созданных для организации Google Workspace
Конкретные пользователи в вашей организации Частные и некотируемые Индивидуальная + Административная установка Если разрешено, любой человек в вашей организации, имеющий URL-адрес листинга приложения. Если разрешено, любой человек в вашей организации, имеющий URL-адрес листинга приложения.
Ваша организация Частный Индивидуальная + Административная установка Если разрешено, любой человек в вашей организации. Если разрешено, любой человек в вашей организации.
Ваша организация Частный Только администратор Администраторы Пользователи, у которых приложение установлено администратором.
Для приложений, доступных пользователям за пределами конкретной организации Google Workspace
Пользователи в организациях Google Workspace Публичный Только администратор Администраторы Пользователи, у которых приложение установлено администратором.
Все пользователи Google Workspace Публичный Индивидуальная + Административная установка
  • Любой, кто использует приложения Google Workspace в личных целях.
  • Если разрешено, пользователи в организациях Google Workspace.
  • Любой, кто использует приложения Google Workspace в личных целях.
  • Если разрешено, пользователи в организациях Google Workspace.

Определите, как ваше приложение интегрируется с приложениями Google Workspace.

Выберите сервисы Google Workspace, с которыми работает ваше приложение или дополнение, например, дополнение Google Workspace или приложение Google Chat. Необходимо выбрать хотя бы один вариант. В некоторых случаях вы можете включить в список приложений несколько интеграций. См. раздел Список интеграций приложений .

В зависимости от выбранных вами интеграций приложений вам может потребоваться предоставить дополнительную информацию и включить соответствующие API в вашем проекте Google Cloud. В следующей таблице описаны дополнительные настройки, необходимые для каждого варианта:

Надстройка Google Workspace

Чтобы опубликовать дополнение Google Workspace, необходимо указать идентификатор развертывания дополнения.

Чтобы найти идентификатор развертывания в Apps Script, выполните следующие действия:

  1. Откройте надстройку Google Workspace в редакторе Apps Script.
  2. Нажмите Развернуть > Управление развертываниями .
  3. Под идентификатором развертывания нажмите кнопку Копировать .

Чтобы найти идентификатор развертывания для HTTP-надстройки, выполните следующие действия:

  1. На странице «Конфигурация приложения» в разделе «Надстройка Google Workspace» нажмите HTTP или другие развертывания > Выберите развертывание .
  2. Выберите развертывание, которое вы хотите опубликовать.
  3. Нажмите Выбрать .

Дополнение «Редактор» (Документы, Таблицы, Слайды, Формы)

Чтобы опубликовать дополнение Editor, необходимо указать идентификатор и версию скрипта проекта, которую вы хотите опубликовать.

Чтобы найти идентификатор скрипта проекта, выполните следующие действия:

  1. Откройте дополнение в редакторе Apps Script.
  2. Слева нажмите проекта .
  3. В разделе «Идентификаторы» скопируйте идентификатор скрипта.

Чтобы узнать версию, выполните следующие действия:

  1. Откройте дополнение в редакторе Apps Script.
  2. В правом верхнем углу нажмите Развернуть > Управление развертываниями .
  3. Номер версии указан в разделе «Конфигурация».

Приложение Google Чат

Чтобы опубликовать интерактивное приложение Google Chat , ознакомьтесь со следующей документацией:

Приложение Drive

Чтобы опубликовать приложение Drive, необходимо включить и настроить API Google Drive .

Веб-приложение

Чтобы опубликовать веб-приложение, необходимо предоставить его универсальный навигационный URL — URL, который указывает на веб-приложение из меню Google. Ваше веб-приложение должно быть запущено в эксплуатацию и полностью работоспособно.

При заполнении страницы со списком товаров в магазине необходимо предоставить дополнительные иконки размером 96x96 и 48x48 пикселей.

Если вы создали свое веб-приложение в Apps Script, выполните следующие действия, чтобы получить универсальный навигационный URL:

  1. Откройте надстройку Google Workspace в редакторе Apps Script.
  2. Нажмите Развернуть > Новое развертывание .
  3. В разделе «Выберите тип» нажмите Веб-приложение .
  4. Заполните поля и нажмите «Развернуть» .
  5. Нажмите «Копировать» .

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

В разделе «Области действия OAuth» укажите полный список областей действия OAuth 2.0, необходимых вашему приложению. Указанные здесь области действия OAuth должны соответствовать отображаемым на экране согласия OAuth и, если применимо, в манифесте Apps Script.

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

Всегда используйте максимально узкие области действия (например, не включайте полную область действия Диска, если вам нужна область действия только для чтения).

Более подробную информацию о проектах Apps Script см. в разделе Области авторизации .

Предоставьте информацию о разработчике приложения

В разделе «Информация о разработчике» заполните контактную информацию и другие данные. Эти поля отображаются на странице описания вашего приложения в магазине .

Поля
Статус трейдера

В соответствии с законами о защите прав потребителей потребители, находящиеся в Европейской экономической зоне (ЕЭЗ), должны быть проинформированы о том, является ли продавец на Торговой площадке трейдером или нет :

  • Трейдер : Трейдер — это лицо, действующее в целях, связанных с торговлей, бизнесом, ремеслом или профессией; или от имени или в интересах трейдера.
  • Неторговец : Неторговец (потребитель) — это лицо, действующее в непрофессиональных целях.

Если не указано иное, на странице описания вашего приложения в магазине отобразится сообщение «Статус трейдера не указан».

Имя разработчика Имя, которое будет отображаться в качестве автора приложения. Если вы трейдер, укажите своё торговое название или юридическое название.
Почтовый адрес разработчика

Требуется для трейдеров. Не взимается с лиц, не являющихся трейдерами.

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

URL-адрес сайта разработчика Веб-сайт, описывающий вас (или вашу организацию) как разработчика.
Электронная почта разработчика

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

  • Если Google необходимо связаться с разработчиком, например, в процессе проверки приложения.
  • Для отправки отзыва из надстроек редактора, если URL-адрес для сообщения о проблеме не указан на странице описания магазина.
URL-адрес веб-сайта приложения Необязательно. Веб-сайт с более подробным описанием вашего приложения.

Сохраните настройки конфигурации вашего приложения в Marketplace SDK

Используя информацию из предыдущего раздела , сохраните конфигурацию вашего приложения в Marketplace SDK:

  1. В консоли Google Cloud перейдите на страницу конфигурации приложения Marketplace SDK:

    Перейти на страницу конфигурации Marketplace SDK

  2. Заполните каждый раздел на основе того, что вы определили в предыдущем разделе .

  3. Нажмите «Сохранить черновик» .

  4. (Необязательно) Вы можете получить аналитику использования приложения в Google Analytics . Для этого добавьте идентификатор Google Analytics в Marketplace SDK.

    1. Перейдите на вкладку Аналитика .
    2. Введите свой идентификатор Google Analytics.
    3. Нажмите «Сохранить» .

Устранение неполадок

В этом разделе описываются распространенные проблемы, с которыми вы можете столкнуться.

Отсутствуют необходимые разрешения при публикации приложений в Marketplace.

Вы не можете публиковать приложения в Marketplace, так как попытки настроить приложение на странице «Конфигурация приложения» в Marketplace SDK завершаются неудачей со следующим сообщением об ошибке:

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 и администрирование» > «Роли» в консоли Google Cloud. Затем назначьте настраиваемую роль учётной записи с недостающими разрешениями.

  • Примитивные roles/editor или roles/owner можно использовать для публикации приложений. Однако в документации «Использование IAM безопасно» эта практика рассматривается как плохая, поскольку невозможно просто ограничить доступ к редактированию других ресурсов проекта.