Class Config

Конфигурация

Содержит параметры конфигурации коннектора. Эти параметры определяют, какие вопросы задаются при добавлении нового коннектора.

const cc = DataStudioApp.createCommunityConnector();
const config = cc.getConfig();

const info_entry = config.newInfo().setId('info_id').setHelpText(
    'This connector can connect to multiple data endpoints.');

Методы

Метод Тип возвращаемого значения Краткое описание
build() Object Проверяет этот объект и возвращает его в формате, необходимом для Data Studio.
new Checkbox() Checkbox Возвращает новую запись в конфигурации флажка.
new Info() Info Возвращает новую запись в конфигурации информации.
new Option Builder() Option Builder Возвращает новый конструктор параметров.
new Select Multiple() Select Multiple Возвращает новый элемент конфигурации с возможностью выбора нескольких параметров.
new Select Single() Select Single Возвращает новый выбор одной записи конфигурации.
new Text Area() Text Area Возвращает новую запись конфигурации текстового поля.
new Text Input() Text Input Возвращает новую запись в конфигурации текстового поля ввода.
print Json() String Выводит JSON-представление этого объекта.
set Date Range Required(dateRangeRequired) Config Если true , то для запросов getData() указывается диапазон дат.
set Is Stepped Config(isSteppedConfig) Config Если true , get Config() вызывается повторно с текущей пользовательской конфигурацией.

Подробная документация

build()

Проверяет этот объект и возвращает его в формате, необходимом для Data Studio.

Возвращаться

Object — проверенный объект Config .

newCheckbox()

Возвращает новую запись в конфигурации флажка.

Возвращаться

Checkbox — новая запись в настройках флажка.

newInfo()

Возвращает новую запись в конфигурации информации.

Возвращаться

Info — Новая запись в конфигурации информации.

newOptionBuilder()

Возвращает новый конструктор параметров.

Возвращаться

OptionBuilder — новый конструктор опционов.

newSelectMultiple()

Возвращает новый элемент конфигурации с возможностью выбора нескольких параметров.

Возвращаться

SelectMultiple — Новая запись в конфигурации для выбора нескольких вариантов.

newSelectSingle()

Возвращает новый выбор одной записи конфигурации.

Возвращаться

SelectSingle — Новая запись в конфигурации выбора одного элемента.

newTextArea()

Возвращает новую запись конфигурации текстового поля.

Возвращаться

TextArea — Новая запись в настройках текстового поля.

newTextInput()

Возвращает новую запись в конфигурации текстового поля ввода.

Возвращаться

TextInput — Новая запись в настройках текстового поля ввода.

printJson()

Выводит JSON-представление этого объекта. Это предназначено только для отладки.

Возвращаться

String

setDateRangeRequired(dateRangeRequired)

Если true , то для запросов getData() указывается диапазон дат.

Параметры

Имя Тип Описание
date Range Required Boolean Следует ли указывать диапазон дат для get Data() .

Возвращаться

Config — Этот конструктор предназначен для создания цепочек вызовов.

setIsSteppedConfig(isSteppedConfig)

Если true , getConfig() вызывается повторно с текущей пользовательской конфигурацией.

Параметры

Имя Тип Описание
is Stepped Config Boolean Пошаговый статус конфигурации для установки.

Возвращаться

Config — Этот конструктор предназначен для создания цепочек вызовов.