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)
build()
验证此对象,并以数据分析所需的格式返回该对象。
返回
Object
- 经过验证的 Config
对象。
printJson()
输出此对象的 JSON 表示法。这仅用于调试。
返回
String
setAccessToken(accessToken)
setBillingProjectId(billingProjectId)
setUseStandardSql(useStandardSql)
确定是将查询解读为标准 SQL 还是旧版 SQL。
参数
名称 | 类型 | 说明 |
useStandardSql | Boolean | 如果为 true ,则系统会将查询解读为标准 SQL。如果为 false ,则系统会将查询解读为旧版 SQL。 |
返回
BigQueryConfig
- 此对象,用于链式调用。
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2025-07-26。
[null,null,["最后更新时间 (UTC):2025-07-26。"],[[["\u003cp\u003e\u003ccode\u003eBigQueryConfig\u003c/code\u003e enables Data Studio connectors to query BigQuery using specified configurations.\u003c/p\u003e\n"],["\u003cp\u003eIt allows setting the billing project, query, SQL type (standard or legacy), and access token.\u003c/p\u003e\n"],["\u003cp\u003eQuery parameters can be added using \u003ccode\u003eaddQueryParameter\u003c/code\u003e with their name, type, and value.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003ebuild()\u003c/code\u003e validates the configuration and returns a \u003ccode\u003eConfig\u003c/code\u003e object for Data Studio to use.\u003c/p\u003e\n"],["\u003cp\u003eFor debugging, \u003ccode\u003eprintJson()\u003c/code\u003e provides the JSON representation of the configuration.\u003c/p\u003e\n"]]],[],null,["# Class BigQueryConfig\n\nBigQueryConfig\n\nA configuration object for a native BigQuery connector. Return this object from `get``Data()`\nfor Data Studio to query BigQuery for the connector.\n\n```javascript\nconst cc = DataStudioApp.createCommunityConnector();\n\nconst bqConfig =\n cc.newBigQueryConfig()\n .setBillingProjectId('billingProjectId')\n .setQuery('queryString')\n .setUseStandardSql(true)\n .setAccessToken('accessToken')\n .addQueryParameter('dob', cc.BigQueryParameterType.STRING, '01011990')\n .build();\n``` \n\n### Methods\n\n| Method | Return type | Brief description |\n|-------------------------------------------------------------------------------------------------|---------------------|---------------------------------------------------------------------------|\n| [addQueryParameter(name, type, value)](#addQueryParameter(String,BigQueryParameterType,String)) | [BigQueryConfig](#) | Adds a query parameter to this [BigQueryConfig](#). |\n| [build()](#build()) | `Object` | Validates this object and returns it in the format needed by Data Studio. |\n| [printJson()](#printJson()) | `String` | Prints the JSON representation of this object. |\n| [setAccessToken(accessToken)](#setAccessToken(String)) | [BigQueryConfig](#) | Sets the access token of this [BigQueryConfig](#). |\n| [setBillingProjectId(billingProjectId)](#setBillingProjectId(String)) | [BigQueryConfig](#) | Sets the billing project ID of this [BigQueryConfig](#). |\n| [setQuery(query)](#setQuery(String)) | [BigQueryConfig](#) | Sets the SQL query of this [BigQueryConfig](#). |\n| [setUseStandardSql(useStandardSql)](#setUseStandardSql(Boolean)) | [BigQueryConfig](#) | Determines if the query is interpreted as standard or legacy SQL. |\n\nDetailed documentation\n----------------------\n\n### `add``Query``Parameter(name, type, value)`\n\nAdds a query parameter to this [BigQueryConfig](#).\n\n#### Parameters\n\n| Name | Type | Description |\n|---------|--------------------------------------------------------------------------------------|----------------------|\n| `name` | `String` | The parameter name. |\n| `type` | [BigQueryParameterType](/apps-script/reference/data-studio/big-query-parameter-type) | The parameter type. |\n| `value` | `String` | The parameter value. |\n\n#### Return\n\n\n[BigQueryConfig](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `build()`\n\nValidates this object and returns it in the format needed by Data Studio.\n\n#### Return\n\n\n`Object` --- The validated [Config](/apps-script/reference/data-studio/config) object.\n\n*** ** * ** ***\n\n### `print``Json()`\n\nPrints the JSON representation of this object. This is for debugging only.\n\n#### Return\n\n\n`String`\n\n*** ** * ** ***\n\n### `set``Access``Token(accessToken)`\n\nSets the access token of this [BigQueryConfig](#).\n\n#### Parameters\n\n| Name | Type | Description |\n|-----------------|----------|--------------------------|\n| `access``Token` | `String` | The access token to set. |\n\n#### Return\n\n\n[BigQueryConfig](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `set``Billing``Project``Id(billingProjectId)`\n\nSets the billing project ID of this [BigQueryConfig](#).\n\n#### Parameters\n\n| Name | Type | Description |\n|------------------------|----------|--------------------------------|\n| `billing``Project``Id` | `String` | The billing project ID to set. |\n\n#### Return\n\n\n[BigQueryConfig](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `set``Query(query)`\n\nSets the SQL query of this [BigQueryConfig](#).\n\n#### Parameters\n\n| Name | Type | Description |\n|---------|----------|-------------------|\n| `query` | `String` | The query to set. |\n\n#### Return\n\n\n[BigQueryConfig](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `set``Use``Standard``Sql(useStandardSql)`\n\nDetermines if the query is interpreted as standard or legacy SQL.\n\n#### Parameters\n\n| Name | Type | Description |\n|----------------------|-----------|----------------------------------------------------------------------------------------------------------|\n| `use``Standard``Sql` | `Boolean` | If `true`, the query is interpreted as standard SQL. If `false`, the query is interpreted as legacy SQL. |\n\n#### Return\n\n\n[BigQueryConfig](#) --- This object, for chaining."]]