Data Studio Service

数据洞察

此服务允许脚本访问和修改数据洞察社区连接器

名称简介
AggregationType用于定义可以为 Field 设置的聚合类型的枚举。
AuthType用于定义可为连接器设置的身份验证类型的枚举。
BigQueryConfig原生 BigQuery 连接器的配置对象。
BigQueryParameterType用于定义您可以设置的 BigQuery 参数类型的枚举。
Checkbox包含配置的复选框信息。
CommunityConnector借助 CommunityConnector,脚本可以访问构建器和实用程序,从而开发适用于数据洞察的社区连接器。
Config包含连接器的配置条目。
DataStudioAppDataStudioApp 允许脚本与面向开发者的数据洞察功能进行交互。
DebugError只有连接器管理员才能看到的错误。
Field包含与字段相关的数据。
FieldType一个枚举,用于定义可以为 Field 设置的类型。
Fields包含社区连接器的一组 Field
GetAuthTypeResponse用于为脚本项目创建 getAuthType() 响应的构建器。
GetDataResponse用于为脚本项目创建 getData() 响应的构建器。
GetSchemaResponse用于为脚本项目创建 getSchema() 响应的构建器。
Info包含配置的信息数据。
OptionBuilder用于创建 SelectSingleSelectMultiple 选项的构建器。
SelectMultiple包含用于配置的多项信息。
SelectSingle包含配置的单个选定信息。
SetCredentialsResponse用于为脚本项目创建 setCredentials() 响应的构建器。
TextArea包含配置的文本区域信息。
TextInput包含配置的文本输入信息。
UserError向连接器用户显示的错误。

AggregationType

属性

媒体资源类型说明
AVGEnum平均值。
COUNTEnum数量。
COUNT_DISTINCTEnum非重复计数。
MAXEnum“尽可能
MINEnum最低
SUMEnum总和
AUTOEnum自动。

AuthType

属性

媒体资源类型说明
NONEEnum无需授权。
OAUTH2Enum需要 OAuth2 授权。
USER_PASSEnum需要提供用户名和密码凭据。
PATH_USER_PASSEnum需要提供用户名、路径和密码。
PATH_KEYEnum所需的路径和键。
KEYEnum需要 API 密钥或令牌。
USER_TOKENEnum需要用户名和令牌。

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

属性

媒体资源类型说明
STRINGEnumString。
INT64Enum64 位整数。
BOOLEnum布尔值。
FLOAT64Enum64 位浮点数。

Checkbox

方法

方法返回类型简介
setAllowOverride(allowOverride)Checkbox允许覆盖此配置条目。
setHelpText(helpText)Checkbox设置此配置条目的帮助文本。
setId(id)Checkbox设置此配置条目的唯一 ID。
setIsDynamic(isDynamic)Checkbox设置此配置条目的动态状态。
setName(name)Checkbox设置此配置条目的显示名称。

CommunityConnector

属性

媒体资源类型说明
AggregationTypeAggregationTypeAggregationType 枚举。
AuthTypeAuthTypeAuthType 枚举。
BigQueryParameterTypeBigQueryParameterTypeBigQueryParameterType 枚举。
FieldTypeFieldTypeFieldType 枚举。

方法

方法返回类型简介
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返回新的信息配置条目。
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返回该 FieldAggregationType
getDescription()String返回此 Field 的说明。
getFormula()String返回此 Field 的公式。
getGroup()String返回此 Field 的组。
getId()String返回此 Field 的 ID。
getIsReaggregatable()Boolean如果此字段可以重新汇总,则返回 true,否则返回 false
getName()String返回此 Field 的名称。
getType()FieldType返回该 FieldFieldType
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)FieldField 设置允许重新汇总的状态。
setName(name)Field设置此 Field 的名称。
setType(type)Field设置此 FieldFieldType

FieldType

属性

媒体资源类型说明
YEAREnum采用 YYYY 格式的年份,例如 2017。
YEAR_QUARTEREnum采用 YYYYQ 格式的年份和季度,例如 20171。
YEAR_MONTHEnum采用 YYYYMM 格式的年份和月份,例如 201703。
YEAR_WEEKEnum采用 YYYYwa 格式的年份和星期,例如 201707。
YEAR_MONTH_DAYEnum采用 YYYYMMDD 格式的年、月和日,例如 20170317。
YEAR_MONTH_DAY_HOUREnum采用 YYYYMMDDHH 格式的年、月、日和小时,例如 2017031703。
YEAR_MONTH_DAY_MINUTEEnum采用 YYYYMMDDHHmm 格式的年、月、日、小时和分钟,例如 201703170230。
YEAR_MONTH_DAY_SECONDEnum采用 YYYYMMDDHHmmss 格式的年、月、日、小时、分钟和秒,例如 20170317023017。
QUARTEREnum季度,格式为 1、2、3 或 4)。
MONTHEnum采用 MM 格式的月份,例如 03。
WEEKEnum以 w 格式表示的周,例如 07。
MONTH_DAYEnum采用 MMDD 格式的月份和日期,例如 0317。
DAY_OF_WEEKEnum介于 [0,6] 范围内的数字,其中 0 表示星期日。
DAYEnum日期,采用 DD 格式,例如 17。
HOUREnum采用 HH 格式的小时,例如 13。
MINUTEEnum采用 mm 格式的分钟,例如 12。
DURATIONEnum时长(以秒为单位)。
COUNTRYEnum国家/地区(如美国)。
COUNTRY_CODEEnum国家/地区代码,如 US。
CONTINENTEnum大洲,例如美洲。
CONTINENT_CODEEnum大洲代码,例如 019。
SUB_CONTINENTEnum某个次大陆(例如北美)。
SUB_CONTINENT_CODEEnum次大陆代码,例如 003。
REGIONEnum某个地区(例如加利福尼亚州)。
REGION_CODEEnum地区代码,例如 CA。
CITYEnum城市,如 Mountain View。
CITY_CODEEnum城市代码,例如 1014044。
METROEnum都市圈,如加利福尼亚州圣弗朗西斯科-奥克兰-圣何塞。
METRO_CODEEnum都市圈代码,例如 200807。
LATITUDE_LONGITUDEEnum纬度经度对,例如 51.5074, -0.1278。
NUMBEREnum一个十进制数字。
PERCENTEnum十进制百分比(可以超过 1.0)。
TEXTEnum自由格式文本。
BOOLEANEnumtruefalse 布尔值。
URLEnum网址(例如 https://google.com)。
HYPERLINKEnum超链接。
IMAGEEnum图片。
IMAGE_LINKEnum图片链接。
CURRENCY_AEDEnum币种为阿联酋迪拉姆。
CURRENCY_ALLEnum币种从 ALL。
CURRENCY_ARSEnum货币(阿根廷比索)。
CURRENCY_AUDEnum币种为澳元。
CURRENCY_BDTEnum币种为 BDT。
CURRENCY_BGNEnum币种为保加利亚列弗。
CURRENCY_BOBEnum币种为玻利维亚诺。
CURRENCY_BRLEnum巴西雷亚尔。
CURRENCY_CADEnum币种为加元。
CURRENCY_CDFEnumCDF 提供的货币。
CURRENCY_CHFEnum瑞士法郎。
CURRENCY_CLPEnum智利比索币种。
CURRENCY_CNYEnum币种为人民币。
CURRENCY_COPEnum币种为哥伦比亚比索。
CURRENCY_CRCEnum哥斯达黎加科朗提供的货币。
CURRENCY_CZKEnum币种为捷克克朗。
CURRENCY_DKKEnum币种为丹麦克朗。
CURRENCY_DOPEnumDOP 币种。
CURRENCY_EGPEnum埃及镑
CURRENCY_ETBEnum以 ETB 为单位。
CURRENCY_EUREnum欧元的币种。
CURRENCY_GBPEnum币种为英镑。
CURRENCY_HKDEnum币种为港元。
CURRENCY_HRKEnumHRK 币种。
CURRENCY_HUFEnum匈牙利福林。
CURRENCY_IDREnum币种为 IDR。
CURRENCY_ILSEnum币种为以色列新谢克尔。
CURRENCY_INREnum币种为印度卢比。
CURRENCY_IRREnum以 IRR 为单位。
CURRENCY_ISKEnum冰岛克朗的货币。
CURRENCY_JMDEnum由 JMD 提供币种。
CURRENCY_JPYEnum币种为日元。
CURRENCY_KRWEnum币种为韩元。
CURRENCY_LKREnum币种为 LKR。
CURRENCY_LTLEnum币种为 LTL。
CURRENCY_MNTEnumMNT 币种。
CURRENCY_MVREnumMVR 使用的币种。
CURRENCY_MXNEnum币种为墨西哥比索。
CURRENCY_MYREnum币种为马来西亚林吉特。
CURRENCY_NGNEnum币种为 NGN。
CURRENCY_NOKEnum币种为挪威克朗。
CURRENCY_NZDEnum币种为新西兰元。
CURRENCY_PABEnumPAB 发行的货币。
CURRENCY_PENEnum币种为 秘鲁索尔。
CURRENCY_PHPEnum币种为菲律宾比索。
CURRENCY_PKREnum币种为巴基斯坦卢比。
CURRENCY_PLNEnum币种为波兰兹罗提。
CURRENCY_RONEnum币种为 RON。
CURRENCY_RSDEnum币种为塞尔维亚第纳尔。
CURRENCY_RUBEnum币种为卢布。
CURRENCY_SAREnum沙特里亚尔。
CURRENCY_SEKEnum币种为瑞典克朗。
CURRENCY_SGDEnum新加坡元。
CURRENCY_THBEnum币种为泰铢。
CURRENCY_TRYEnum土耳其里拉。
CURRENCY_TWDEnum币种为新台币。
CURRENCY_TZSEnumTZS 提供币种。
CURRENCY_UAHEnum币种为乌克兰格里夫纳。
CURRENCY_USDEnum币种为美元。
CURRENCY_UYUEnum币种为 UYU。
CURRENCY_VEFEnumVEF 为货币。
CURRENCY_VNDEnum币种为越南盾。
CURRENCY_YEREnum币种为 YER。
CURRENCY_ZAREnum南非兰特。

Fields

方法

方法返回类型简介
asArray()Field[]以数组形式返回此对象的视图。
build()Object[]验证此对象,并以数据洞察所需的格式返回该对象。
forIds(ids)Fields返回一个新的 Fields 对象,该对象过滤为 Field 且 ID 为 ids
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触发此异常被抛出。