Эта служба позволяет скриптам получать доступ к коннекторам сообщества Data Studio и изменять их.
Классы
| Имя | Краткое описание |
|---|---|
Aggregation Type | Перечисление, определяющее типы агрегирования, которые можно установить для Field . |
Auth Type | Перечисление, определяющее типы аутентификации, которые можно установить для коннектора. |
Big Query Config | Объект конфигурации для встроенного коннектора BigQuery. |
Big Query Parameter Type | Перечисление, определяющее типы параметров BigQuery, которые вы можете задать. |
Checkbox | Содержит информацию о флажках для конфигурации. |
Community Connector | CommunityConnector позволяет скриптам получать доступ к конструкторам и утилитам, что упрощает разработку коннекторов сообщества для Data Studio. |
Config | Содержит записи конфигурации для коннектора. |
Data Studio App | Приложение DataStudioApp позволяет скриптам взаимодействовать с ориентированными на разработчиков функциями Data Studio. |
Debug Error | Ошибка, видимая только администраторам коннектора. |
Field | Содержит данные, относящиеся к данной области. |
Field Type | Перечисление, определяющее типы, которые могут быть заданы для Field . |
Fields | Содержит набор Field для коннектора сообщества. |
Get Auth Type Response | Конструктор для создания ответа get Auth Type() для вашего скриптового проекта. |
Get Data Response | Конструктор для создания ответа от get Data() для вашего скриптового проекта. |
Get Schema Response | Конструктор для создания ответа от get Schema() для вашего скриптового проекта. |
Info | Содержит информационные данные для конфигурации. |
Option Builder | Конструктор для создания вариантов Select Single » и Select Multiple ». |
Select Multiple | Содержит информацию для выбора нескольких параметров конфигурации. |
Select Single | Содержит выборочную информацию по конфигурации. |
Set Credentials Response | Конструктор для создания ответа set Credentials() для вашего скриптового проекта. |
Text Area | Содержит информацию из текстовой области для конфигурации. |
Text Input | Содержит текстовую информацию для ввода в конфигурацию. |
User Error | Ошибка, отображаемая пользователям коннектора. |
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
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
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. |
BigQueryParameterType
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
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 | Задает отображаемое имя для этой записи конфигурации. |
CommunityConnector
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
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() вызывается повторно с текущей пользовательской конфигурацией. |
DataStudioApp
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
create Community Connector() | Community Connector | Создает новый коннектор сообщества. |
DebugError
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
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 . |
FieldType
Характеристики
| Свойство | Тип | Описание |
|---|---|---|
YEAR | Enum | Год в формате ГГГГ, например, 2017. |
YEAR_QUARTER | Enum | Год и квартал в формате ГГГГК, например, 20171. |
YEAR_MONTH | Enum | Год и месяц в формате ГГГГММ, например, 201703. |
YEAR_WEEK | Enum | Год и неделя в формате YYYYww, например, 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 | Месяц в формате MM, например, 03. |
WEEK | Enum | Неделя в формате ww, например, 07. |
MONTH_DAY | Enum | Месяц и день в формате MMDD, например, 0317. |
DAY_OF_WEEK | Enum | Число в диапазоне [0,6], где 0 обозначает воскресенье. |
DAY | Enum | День в формате ДД, например, 17. |
HOUR | Enum | Час в формате HH, например, 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 | Валюта из дирхамов ОАЭ. |
CURRENCY_ALL | Enum | Валюта из всех стран. |
CURRENCY_ARS | Enum | Валюта из ARS. |
CURRENCY_AUD | Enum | Валюта: австралийский доллар (AUD). |
CURRENCY_BDT | Enum | Валюта из BDT. |
CURRENCY_BGN | Enum | Валюта: болгарский лев. |
CURRENCY_BOB | Enum | Валюта из Банка Боба. |
CURRENCY_BRL | Enum | Валюта из бразильских реалов. |
CURRENCY_CAD | Enum | Валюта из канадских долларов. |
CURRENCY_CDF | Enum | Валюта из CDF. |
CURRENCY_CHF | Enum | Валюта из швейцарских франков. |
CURRENCY_CLP | Enum | Валюта из чилийских песо. |
CURRENCY_CNY | Enum | Валюта: юани (CNY). |
CURRENCY_COP | Enum | Валюта из COP. |
CURRENCY_CRC | Enum | Валюта из КНР. |
CURRENCY_CZK | Enum | Валюта: чешские кроны. |
CURRENCY_DKK | Enum | Валюта: датские кроны (DKK). |
CURRENCY_DOP | Enum | Валюта из DOP. |
CURRENCY_EGP | Enum | Валюта: египетский фунт. |
CURRENCY_ETB | Enum | Валюта из ETB. |
CURRENCY_EUR | Enum | Валюта: евро. |
CURRENCY_GBP | Enum | Валюта из фунтов стерлингов. |
CURRENCY_HKD | Enum | Валюта: гонконгский доллар. |
CURRENCY_HRK | Enum | Валюта: хорватские кунки. |
CURRENCY_HUF | Enum | Валюта из венгерских форинтов. |
CURRENCY_IDR | Enum | Валюта: индонезийская рупия. |
CURRENCY_ILS | Enum | Валюта из шекелей. |
CURRENCY_INR | Enum | Валюта: индийские рупии. |
CURRENCY_IRR | Enum | Валюта из IRR. |
CURRENCY_ISK | Enum | Валюта из ISK. |
CURRENCY_JMD | Enum | Валюта из ямайских долларов. |
CURRENCY_JPY | Enum | Валюта: японская иена. |
CURRENCY_KRW | Enum | Валюта: корейские воны (KRW). |
CURRENCY_LKR | Enum | Валюта: ланкийские рупии (LKR). |
CURRENCY_LTL | Enum | Валюта из литовских литв. |
CURRENCY_MNT | Enum | Валюта из MNT. |
CURRENCY_MVR | Enum | Валюта из MVR. |
CURRENCY_MXN | Enum | Валюта: мексиканские песо (MXN). |
CURRENCY_MYR | Enum | Валюта: малайзийский ринггит (MYR). |
CURRENCY_NGN | Enum | Валюта: нигерийская найра (NGN). |
CURRENCY_NOK | Enum | Валюта: норвежские кроны. |
CURRENCY_NZD | Enum | Валюта: новозеландский доллар. |
CURRENCY_PAB | Enum | Валюта из PAB. |
CURRENCY_PEN | Enum | Валюта из ПЕН. |
CURRENCY_PHP | Enum | Валюта из PHP. |
CURRENCY_PKR | Enum | Валюта: пакистанские рупии (PKR). |
CURRENCY_PLN | Enum | Валюта из польских злотых. |
CURRENCY_RON | Enum | Валюта из румынского лея. |
CURRENCY_RSD | Enum | Валюта из RSD. |
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 | Валюта из тайваньских долларов. |
CURRENCY_TZS | Enum | Валюта: танзанийские шиллинги (TZS). |
CURRENCY_UAH | Enum | Валюта: гривны (грн). |
CURRENCY_USD | Enum | Валюта: доллары США. |
CURRENCY_UYU | Enum | Валюта от UYU. |
CURRENCY_VEF | Enum | Валюта из ВЭФ. |
CURRENCY_VND | Enum | Валюта: вьетнамский донг. |
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 | Возвращает поле с заданным ID или null , если в объекте Fields нет поля с таким ID. |
new Dimension() | Field | Возвращает новое измерение Field . |
new Metric() | Field | Возвращает новый объект метрики Field . |
set Default Dimension(fieldId) | void | Задает измерение по умолчанию, которое будет использоваться для набора полей. |
set Default Metric(fieldId) | void | Задает метрику по умолчанию, которая будет использоваться для набора полей. |
GetAuthTypeResponse
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
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-адрес справки конструктора. |
GetDataResponse
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
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 | Устанавливает статус применения фильтров для данного конструктора. |
GetSchemaResponse
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
build() | Object | Проверяет этот объект и возвращает его в формате, необходимом для Data Studio. |
print Json() | String | Выводит JSON-представление этого объекта. |
set Fields(fields) | Get Schema Response | Задает Fields конструктора. |
Info
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
set Id(id) | Info | Задает уникальный идентификатор для этой записи конфигурации. |
set Text(text) | Info | Задает текст для этой записи конфигурации. |
OptionBuilder
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
set Label(label) | Option Builder | Задает метку для этого конструктора параметров. |
set Value(value) | Option Builder | Задает значение этого конструктора параметров. |
SelectMultiple
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
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 | Задает отображаемое имя для этой записи конфигурации. |
SelectSingle
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
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 | Задает отображаемое имя для этой записи конфигурации. |
SetCredentialsResponse
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
build() | Object | Проверяет этот объект и возвращает его в формате, необходимом для Data Studio. |
print Json() | String | Выводит JSON-представление этого объекта. |
set Is Valid(isValid) | Set Credentials Response | Устанавливает допустимый статус Set Credentials Response . |
TextArea
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
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 | Задает текст-заполнитель для этой записи конфигурации. |
TextInput
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
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 | Задает текст-заполнитель для этой записи конфигурации. |
UserError
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
print Json() | String | Выводит JSON-представление этого объекта. |
set Debug Text(text) | User Error | Задает текст сообщения об ошибке отладки, который отображается только администраторам. |
set Text(text) | User Error | Задает текст сообщения об ошибке для пользователя. |
throw Exception() | void | Приводит к возникновению этого исключения. |