Class BigQueryConfig

BigQueryConfig

Objet de configuration pour un connecteur BigQuery natif. Renvoie 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();

Méthodes

MéthodeType renvoyéBrève description
addQueryParameter(name, type, value)BigQueryConfigAjoute un paramètre de requête à ce BigQueryConfig.
build()ObjectValide cet objet et le renvoie au format requis par Data Studio.
printJson()StringAffiche la représentation JSON de cet objet.
setAccessToken(accessToken)BigQueryConfigDéfinit le jeton d'accès de ce BigQueryConfig.
setBillingProjectId(billingProjectId)BigQueryConfigDéfinit l'ID du projet de facturation de ce BigQueryConfig.
setQuery(query)BigQueryConfigDéfinit la requête SQL de ce BigQueryConfig.
setUseStandardSql(useStandardSql)BigQueryConfigDétermine si la requête est interprétée comme du SQL standard ou ancien.

Documentation détaillée

addQueryParameter(name, type, value)

Ajoute un paramètre de requête à ce BigQueryConfig.

Paramètres

NomTypeDescription
nameStringNom du paramètre.
typeBigQueryParameterTypeType de paramètre.
valueStringValeur 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()

Affiche la représentation JSON de cet objet. Ceci n'est destiné qu'au débogage.

Renvois

String


setAccessToken(accessToken)

Définit le jeton d'accès de ce BigQueryConfig.

Paramètres

NomTypeDescription
accessTokenStringJeton d'accès à définir.

Renvois

BigQueryConfig : cet objet, pour le chaînage.


setBillingProjectId(billingProjectId)

Définit l'ID du projet de facturation de ce BigQueryConfig.

Paramètres

NomTypeDescription
billingProjectIdStringID du projet de facturation à définir.

Renvois

BigQueryConfig : cet objet, pour le chaînage.


setQuery(query)

Définit la requête SQL de ce BigQueryConfig.

Paramètres

NomTypeDescription
queryStringRequête à définir.

Renvois

BigQueryConfig : cet objet, pour le chaînage.


setUseStandardSql(useStandardSql)

Détermine si la requête est interprétée comme du SQL standard ou ancien.

Paramètres

NomTypeDescription
useStandardSqlBooleanSi la valeur est true, la requête est interprétée comme du 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.