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 .

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()

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

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

String

set Date Range Required(dateRangeRequired)

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

Параметры

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

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

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

set Is Stepped Config(isSteppedConfig)

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

Параметры

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

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

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