Требования к коннекторам партнеров

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

Apps Script

  1. Предоставьте доступ для просмотра вашего проекта Apps Script следующим аккаунтам:
  2. Создайте развертывание под названием Production и добавьте в развертывание Production версию кода, который вы хотите опубликовать.
  3. Если вы обновляли код после создания развертывания Production, то, прежде чем отправить коннектор, убедитесь, что нужная версия кода выбрана в том же развертывании.

Манифест

Ниже перечисляется, что нужно указать в манифесте. Подробную информацию обо всех объектах манифеста можно найти здесь.

  1. В описании (description) представьте всю информацию и инструкции, которые помогут пользователям понять, как работать с коннектором. Если описание будет непонятным или неполным, коннектор будет отклонен при проверке.
  2. Страница, указанная в параметре addOnUrl, должна быть отведена только для этого коннектора. Желательно разместить ее в вашем домене.
    • Страница должна содержать Условия использования и Политику конфиденциальности или ссылаться на эти документы (размещенные в том же домене, что и addOnUrl).
    • На странице должны быть приведены инструкции по использованию коннектора.
    • Если для работы с коннектором необходимо войти в аккаунт, на странице должна быть ссылка для входа.
    • Страницу нельзя размещать на платформе https://sites.google.com/.
    • Ознакомьтесь с примерами страниц наших партнеров: Funnel, Supermetrics и CallRail.
  3. В свойстве supportUrl должна быть указана страница службы поддержки, а не адрес электронной почты или ссылка mailto.
  4. В свойстве sources должны быть перечислены все источники, к которым подключается коннектор. Подробнее…
    • Список доступных источников можно найти здесь. Если источника, к которому вы подключаетесь, нет в списке, отправьте запрос на его добавление. Коннектор не будет одобрен, если источников, указанных в манифесте, нет в этом списке.
    • Значения этого свойства индексируются как дополнительные метаданные для поиска по галерее. Поэтому если пользователь введет запрос с названием источника данных, который применен в вашем коннекторе, то коннектор появится в результатах поиска.
    • Также пользователи смогут найти ваш коннектор, выбрав источник данных в специальном меню интерфейса.
  5. С помощью метода UrlFetchApp должен быть разрешен вызов только тех конечных точек, которые необходимы для работы коннектора. Для этого добавьте свойство urlFetchWhitelist на корневой уровень манифеста. Подробнее…
    • В этом свойстве должны быть указаны все URL, к которым коннектор подключается с помощью вызова UrlFetchApp.
    • Если коннектор не выполняет вызов UrlFetchApp, назначьте свойству значение [] (пустой список).
    • Если коннектор подключается к разным доменам или префиксы конечных точек меняются, не используйте свойство urlFetchWhitelist в манифесте.
  6. В манифесте должны быть указаны следующие значения: shortDescription, authType, feeType, privacyPolicyUrl и termsOfServiceUrl.
  7. Название коннектора (name) должно отражать его функциональные возможности. Это поможет пользователям при выборе подходящих коннекторов.

Шаблон и отчет

  1. Если в коннекторе используется постоянная схема, создайте шаблон отчета для коннектора и добавьте его в манифест. Включите доступ к отчету по ссылке.
  2. Создайте с помощью коннектора хотя бы один демонстрационный отчет и добавьте его в галерею Студии данных. Это может быть точная копия шаблона отчетов или же отдельный отчет, в котором представлены более широкие возможности коннектора.
    • Если вы добавите демонстрационные отчеты, ваш коннектор сможет упоминаться в примерах использования, новостных рассылках, записях блогов и т. п.

Коннектор

  1. Если для работы с коннектором нужен аккаунт, то в свойствах коннектора description или по ссылке addOnUrl должны быть приведены инструкции по созданию такого аккаунта.
  2. Если коннектор не закончен или находится на стадии бета-тестирования, публиковать его нельзя. Вы можете в любой момент вносить изменения в коннектор, однако версия, предложенная пользователям в развертывании, должна быть протестированной и полностью рабочей.
  3. При возникновении внутренней ошибки коннектора пользователь должен видеть информативное и актуальное сообщение. Это также касается случаев, когда пользователь вводит недействительные данные в настройках или не вводит их совсем.
  4. В свойствах shortDescription и description, в ссылках addOnUrl и supportUrl, а также на странице аутентификации по протоколу OAuth (если применяется) не должно быть орфографических и грамматических ошибок.
  5. Задайте подходящий вам метод аутентификации в функции getAuthType(). Не запрашивайте учетные данные с помощью функции getConfig().
  6. Пройдите проверку клиента OAuth. Это требуется для всех коннекторов, независимо от выбранного в методе getAuthType() способа аутентификации. Проверку выполняет отдельная команда. См. ответы на часто задаваемые вопросы по OAuth. Пока вы не пройдете проверку клиента OAuth, коннектор не будет опубликован.
  7. Убедитесь, что вы не нарушаете Условия использования галерей Студии данных (для поставщиков программных продуктов).

Если вы выполнили все требования, нажмите кнопку ниже, чтобы запросить проверку коннектора.

Опубликовать коннектор партнера