Class DataSourceTable

DataSourceTable

Uzyskuj dostęp do tabeli źródeł danych i modyfikuj ją. Aby utworzyć nową tabelę źródła danych w nowym arkuszu, użyj Spreadsheet.insertSheetWithDataSourceTable(spec).

Ten przykład pokazuje, jak utworzyć nową tabelę źródeł danych.

SpreadsheetApp.enableBigQueryExecution();
var spreadsheet = SpreadsheetApp.getActive();
var spec = SpreadsheetApp.newDataSourceSpec()
           .asBigQuery()
           .setProjectId('big_query_project')
           .setRawQuery('select @FIELD from table limit @LIMIT')
           .setParameterFromCell('FIELD', 'Sheet1!A1')
           .setParameterFromCell('LIMIT', 'namedRangeCell')
           .build();
// Starts data execution asynchronously.
var dataSheet = spreadsheet.insertSheetWithDataSourceTable(spec);
var dataSourceTable = dataSheet.getDataSourceTables()[0];
// waitForCompletion() blocks script execution until data execution completes.
dataSourceTable.waitForCompletion(60);
// Check status after execution.
Logger.log("Data execution state: %s.", dataSourceTable.getStatus().getExecutionState());

Ten przykład pokazuje, jak edytować źródło danych.

SpreadsheetApp.enableBigQueryExecution();
var dataSheet = SpreadsheetApp.getActive().getSheetByName("Data Sheet 1");
var dataSourceTable = dataSheet.getDataSourceTables()[0];
var dataSource = dataSourceTable.getDataSource();
var newSpec = dataSource.getSpec()
              .copy()
              .asBigQuery()
              .setRawQuery('select name from table limit 2')
              .removeAllParameters()
              .build();
// Updates data source specification and starts data execution asynchronously.
dataSource.updateSpec(newSpec);
// Check status during execution.
Logger.log("Data execution state: %s.", dataSourceTable.getStatus().getExecutionState());
// waitForCompletion() blocks script execution until data execution completes.
dataSourceTable.waitForCompletion(60);
// Check status after execution.
Logger.log("Data execution state: %s.", dataSourceTable.getStatus().getExecutionState());

Metody

MetodaZwracany typKrótki opis
addColumns(columnNames)DataSourceTableDodaje kolumny do tabeli źródeł danych.
addFilter(columnName, filterCriteria)DataSourceTableDodaje filtr zastosowany do tabeli źródeł danych.
addSortSpec(columnName, ascending)DataSourceTableDodaje specyfikację sortowania w kolumnie w tabeli źródeł danych.
addSortSpec(columnName, sortOrder)DataSourceTableDodaje specyfikację sortowania w kolumnie w tabeli źródeł danych.
forceRefreshData()DataSourceTableOdświeża dane tego obiektu niezależnie od bieżącego stanu.
getColumns()DataSourceTableColumn[]Pobiera wszystkie kolumny źródeł danych dodane do tabeli źródeł danych.
getDataSource()DataSourcePobiera źródło danych, z którym obiekt jest połączony.
getFilters()DataSourceTableFilter[]Zwraca wszystkie filtry zastosowane do tabeli źródła danych.
getRange()RangePobiera Range, który rozciąga się do tej tabeli źródeł danych.
getRowLimit()IntegerZwraca limit wierszy w tabeli źródeł danych.
getSortSpecs()SortSpec[]Pobiera wszystkie specyfikacje sortowania w tabeli źródeł danych.
getStatus()DataExecutionStatusPobiera stan wykonania danych obiektu.
isSyncingAllColumns()BooleanZwraca uwagę, czy tabela źródeł danych synchronizuje wszystkie kolumny w powiązanym źródle danych.
refreshData()DataSourceTableOdświeża dane obiektu.
removeAllColumns()DataSourceTableUsuwa wszystkie kolumny z tabeli źródła danych.
removeAllSortSpecs()DataSourceTableUsuwa wszystkie specyfikacje sortowania z tabeli źródeł danych.
setRowLimit(rowLimit)DataSourceTableAktualizuje limit wierszy w tabeli źródeł danych.
syncAllColumns()DataSourceTableZsynchronizuj wszystkie bieżące i przyszłe kolumny z powiązanego źródła danych z tabelą źródeł danych.
waitForCompletion(timeoutInSeconds)DataExecutionStatusPowoduje, że bieżące wykonanie zostanie zakończone po upływie określonej liczby sekund.

Szczegółowa dokumentacja

addColumns(columnNames)

Dodaje kolumny do tabeli źródeł danych.

Parametry

NazwaTypOpis
columnNamesString[]Lista nazw kolumn, które chcesz dodać.

Zwróć

DataSourceTable – tabela źródeł danych na potrzeby łańcucha.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

addFilter(columnName, filterCriteria)

Dodaje filtr zastosowany do tabeli źródeł danych.

Parametry

NazwaTypOpis
columnNameStringNazwa kolumny, do której chcesz zastosować ten filtr.
filterCriteriaFilterCriteriaKryteria filtrowania, które mają zostać zastosowane.

Zwróć

