Манифест ( appsscript.json
) — это JSON-файл в проекте коннектора Apps Script. Он содержит определённую информацию о вашем коннекторе Community, необходимую для развёртывания и использования коннектора в 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 ) | Указывает тип комиссии для вашего коннектора. См. 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 | Указывает, что соединитель использует путь/ключ. |
FeeType
Значения типа платы могут быть любыми из следующих:
Значение перечисления | Описание |
---|---|
FREE | Указывает на то, что использование соединителя абсолютно бесплатно. |
FREE_TRIAL | Указывает, что у соединителя есть возможность бесплатной пробной версии. |
PAID | Указывает, что пользователю необходимо будет заплатить за использование соединителя. |
Источники
Sources — это список перечислений для источников. Вы можете просмотреть существующий список источников в нашем репозитории реестра данных . Если источник, к которому вы подключаетесь, отсутствует в репозитории, отправьте запрос на добавление источника в репозиторий реестра данных . Имя источника может содержать только заглавные буквы и символы подчёркивания (например, Google Analytics будет GOOGLE_ANALYTICS
). В манифесте коннектора сообщества используйте значение свойства идентификатора источника данных, например, GOOGLE_ANALYTICS
.
Пример манифеста для коннектора сообщества
Ниже приведен пример заполненного манифеста: