Class BigQueryConfig

BigQueryConfig

Ein Konfigurationsobjekt für einen nativen BigQuery-Connector. Geben Sie dieses Objekt von getData() zurück, damit Data Studio BigQuery für den Connector abfragen kann.

const cc = DataStudioApp.createCommunityConnector();

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

Methoden

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

Detaillierte Dokumentation

addQueryParameter(name, type, value)

Fügt dieser 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 im 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 zu Debugging-Zwecken.

Rückflug

String


setAccessToken(accessToken)

Legt das Zugriffstoken dieser BigQueryConfig fest.

Parameter

NameTypBeschreibung
accessTokenStringDas festzulegende Zugriffstoken.

Rückflug

BigQueryConfig : Dieses Objekt zur Verkettung.


setBillingProjectId(billingProjectId)

Legt die Abrechnungsprojekt-ID dieser BigQueryConfig fest.

Parameter

NameTypBeschreibung
billingProjectIdStringDie festzulegende Abrechnungsprojekt-ID.

Rückflug

BigQueryConfig : Dieses Objekt zur Verkettung.


setQuery(query)

Legt die SQL-Abfrage dieser 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
useStandardSqlBooleanWenn true, wird die Abfrage als Standard-SQL interpretiert. Wenn false, wird die Abfrage als Legacy-SQL interpretiert.

Rückflug

BigQueryConfig : Dieses Objekt zur Verkettung.