Class BigQueryConfig

BigQueryConfig

Um objeto de configuração para um conector nativo do BigQuery. Retorne esse objeto de getData(). do Data Studio para consultar o conector no BigQuery.

var cc = DataStudioApp.createCommunityConnector();
var types = cc.BigQueryParameterType;

var bqConfig = cc.newBigQueryConfig()
  .setBillingProjectId('billingProjectId')
  .setQuery('queryString')
  .setUseStandardSql(true)
  .setAccessToken('accessToken')
  .addQueryParameter('dob', types.STRING, '01011990')
  .build();

Métodos

MétodoTipo de retornoBreve descrição
addQueryParameter(name, type, value)BigQueryConfigAdiciona um parâmetro de consulta a BigQueryConfig.
build()ObjectValida esse objeto e o retorna no formato exigido pelo Data Studio.
printJson()StringImprime a representação JSON desse objeto.
setAccessToken(accessToken)BigQueryConfigDefine o token de acesso desse BigQueryConfig.
setBillingProjectId(billingProjectId)BigQueryConfigDefine o ID do projeto de faturamento deste BigQueryConfig.
setQuery(query)BigQueryConfigDefine a consulta SQL deste BigQueryConfig.
setUseStandardSql(useStandardSql)BigQueryConfigDetermina se a consulta é interpretada como SQL padrão ou legado.

Documentação detalhada

addQueryParameter(name, type, value)

Adiciona um parâmetro de consulta a BigQueryConfig.

Parâmetros

NomeTipoDescrição
nameStringO nome do parâmetro.
typeBigQueryParameterTypeTipo de parâmetro.
valueStringO valor do parâmetro.

Retornar

BigQueryConfig: este objeto, para encadeamento.


build()

Valida esse objeto e o retorna no formato exigido pelo Data Studio.

Retornar

Object: o objeto Config validado.


printJson()

Imprime a representação JSON desse objeto. Isso é apenas para depuração.

Retornar

String


setAccessToken(accessToken)

Define o token de acesso desse BigQueryConfig.

Parâmetros

NomeTipoDescrição
accessTokenStringO token de acesso a ser definido.

Retornar

BigQueryConfig: este objeto, para encadeamento.


setBillingProjectId(billingProjectId)

Define o ID do projeto de faturamento deste BigQueryConfig.

Parâmetros

NomeTipoDescrição
billingProjectIdStringO ID do projeto de faturamento a ser definido.

Retornar

BigQueryConfig: este objeto, para encadeamento.


setQuery(query)

Define a consulta SQL deste BigQueryConfig.

Parâmetros

NomeTipoDescrição
queryStringA 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

NomeTipoDescrição
useStandardSqlBooleanSe for true, a consulta será interpretada como SQL padrão. Se for false, a consulta será interpretada como SQL legado.

Retornar

BigQueryConfig: este objeto, para encadeamento.