Class DataSource

DataSource

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

Utilizza questa classe solo con dati collegati a un database.

Metodi

MetodoTipo restituitoBreve descrizione
cancelAllLinkedDataSourceObjectRefreshes()voidAnnullerà 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 dell'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 dell'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 gli oggetti dell'origine dati collegati dell'origine dati con la nuova specifica.
updateSpec(spec, refreshAllLinkedObjects)DataSourceAggiorna la specifica dell'origine dati e aggiorna data source sheets collegato con la nuova specifica.
waitForAllDataExecutionsCompletion(timeoutInSeconds)voidAttende il completamento di tutte le esecuzioni attuali degli oggetti dell'origine dati collegati, con timeout dopo il numero di secondi specificato.

Documentazione dettagliata

cancelAllLinkedDataSourceObjectRefreshes()

Annullerà 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();

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 dati specifici tipo di origine.

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. Questo metodo è disponibile solo per le origini dati BigQuery.

Parametri

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

Invio

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 dell'origine dati da questa origine dati nella prima cella di un nuovo foglio. Come effetto collaterale, il nuovo foglio diventa il foglio attivo.

Invio

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 lato rende il nuovo foglio il foglio attivo.

Questo metodo è disponibile solo per le origini dati BigQuery.

Invio

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 ottenere.

Invio

DataSourceColumn: la colonna calcolata corrispondente al nome della colonna o null se non sono presenti nella 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.

Le specifiche dell'origine dati del tipo DataSourceType.LOOKER restituiscono un array vuoto.

Invio

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 dell'origine dati.

Invio

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

Invio

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()

Ottiene la specifica dell'origine dati.

Invio

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 dati specifici tipo di origine.

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 gli oggetti dell'origine dati collegati dell'origine dati con la nuova specifica.

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 dati specifici tipo di origine.

Genera un'eccezione se il tipo di specifica dell'origine dati è di tipo diverso rispetto alla specifica tipo di origine dati corrente.

Parametri

NomeTipoDescrizione
specDataSourceSpecLa specifica dell'origine dati con cui eseguire l'aggiornamento.

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

updateSpec(spec, refreshAllLinkedObjects)

Consente di aggiornare la specifica dell'origine dati e l'elemento 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 dati specifici tipo di origine.

Genera un'eccezione se il tipo di specifica dell'origine dati è di tipo diverso rispetto alla specifica tipo di origine dati corrente.

Parametri

NomeTipoDescrizione
specDataSourceSpecLa specifica dell'origine dati con cui eseguire l'aggiornamento.
refreshAllLinkedObjectsBooleanSe true, aggiorna anche tutti gli oggetti dell'origine dati collegati a questa origine dati.

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

waitForAllDataExecutionsCompletion(timeoutInSeconds)

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

Parametri

NomeTipoDescrizione
timeoutInSecondsIntegerIl tempo di attesa per le esecuzioni 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