Class BigQueryConfig

BigQueryConfig

Ein Konfigurationsobjekt für einen nativen BigQuery-Connector. Dieses Objekt von getData() zurückgeben damit Data Studio den Connector in BigQuery abfragen kann.

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();

Methoden

MethodeRückgabetypKurzbeschreibung
addQueryParameter(name, type, value)BigQueryConfigFügt diesem BigQueryConfig einen Abfrageparameter hinzu.
build()ObjectValidiert dieses Objekt und gibt es in dem von Data Studio benötigten Format zurück.
printJson()StringGibt die JSON-Darstellung dieses Objekts aus.
setAccessToken(accessToken)BigQueryConfigLegt das Zugriffstoken von BigQueryConfig fest.
setBillingProjectId(billingProjectId)BigQueryConfigLegt die Abrechnungsprojekt-ID für diesen BigQueryConfig fest.
setQuery(query)BigQueryConfigLegt die SQL-Abfrage von BigQueryConfig fest.
setUseStandardSql(useStandardSql)BigQueryConfigBestimmt, ob die Abfrage als Standard- oder Legacy-SQL interpretiert wird.

Detaillierte Dokumentation

addQueryParameter(name, type, value)

Fügt diesem BigQueryConfig einen Abfrageparameter hinzu.

Parameter

NameTypBeschreibung
nameStringDer Parametername.
typeBigQueryParameterTypeDer Parametertyp.
valueStringDer Parameterwert.

Rückflug

BigQueryConfig: Dieses Objekt zur Verkettung.


build()

Validiert dieses Objekt und gibt es in dem von Data Studio benötigten Format zurück.

Rückflug

Object: Das validierte Config-Objekt.


printJson()

Gibt die JSON-Darstellung dieses Objekts aus. Dies dient nur der Fehlerbehebung.

Rückflug

String


setAccessToken(accessToken)

Legt das Zugriffstoken von BigQueryConfig fest.

Parameter

NameTypBeschreibung
accessTokenStringDas festzulegende Zugriffstoken.

Rückflug

BigQueryConfig: Dieses Objekt zur Verkettung.


setBillingProjectId(billingProjectId)

Legt die Abrechnungsprojekt-ID für diesen BigQueryConfig fest.

Parameter

NameTypBeschreibung
billingProjectIdStringDie festzulegende ID des Abrechnungsprojekts.

Rückflug

BigQueryConfig: Dieses Objekt zur Verkettung.


setQuery(query)

Legt die SQL-Abfrage von BigQueryConfig fest.

Parameter

NameTypBeschreibung
queryStringDie festzulegende Abfrage.

Rückflug

BigQueryConfig: Dieses Objekt zur Verkettung.


setUseStandardSql(useStandardSql)

Bestimmt, ob die Abfrage als Standard- oder Legacy-SQL interpretiert wird.

Parameter

NameTypBeschreibung
useStandardSqlBooleanBei true wird die Abfrage als Standard-SQL interpretiert. Bei false wird die Abfrage als Legacy-SQL interpretiert.

Rückflug

BigQueryConfig: Dieses Objekt zur Verkettung.