REST Resource: spreadsheets

Risorsa: foglio di lavoro

Risorsa che rappresenta un foglio di lavoro.

Rappresentazione JSON 
{
  "spreadsheetId": string,
  "properties": {
    object (SpreadsheetProperties)
  },
  "sheets": [
    {
      object (Sheet)
    }
  ],
  "namedRanges": [
    {
      object (NamedRange)
    }
  ],
  "spreadsheetUrl": string,
  "developerMetadata": [
    {
      object (DeveloperMetadata)
    }
  ],
  "dataSources": [
    {
      object (DataSource)
    }
  ],
  "dataSourceSchedules": [
    {
      object (DataSourceRefreshSchedule)
    }
  ]
}
Campi
spreadsheetId

string

L'ID del foglio di lavoro. Questo campo è di sola lettura.
properties

object (SpreadsheetProperties)

Proprietà generali di un foglio di lavoro.
sheets[]

object (Sheet)

I fogli che fanno parte di un foglio di lavoro.
namedRanges[]

object (NamedRange)

Gli intervalli denominati definiti in un foglio di lavoro.
spreadsheetUrl

string

L'URL del foglio di lavoro. Questo campo è di sola lettura.
developerMetadata[]

object (DeveloperMetadata)

I metadati dello sviluppatore associati a un foglio di lavoro.
dataSources[]

object (DataSource)

Un elenco di origini dati esterne collegate al foglio di lavoro.
dataSourceSchedules[]

object (DataSourceRefreshSchedule)

Solo output. Un elenco di pianificazioni di aggiornamento dell'origine dati.

SpreadsheetProperties

Proprietà di un foglio di lavoro.

Rappresentazione JSON 
{
  "title": string,
  "locale": string,
  "autoRecalc": enum (RecalculationInterval),
  "timeZone": string,
  "defaultFormat": {
    object (CellFormat)
  },
  "iterativeCalculationSettings": {
    object (IterativeCalculationSettings)
  },
  "spreadsheetTheme": {
    object (SpreadsheetTheme)
  },
  "importFunctionsExternalUrlAccessAllowed": boolean
}
Campi
title

string

Il titolo del foglio di lavoro.
locale

string

Le impostazioni internazionali del foglio di lavoro in uno dei seguenti formati:

  • un codice lingua ISO 639-1 come en

  • un codice lingua ISO 639-2 come fil, se non esiste un codice 639-1

  • Una combinazione del codice lingua ISO e del codice paese, ad esempio en_US

Nota: quando aggiorni questo campo, non tutte le impostazioni internazionali/lingue sono supportate.
autoRecalc

enum (RecalculationInterval)

Il tempo di attesa prima che le funzioni volatili vengano ricalcolate.
timeZone

string

Il fuso orario del foglio di lavoro, in formato CLDR come America/New_York. Se il fuso orario non viene riconosciuto, potrebbe essere un fuso orario personalizzato, ad esempio GMT-07:00.
defaultFormat

object (CellFormat)

Il formato predefinito di tutte le celle del foglio di lavoro. CellData.effectiveFormat non verrà impostato se il formato della cella corrisponde a quello predefinito. Questo campo è di sola lettura.
iterativeCalculationSettings

object (IterativeCalculationSettings)

Determina se e come i riferimenti circolari vengono risolti con un calcolo iterativo. L'assenza di questo campo indica che i riferimenti circolari generano errori di calcolo.
spreadsheetTheme

object (SpreadsheetTheme)

Tema applicato al foglio di lavoro.
importFunctionsExternalUrlAccessAllowed

boolean

Indica se consentire l'accesso all'URL esterno per le funzioni relative all'immagine e all'importazione. Leggi solo se vero. Se il valore è false, puoi impostare il valore su true.

RecalculationInterval

Un'enumerazione delle possibili opzioni dell'intervallo di ricalcolo.

Enum
RECALCULATION_INTERVAL_UNSPECIFIED Valore predefinito. Questo valore non deve essere utilizzato.
ON_CHANGE Le funzioni volatili vengono aggiornate a ogni modifica.
MINUTE Le funzioni volatili vengono aggiornate a ogni modifica e ogni minuto.
HOUR Le funzioni volatili vengono aggiornate a ogni modifica e ogni ora.

IterativeCalculationSettings

Impostazioni per controllare il modo in cui le dipendenze circolari vengono risolte con un calcolo iterativo.

Rappresentazione JSON 
{
  "maxIterations": integer,
  "convergenceThreshold": number
}
Campi
maxIterations

integer

Quando il calcolo iterativo è abilitato, il numero massimo di cicli di calcolo da eseguire.
convergenceThreshold

number

Quando il calcolo iterativo è abilitato e i risultati successivi differiscono di un valore inferiore a questo valore di soglia, gli arrotondamenti dei calcoli si interrompono.

SpreadsheetTheme

Rappresenta il tema del foglio di lavoro

Rappresentazione JSON 
{
  "primaryFontFamily": string,
  "themeColors": [
    {
      object (ThemeColorPair)
    }
  ]
}
Campi
primaryFontFamily

string

Nome della famiglia di caratteri principale.
themeColors[]

object (ThemeColorPair)

Le coppie di colori del tema del foglio di lavoro. Per aggiornare il tema, devi fornire tutte le coppie di colori.

ThemeColorPair

Una coppia che mappa un tipo di colore di un tema del foglio di lavoro al colore concreto che rappresenta.

Rappresentazione JSON 
{
  "colorType": enum (ThemeColorType),
  "color": {
    object (ColorStyle)
  }
}
Campi
colorType

enum (ThemeColorType)

Il tipo di colore del tema del foglio di lavoro.
color

object (ColorStyle)

Il colore concreto corrispondente al tipo di colore del tema.

NamedRange

Un intervallo denominato.

Rappresentazione JSON 
{
  "namedRangeId": string,
  "name": string,
  "range": {
    object (GridRange)
  }
}
Campi
namedRangeId

string

L'ID dell'intervallo denominato.
name

string

Il nome dell'intervallo denominato.
range

object (GridRange)

L'intervallo rappresentato.

DataSource

Informazioni su un'origine dati esterna nel foglio di lavoro.

Rappresentazione JSON 
{
  "dataSourceId": string,
  "spec": {
    object (DataSourceSpec)
  },
  "calculatedColumns": [
    {
      object (DataSourceColumn)
    }
  ],
  "sheetId": integer
}
Campi
dataSourceId

string

L'ID univoco basato sul foglio di lavoro che identifica l'origine dati. Esempio: 1080547365.
spec

object (DataSourceSpec)

Il DataSourceSpec per l'origine dati collegata a questo foglio di lavoro.
calculatedColumns[]

object (DataSourceColumn)

Tutte le colonne calcolate nell'origine dati.
sheetId

integer

L'ID del Sheet connesso all'origine dati. Una volta impostato, il campo non può essere modificato.

Quando crei un'origine dati, viene creato anche un foglio DATA_SOURCE associato. Se il campo non viene specificato, l'ID del foglio creato verrà generato in modo casuale.

DataSourceSpec

Consente di specificare i dettagli dell'origine dati. Ad esempio, per BigQuery, consente di specificare le informazioni sull'origine BigQuery.

Rappresentazione JSON 
{
  "parameters": [
    {
      object (DataSourceParameter)
    }
  ],

  // Union field spec can be only one of the following:
  "bigQuery": {
    object (BigQueryDataSourceSpec)
  }
  // End of list of possible types for union field spec.
}
Campi
parameters[]

object (DataSourceParameter)

I parametri dell'origine dati, utilizzati durante l'esecuzione di query sull'origine dati.
Campo di unione spec. La specifica effettiva per tipo di origine dati. spec può essere solo uno dei seguenti:
bigQuery

object (BigQueryDataSourceSpec)

Un BigQueryDataSourceSpec.

BigQueryDataSourceSpec

La specifica di un'origine dati BigQuery connessa a un foglio.

Rappresentazione JSON 
{
  "projectId": string,

  // Union field spec can be only one of the following:
  "querySpec": {
    object (BigQueryQuerySpec)
  },
  "tableSpec": {
    object (BigQueryTableSpec)
  }
  // End of list of possible types for union field spec.
}
Campi
projectId

string

L'ID di un progetto Google Cloud abilitato per BigQuery a cui è collegato un account di fatturazione. Per le query eseguite sull'origine dati, il progetto viene addebitato.
Campo di unione spec. La specifica effettiva. spec può essere solo uno dei seguenti:
querySpec

object (BigQueryQuerySpec)

