Манифест ( appsscript.json ) — это JSON-файл в вашем проекте коннектора Apps Script. Он содержит определенную информацию о вашем коннекторе сообщества, необходимую для развертывания и использования коннектора в Data 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 . Значение должно быть идентификатором отчета Data Studio, который будет использоваться в качестве шаблона. См. руководство по предоставлению шаблонов отчетов . |
forceViewersCredentials | boolean | Указывает, следует ли принудительно использовать учетные данные пользователя для источников данных, созданных с помощью этого коннектора. Это свойство является необязательным и по умолчанию имеет значение false . Дополнительные сведения об учетных данных пользователя см. в разделе «Учетные данные источника данных» . |
useQueryConfig | boolean | УСТАРЕЛО : Указывает, будет ли этот коннектор возвращать конфигурацию запроса для `getData()`. Используйте `advancedServices` вместо этого. |
advancedServices.data | boolean | Будет ли этот коннектор возвращать конфигурацию запроса для функции `getData()`. См. расширенные сервисы . |
advancedServices.schema | boolean | Будет ли этот коннектор возвращать конфигурацию запроса для функции `getSchema()`. См. расширенные сервисы . |
| Необязательно (свойство корневого уровня) | ||
urlFetchWhitelist | list(string) | Список префиксов HTTPS-адресов, используемых вашим коннектором. Любая получаемая конечная точка URL должна соответствовать одному из префиксов в этом списке. Это помогает защитить данные пользователей. Дополнительные сведения см. в разделе «Добавление URL-адресов в список разрешенных» . |
AuthType
В качестве типа метода аутентификации может использоваться одно из следующих значений:
| Значение перечисления | Описание |
|---|---|
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 ). В манифесте вашего Community Connector используйте значение свойства id источника данных, например, GOOGLE_ANALYTICS .
Пример манифеста для Community Connector
Ниже приведён пример заполненного манифеста: