Class DataSource

DataSource

Accedere all'origine dati esistente e modificarla. Per creare una tabella dell'origine dati con una nuova origine dati, consulta DataSourceTable.

Utilizza questa classe solo con i dati collegati a un database.

Metodi

MetodoTipo restituitoBreve descrizione
cancelAllLinkedDataSourceObjectRefreshes()voidAnnulla tutti gli aggiornamenti attualmente in esecuzione degli oggetti dell'origine dati collegati a questa origine dati.
createCalculatedColumn(name, formula)DataSourceColumnCrea una colonna calcolata.
createDataSourcePivotTableOnNewSheet()DataSourcePivotTableCrea una tabella pivot di origine dati da questa origine dati nella prima cella di un nuovo foglio.
createDataSourceTableOnNewSheet()DataSourceTableCrea una tabella dell'origine dati da questa origine dati nella prima cella di un nuovo foglio.
getCalculatedColumnByName(columnName)DataSourceColumnRestituisce la colonna calcolata nell'origine dati che corrisponde al nome della colonna.
getCalculatedColumns()DataSourceColumn[]Restituisce tutte le colonne calcolate nell'origine dati.
getColumns()DataSourceColumn[]Restituisce tutte le colonne nell'origine dati.
getDataSourceSheets()DataSourceSheet[]Restituisce i fogli dell'origine dati associati a questa origine dati.
getSpec()DataSourceSpecRecupera la specifica dell'origine dati.
refreshAllLinkedDataSourceObjects()voidAggiorna tutti gli oggetti dell'origine dati collegati all'origine dati.
updateSpec(spec)DataSourceAggiorna la specifica dell'origine dati e aggiorna gli oggetti dell'origine dati collegati a questa origine dati con la nuova specifica.
updateSpec(spec, refreshAllLinkedObjects)DataSourceConsente di aggiornare la specifica dell'origine dati e di aggiornare il campo data source sheets collegato con la nuova specifica.
waitForAllDataExecutionsCompletion(timeoutInSeconds)voidAttende il completamento di tutte le esecuzioni correnti degli oggetti dell'origine dati collegati, con timeout dopo il numero di secondi specificato.

Documentazione dettagliata

cancelAllLinkedDataSourceObjectRefreshes()

Annulla tutti gli aggiornamenti attualmente in esecuzione degli oggetti dell'origine dati collegati a questa origine dati.

Questo esempio mostra come annullare tutti gli aggiornamenti di un'origine dati.

SpreadsheetApp.enableBigQueryExecution();
const dataSource = spreadsheet.getDataSources()[0];
dataSource.cancelAllLinkedDataSourceObjectRefreshes();

Genera un'eccezione se il tipo di origine dati non è abilitato. Utilizza i metodi SpreadsheetApp#enable...Execution() per attivare l'esecuzione dei dati per il tipo di origine dati specifico.

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

createCalculatedColumn(name, formula)

Crea una colonna calcolata.

Parametri

NomeTipoDescrizione
nameStringIl nome della colonna calcolata.
formulaStringLa formula della colonna calcolata.

Ritorni

DataSourceColumn: la colonna calcolata appena creata.

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

createDataSourcePivotTableOnNewSheet()

Crea una tabella pivot di origine dati da questa origine dati nella prima cella di un nuovo foglio. Come effetto collaterale, rende il nuovo foglio attivo.

Ritorni

DataSourcePivotTable: la tabella pivot dell'origine dati appena creata.

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

createDataSourceTableOnNewSheet()

Crea una tabella dell'origine dati da questa origine dati nella prima cella di un nuovo foglio. Come effetto collaterale, rende attivo il nuovo foglio.

Ritorni

DataSourceTable: la tabella dell'origine dati appena creata.

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

getCalculatedColumnByName(columnName)

Restituisce la colonna calcolata nell'origine dati che corrisponde al nome della colonna.

Parametri

NomeTipoDescrizione
columnNameStringIl nome della colonna calcolata da recuperare.

Ritorni

DataSourceColumn: la colonna calcolata che corrisponde al nome della colonna oppure null in assenza di questa colonna calcolata.

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

getCalculatedColumns()

Restituisce tutte le colonne calcolate nell'origine dati.

Ritorni

DataSourceColumn[]: un array di tutte le colonne calcolate nell'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

getColumns()

Restituisce tutte le colonne nell'origine dati.

Ritorni

DataSourceColumn[]: un array di tutti i DataSourceColumn nell'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

getDataSourceSheets()

Restituisce i fogli dell'origine dati associati a questa origine dati.

Ritorni

DataSourceSheet[]: un array di fogli di 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

getSpec()

Recupera la specifica dell'origine dati.

Ritorni

DataSourceSpec: la specifica 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

refreshAllLinkedDataSourceObjects()

Aggiorna tutti gli oggetti dell'origine dati collegati 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 il tipo di origine dati specifico.

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

updateSpec(spec)

Aggiorna la specifica dell'origine dati e aggiorna gli oggetti dell'origine dati collegati a questa origine dati con la nuova specifica.

Genera un'eccezione se il tipo di origine dati non è abilitato. Utilizza i metodi SpreadsheetApp#enable...Execution() per attivare l'esecuzione dei dati per il tipo di origine dati specifico.

Parametri

NomeTipoDescrizione
specDataSourceSpecLa specifica dell'origine dati da utilizzare per l'aggiornamento.

Ritorni

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

updateSpec(spec, refreshAllLinkedObjects)

Consente di aggiornare la specifica dell'origine dati e di aggiornare il campo data source sheets collegato con la nuova specifica.

Genera un'eccezione se il tipo di origine dati non è abilitato. Utilizza i metodi SpreadsheetApp#enable...Execution() per attivare l'esecuzione dei dati per il tipo di origine dati specifico.

Parametri

NomeTipoDescrizione
specDataSourceSpecLa specifica dell'origine dati da utilizzare per l'aggiornamento.
refreshAllLinkedObjectsBooleanSe true, aggiorna anche tutti gli oggetti dell'origine dati collegati a questa origine dati.

Ritorni

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

waitForAllDataExecutionsCompletion(timeoutInSeconds)

Attende il completamento di tutte le esecuzioni correnti degli oggetti dell'origine dati collegati, con timeout dopo il numero di secondi specificato. Genera un'eccezione se le esecuzioni non vengono completate quando si verifica il timeout, ma non le annulla.

Parametri

NomeTipoDescrizione
timeoutInSecondsIntegerIl tempo di attesa per l'esecuzione dei dati, in secondi. Il massimo è 300 secondi.

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