Class BigQueryConfig
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
BigQueryConfig
Objet de configuration pour un connecteur BigQuery natif. Renvoyez cet objet à partir de getData() pour que Data Studio interroge BigQuery pour le connecteur.
const cc = DataStudioApp.createCommunityConnector();
const bqConfig =
cc.newBigQueryConfig()
.setBillingProjectId('billingProjectId')
.setQuery('queryString')
.setUseStandardSql(true)
.setAccessToken('accessToken')
.addQueryParameter('dob', cc.BigQueryParameterType.STRING, '01011990')
.build();
Documentation détaillée
addQueryParameter(name, type, value)
Ajoute un paramètre de requête à cet élément BigQueryConfig.
Paramètres
| Nom | Type | Description |
name | String | Nom du paramètre. |
type | BigQueryParameterType | Type de paramètre. |
value | String | Valeur du paramètre. |
Renvois
BigQueryConfig : cet objet, pour le chaînage.
build()
Valide cet objet et le renvoie au format requis par Data Studio.
Renvois
Object : objet Config validé.
printJson()
Imprime la représentation JSON de cet objet. Cette option est réservée au débogage.
Renvois
String
setAccessToken(accessToken)
Définit le jeton d'accès de cet élément BigQueryConfig.
Paramètres
| Nom | Type | Description |
accessToken | String | Jeton d'accès à définir. |
Renvois
BigQueryConfig : cet objet, pour le chaînage.
setBillingProjectId(billingProjectId)
Définit l'ID du projet de facturation de cet élément BigQueryConfig.
Paramètres
| Nom | Type | Description |
billingProjectId | String | ID du projet de facturation à définir. |
Renvois
BigQueryConfig : cet objet, pour le chaînage.
setQuery(query)
Définit la requête SQL de cet élément BigQueryConfig.
Paramètres
| Nom | Type | Description |
query | String | Requête à définir. |
Renvois
BigQueryConfig : cet objet, pour le chaînage.
setUseStandardSql(useStandardSql)
Détermine si la requête est interprétée en SQL standard ou en ancien SQL.
Paramètres
| Nom | Type | Description |
useStandardSql | Boolean | Si la valeur est true, la requête est interprétée en SQL standard. Si la valeur est false, la requête est interprétée comme de l'ancien SQL. |
Renvois
BigQueryConfig : cet objet, pour le chaînage.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/26 (UTC).
[null,null,["Dernière mise à jour le 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."]]
