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

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

Apps Script

Перед отправкой коннектора на проверку выполните следующие действия в Apps Script:

  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 Это должна быть размещенная страница для получения поддержки по вашему коннектору. Это не может быть ссылка на электронную почту или адрес электронной почты.
  4. logoUrl Адрес должен указывать на статическое изображение, размещенное под вашим контролем. Вы не можете использовать изображения, предоставляемые сервисами Google, на доменах типа *.gstatic.com , *.ggpht.com , *.google.com , *.googleusercontent.com . Использование Google Cloud Storage для размещения изображений с домена *.googleapis.com допустимо и является рекомендуемым вариантом хостинга.
    • Коннекторы с анимированными значками будут отклонены. Используйте статические изображения.
    • Рекомендуется использовать изображение размером не менее 48x48 пикселей.
    • Избегайте изображений, содержащих только текст, которые трудно читать при уменьшении до размера 48x48 пикселей.
  5. Заполните sources Свойство, содержащее все источники, к которым подключается ваш коннектор. Подробнее см. раздел «Источники» в справочнике манифеста .
    • Вы можете просмотреть существующий список источников в репозитории Data Registry . Если источник, к которому вы подключаетесь, отсутствует в репозитории, отправьте запрос на добавление источника в репозиторий Data Registry . Ваш коннектор не пройдет проверку, если источники в вашем манифесте отсутствуют в репозитории.
    • Это дополнительные метаданные для коннектора, которые будут индексироваться для функции поиска в галерее. Ваш коннектор будет отображаться в результатах поиска, когда пользователи будут искать определенный источник в галерее.
  6. Укажите значения для shortDescription , authType , feeType , privacyPolicyUrl и termsOfServiceUrl .
  7. name Название должно напрямую отражать назначение коннектора. Четкое название поможет пользователям определить, соответствует ли ваш коннектор их потребностям. Избегайте использования слова «коннектор» в названии, поскольку пользователи и так знают, что перед ними коннектор.
    • Не используйте специальные или невидимые символы с целью привлечения внимания к разъему или потенциального изменения его положения.
  8. Не используйте сокращенные названия для Data 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 link, supportUrl link и OAuth page (если применимо) не должно быть орфографических и грамматических ошибок.
  5. shortDescription не могут содержаться URL-адреса.
  6. Используйте методы аутентификации, предоставляемые функцией getAuthType() . Не запрашивайте учетные данные через getConfig() .
  7. Завершите процесс проверки клиента OAuth . Проверка обязательна для всех коннекторов независимо от метода аутентификации в getAuthType() . Процесс проверки отличается от проверки коннектора и обрабатывается отдельной командой, а не Data Studio. Для получения дополнительной информации обратитесь к разделу часто задаваемых вопросов (FAQ) по проверке API OAuth . Ваш коннектор будет отклонен, если процесс проверки клиента OAuth не будет завершен.
  8. Убедитесь, что вы соблюдаете Условия предоставления услуг Data Studio Galleries (для отправителя) .

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

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