Class BigQueryConfig
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
ConfiguraçãodaBigQuery
Um objeto de configuração para um conector nativo do BigQuery. Retorne este objeto de getData()
para que o Data Studio consulte o BigQuery para o conector.
const cc = DataStudioApp.createCommunityConnector();
const bqConfig =
cc.newBigQueryConfig()
.setBillingProjectId('billingProjectId')
.setQuery('queryString')
.setUseStandardSql(true)
.setAccessToken('accessToken')
.addQueryParameter('dob', cc.BigQueryParameterType.STRING, '01011990')
.build();
Documentação detalhada
addQueryParameter(name, type, value)
Adiciona um parâmetro de consulta a BigQueryConfig.
Parâmetros
| Nome | Tipo | Descrição |
name | String | O nome do parâmetro. |
type | BigQueryParameterType | Tipo de parâmetro. |
value | String | O valor do parâmetro. |
Retornar
BigQueryConfig: este objeto, para encadeamento.
build()
Valida e retorna o objeto no formato necessário para o Data Studio.
Retornar
Object: o objeto Config validado.
printJson()
Mostra a representação JSON desse objeto. Isso é apenas para depuração.
Retornar
String
setAccessToken(accessToken)
Define o token de acesso desse BigQueryConfig.
Parâmetros
| Nome | Tipo | Descrição |
accessToken | String | O token de acesso a ser definido. |
Retornar
BigQueryConfig: este objeto, para encadeamento.
setBillingProjectId(billingProjectId)
Define o ID do projeto de faturamento desse BigQueryConfig.
Parâmetros
| Nome | Tipo | Descrição |
billingProjectId | String | O ID do projeto de faturamento a ser definido. |
Retornar
BigQueryConfig: este objeto, para encadeamento.
setQuery(query)
Define a consulta SQL desse BigQueryConfig.
Parâmetros
| Nome | Tipo | Descrição |
query | String | A consulta a ser definida. |
Retornar
BigQueryConfig: este objeto, para encadeamento.
setUseStandardSql(useStandardSql)
Determina se a consulta é interpretada como SQL padrão ou legado.
Parâmetros
| Nome | Tipo | Descrição |
useStandardSql | Boolean | Se true, a consulta é interpretada como SQL padrão. Se false, a consulta é interpretada como SQL legado. |
Retornar
BigQueryConfig: este objeto, para encadeamento.
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-26 UTC.
[null,null,["Última atualização 2025-07-26 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."]]
