Accedere alla tabella dell'origine dati esistente e modificarla. Per creare una nuova tabella di origine dati in un nuovo foglio:
usa Spreadsheet.insertSheetWithDataSourceTable(spec)
.
Utilizza questa classe solo con le origini dati BigQuery.
Questo esempio mostra come creare una nuova tabella di origine dati.
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());
Questo esempio mostra come modificare un'origine dati.
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());
Metodi
Metodo | Tipo restituito | Breve descrizione |
---|---|---|
addColumns(columnNames) | DataSourceTable | Aggiunge colonne alla tabella dell'origine dati. |
addFilter(columnName, filterCriteria) | DataSourceTable | Aggiunge un filtro applicato alla tabella dell'origine dati. |
addSortSpec(columnName, ascending) | DataSourceTable | Aggiunge una specifica di ordinamento su una colonna nella tabella dell'origine dati. |
addSortSpec(columnName, sortOrder) | DataSourceTable | Aggiunge una specifica di ordinamento su una colonna nella tabella dell'origine dati. |
cancelDataRefresh() | DataSourceTable | Annulla l'aggiornamento dei dati associato all'oggetto se è attualmente in esecuzione. |
forceRefreshData() | DataSourceTable | Aggiorna i dati di questo oggetto indipendentemente dallo stato corrente. |
getColumns() | DataSourceTableColumn[] | Restituisce tutte le colonne dell'origine dati aggiunte alla tabella dell'origine dati. |
getDataSource() | DataSource | Recupera l'origine dati a cui è collegato l'oggetto. |
getFilters() | DataSourceTableFilter[] | Restituisce tutti i filtri applicati alla tabella dell'origine dati. |
getRange() | Range | Recupera l'Range coperto da questa tabella dell'origine dati. |
getRowLimit() | Integer | Restituisce il limite di righe per la tabella dell'origine dati. |
getSortSpecs() | SortSpec[] | Ottiene tutte le specifiche di ordinamento nella tabella dell'origine dati. |
getStatus() | DataExecutionStatus | Restituisce lo stato di esecuzione dei dati dell'oggetto. |
isSyncingAllColumns() | Boolean | Indica se la tabella dell'origine dati sta sincronizzando tutte le colonne nell'origine dati associata. |
refreshData() | DataSourceTable | Aggiorna i dati dell'oggetto. |
removeAllColumns() | DataSourceTable | Rimuove tutte le colonne nella tabella dell'origine dati. |
removeAllSortSpecs() | DataSourceTable | Rimuove tutte le specifiche di ordinamento nella tabella dell'origine dati. |
setRowLimit(rowLimit) | DataSourceTable | Aggiorna il limite di righe per la tabella dell'origine dati. |
syncAllColumns() | DataSourceTable | Sincronizza tutte le colonne correnti e future nell'origine dati associata con la tabella dell'origine dati. |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | Attende il completamento dell'esecuzione corrente, con timeout dopo il numero di secondi specificato. |
Documentazione dettagliata
addColumns(columnNames)
Aggiunge colonne alla tabella dell'origine dati.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
columnNames | String[] | L'elenco dei nomi delle colonne da aggiungere. |
Invio
DataSourceTable
: tabella dell'origine dati, per il concatenamento.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addFilter(columnName, filterCriteria)
Aggiunge un filtro applicato alla tabella dell'origine dati.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
columnName | String | Il nome della colonna a cui applicare questo filtro. |
filterCriteria | FilterCriteria | I criteri di filtro da applicare. |
Invio
DataSourceTable
: la tabella dell'origine dati per l'accodamento.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addSortSpec(columnName, ascending)
Aggiunge una specifica di ordinamento su una colonna nella tabella dell'origine dati.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
columnName | String | Il nome della colonna da ordinare. |
ascending | Boolean | Se true , ordina la colonna in ordine crescente; se false , ordina
la colonna in ordine decrescente. |
Invio
DataSourceTable
: il foglio dell'origine dati, per il concatenamento.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addSortSpec(columnName, sortOrder)
Aggiunge una specifica di ordinamento su una colonna nella tabella dell'origine dati.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
columnName | String | Il nome della colonna da ordinare. |
sortOrder | SortOrder | L'ordinamento. |
Invio
DataSourceTable
: il foglio dell'origine dati per l'accodamento.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
cancelDataRefresh()
Annullerà l'aggiornamento dei dati associato a questo oggetto se è attualmente in esecuzione.
Questo esempio mostra come annullare un aggiornamento della formula.
const spreadsheet = SpreadsheetApp.getActive(); const formula = spreadsheet.getDataSourceFormulas()[0]; // Cancel the ongoing refresh on the formula. formula.cancelDataRefresh();
Viene lanciata un'eccezione se il tipo di origine dati non è abilitato. Utilizza i metodi SpreadsheetApp#enable...Execution()
per attivare l'esecuzione dei dati per un'origine dati specifica
di testo.
Invio
DataSourceTable
: l'oggetto dati.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
forceRefreshData()
Aggiorna i dati dell'oggetto indipendentemente dallo stato attuale. Vedi refreshData()
per
ulteriori dettagli. Se vuoi annullare un aggiornamento attualmente in esecuzione di questo oggetto, consulta cancelDataRefresh()
.
Viene lanciata un'eccezione se il tipo di origine dati non è abilitato. Utilizza i metodi SpreadsheetApp#enable...Execution()
per attivare l'esecuzione dei dati per un'origine dati specifica
di testo.
Invio
DataSourceTable
: l'oggetto dati.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getColumns()
Restituisce tutte le colonne dell'origine dati aggiunte alla tabella dell'origine dati.
Invio
DataSourceTableColumn[]
: un elenco di colonne della tabella dell'origine dati.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataSource()
Recupera l'origine dati a cui è collegato l'oggetto.
Invio
DataSource
: l'origine dati.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFilters()
Restituisce tutti i filtri applicati alla tabella dell'origine dati.
Invio
DataSourceTableFilter[]
: un array di tutti i filtri applicati alla tabella dell'origine dati.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getRange()
Ottiene i Range
misurati da questa tabella di origine dati.
Invio
Range
: l'intervallo.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getRowLimit()
Restituisce il limite di righe per la tabella dell'origine dati.
Invio
Integer
: il limite di righe per la tabella dell'origine dati o null
se non è impostato alcun limite e
utilizza il limite massimo predefinito come nella UI di Fogli Google.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getSortSpecs()
Ottiene tutte le specifiche di ordinamento nella tabella dell'origine dati.
Invio
SortSpec[]
: un elenco di specifiche di ordinamento.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getStatus()
Restituisce lo stato di esecuzione dei dati dell'oggetto.
Invio
DataExecutionStatus
: lo stato di esecuzione dei dati.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
isSyncingAllColumns()
Indica se la tabella dell'origine dati sta sincronizzando tutte le colonne nell'origine dati associata.
Invio
Boolean
- True
se la tabella dell'origine dati sta sincronizzando tutte le colonne nei dati associati
oppure false
.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
refreshData()
Aggiorna i dati dell'oggetto.
Genera un'eccezione se attualmente è nello stato error
. Utilizza DataSource#updateSpec()
per aggiornare la specifica. Il metodo è
preferito rispetto a forceRefreshData()
per evitare modifiche impreviste all'origine dati.
Genera un'eccezione se il tipo di origine dati non è abilitato. Utilizza i metodi SpreadsheetApp#enable...Execution()
per attivare l'esecuzione dei dati per un'origine dati specifica
di testo.
Invio
DataSourceTable
: l'oggetto dati.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
removeAllColumns()
Rimuove tutte le colonne nella tabella dell'origine dati.
Invio
DataSourceTable
: tabella dell'origine dati, per il concatenamento.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
removeAllSortSpecs()
Rimuove tutte le specifiche di ordinamento nella tabella dell'origine dati.
Invio
DataSourceTable
: il foglio dell'origine dati, per il concatenamento.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setRowLimit(rowLimit)
Aggiorna il limite di righe per la tabella dell'origine dati. Se il limite di righe fornito è null
,
aggiorna la tabella dell'origine dati in modo che utilizzi il limite massimo predefinito di righe come nella UI di Fogli Google.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
rowLimit | Integer | Il nuovo limite di righe per la tabella di dati. Se null , aggiorna la tabella per utilizzare
il limite di righe predefinito. |
Invio
DataSourceTable
: tabella dell'origine dati, per il concatenamento.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
syncAllColumns()
Sincronizzare tutte le colonne attuali e future dell'origine dati associata con la tabella dell'origine dati.
Invio
DataSourceTable
: tabella dell'origine dati, per il concatenamento.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
waitForCompletion(timeoutInSeconds)
Attende il completamento dell'esecuzione corrente, con timeout dopo il numero di secondi specificato. Genera un'eccezione se l'esecuzione non viene completata in caso di timeout, ma non annulla l'evento nell'esecuzione dei dati.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
timeoutInSeconds | Integer | Il tempo di attesa dell'esecuzione dei dati, in secondi. Il massimo è 300 secondi. |
Invio
DataExecutionStatus
: lo stato di esecuzione dei dati.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets