Содержит выбранную единственную информацию для конфигурации. Его свойства определяют, как выбранный сингл отображается в Data Studio.
const cc = DataStudioApp.createCommunityConnector(); const config = cc.getConfig(); const option1 = config.newOptionBuilder().setLabel('option label').setValue('option_value'); const option2 = config.newOptionBuilder() .setLabel('second option label') .setValue('option_value_2'); const info1 = config.newSelectSingle() .setId('api_endpoint') .setName('Data Type') .setHelpText('Select the data type you\'re interested in.') .setAllowOverride(true) .addOption(option1) .addOption(option2);
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
add Option(optionBuilder) | Select Single | Добавляет новую опцию выбора. |
set Allow Override(allowOverride) | Select Single | Включает переопределение этой записи конфигурации. |
set Help Text(helpText) | Select Single | Устанавливает текст справки для этой записи конфигурации. |
set Id(id) | Select Single | Устанавливает уникальный идентификатор для этой записи конфигурации. |
set Is Dynamic(isDynamic) | Select Single | Устанавливает динамический статус для этой записи конфигурации. |
set Name(name) | Select Single | Задает отображаемое имя для этой записи конфигурации. |
Подробная документация
add Option(optionBuilder)
Добавляет новую опцию выбора.
Параметры
Имя | Тип | Описание |
---|---|---|
option Builder | Option Builder | Застройщик на выбор. |
Возвращаться
Select Single
— «Этот конструктор» для создания цепочки.
set Allow Override(allowOverride)
Включает переопределение этой записи конфигурации. Если установлено значение true
, создатели источников данных имеют возможность включить это для редакторов отчетов.
Параметры
Имя | Тип | Описание |
---|---|---|
allow Override | Boolean | Можно ли переопределить эту запись конфигурации в отчетах. |
Возвращаться
Select Single
— «Этот конструктор» для создания цепочки.
set Help Text(helpText)
Устанавливает текст справки для этой записи конфигурации.
Параметры
Имя | Тип | Описание |
---|---|---|
help Text | String | HelpText для установки. |
Возвращаться
Select Single
— «Этот конструктор» для создания цепочки.
set Id(id)
Устанавливает уникальный идентификатор для этой записи конфигурации.
Параметры
Имя | Тип | Описание |
---|---|---|
id | String | Идентификатор, который необходимо установить. |
Возвращаться
Select Single
— «Этот конструктор» для создания цепочки.
set Is Dynamic(isDynamic)
Устанавливает динамический статус для этой записи конфигурации.
Если запись динамической конфигурации изменяется, последующие записи конфигурации удаляются.
Параметры
Имя | Тип | Описание |
---|---|---|
is Dynamic | Boolean | Динамический статус, который нужно установить. |
Возвращаться
Select Single
— «Этот конструктор» для объединения в цепочку.
set Name(name)
Задает отображаемое имя для этой записи конфигурации.
Параметры
Имя | Тип | Описание |
---|---|---|
name | String | Имя для установки. |
Возвращаться
Select Single
— «Этот конструктор» для объединения в цепочку.