Требования к партнерскому соединителю

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

Скрипт приложений

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

  1. Предоставьте доступ к просмотру вашего проекта Apps Script следующим лицам:
  2. Создайте развертывание с именем Production и обновите его до версии Production , которую вы собираетесь опубликовать.
  3. Подтвердите, что вы обновили Production развертывание до версии кода, которую хотите просмотреть.
  4. Убедитесь, что файл манифеста виден в Apps Script. Слева нажмите параметров проекта . Установите флажок Показывать файл манифеста «appsscript.json» в редакторе .

Манифест

Включите следующее в манифест соединителя и убедитесь, что ваш проект Apps Script настроен на отображение файла манифеста appsscript.json в редакторе.

Для получения дополнительной информации просмотрите ссылку на манифест Community Connector .

dataStudio

  1. description должен предоставить информацию и инструкции для базового понимания разъема и того, как его использовать. Разъемы с расплывчатыми и неполными описаниями будут отклонены.
  2. addOnUrl это должна быть выделенная размещенная страница о вашем соединителе, предпочтительно размещенная в вашем собственном домене. Страница должна содержать следующее:
    • Политика конфиденциальности и Условия использования или ссылка на этот контент в том же домене, что и addOnUrl .
    • Подробности, которые пользователю необходимо знать для использования вашего соединителя.
    • Ссылка для регистрации, если для использования вашего соединителя требуется учетная запись.
    • Контент желательно размещать на вашем домене. Хостинг на https://sites.google.com/ запрещен.
    • Посмотрите примеры страниц от существующих партнеров: Funnel , Supermetrics , CallRail .
  3. supportUrl должна быть размещенной страницей, чтобы получить поддержку для вашего соединителя. Это не может быть адрес электронной почты или ссылка mailto.
  4. logoUrl должен указывать на статическое изображение, размещенное под вашим контролем. Вы не можете использовать изображения, предоставляемые службами Google, в таких доменах, как *.gstatic.com , *.ggpht.com , *.google.com , *.googleusercontent.com . Использование Google Cloud Storage для размещения изображений из домена *.googleapis.com допустимо и является рекомендуемым вариантом хостинга.
    • Коннекторы с анимированными значками будут отклонены. Используйте статические изображения.
    • Рекомендуется использовать изображение размером не менее 48x48 пикселей.
    • Избегайте изображений, содержащих только текст, которые трудно читать при уменьшении до размера 48x48 пикселей.
  5. Заполните sources свойство со всеми источниками, к которым подключается ваш соединитель. Подробности см. в разделе «Источники» в справочнике по манифесту .
    • Посмотреть существующий список источников можно в Data Registry Repository . Если источник, к которому вы подключаетесь, не существует в репозитории, отправьте запрос на включение в репозиторий реестра данных , чтобы добавить источник. Ваш соединитель не пройдет процесс проверки, если источники в вашем манифесте не существуют в репозитории.
    • Это дополнительные метаданные для соединителя, которые будут индексироваться для функции поиска в галерее. Ваш соединитель будет отображаться в результатах поиска, когда пользователи будут искать определенный источник в галерее.
  6. Укажите значения для shortDescription , authType , feeType , privacyPolicyUrl и termsOfServiceUrl .
  7. name должен непосредственно отражать назначение соединителя. Понятное название поможет пользователям определить, соответствует ли ваш соединитель их потребностям. Избегайте использования слова « соединитель» в названии, поскольку пользователи уже знают, что смотрят на соединитель.
    • Не включайте специальные или невидимые символы с целью привлечь внимание или потенциально изменить положение вашего разъема.
  8. Не используйте сокращенные имена Looker Studio где-либо в манифесте (например, GDS, DS и т. д.).
  9. Использование смайлов в любом поле манифеста ( description , shortDescription , name и т. д.) запрещено. В общем, не добавляйте специальные или невидимые символы с целью привлечь внимание к разъему.
  10. Если ваш соединитель имеет фиксированную схему, создайте шаблон отчета для вашего соединителя и добавьте его в манифест. Включите общий доступ по ссылке для отчета.

urlFetchWhitelist

  1. Ограничьте количество конечных точек, вызываемых UrlFetchApp до тех, которые абсолютно необходимы для функциональности соединителя. Добавьте свойство urlFetchWhitelist на корневой уровень вашего манифеста. Просмотрите ссылку urlFetchWhitelist для получения дополнительной информации.
    • Включите все конечные точки, используемые со службой UrlFetchApp .
    • Если ваш соединитель не извлекает ресурсы с помощью службы UrlFetchApp , задайте для urlFetchWhitelist пустой список [] .
    • Если ваш соединитель не подключается к набору фиксированных конечных точек или префикс конечной точки меняется, опустите свойство urlFetchWhitelist и укажите сведения в поле формы «Исключение для urlFetchWhitelist» при отправке запроса на проверку.

oauthScopes

  1. Установите явные области действия OAuth в манифесте. Соединители без явных областей действия OAuth будут отклонены.

Разъем

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

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

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