Эта служба позволяет сценариям получать доступ к коннекторам сообщества Data Studio и изменять их.
Классы
| Имя | Краткое описание |
|---|---|
AggregationType | Перечисление, определяющее типы агрегирования, которые можно задать для Field . |
AuthType | Перечисление, определяющее типы аутентификации, которые можно установить для соединителя. |
BigQueryConfig | Объект конфигурации для собственного коннектора BigQuery. |
BigQueryParameterType | Перечисление, определяющее типы параметров BigQuery, которые вы можете задать. |
Checkbox | Содержит информацию о флажках для конфигурации. |
CommunityConnector | CommunityConnector позволяет сценариям получать доступ к сборщикам и утилитам, которые помогают в разработке Community Connectors для Data Studio. |
Config | Содержит записи конфигурации для соединителя. |
DataStudioApp | DataStudioApp позволяет сценариям взаимодействовать с ориентированными на разработчиков функциями Data Studio. |
DebugError | Ошибка, которая видна только администраторам коннектора. |
Field | Содержит данные, относящиеся к полю. |
FieldType | Перечисление, определяющее типы, которые можно задать для Field . |
Fields | Содержит набор Field для соединителя сообщества. |
GetAuthTypeResponse | Builder для создания ответа getAuthType() для вашего проекта скрипта. |
GetDataResponse | Builder для создания ответа getData() для вашего проекта скрипта. |
GetSchemaResponse | Builder для создания ответа getSchema() для вашего проекта скрипта. |
Info | Содержит информационные данные для конфигурации. |
OptionBuilder | Построитель для создания опций для SelectSingle и SelectMultiple . |
SelectMultiple | Содержит выбранную информацию для конфигурации. |
SelectSingle | Содержит выбранную единственную информацию для конфигурации. |
SetCredentialsResponse | Builder для создания ответа setCredentials() для вашего проекта скрипта. |
TextArea | Содержит информацию о текстовой области для конфигурации. |
TextInput | Содержит информацию для ввода текста для конфигурации. |
UserError | Ошибка, которая отображается пользователям соединителя. |
AggregationType
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
AVG | Enum | Средний. |
COUNT | Enum | Считать. |
COUNT_DISTINCT | Enum | Граф отличен. |
MAX | Enum | Макс. |
MIN | Enum | Мин. |
SUM | Enum | Сумма. |
AUTO | Enum | Авто. |
AuthType
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
NONE | Enum | Никакой авторизации не требуется. |
OAUTH2 | Enum | Требуется авторизация OAuth2. |
USER_PASS | Enum | Необходимы учетные данные имени пользователя и пароля. |
PATH_USER_PASS | Enum | Необходимо имя пользователя, путь и пароль. |
PATH_KEY | Enum | Нужен путь и ключ. |
KEY | Enum | Требуется ключ API или токен. |
USER_TOKEN | Enum | Необходимо имя пользователя и токен. |
BigQueryConfig
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
addQueryParameter(name, type, value) | BigQueryConfig | Добавляет параметр запроса в этот BigQueryConfig . |
build() | Object | Проверяет этот объект и возвращает его в формате, необходимом Data Studio. |
printJson() | String | Печатает JSON-представление этого объекта. |
setAccessToken(accessToken) | BigQueryConfig | Устанавливает токен доступа для этого BigQueryConfig . |
setBillingProjectId(billingProjectId) | BigQueryConfig | Устанавливает идентификатор проекта выставления счетов для этого BigQueryConfig . |
setQuery(query) | BigQueryConfig | Устанавливает SQL-запрос этого BigQueryConfig . |
setUseStandardSql(useStandardSql) | BigQueryConfig | Определяет, интерпретируется ли запрос как стандартный или устаревший SQL. |
BigQueryParameterType
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
STRING | Enum | Нить. |
INT64 | Enum | 64-битное целое число. |
BOOL | Enum | Логическое значение. |
FLOAT64 | Enum | 64-битное число с плавающей запятой. |
Checkbox
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
setAllowOverride(allowOverride) | Checkbox | Включает переопределение этой записи конфигурации. |
setHelpText(helpText) | Checkbox | Устанавливает текст справки для этой записи конфигурации. |
setId(id) | Checkbox | Устанавливает уникальный идентификатор для этой записи конфигурации. |
setIsDynamic(isDynamic) | Checkbox | Устанавливает динамический статус для этой записи конфигурации. |
setName(name) | Checkbox | Задает отображаемое имя для этой записи конфигурации. |
CommunityConnector
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
AggregationType | AggregationType | Перечисление AggregationType . |
AuthType | AuthType | Перечисление AuthType . |
BigQueryParameterType | BigQueryParameterType | Перечисление BigQueryParameterType . |
FieldType | FieldType | Перечисление FieldType . |
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
getConfig() | Config | Возвращает объект Config . |
getFields() | Fields | Возвращает объект Fields . |
newAuthTypeResponse() | GetAuthTypeResponse | Возвращает новый объект GetAuthTypeResponse . |
newBigQueryConfig() | BigQueryConfig | Возвращает новый объект BigQueryConfig . |
newDebugError() | DebugError | Возвращает новый объект DebugError . |
newGetDataResponse() | GetDataResponse | Возвращает новый объект GetDataResponse . |
newGetSchemaResponse() | GetSchemaResponse | Возвращает новый объект GetSchemaResponse . |
newSetCredentialsResponse() | SetCredentialsResponse | Возвращает новый объект SetCredentialsResponse . |
newUserError() | UserError | Возвращает новый объект UserError . |
Config
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
build() | Object | Проверяет этот объект и возвращает его в формате, необходимом Data Studio. |
newCheckbox() | Checkbox | Возвращает новую запись конфигурации флажка. |
newInfo() | Info | Возвращает новую запись конфигурации информации. |
newOptionBuilder() | OptionBuilder | Возвращает новый конструктор опций. |
newSelectMultiple() | SelectMultiple | Возвращает новую запись выбора нескольких конфигураций. |
newSelectSingle() | SelectSingle | Возвращает новую выбранную одну запись конфигурации. |
newTextArea() | TextArea | Возвращает новую запись конфигурации текстовой области. |
newTextInput() | TextInput | Возвращает новую запись конфигурации ввода текста. |
printJson() | String | Печатает JSON-представление этого объекта. |
setDateRangeRequired(dateRangeRequired) | Config | Если true , для запросов getData() предоставляется диапазон дат. |
setIsSteppedConfig(isSteppedConfig) | Config | Если true , getConfig() вызывается снова с текущей пользовательской конфигурацией. |
DataStudioApp
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
createCommunityConnector() | CommunityConnector | Создает новый соединитель сообщества. |
DebugError
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
printJson() | String | Печатает JSON-представление этого объекта. |
setText(text) | DebugError | Устанавливает текст ошибки отладки, который отображается только администраторам. |
throwException() | void | Запускает создание этого исключения. |
Field
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
getAggregation() | AggregationType | Возвращает AggregationType этого Field . |
getDescription() | String | Возвращает описание этого Field . |
getFormula() | String | Возвращает формулу этого Field . |
getGroup() | String | Возвращает группу этого Field . |
getId() | String | Возвращает идентификатор этого Field . |
getIsReaggregatable() | Boolean | Возвращает true , если это поле можно повторно агрегировать, в противном случае false . |
getName() | String | Возвращает имя этого Field . |
getType() | FieldType | Возвращает FieldType этого Field . |
isDefault() | Boolean | Возвращает true , если это Field является метрикой или измерением по умолчанию. |
isDimension() | Boolean | Возвращает true , если это поле является измерением. |
isHidden() | Boolean | Возвращает true , если это Field скрыто. |
isMetric() | Boolean | Возвращает true если это поле является метрикой. |
setAggregation(aggregation) | Field | Устанавливает тип агрегирования этого Field . |
setDescription(description) | Field | Устанавливает описание этого Field . |
setFormula(formula) | Field | Устанавливает формулу этого Field . |
setGroup(group) | Field | Устанавливает группу этого Field . |
setId(id) | Field | Устанавливает идентификатор этого Field . |
setIsHidden(isHidden) | Field | Устанавливает скрытый статус этого Field . |
setIsReaggregatable(isReaggregatable) | Field | Устанавливает статус разрешения реагрегации для Field . |
setName(name) | Field | Устанавливает имя этого Field . |
setType(type) | Field | Устанавливает FieldType этого Field . |
FieldType
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
YEAR | Enum | Год в формате ГГГГ, например 2017. |
YEAR_QUARTER | Enum | Год и квартал в формате ГГГГК, например 20171. |
YEAR_MONTH | Enum | Год и месяц в формате ГГГГММ, например 201703. |
YEAR_WEEK | Enum | Год и неделя в формате ГГГГвв, например 201707. |
YEAR_MONTH_DAY | Enum | Год, месяц и день в формате ГГГГММДД, например 20170317. |
YEAR_MONTH_DAY_HOUR | Enum | Год, месяц, день и час в формате ГГГГММДДЧЧ, например 2017031703. |
YEAR_MONTH_DAY_MINUTE | Enum | Год, месяц, день, час и минута в формате ГГГГММДДЧЧмм, например 201703170230. |
YEAR_MONTH_DAY_SECOND | Enum | Год, месяц, день, час, минута и секунда в формате ГГГГММДДЧЧммсс, например 20170317023017. |
QUARTER | Enum | Четверть в формате 1, 2, 3 или 4). |
MONTH | Enum | Месяц в формате ММ, например 03. |
WEEK | Enum | Неделя в формате ww типа 07. |
MONTH_DAY | Enum | Месяц и день в формате ММДД, например 0317. |
DAY_OF_WEEK | Enum | Число в диапазоне [0,6], где 0 соответствует воскресенью. |
DAY | Enum | День в формате ДД например 17. |
HOUR | Enum | Час в формате ЧЧ, например 13. |
MINUTE | Enum | Минуты в формате мм, например 12. |
DURATION | Enum | Продолжительность времени в секундах. |
COUNTRY | Enum | Такая страна, как США. |
COUNTRY_CODE | Enum | Код страны, например США. |
CONTINENT | Enum | Континент, такой как Америка. |
CONTINENT_CODE | Enum | Код континента, например 019. |
SUB_CONTINENT | Enum | Субконтинент, такой как Северная Америка. |
SUB_CONTINENT_CODE | Enum | Код субконтинента, например 003. |
REGION | Enum | Такой регион, как Калифорния. |
REGION_CODE | Enum | Код региона, например CA. |
CITY | Enum | Такой город, как Маунтин-Вью. |
CITY_CODE | Enum | Код города, например 1014044. |
METRO | Enum | Метро, такое как Сан-Франциско-Окленд-Сан-Хосе, Калифорния. |
METRO_CODE | Enum | Код метро, например 200807. |
LATITUDE_LONGITUDE | Enum | Пара широты и долготы, например 51,5074, -0,1278. |
NUMBER | Enum | Десятичное число. |
PERCENT | Enum | Десятичный процент (может быть больше 1,0). |
TEXT | Enum | Текст в свободной форме. |
BOOLEAN | Enum | Логическое значение true или false . |
URL | Enum | URL-адрес в виде текста, например https://google.com. |
HYPERLINK | Enum | Гиперссылка. |
IMAGE | Enum | Изображение. |
IMAGE_LINK | Enum | Ссылка на изображение. |
CURRENCY_AED | Enum | Валюта от AED. |
CURRENCY_ALL | Enum | Валюта от ВСЕХ. |
CURRENCY_ARS | Enum | Валюта от ARS. |
CURRENCY_AUD | Enum | Валюта AUD. |
CURRENCY_BDT | Enum | Валюта от БДТ. |
CURRENCY_BGN | Enum | Валюта от левов. |
CURRENCY_BOB | Enum | Валюта от BOB. |
CURRENCY_BRL | Enum | Валюта BRL. |
CURRENCY_CAD | Enum | Валюта из CAD. |
CURRENCY_CDF | Enum | Валюта из CDF. |
CURRENCY_CHF | Enum | Валюта из швейцарских франков. |
CURRENCY_CLP | Enum | Валюта от CLP. |
CURRENCY_CNY | Enum | Валюта от CNY. |
CURRENCY_COP | Enum | Валюта от КС. |
CURRENCY_CRC | Enum | Валюта от CRC. |
CURRENCY_CZK | Enum | Валюта от CZK. |
CURRENCY_DKK | Enum | Валюта датских крон. |
CURRENCY_DOP | Enum | Валюта от DOP. |
CURRENCY_EGP | Enum | Валюта EGP. |
CURRENCY_ETB | Enum | Валюта от ETB. |
CURRENCY_EUR | Enum | Валюта от евро. |
CURRENCY_GBP | Enum | Валюта от GBP. |
CURRENCY_HKD | Enum | Валюта Гонконгского доллара. |
CURRENCY_HRK | Enum | Валюта от HRK. |
CURRENCY_HUF | Enum | Валюта из венгерских форинтов. |
CURRENCY_IDR | Enum | Валюта от IDR. |
CURRENCY_ILS | Enum | Валюта от ILS. |
CURRENCY_INR | Enum | Валюта INR. |
CURRENCY_IRR | Enum | Валюта от IRR. |
CURRENCY_ISK | Enum | Валюта от ISK. |
CURRENCY_JMD | Enum | Валюта от JMD. |
CURRENCY_JPY | Enum | Валюта от JPY. |
CURRENCY_KRW | Enum | Валюта KRW. |
CURRENCY_LKR | Enum | Валюта от LKR. |
CURRENCY_LTL | Enum | Валюта от литов. |
CURRENCY_MNT | Enum | Валюта от MNT. |
CURRENCY_MVR | Enum | Валюта от МВР. |
CURRENCY_MXN | Enum | Валюта MXN. |
CURRENCY_MYR | Enum | Валюта MYR. |
CURRENCY_NGN | Enum | Валюта от NGN. |
CURRENCY_NOK | Enum | Валюта NOK. |
CURRENCY_NZD | Enum | Валюта новозеландский доллар. |
CURRENCY_PAB | Enum | Валюта от PAB. |
CURRENCY_PEN | Enum | Валюта из PEN. |
CURRENCY_PHP | Enum | Валюта из PHP. |
CURRENCY_PKR | Enum | Валюта PKR. |
CURRENCY_PLN | Enum | Валюта от злотых. |
CURRENCY_RON | Enum | Валюта от RON. |
CURRENCY_RSD | Enum | Валюта от РСД. |
CURRENCY_RUB | Enum | Валюта от руб. |
CURRENCY_SAR | Enum | Валюта из САР. |
CURRENCY_SEK | Enum | Валюта SEK. |
CURRENCY_SGD | Enum | Валюта SGD. |
CURRENCY_THB | Enum | Валюта THB. |
CURRENCY_TRY | Enum | Валюта TRY. |
CURRENCY_TWD | Enum | Валюта TWD. |
CURRENCY_TZS | Enum | Валюта от ТЗС. |
CURRENCY_UAH | Enum | Валюта от гривны. |
CURRENCY_USD | Enum | Валюта от долларов США. |
CURRENCY_UYU | Enum | Валюта от УЮ. |
CURRENCY_VEF | Enum | Валюта от ВЭФ. |
CURRENCY_VND | Enum | Валюта VND. |
CURRENCY_YER | Enum | Валюта от YER. |
CURRENCY_ZAR | Enum | Валюта ZAR. |
Fields
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
asArray() | Field[] | Возвращает представление этого объекта в виде массива. |
build() | Object[] | Проверяет этот объект и возвращает его в формате, необходимом Data Studio. |
forIds(ids) | Fields | Возвращает новый объект Fields , отфильтрованный по Field с идентификатором в ids . |
getDefaultDimension() | Field | Возвращает измерение по умолчанию, которое будет использоваться для набора полей. |
getDefaultMetric() | Field | Возвращает метрику по умолчанию, которая будет использоваться для набора полей. |
getFieldById(fieldId) | Field | Возвращает поле с заданным идентификатором или null , если в этом объекте Fields нет поля с этим идентификатором. |
newDimension() | Field | Возвращает новое измерение Field . |
newMetric() | Field | Возвращает новое Field метрики. |
setDefaultDimension(fieldId) | void | Устанавливает размерность по умолчанию, которая будет использоваться для набора полей. |
setDefaultMetric(fieldId) | void | Устанавливает метрику по умолчанию, которая будет использоваться для набора полей. |
GetAuthTypeResponse
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
build() | Object | Проверяет этот объект и возвращает его в формате, необходимом Data Studio. |
printJson() | String | Печатает JSON-представление этого объекта. |
setAuthType(authType) | GetAuthTypeResponse | Устанавливает AuthType строителя. |
setHelpUrl(helpUrl) | GetAuthTypeResponse | Устанавливает URL-адрес справки конструктора. |
GetDataResponse
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
addAllRows(rows) | GetDataResponse | Добавляет несколько строк данных в этот GetDataResponse . |
addRow(row) | GetDataResponse | Добавляет строку данных в этот GetDataResponse . |
build() | Object | Проверяет этот объект и возвращает его в формате, необходимом Data Studio. |
setFields(fields) | GetDataResponse | Устанавливает Fields строителя. |
setFiltersApplied(filtersApplied) | GetDataResponse | Устанавливает статус примененных фильтров для этого конструктора. |
GetSchemaResponse
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
build() | Object | Проверяет этот объект и возвращает его в формате, необходимом Data Studio. |
printJson() | String | Печатает JSON-представление этого объекта. |
setFields(fields) | GetSchemaResponse | Устанавливает Fields строителя. |
Info
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
setId(id) | Info | Устанавливает уникальный идентификатор для этой записи конфигурации. |
setText(text) | Info | Устанавливает текст для этой записи конфигурации. |
OptionBuilder
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
setLabel(label) | OptionBuilder | Устанавливает метку этого конструктора опций. |
setValue(value) | OptionBuilder | Устанавливает значение этого конструктора опций. |
SelectMultiple
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
addOption(optionBuilder) | SelectMultiple | Добавляет новую опцию выбора. |
setAllowOverride(allowOverride) | SelectMultiple | Включает переопределение этой записи конфигурации. |
setHelpText(helpText) | SelectMultiple | Устанавливает текст справки для этой записи конфигурации. |
setId(id) | SelectMultiple | Устанавливает уникальный идентификатор для этой записи конфигурации. |
setIsDynamic(isDynamic) | SelectMultiple | Устанавливает динамический статус для этой записи конфигурации. |
setName(name) | SelectMultiple | Задает отображаемое имя для этой записи конфигурации. |
SelectSingle
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
addOption(optionBuilder) | SelectSingle | Добавляет новую опцию выбора. |
setAllowOverride(allowOverride) | SelectSingle | Включает переопределение этой записи конфигурации. |
setHelpText(helpText) | SelectSingle | Устанавливает текст справки для этой записи конфигурации. |
setId(id) | SelectSingle | Устанавливает уникальный идентификатор для этой записи конфигурации. |
setIsDynamic(isDynamic) | SelectSingle | Устанавливает динамический статус для этой записи конфигурации. |
setName(name) | SelectSingle | Задает отображаемое имя для этой записи конфигурации. |
SetCredentialsResponse
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
build() | Object | Проверяет этот объект и возвращает его в формате, необходимом Data Studio. |
printJson() | String | Печатает JSON-представление этого объекта. |
setIsValid(isValid) | SetCredentialsResponse | Устанавливает действительный статус этого SetCredentialsResponse . |
TextArea
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
setAllowOverride(allowOverride) | TextArea | Включает переопределение этой записи конфигурации. |
setHelpText(helpText) | TextArea | Устанавливает текст справки для этой записи конфигурации. |
setId(id) | TextArea | Устанавливает уникальный идентификатор для этой записи конфигурации. |
setIsDynamic(isDynamic) | TextArea | Устанавливает динамический статус для этой записи конфигурации. |
setName(name) | TextArea | Задает отображаемое имя для этой записи конфигурации. |
setPlaceholder(placeholder) | TextArea | Устанавливает текст-заполнитель для этой записи конфигурации. |
TextInput
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
setAllowOverride(allowOverride) | TextInput | Включает переопределение этой записи конфигурации. |
setHelpText(helpText) | TextInput | Устанавливает текст справки для этой записи конфигурации. |
setId(id) | TextInput | Устанавливает уникальный идентификатор для этой записи конфигурации. |
setIsDynamic(isDynamic) | TextInput | Устанавливает динамический статус для этой записи конфигурации. |
setName(name) | TextInput | Задает отображаемое имя для этой записи конфигурации. |
setPlaceholder(placeholder) | TextInput | Устанавливает текст-заполнитель для этой записи конфигурации. |
UserError
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
printJson() | String | Печатает JSON-представление этого объекта. |
setDebugText(text) | UserError | Устанавливает текст ошибки отладки, который отображается только администраторам. |
setText(text) | UserError | Устанавливает текст пользовательской ошибки. |
throwException() | void | Запускает создание этого исключения. |