DataSourceTable – tabela źródeł danych na potrzeby łańcucha.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

addSortSpec(columnName, ascending)

Dodaje specyfikację sortowania w kolumnie w tabeli źródeł danych.

Parametry

NazwaTypOpis
columnNameStringNazwa kolumny, którą chcesz posortować.
ascendingBooleanJeśli true, sortuj kolumnę w kolejności malejącej. Jeśli false ma być posortowana w kolejności malejącej.

Zwróć

DataSourceTable – arkusz źródeł danych na potrzeby łańcucha.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

addSortSpec(columnName, sortOrder)

Dodaje specyfikację sortowania w kolumnie w tabeli źródeł danych.

Parametry

NazwaTypOpis
columnNameStringNazwa kolumny, którą chcesz posortować.
sortOrderSortOrderKolejność sortowania.

Zwróć

DataSourceTable – arkusz źródeł danych na potrzeby łańcucha.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

forceRefreshData()

Odświeża dane tego obiektu niezależnie od bieżącego stanu. Więcej informacji: refreshData().

Zwraca wyjątek, jeśli typ źródła danych nie jest włączony. Użyj metod SpreadsheetApp#enable...Execution(), aby włączyć wykonywanie danych dla określonego typu źródła danych.

Zwróć

DataSourceTable – obiekt danych;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getColumns()

Pobiera wszystkie kolumny źródeł danych dodane do tabeli źródeł danych.

Zwróć

DataSourceTableColumn[] – lista kolumn tabeli źródeł danych.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getDataSource()

Pobiera źródło danych, z którym obiekt jest połączony.

Zwróć

DataSource – źródło danych,

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getFilters()

Zwraca wszystkie filtry zastosowane do tabeli źródła danych.

Zwróć

DataSourceTableFilter[] – tablica wszystkich filtrów zastosowanych w tabeli źródeł danych

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getRange()

Pobiera Range, który rozciąga się do tej tabeli źródeł danych.

Zwróć

Range – zakres.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getRowLimit()

Zwraca limit wierszy w tabeli źródeł danych.

Zwróć

Integer – limit wierszy tabeli tabeli danych lub null, jeśli nie ustawiono limitu, a tabela używa domyślnego limitu, jak w interfejsie Arkuszy Google.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getSortSpecs()

Pobiera wszystkie specyfikacje sortowania w tabeli źródeł danych.

Zwróć

SortSpec[] – lista specyfikacji sortowania.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getStatus()

Pobiera stan wykonania danych obiektu.

Zwróć

DataExecutionStatus – stan wykonania danych.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

isSyncingAllColumns()

Zwraca uwagę, czy tabela źródeł danych synchronizuje wszystkie kolumny w powiązanym źródle danych.

Zwróć

BooleanTrue, jeśli tabela źródła danych synchronizuje wszystkie kolumny w powiązanym źródle danych lub false.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

refreshData()

Odświeża dane obiektu.

Zwraca wyjątek, jeśli obecnie jest w stanie error. Użyj DataSource#updateSpec(), aby zaktualizować specyfikację. Ta metoda jest preferowana zamiast forceRefreshData(), aby zapobiec nieoczekiwanym zmianom w źródle danych.

Zwraca wyjątek, jeśli typ źródła danych nie jest włączony. Użyj metod SpreadsheetApp#enable...Execution(), aby włączyć wykonywanie danych dla określonego typu źródła danych.

Zwróć

DataSourceTable – obiekt danych;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

removeAllColumns()

Usuwa wszystkie kolumny z tabeli źródła danych.

Zwróć

DataSourceTable – tabela źródeł danych na potrzeby łańcucha.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

removeAllSortSpecs()

Usuwa wszystkie specyfikacje sortowania z tabeli źródeł danych.

Zwróć

DataSourceTable – arkusz źródeł danych na potrzeby łańcucha.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setRowLimit(rowLimit)

Aktualizuje limit wierszy w tabeli źródeł danych. Jeśli podany limit wierszy wynosi null, aktualizujesz tabelę źródła danych, aby używała domyślnego limitu wierszy określonego w interfejsie Arkuszy Google.

Parametry

NazwaTypOpis
rowLimitIntegerNowy limit wierszy w tabeli danych. Jeśli null, zaktualizujemy tabelę, tak aby używała domyślnego limitu wierszy.

Zwróć

DataSourceTable – tabela źródeł danych na potrzeby łańcucha.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

syncAllColumns()

Zsynchronizuj wszystkie bieżące i przyszłe kolumny z powiązanego źródła danych z tabelą źródeł danych.

Zwróć

DataSourceTable – tabela źródeł danych na potrzeby łańcucha.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

waitForCompletion(timeoutInSeconds)

Powoduje, że bieżące wykonanie zostanie zakończone po upływie określonej liczby sekund. Zwraca wyjątek, jeśli wykonanie zadania nie zostanie zakończone, ale nie anuluje jego wykonania.

Parametry

NazwaTypOpis
timeoutInSecondsIntegerCzas oczekiwania na wykonanie danych (w sekundach). Maksymalna długość to 300 sekund.

Zwróć

DataExecutionStatus – stan wykonania danych.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets