此页面由 Cloud Translation API 翻译。

Data Studio Service

借助此服务，脚本可以访问和修改数据洞察社区连接器。

类

名称	简介
`AggregationType`	一个枚举，用于定义可为 `Field` 设置的汇总类型。
`AuthType`	一个枚举，用于定义可为连接器设置的身份验证类型。
`BigQueryConfig`	原生 BigQuery 连接器的配置对象。
`BigQueryParameterType`	一个枚举，用于定义您可以设置的 BigQuery 参数类型。
`Checkbox`	包含配置的复选框信息。
`CommunityConnector`	借助社区连接器，脚本可以访问构建器和实用程序，以帮助开发适用于数据洞察的社区连接器。
`Config`	包含连接器的配置条目。
`DataStudioApp`	借助 DataStudio 应用，脚本可以与面向开发者的 Data Studio 功能进行交互。
`DebugError`	只有连接器的管理员才能看到此错误。
`Field`	包含与字段相关的数据。
`FieldType`	一个枚举，用于定义可为 `Field` 设置的类型。
`Fields`	包含社区连接器的一组 `Field`。
`GetAuthTypeResponse`	用于为脚本项目创建 `getAuthType()` 响应的构建器。
`GetDataResponse`	用于为脚本项目创建 `getData()` 响应的构建器。
`GetSchemaResponse`	用于为脚本项目创建 `getSchema()` 响应的构建器。
`Info`	包含配置的信息数据。
`OptionBuilder`	用于为 `SelectSingle` 和 `SelectMultiple` 创建选项的构建器。
`SelectMultiple`	包含配置的多个选定信息。
`SelectSingle`	包含配置的部分单个信息。
`SetCredentialsResponse`	用于为脚本项目创建 `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`	验证此对象，并以数据分析所需的格式返回该对象。
`printJson()`	`String`	输出此对象的 JSON 表示法。
`setAccessToken(accessToken)`	`BigQueryConfig`	设置此 `BigQueryConfig` 的访问令牌。
`setBillingProjectId(billingProjectId)`	`BigQueryConfig`	设置此 `BigQueryConfig` 的结算项目 ID。
`setQuery(query)`	`BigQueryConfig`	设置此 `BigQueryConfig` 的 SQL 查询。
`setUseStandardSql(useStandardSql)`	`BigQueryConfig`	确定是将查询解读为标准 SQL 还是旧版 SQL。

`BigQueryParameterType`

属性

属性	类型	说明
`STRING`	`Enum`	String。
`INT64`	`Enum`	64 位整数。
`BOOL`	`Enum`	布尔值。
`FLOAT64`	`Enum`	64 位浮点数。

`Checkbox`

方法

方法	返回类型	简介
`setAllowOverride(allowOverride)`	`Checkbox`	允许替换此配置条目。
`setHelpText(helpText)`	`Checkbox`	设置此配置条目的帮助文本。
`setId(id)`	`Checkbox`	设置此配置条目的唯一 ID。
`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`	验证此对象，并以数据分析所需的格式返回该对象。
`newCheckbox()`	`Checkbox`	返回新的复选框配置条目。
`newInfo()`	`Info`	返回新的 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`	返回此 `Field` 的 `AggregationType`。
`getDescription()`	`String`	返回此 `Field` 的说明。
`getFormula()`	`String`	返回此 `Field` 的公式。
`getGroup()`	`String`	返回此 `Field` 的组。
`getId()`	`String`	返回此 `Field` 的 ID。
`getIsReaggregatable()`	`Boolean`	如果此字段可以重新汇总，则返回 `true`；否则返回 `false`。
`getName()`	`String`	返回此 `Field` 的名称。
`getType()`	`FieldType`	返回此 `Field` 的 `FieldType`。
`isDefault()`	`Boolean`	如果此 `Field` 是默认指标或维度，则返回 `true`。
`isDimension()`	`Boolean`	如果此字段是维度，则返回 `true`。
`isHidden()`	`Boolean`	如果此 `Field` 处于隐藏状态，则返回 `true`。
`isMetric()`	`Boolean`	如果此字段是指标，则返回 `true`。
`setAggregation(aggregation)`	`Field`	设置此 `Field` 的汇总类型。
`setDescription(description)`	`Field`	设置此 `Field` 的说明。
`setFormula(formula)`	`Field`	设置此 `Field` 的公式。
`setGroup(group)`	`Field`	设置此 `Field` 的组。
`setId(id)`	`Field`	设置此 `Field` 的 ID。
`setIsHidden(isHidden)`	`Field`	设置此 `Field` 的隐藏状态。
`setIsReaggregatable(isReaggregatable)`	`Field`	为 `Field` 设置允许重新汇总的状态。
`setName(name)`	`Field`	设置此 `Field` 的名称。
`setType(type)`	`Field`	设置此 `Field` 的 `FieldType`。

`FieldType`

属性

属性	类型	说明
`YEAR`	`Enum`	年份，格式为 YYYY，例如 2017。
`YEAR_QUARTER`	`Enum`	年份和季度，格式为 YYYYQ，例如 20171。
`YEAR_MONTH`	`Enum`	年份和月份，采用 YYYYMM 格式，例如 201703。
`YEAR_WEEK`	`Enum`	年份和周数，采用 YYYYww 格式，例如 201707。
`YEAR_MONTH_DAY`	`Enum`	年、月和日，格式为 YYYYMMDD，例如 20170317。
`YEAR_MONTH_DAY_HOUR`	`Enum`	年、月、日和小时，格式为 YYYYMMDDHH，例如 2017031703。
`YEAR_MONTH_DAY_MINUTE`	`Enum`	年、月、日、小时和分钟，格式为 YYYYMMDDHHmm，例如 201703170230。
`YEAR_MONTH_DAY_SECOND`	`Enum`	年、月、日、小时、分钟和秒，格式为 YYYYMMDDHHmmss，例如 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`	天，采用 DD 格式，例如 17。
`HOUR`	`Enum`	小时，采用 HH 格式，例如 13。
`MINUTE`	`Enum`	分钟，采用 mm 格式，例如 12。
`DURATION`	`Enum`	时长（以秒为单位）。
`COUNTRY`	`Enum`	国家/地区，例如美国。
`COUNTRY_CODE`	`Enum`	国家/地区代码，例如 US。
`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`	网址（例如 https://google.com）。
`HYPERLINK`	`Enum`	超链接。
`IMAGE`	`Enum`	图片。
`IMAGE_LINK`	`Enum`	图片链接。
`CURRENCY_AED`	`Enum`	币种为阿联酋迪拉姆。
`CURRENCY_ALL`	`Enum`	币种为“ALL”。
`CURRENCY_ARS`	`Enum`	币种为 ARS。
`CURRENCY_AUD`	`Enum`	币种为澳元。
`CURRENCY_BDT`	`Enum`	币种为 BDT。
`CURRENCY_BGN`	`Enum`	币种为保加利亚列弗。
`CURRENCY_BOB`	`Enum`	货币来自 BOB。
`CURRENCY_BRL`	`Enum`	币种为巴西雷亚尔。
`CURRENCY_CAD`	`Enum`	币种为加元。
`CURRENCY_CDF`	`Enum`	货币来自 CDF。
`CURRENCY_CHF`	`Enum`	币种为瑞士法郎。
`CURRENCY_CLP`	`Enum`	币种为智利比索。
`CURRENCY_CNY`	`Enum`	币种为人民币。
`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`	币种为埃塞俄比亚比尔。
`CURRENCY_EUR`	`Enum`	币种为欧元。
`CURRENCY_GBP`	`Enum`	币种为英镑。
`CURRENCY_HKD`	`Enum`	币种为港元。
`CURRENCY_HRK`	`Enum`	币种为 HRK。
`CURRENCY_HUF`	`Enum`	币种为匈牙利福林 (HUF)。
`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`	币种为日元。
`CURRENCY_KRW`	`Enum`	币种为韩元 (KRW)。
`CURRENCY_LKR`	`Enum`	币种为 LKR。
`CURRENCY_LTL`	`Enum`	币种为 LTL。
`CURRENCY_MNT`	`Enum`	币种为 MNT。
`CURRENCY_MVR`	`Enum`	所用币种为 MVR。
`CURRENCY_MXN`	`Enum`	币种为墨西哥比索 (MXN)。
`CURRENCY_MYR`	`Enum`	币种为马来西亚林吉特。
`CURRENCY_NGN`	`Enum`	币种为 NGN。
`CURRENCY_NOK`	`Enum`	币种为挪威克朗 (NOK)。
`CURRENCY_NZD`	`Enum`	币种为新西兰元 (NZD)。
`CURRENCY_PAB`	`Enum`	币种为 PAB。
`CURRENCY_PEN`	`Enum`	币种为 PEN。
`CURRENCY_PHP`	`Enum`	来自 PHP 的货币。
`CURRENCY_PKR`	`Enum`	币种为 PKR。
`CURRENCY_PLN`	`Enum`	币种为波兰兹罗提。
`CURRENCY_RON`	`Enum`	币种为罗马尼亚列伊。
`CURRENCY_RSD`	`Enum`	币种为 RSD。
`CURRENCY_RUB`	`Enum`	币种为俄罗斯卢布。
`CURRENCY_SAR`	`Enum`	币种为沙特里亚尔 (SAR)。
`CURRENCY_SEK`	`Enum`	币种为瑞典克朗。
`CURRENCY_SGD`	`Enum`	币种为新加坡元 (SGD)。
`CURRENCY_THB`	`Enum`	币种为泰铢。
`CURRENCY_TRY`	`Enum`	币种为 TRY。
`CURRENCY_TWD`	`Enum`	币种为新台币。
`CURRENCY_TZS`	`Enum`	币种为 TZS。
`CURRENCY_UAH`	`Enum`	币种为乌克兰格里夫纳。
`CURRENCY_USD`	`Enum`	币种为美元。
`CURRENCY_UYU`	`Enum`	来自 UYU 的币种。
`CURRENCY_VEF`	`Enum`	币种为 VEF。
`CURRENCY_VND`	`Enum`	币种为越南盾。
`CURRENCY_YER`	`Enum`	币种为 YER。
`CURRENCY_ZAR`	`Enum`	币种为南非兰特。

`Fields`

方法

方法	返回类型	简介
`asArray()`	`Field[]`	以数组的形式返回此对象的视图。
`build()`	`Object[]`	验证此对象，并以数据分析所需的格式返回该对象。
`forIds(ids)`	`Fields`	返回一个新的 `Fields` 对象，其中包含 ID 在 `ids` 中的 `Field` 被过滤掉。
`getDefaultDimension()`	`Field`	返回要为这组字段使用的默认维度。
`getDefaultMetric()`	`Field`	返回要为这组字段使用的默认指标。
`getFieldById(fieldId)`	`Field`	返回具有指定 ID 的字段，如果此 `Fields` 对象中没有具有该 ID 的字段，则返回 `null`。
`newDimension()`	`Field`	返回新的维度 `Field`。
`newMetric()`	`Field`	返回新指标 `Field`。
`setDefaultDimension(fieldId)`	`void`	设置要为这组字段使用的默认维度。
`setDefaultMetric(fieldId)`	`void`	设置要为这组字段使用的默认指标。

`GetAuthTypeResponse`

方法

方法	返回类型	简介
`build()`	`Object`	验证此对象，并以数据分析所需的格式返回该对象。
`printJson()`	`String`	输出此对象的 JSON 表示法。
`setAuthType(authType)`	`GetAuthTypeResponse`	设置构建器的 `AuthType`。
`setHelpUrl(helpUrl)`	`GetAuthTypeResponse`	设置构建工具的帮助网址。

`GetDataResponse`

方法

方法	返回类型	简介
`addAllRows(rows)`	`GetDataResponse`	向此 `GetDataResponse` 添加多行数据。
`addRow(row)`	`GetDataResponse`	向此 `GetDataResponse` 添加一行数据。
`build()`	`Object`	验证此对象，并以数据分析所需的格式返回该对象。
`setFields(fields)`	`GetDataResponse`	设置构建器的 `Fields`。
`setFiltersApplied(filtersApplied)`	`GetDataResponse`	设置此构建器的过滤器应用状态。

`GetSchemaResponse`

方法

方法	返回类型	简介
`build()`	`Object`	验证此对象，并以数据分析所需的格式返回该对象。
`printJson()`	`String`	输出此对象的 JSON 表示法。
`setFields(fields)`	`GetSchemaResponse`	设置构建器的 `Fields`。

`Info`

方法

方法	返回类型	简介
`setId(id)`	`Info`	设置此配置条目的唯一 ID。
`setText(text)`	`Info`	设置此配置条目的文本。

`OptionBuilder`

方法

方法	返回类型	简介
`setLabel(label)`	`OptionBuilder`	设置此选项构建器的标签。
`setValue(value)`	`OptionBuilder`	设置此选项构建器的值。

`SelectMultiple`

方法

方法	返回类型	简介
`addOption(optionBuilder)`	`SelectMultiple`	添加了新的选择选项。
`setAllowOverride(allowOverride)`	`SelectMultiple`	允许替换此配置条目。
`setHelpText(helpText)`	`SelectMultiple`	设置此配置条目的帮助文本。
`setId(id)`	`SelectMultiple`	设置此配置条目的唯一 ID。
`setIsDynamic(isDynamic)`	`SelectMultiple`	设置此配置条目的动态状态。
`setName(name)`	`SelectMultiple`	设置此配置条目的显示名称。

`SelectSingle`

方法

方法	返回类型	简介
`addOption(optionBuilder)`	`SelectSingle`	添加了新的选择选项。
`setAllowOverride(allowOverride)`	`SelectSingle`	允许替换此配置条目。
`setHelpText(helpText)`	`SelectSingle`	设置此配置条目的帮助文本。
`setId(id)`	`SelectSingle`	设置此配置条目的唯一 ID。
`setIsDynamic(isDynamic)`	`SelectSingle`	设置此配置条目的动态状态。
`setName(name)`	`SelectSingle`	设置此配置条目的显示名称。

`SetCredentialsResponse`

方法

方法	返回类型	简介
`build()`	`Object`	验证此对象，并以数据分析所需的格式返回该对象。
`printJson()`	`String`	输出此对象的 JSON 表示法。
`setIsValid(isValid)`	`SetCredentialsResponse`	设置此 `SetCredentialsResponse` 的有效状态。

`TextArea`

方法

方法	返回类型	简介
`setAllowOverride(allowOverride)`	`TextArea`	允许替换此配置条目。
`setHelpText(helpText)`	`TextArea`	设置此配置条目的帮助文本。
`setId(id)`	`TextArea`	设置此配置条目的唯一 ID。
`setIsDynamic(isDynamic)`	`TextArea`	设置此配置条目的动态状态。
`setName(name)`	`TextArea`	设置此配置条目的显示名称。
`setPlaceholder(placeholder)`	`TextArea`	设置此配置条目的占位符文本。

`TextInput`

方法

方法	返回类型	简介
`setAllowOverride(allowOverride)`	`TextInput`	允许替换此配置条目。
`setHelpText(helpText)`	`TextInput`	设置此配置条目的帮助文本。
`setId(id)`	`TextInput`	设置此配置条目的唯一 ID。
`setIsDynamic(isDynamic)`	`TextInput`	设置此配置条目的动态状态。
`setName(name)`	`TextInput`	设置此配置条目的显示名称。
`setPlaceholder(placeholder)`	`TextInput`	设置此配置条目的占位符文本。

`UserError`

方法

方法	返回类型	简介
`printJson()`	`String`	输出此对象的 JSON 表示法。
`setDebugText(text)`	`UserError`	设置调试错误的文本，该文本仅向管理员显示。
`setText(text)`	`UserError`	设置用户错误的文本。
`throwException()`	`void`	触发系统抛出此异常。

Data Studio Service 使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

类

属性

属性

方法

属性

方法

属性

方法

方法

方法

方法

方法

属性

方法

方法

方法

方法

方法

方法

方法

方法

方法

方法

方法

方法

Data Studio Service