Class BigQueryConfig

BigQueryConfig

原生 BigQuery 连接器的配置对象。从 getData() 返回此对象,以便数据洞察查询 BigQuery 以获取连接器。

const cc = DataStudioApp.createCommunityConnector();

const bqConfig =
    cc.newBigQueryConfig()
        .setBillingProjectId('billingProjectId')
        .setQuery('queryString')
        .setUseStandardSql(true)
        .setAccessToken('accessToken')
        .addQueryParameter('dob', cc.BigQueryParameterType.STRING, '01011990')
        .build();

方法

方法返回类型简介
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。

详细文档

addQueryParameter(name, type, value)

向此 BigQueryConfig 添加查询参数。

参数

名称类型说明
nameString参数名称。
typeBigQueryParameterType参数类型。
valueString参数值。

返回

BigQueryConfig - 此对象,用于链式调用。


build()

验证此对象,并以数据分析所需的格式返回该对象。

返回

Object - 经过验证的 Config 对象。


printJson()

输出此对象的 JSON 表示法。这仅用于调试。

返回

String


setAccessToken(accessToken)

设置此 BigQueryConfig 的访问令牌。

参数

名称类型说明
accessTokenString要设置的访问令牌。

返回

BigQueryConfig - 此对象,用于链式调用。


setBillingProjectId(billingProjectId)

设置此 BigQueryConfig 的结算项目 ID。

参数

名称类型说明
billingProjectIdString要设置的结算项目 ID。

返回

BigQueryConfig - 此对象,用于链式调用。


setQuery(query)

设置此 BigQueryConfig 的 SQL 查询。

参数

名称类型说明
queryString要设置的查询。

返回

BigQueryConfig - 此对象,用于链式调用。


setUseStandardSql(useStandardSql)

确定是将查询解读为标准 SQL 还是旧版 SQL。

参数

名称类型说明
useStandardSqlBoolean如果为 true,则系统会将查询解读为标准 SQL。如果为 false,则系统会将查询解读为旧版 SQL。

返回

BigQueryConfig - 此对象,用于链式调用。