Эта служба позволяет сценариям получать доступ к коннекторам сообщества Data Studio и изменять их.
Классы
| Имя | Краткое описание |
|---|---|
Aggregation Type | Перечисление, определяющее типы агрегирования, которые можно задать для Field . |
Auth Type | Перечисление, определяющее типы аутентификации, которые можно установить для соединителя. |
Big Query Config | Объект конфигурации для собственного коннектора BigQuery. |
Big Query Parameter Type | Перечисление, определяющее типы параметров BigQuery, которые вы можете задать. |
Checkbox | Содержит информацию о флажках для конфигурации. |
Community Connector | Community Connector позволяет сценариям получать доступ к сборщикам и утилитам, которые помогают в разработке Community Connectors для Data Studio. |
Config | Содержит записи конфигурации для соединителя. |
Data Studio App | Приложение Data Studio позволяет сценариям взаимодействовать с ориентированными на разработчиков функциями Data Studio. |
Debug Error | Ошибка, которая видна только администраторам коннектора. |
Field | Содержит данные, относящиеся к полю. |
Field Type | Перечисление, определяющее типы, которые можно задать для Field . |
Fields | Содержит набор Field для соединителя сообщества. |
Get Auth Type Response | Builder для создания ответа get Auth Type() для вашего проекта скрипта. |
Get Data Response | Builder для создания ответа get Data() для вашего проекта скрипта. |
Get Schema Response | Builder для создания ответа get Schema() для вашего проекта скрипта. |
Info | Содержит информационные данные для конфигурации. |
Option Builder | Конструктор для создания опций Select Single и Select Multiple s. |
Select Multiple | Содержит выбранную информацию для конфигурации. |
Select Single | Содержит выбранную единственную информацию для конфигурации. |
Set Credentials Response | Builder для создания ответа set Credentials() для вашего проекта скрипта. |
Text Area | Содержит информацию о текстовой области для конфигурации. |
Text Input | Содержит информацию для ввода текста для конфигурации. |
User Error | Ошибка, которая отображается пользователям соединителя. |
Aggregation Type
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
AVG | Enum | Средний. |
COUNT | Enum | Считать. |
COUNT_DISTINCT | Enum | Граф отличен. |
MAX | Enum | Макс. |
MIN | Enum | Мин. |
SUM | Enum | Сумма. |
AUTO | Enum | Авто. |
Auth Type
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
NONE | Enum | Никакой авторизации не требуется. |
OAUTH2 | Enum | Требуется авторизация OAuth2. |
USER_PASS | Enum | Необходимы учетные данные имени пользователя и пароля. |
PATH_USER_PASS | Enum | Необходимо имя пользователя, путь и пароль. |
PATH_KEY | Enum | Нужен путь и ключ. |
KEY | Enum | Требуется ключ API или токен. |
USER_TOKEN | Enum | Необходимо имя пользователя и токен. |
Big Query Config
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
add Query Parameter(name, type, value) | Big Query Config | Добавляет параметр запроса в эту Big Query Config . |
build() | Object | Проверяет этот объект и возвращает его в формате, необходимом Data Studio. |
print Json() | String | Печатает JSON-представление этого объекта. |
set Access Token(accessToken) | Big Query Config | Устанавливает токен доступа для этой Big Query Config . |
set Billing Project Id(billingProjectId) | Big Query Config | Устанавливает идентификатор проекта выставления счетов для этой Big Query Config . |
set Query(query) | Big Query Config | Устанавливает SQL-запрос этой Big Query Config . |
set Use Standard Sql(useStandardSql) | Big Query Config | Определяет, интерпретируется ли запрос как стандартный или устаревший SQL. |
Big Query Parameter Type
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
STRING | Enum | Нить. |
INT64 | Enum | 64-битное целое число. |
BOOL | Enum | Логическое значение. |
FLOAT64 | Enum | 64-битное число с плавающей запятой. |
Checkbox
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
set Allow Override(allowOverride) | Checkbox | Включает переопределение этой записи конфигурации. |
set Help Text(helpText) | Checkbox | Устанавливает текст справки для этой записи конфигурации. |
set Id(id) | Checkbox | Устанавливает уникальный идентификатор для этой записи конфигурации. |
set Is Dynamic(isDynamic) | Checkbox | Устанавливает динамический статус для этой записи конфигурации. |
set Name(name) | Checkbox | Задает отображаемое имя для этой записи конфигурации. |
Community Connector
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
Aggregation Type | Aggregation Type | Перечисление Aggregation Type . |
Auth Type | Auth Type | Перечисление Auth Type . |
Big Query Parameter Type | Big Query Parameter Type | Перечисление Big Query Parameter Type . |
Field Type | Field Type | Перечисление Field Type . |
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
get Config() | Config | Возвращает объект Config . |
get Fields() | Fields | Возвращает объект Fields . |
new Auth Type Response() | Get Auth Type Response | Возвращает новый объект Get Auth Type Response . |
new Big Query Config() | Big Query Config | Возвращает новый объект Big Query Config . |
new Debug Error() | Debug Error | Возвращает новый объект Debug Error . |
new Get Data Response() | Get Data Response | Возвращает новый объект Get Data Response . |
new Get Schema Response() | Get Schema Response | Возвращает новый объект Get Schema Response . |
new Set Credentials Response() | Set Credentials Response | Возвращает новый объект Set Credentials Response . |
new User Error() | User Error | Возвращает новый объект User Error . |
Config
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
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() вызывается снова с текущей пользовательской конфигурацией. |
Data Studio App
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
create Community Connector() | Community Connector | Создает новый соединитель сообщества. |
Debug Error
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
print Json() | String | Печатает JSON-представление этого объекта. |
set Text(text) | Debug Error | Устанавливает текст ошибки отладки, который отображается только администраторам. |
throw Exception() | void | Запускает создание этого исключения. |
Field
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
get Aggregation() | Aggregation Type | Возвращает Aggregation Type этого Field . |
get Description() | String | Возвращает описание этого Field . |
get Formula() | String | Возвращает формулу этого Field . |
get Group() | String | Возвращает группу этого Field . |
get Id() | String | Возвращает идентификатор этого Field . |
get Is Reaggregatable() | Boolean | Возвращает true , если это поле можно повторно агрегировать, в противном случае — false . |
get Name() | String | Возвращает имя этого Field . |
get Type() | Field Type | Возвращает Field Type этого Field . |
is Default() | Boolean | Возвращает true , если это Field является метрикой или измерением по умолчанию. |
is Dimension() | Boolean | Возвращает true если это поле является измерением. |
is Hidden() | Boolean | Возвращает true если это Field скрыто. |
is Metric() | Boolean | Возвращает true если это поле является метрикой. |
set Aggregation(aggregation) | Field | Устанавливает тип агрегирования этого Field . |
set Description(description) | Field | Устанавливает описание этого Field . |
set Formula(formula) | Field | Устанавливает формулу этого Field . |
set Group(group) | Field | Устанавливает группу этого Field . |
set Id(id) | Field | Устанавливает идентификатор этого Field . |
set Is Hidden(isHidden) | Field | Устанавливает скрытый статус этого Field . |
set Is Reaggregatable(isReaggregatable) | Field | Устанавливает статус разрешения реагрегации для Field . |
set Name(name) | Field | Устанавливает имя этого Field . |
set Type(type) | Field | Устанавливает Field Type этого Field . |
Field Type
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
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
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
as Array() | Field[] | Возвращает представление этого объекта в виде массива. |
build() | Object[] | Проверяет этот объект и возвращает его в формате, необходимом Data Studio. |
for Ids(ids) | Fields | Возвращает новый объект Fields , отфильтрованный по Field с идентификатором в ids . |
get Default Dimension() | Field | Возвращает измерение по умолчанию, которое будет использоваться для набора полей. |
get Default Metric() | Field | Возвращает метрику по умолчанию, которая будет использоваться для набора полей. |
get Field By Id(fieldId) | Field | Возвращает поле с заданным идентификатором или null если в этом объекте Fields нет поля с этим идентификатором. |
new Dimension() | Field | Возвращает новое измерение Field . |
new Metric() | Field | Возвращает новое Field метрики. |
set Default Dimension(fieldId) | void | Устанавливает размерность по умолчанию, которая будет использоваться для набора полей. |
set Default Metric(fieldId) | void | Устанавливает метрику по умолчанию, которая будет использоваться для набора полей. |
Get Auth Type Response
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
build() | Object | Проверяет этот объект и возвращает его в формате, необходимом Data Studio. |
print Json() | String | Печатает JSON-представление этого объекта. |
set Auth Type(authType) | Get Auth Type Response | Устанавливает Auth Type строителя. |
set Help Url(helpUrl) | Get Auth Type Response | Устанавливает URL-адрес справки конструктора. |
Get Data Response
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
add All Rows(rows) | Get Data Response | Добавляет несколько строк данных в этот Get Data Response . |
add Row(row) | Get Data Response | Добавляет строку данных в этот Get Data Response . |
build() | Object | Проверяет этот объект и возвращает его в формате, необходимом Data Studio. |
set Fields(fields) | Get Data Response | Устанавливает Fields строителя. |
set Filters Applied(filtersApplied) | Get Data Response | Устанавливает статус примененных фильтров для этого конструктора. |
Get Schema Response
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
build() | Object | Проверяет этот объект и возвращает его в формате, необходимом Data Studio. |
print Json() | String | Печатает JSON-представление этого объекта. |
set Fields(fields) | Get Schema Response | Устанавливает Fields строителя. |
Info
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
set Id(id) | Info | Устанавливает уникальный идентификатор для этой записи конфигурации. |
set Text(text) | Info | Устанавливает текст для этой записи конфигурации. |
Option Builder
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
set Label(label) | Option Builder | Устанавливает метку этого конструктора опций. |
set Value(value) | Option Builder | Устанавливает значение этого конструктора опций. |
Select Multiple
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
add Option(optionBuilder) | Select Multiple | Добавляет новую опцию выбора. |
set Allow Override(allowOverride) | Select Multiple | Включает переопределение этой записи конфигурации. |
set Help Text(helpText) | Select Multiple | Устанавливает текст справки для этой записи конфигурации. |
set Id(id) | Select Multiple | Устанавливает уникальный идентификатор для этой записи конфигурации. |
set Is Dynamic(isDynamic) | Select Multiple | Устанавливает динамический статус для этой записи конфигурации. |
set Name(name) | Select Multiple | Задает отображаемое имя для этой записи конфигурации. |
Select Single
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
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 | Задает отображаемое имя для этой записи конфигурации. |
Set Credentials Response
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
build() | Object | Проверяет этот объект и возвращает его в формате, необходимом Data Studio. |
print Json() | String | Печатает JSON-представление этого объекта. |
set Is Valid(isValid) | Set Credentials Response | Устанавливает действительный статус этого Set Credentials Response . |
Text Area
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
set Allow Override(allowOverride) | Text Area | Включает переопределение этой записи конфигурации. |
set Help Text(helpText) | Text Area | Устанавливает текст справки для этой записи конфигурации. |
set Id(id) | Text Area | Устанавливает уникальный идентификатор для этой записи конфигурации. |
set Is Dynamic(isDynamic) | Text Area | Устанавливает динамический статус для этой записи конфигурации. |
set Name(name) | Text Area | Задает отображаемое имя для этой записи конфигурации. |
set Placeholder(placeholder) | Text Area | Устанавливает текст-заполнитель для этой записи конфигурации. |
Text Input
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
set Allow Override(allowOverride) | Text Input | Включает переопределение этой записи конфигурации. |
set Help Text(helpText) | Text Input | Устанавливает текст справки для этой записи конфигурации. |
set Id(id) | Text Input | Устанавливает уникальный идентификатор для этой записи конфигурации. |
set Is Dynamic(isDynamic) | Text Input | Устанавливает динамический статус для этой записи конфигурации. |
set Name(name) | Text Input | Задает отображаемое имя для этой записи конфигурации. |
set Placeholder(placeholder) | Text Input | Устанавливает текст-заполнитель для этой записи конфигурации. |
User Error
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
print Json() | String | Печатает JSON-представление этого объекта. |
set Debug Text(text) | User Error | Устанавливает текст ошибки отладки, который отображается только администраторам. |
set Text(text) | User Error | Устанавливает текст пользовательской ошибки. |
throw Exception() | void | Запускает создание этого исключения. |