Class BigQueryConfig
Stay organized with collections
Save and categorize content based on your preferences.
BigQueryConfig
A configuration object for a native BigQuery connector. Return this object from getData()
for Data Studio to query BigQuery for the connector.
const cc = DataStudioApp.createCommunityConnector();
const bqConfig =
cc.newBigQueryConfig()
.setBillingProjectId('billingProjectId')
.setQuery('queryString')
.setUseStandardSql(true)
.setAccessToken('accessToken')
.addQueryParameter('dob', cc.BigQueryParameterType.STRING, '01011990')
.build();
Detailed documentation
addQueryParameter(name, type, value)
build()
Validates this object and returns it in the format needed by Data Studio.
Return
Object — The validated Config object.
printJson()
Prints the JSON representation of this object. This is for debugging only.
Return
String
setAccessToken(accessToken)
Sets the access token of this BigQueryConfig.
Parameters
| Name | Type | Description |
accessToken | String | The access token to set. |
Return
BigQueryConfig — This object, for chaining.
setBillingProjectId(billingProjectId)
Sets the billing project ID of this BigQueryConfig.
Parameters
| Name | Type | Description |
billingProjectId | String | The billing project ID to set. |
Return
BigQueryConfig — This object, for chaining.
setQuery(query)
Sets the SQL query of this BigQueryConfig.
Parameters
| Name | Type | Description |
query | String | The query to set. |
Return
BigQueryConfig — This object, for chaining.
setUseStandardSql(useStandardSql)
Determines if the query is interpreted as standard or legacy SQL.
Parameters
| Name | Type | Description |
useStandardSql | Boolean | If true, the query is interpreted as standard SQL. If false, the query is interpreted as legacy SQL. |
Return
BigQueryConfig — This object, for chaining.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-02 UTC.
[null,null,["Last updated 2024-12-02 UTC."],[[["\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."]]