Un BigQueryQuerySpec.
tableSpec

object (BigQueryTableSpec)

Un BigQueryTableSpec.

BigQueryQuerySpec

Specifica una query BigQuery personalizzata.

Rappresentazione JSON 
{
  "rawQuery": string
}
Campi
rawQuery

string

La stringa di query non elaborata.

BigQueryTableSpec

Specifica una definizione di tabella BigQuery. Sono consentite solo le tabelle native.

Rappresentazione JSON 
{
  "tableProjectId": string,
  "tableId": string,
  "datasetId": string
}
Campi
tableProjectId

string

L'ID di un progetto BigQuery a cui appartiene la tabella. Se non specificato, si presume il valore projectId.
tableId

string

L'ID della tabella BigQuery.
datasetId

string

L'ID del set di dati BigQuery.

DataSourceParameter

Un parametro nella query di un'origine dati. Il parametro consente all'utente di trasferire i valori dal foglio di lavoro a una query.

Rappresentazione JSON 
{

  // Union field identifier can be only one of the following:
  "name": string
  // End of list of possible types for union field identifier.

  // Union field value can be only one of the following:
  "namedRangeId": string,
  "range": {
    object (GridRange)
  }
  // End of list of possible types for union field value.
}
Campi
Campo di unione identifier. L'identificatore del parametro. identifier può essere solo uno dei seguenti:
name

string

Parametro con nome. Deve essere un identificatore legittimo per il DataSource che lo supporta. Ad esempio, Identificatore BigQuery.
Campo di unione value. Il valore del parametro. value può essere solo uno dei seguenti:
namedRangeId

string

ID di NamedRange. Le sue dimensioni devono essere 1 x 1.
range

object (GridRange)

Un intervallo contenente il valore del parametro. Le sue dimensioni devono essere 1 x 1.

DataSourceRefreshSchedule

Pianifica l'aggiornamento dell'origine dati.

Le origini dati nel foglio di lavoro vengono aggiornate entro un intervallo di tempo. Puoi specificare l'ora di inizio facendo clic sul pulsante Aggiornamento pianificato nell'editor di Fogli, ma l'intervallo è fisso su quattro ore. Ad esempio, se specifichi come ora di inizio le 8:00 , l'aggiornamento verrà eseguito tutti i giorni tra le 8:00 e le 12:00.

Rappresentazione JSON 
{
  "enabled": boolean,
  "refreshScope": enum (DataSourceRefreshScope),
  "nextRun": {
    object (Interval)
  },

  // Union field schedule_config can be only one of the following:
  "dailySchedule": {
    object (DataSourceRefreshDailySchedule)
  },
  "weeklySchedule": {
    object (DataSourceRefreshWeeklySchedule)
  },
  "monthlySchedule": {
    object (DataSourceRefreshMonthlySchedule)
  }
  // End of list of possible types for union field schedule_config.
}
Campi
enabled

boolean

True se la pianificazione dell'aggiornamento è attivata o false in caso contrario.
refreshScope

enum (DataSourceRefreshScope)

L'ambito dell'aggiornamento. Deve essere ALL_DATA_SOURCES.
nextRun

object (Interval)

Solo output. L'intervallo di tempo della prossima esecuzione.
Campo di unione schedule_config. Le configurazioni di pianificazione schedule_config possono essere solo una delle seguenti:
dailySchedule

object (DataSourceRefreshDailySchedule)

Programma dell'aggiornamento giornaliero.
weeklySchedule

object (DataSourceRefreshWeeklySchedule)

Programma di aggiornamento settimanale.
monthlySchedule

object (DataSourceRefreshMonthlySchedule)

Pianificazione dell'aggiornamento mensile.

DataSourceRefreshScope

Gli ambiti di aggiornamento dell'origine dati.

Enum
DATA_SOURCE_REFRESH_SCOPE_UNSPECIFIED Valore predefinito, non utilizzare.
ALL_DATA_SOURCES Aggiorna tutte le origini dati e gli oggetti delle origini dati associati nel foglio di lavoro.

DataSourceRefreshDailySchedule

Una pianificazione per l'aggiornamento dei dati ogni giorno in un determinato intervallo di tempo.

Rappresentazione JSON 
{
  "startTime": {
    object (TimeOfDay)
  }
}
Campi
startTime

object (TimeOfDay)

