Class BigQueryDataSourceSpecBuilder

BigQueryDataSourceSpecBuilder

Der Builder für BigQueryDataSourceSpecBuilder.

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
build()	DataSourceSpec	Erstellt eine Datenquellenspezifikation anhand der Einstellungen in diesem Builder.
copy()	DataSourceSpecBuilder	Erstellt einen DataSourceSpecBuilder basierend auf den Einstellungen dieser Datenquelle.
getDatasetId()	String	Ruft die BigQuery-Dataset-ID ab.
getParameters()	DataSourceParameter[]	Ruft die Parameter der Datenquelle ab.
getProjectId()	String	Ruft die Abrechnungsprojekt-ID ab.
getRawQuery()	String	Ruft den Abfragestring im Rohformat ab.
getTableId()	String	Ruft die BigQuery-Tabellen-ID ab.
getTableProjectId()	String	Ruft die BigQuery-Projekt-ID für die Tabelle ab.
getType()	DataSourceType	Ruft den Typ der Datenquelle ab.
removeAllParameters()	BigQueryDataSourceSpecBuilder	Entfernt alle Parameter.
removeParameter(parameterName)	BigQueryDataSourceSpecBuilder	Entfernt den angegebenen Parameter.
setDatasetId(datasetId)	BigQueryDataSourceSpecBuilder	Legt die BigQuery-Dataset-ID fest.
setParameterFromCell(parameterName, sourceCell)	BigQueryDataSourceSpecBuilder	Fügt einen Parameter hinzu. Wenn der Parameter mit dem Namen bereits vorhanden ist, wird die Quellzelle für Daten quellenspezifikations-Builder vom Typ DataSourceType.BIGQUERY aktualisiert.
setProjectId(projectId)	BigQueryDataSourceSpecBuilder	Legt die BigQuery-Abrechnungsprojekt-ID fest.
setRawQuery(rawQuery)	BigQueryDataSourceSpecBuilder	Legt den Abfragestring im Rohformat fest.
setTableId(tableId)	BigQueryDataSourceSpecBuilder	Legt die BigQuery-Tabellen-ID fest.
setTableProjectId(projectId)	BigQueryDataSourceSpecBuilder	Legt die BigQuery-Projekt-ID für die Tabelle fest.

Detaillierte Dokumentation

build()

Erstellt eine Datenquellenspezifikation anhand der Einstellungen in diesem Builder. Vor dem Erstellen muss mit as...() ein Datenquellentyp angegeben werden.

Im folgenden Codebeispiel wird eine BigQuery-Datenquellenspezifikation erstellt.

const bigQueryDataSourceSpec = SpreadsheetApp.newDataSourceSpec().asBigQuery();
// TODO(developer): Replace with the required dataset, project and table IDs.
bigQueryDataSourceSpec.setDatasetId('my data set id');
bigQueryDataSourceSpec.setProjectId('my project id');
bigQueryDataSourceSpec.setTableId('my table id');

bigQueryDataSourceSpec.build();

Im folgenden Codebeispiel wird eine Looker-Datenquellenspezifikation erstellt.

const lookerDataSourceSpecBuilder =
    SpreadsheetApp.newDataSourceSpec().asLooker();
const lookerSpec = lookerDataSourceSpecBuilder.setExploreName('my explore name')
                       .setInstanceUrl('my instance url')
                       .setModelName('my model name')
                       .build();

Rückgabe

DataSourceSpec – Die Datenquellenspezifikation.

---

copy()

Erstellt einen DataSourceSpecBuilder basierend auf den Einstellungen dieser Datenquelle.

// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);
const spec = ss.getDataSources()[0].getSpec();

const newSpec = spec.copy();

Rückgabe

DataSourceSpecBuilder – Der Builder.

---

getDatasetId()

Ruft die BigQuery-Dataset-ID ab.

Rückgabe

String – Die Dataset-ID oder ein leerer String, wenn die Datenquellenspezifikation durch eine Rohabfrage definiert wird.

---

getParameters()

Ruft die Parameter der Datenquelle ab.

// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);
const spec = ss.getDataSources()[0].getSpec();
const parameters = spec.getParameters();

Diese Methode ist nur für BigQuery-Datenquellen verfügbar.

Rückgabe

DataSourceParameter[] – Die Parameterliste.

---

getProjectId()

Ruft die Abrechnungsprojekt-ID ab.

Rückgabe

String – Die Projekt-ID.

---

getRawQuery()

Ruft den Abfragestring im Rohformat ab.

Rückgabe

String – Der Abfragestring im Rohformat.

---

getTableId()

Ruft die BigQuery-Tabellen-ID ab.

Rückgabe

String – Die Tabellen-ID oder ein leerer String, wenn die Datenquellenspezifikation durch eine Rohabfrage definiert wird.

---

getTableProjectId()

Ruft die BigQuery-Projekt-ID für die Tabelle ab.

Rückgabe

String – Die Tabellenprojekt-ID oder ein leerer String, wenn die Datenquellenspezifikation durch eine Rohabfrage definiert wird.

---

getType()

Ruft den Typ der Datenquelle ab.

// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);
const spec = ss.getDataSources()[0].getSpec();
const type = spec.getType();

Rückgabe

DataSourceType – Der Datenquellentyp.

---

removeAllParameters()

Entfernt alle Parameter.

const specBuilder = SpreadsheetApp.newDataSourceSpec();
specBuilder.removeAllParameters();

Rückgabe

BigQueryDataSourceSpecBuilder – Der Builder zur Verkettung.

---

removeParameter(parameterName)

Entfernt den angegebenen Parameter.

const specBuilder = SpreadsheetApp.newDataSourceSpec();
specBuilder.removeParameter('x');

Parameter

Name	Typ	Beschreibung
parameterName	String	Der Name des zu entfernenden Parameters.

Rückgabe

BigQueryDataSourceSpecBuilder – Der Builder zur Verkettung.

---

setDatasetId(datasetId)

Legt die BigQuery-Dataset-ID fest.

Parameter

Name	Typ	Beschreibung
datasetId	String	Die ID des Datasets.

Rückgabe

BigQueryDataSourceSpecBuilder – Dieser Builder zur Verkettung.

---

setParameterFromCell(parameterName, sourceCell)

Fügt einen Parameter hinzu. Wenn der Parameter mit dem Namen bereits vorhanden ist, wird die Quellzelle für Datenquellenspezifikations-Builder vom Typ DataSourceType.BIGQUERY aktualisiert.

Diese Methode ist nur für BigQuery-Datenquellen verfügbar.

const specBuilder = SpreadsheetApp.newDataSourceSpec().asBigQuery();
specBuilder.setParameterFromCell('x', 'A1');
const bigQuerySpec = specBuilder.build();

Parameter

Name	Typ	Beschreibung
parameterName	String	Der Parametername.
sourceCell	String	Die Quellzelle in A1-Notation.

Rückgabe

BigQueryDataSourceSpecBuilder – Der Builder zur Verkettung.

---

setProjectId(projectId)

Legt die BigQuery-Abrechnungsprojekt-ID fest.

Parameter

Name	Typ	Beschreibung
projectId	String	Die ID des Abrechnungsprojekts.

Rückgabe

BigQueryDataSourceSpecBuilder – Der Builder zur Verkettung.

---

setRawQuery(rawQuery)

Legt den Abfragestring im Rohformat fest.

Parameter

Name	Typ	Beschreibung
rawQuery	String	Der Abfragestring im Rohformat.

Rückgabe

BigQueryDataSourceSpecBuilder – Der Builder zur Verkettung.

---

setTableId(tableId)

Legt die BigQuery-Tabellen-ID fest.

Parameter

Name	Typ	Beschreibung
tableId	String	Die ID der Tabelle.

Rückgabe

BigQueryDataSourceSpecBuilder – Dieser Builder zur Verkettung.

---

setTableProjectId(projectId)

Legt die BigQuery-Projekt-ID für die Tabelle fest.

Parameter

Name	Typ	Beschreibung
projectId	String	Die Projekt-ID der BigQuery-Tabelle.

Rückgabe

BigQueryDataSourceSpecBuilder – Der Builder zur Verkettung.