Ссылка на манифест

Манифест ( appsscript.json ) — это файл JSON в проекте соединителя Apps Script. Он содержит определенную информацию о вашем соединителе сообщества, необходимую для развертывания и использования вашего соединителя в Looker Studio. Подробнее о манифестах читайте в Apps Script .

Ваш манифест должен содержать следующую информацию:

имя свойства Тип Описание
Обязательно (в свойстве dataStudio )
name string Имя вашего разъема.
Ограничено 28 символами
company string Название организации или разработчика.
companyUrl string (link) Ссылка на сайт организации или разработчика.
logoUrl string (image link) URL-адрес значка вашего соединителя.
Требуемые размеры: 40х40 пикселей.
addOnUrl string (link) Ссылка на специальную страницу «Подробнее», на которой объясняется, что делает ваш соединитель и к каким данным он обращается. Вы должны разместить и поддерживать эту страницу.
Эта страница должна содержать ваши Условия обслуживания и Политику конфиденциальности или ссылаться на них.
supportUrl string (link) Ссылка на страницу поддержки для поддержки этого соединителя. Пользователи должны иметь возможность сообщать о проблемах с вашим соединителем по этой ссылке. Вы должны разместить и поддерживать эту страницу.
description string Описание вашего разъема.
Пользователи увидят полное описание на странице конфигурации вашего соединителя. Ссылки будут кликабельны.
Необязательно (в свойстве dataStudio )
shortDescription string Ограничение: 114 символов. Если ваш соединитель опубликован, это краткое описание будет видно на карточке галереи для вашего соединителя. Используйте это, чтобы кратко описать, что делает ваш соединитель. Пользователи смогут просмотреть это, просматривая соединители в галерее.
privacyPolicyUrl string (link) Ссылка на Политику конфиденциальности коннектора/организации-разработчика.
termsOfServiceUrl string (link) Ссылка на Условия предоставления услуг для коннектора/организации-разработчика.
authType list( AuthType ) Тип метода аутентификации для вашего соединителя. См. AuthType ниже.
feeType list( FeeType ) Указывает тип платы для вашего соединителя. См. Тип комиссии ниже.
sources list( Sources ) Список источников данных, к которым может подключаться этот соединитель. См. Источники ниже.
templates Object Список шаблонов, которые можно использовать с этим соединителем. Поддерживается только один шаблон по умолчанию, определяемый установкой ключа default . Значением должен быть идентификатор отчета Looker Studio, который будет использоваться в качестве шаблона. См. руководство « Предоставление шаблонов отчетов» .
forceViewersCredentials boolean Следует ли принудительно использовать учетные данные зрителя для источников данных, созданных из этого соединителя. Это свойство является необязательным и по умолчанию имеет значение false . Дополнительные сведения об учетных данных пользователя см. в разделе Учетные данные источника данных .
useQueryConfig boolean УСТАРЕЛО : будет ли этот соединитель возвращать конфигурацию запроса для getData(). Вместо этого используйте «advancedServices».
advancedServices.data boolean Будет ли этот соединитель возвращать конфигурацию запроса для getData(). См. дополнительные услуги .
advancedServices.schema boolean Будет ли этот соединитель возвращать конфигурацию запроса для getSchema(). См. дополнительные услуги .
Необязательно (свойство корневого уровня)
urlFetchWhitelist list(string) Список префиксов URL-адресов HTTPS, которые использует ваш соединитель. Любая полученная конечная точка URL-адреса должна соответствовать одному из префиксов в этом списке. Это может помочь защитить пользовательские данные. Дополнительные сведения см. в разделе URL-адреса в списке безопасных .

Тип аутентификации

Значения типа метода аутентификации могут быть одним из следующих:

Перечисляемое значение Описание
NONE Указывает, что для соединителя не требуется проверка подлинности.
OAUTH2 Указывает, что соединитель использует OAuth 2.0.
KEY Указывает, что соединитель использует ключ API.
USER_PASS Указывает, что соединитель использует имя пользователя и пароль.
USER_TOKEN Указывает, что соединитель использует имя пользователя/токен.
PATH_USER_PASS Указывает, что соединитель использует путь/имя пользователя/пароль.
PATH_KEY Указывает, что соединитель использует путь/ключ.

Тип комиссии

Значения типа комиссии могут быть любыми из следующих:

Перечисляемое значение Описание
FREE Указывает на то, что разъем можно использовать совершенно бесплатно.
FREE_TRIAL Указывает, что для соединителя доступна бесплатная пробная версия.
PAID Указывает, что пользователю придется заплатить за использование соединителя.

Источники

Источники — это список перечислений для источников. Вы можете просмотреть существующий список источников в нашем хранилище реестра данных . Если источник, к которому вы подключаетесь, не существует в репозитории, отправьте запрос на включение в репозиторий реестра данных, чтобы добавить источник. Имя источника может содержать только символы верхнего регистра и символы подчеркивания (например, Google Analytics будет GOOGLE_ANALYTICS ). В манифесте Community Connector используйте значение свойства идентификатора источника данных, например GOOGLE_ANALYTICS .

Пример манифеста для соединителя сообщества

Ниже приведен пример заполненного манифеста:

студия данных/appsscript.json
{
  "dataStudio": {
    "name": "Nucleus by Hooli",
    "company": "Hooli Inc.",
    "companyUrl": "https://hooli.xyz",
    "logoUrl": "https://hooli.xyz/middle-out-optimized/nucleus/logo.png",
    "addonUrl": "https://hooli.xyz/data-studio-connector",
    "supportUrl": "https://hooli.xyz/data-studio-connector/support",
    "description": "Nucleus by Hooli connector lets you connect to your data in Data Studio using Nucleus middle out optimization. You will need an account on hooli.xyz to use this connector. Create your account at https://hooli.xyz/signup",
    "shortDescription": "Connect to your data using Nucleus middle out optimization",
    "privacyPolicyUrl": "https://hooli.xyz/privacy",
    "termsOfServiceUrl": "https://hooli.xyz/tos",
    "authType": ["NONE"],
    "feeType": ["PAID"],
    "sources": ["HOOLI_CHAT_LOG", "ENDFRAME_SERVER_STREAM", "RETINABYTE_USER_ANALYTICS"],
    "templates": {
      "default": "872223s89f5fdkjnd983kjf"
    }
  },
  "urlFetchWhitelist": [
    "https://api.hooli.xyz/",
    "https://hooli.xyz/"
  ]
}