L'ora di inizio di un intervallo di tempo in cui è pianificato un aggiornamento dell'origine dati. Viene utilizzata solo la parte hours. L'impostazione predefinita della dimensione dell'intervallo di tempo è quella nell'editor di Fogli.

TimeOfDay

Rappresenta un'ora del giorno. La data e il fuso orario non sono significativi o sono specificati altrove. Un'API può scegliere di consentire secondi intercalari. I tipi correlati sono google.type.Date e google.protobuf.Timestamp.

Rappresentazione JSON 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
Campi
hours

integer

Ore del giorno nel formato 24 ore. Il valore deve essere compreso tra 0 e 23. Un'API può scegliere di consentire il valore "24:00:00" per scenari come l'orario di chiusura dell'attività.
minutes

integer

Minuti di ora del giorno. Il valore deve essere compreso tra 0 e 59.
seconds

integer

Secondi di minuti. Normalmente deve essere compreso tra 0 e 59. Un'API potrebbe consentire il valore 60 se consente i secondi intercalari.
nanos

integer

Frazioni di secondi in nanosecondi. Il valore deve essere compreso tra 0 e 999.999.999.

DataSourceRefreshWeeklySchedule

Una pianificazione settimanale per l'aggiornamento dei dati in giorni specifici in un determinato intervallo di tempo.

Rappresentazione JSON 
{
  "startTime": {
    object (TimeOfDay)
  },
  "daysOfWeek": [
    enum (DayOfWeek)
  ]
}
Campi
startTime

object (TimeOfDay)

L'ora di inizio di un intervallo di tempo in cui è pianificato un aggiornamento dell'origine dati. Viene utilizzata solo la parte hours. L'impostazione predefinita della dimensione dell'intervallo di tempo è quella nell'editor di Fogli.
daysOfWeek[]

enum (DayOfWeek)

Giorni della settimana da aggiornare. È necessario specificare almeno un giorno.

DayOfWeek

Rappresenta un giorno della settimana.

Enum
DAY_OF_WEEK_UNSPECIFIED Il giorno della settimana non è specificato.
MONDAY Lunedì
TUESDAY Martedì
WEDNESDAY Mercoledì
THURSDAY Giovedì
FRIDAY venerdì
SATURDAY Sabato
SUNDAY domenica

DataSourceRefreshMonthlySchedule

Una pianificazione mensile per l'aggiornamento dei dati in giorni specifici del mese in un determinato intervallo di tempo.

Rappresentazione JSON 
{
  "startTime": {
    object (TimeOfDay)
  },
  "daysOfMonth": [
    integer
  ]
}
Campi
startTime

object (TimeOfDay)

L'ora di inizio di un intervallo di tempo in cui è pianificato un aggiornamento dell'origine dati. Viene utilizzata solo la parte hours. L'impostazione predefinita della dimensione dell'intervallo di tempo è quella nell'editor di Fogli.
daysOfMonth[]

integer

Giorni del mese da aggiornare. Sono supportati solo numeri da 1 a 28, che vengono mappati dal primo al 28° giorno. È necessario specificare almeno un giorno.

Intervallo

Rappresenta un intervallo di tempo, codificato come inizio timestamp (incluso) e fine timestamp (esclusivo).

L'inizio deve essere inferiore o uguale alla fine. Quando l'inizio corrisponde alla fine, l'intervallo è vuoto (non corrisponde a nessun orario). Se non vengono specificati né l'inizio che la fine, l'intervallo corrisponde in qualsiasi momento.

Rappresentazione JSON 
{
  "startTime": string,
  "endTime": string
}
Campi
startTime

string (Timestamp format)

Campo facoltativo. Inizio inclusivo dell'intervallo.

Se specificato, un timestamp corrispondente a questo intervallo dovrà essere uguale o successivo all'inizio.
endTime

string (Timestamp format)

Campo facoltativo. Fine esclusiva dell'intervallo.

Se specificato, un timestamp corrispondente a questo intervallo dovrà essere precedente alla fine.

Metodi

batchUpdate

 Applica uno o più aggiornamenti al foglio di lavoro.

create

 Crea un foglio di lavoro, restituendo quello appena creato.

get

 Restituisce il foglio di lavoro all'ID specificato.

getByDataFilter

 Restituisce il foglio di lavoro all'ID specificato.