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)
    }
  ],
  "comments": [
    {
      object (CommentThread)
    }
  ],
  "commentsViewMode": enum (CommentsViewMode)
}
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 delle pianificazioni di aggiornamento delle origini dati.
comments[]

object (CommentThread)

I thread di commenti associati al foglio di lavoro.

commentsViewMode

enum (CommentsViewMode)

Solo output. La modalità di visualizzazione dei commenti applicata al foglio di lavoro.

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, ad esempio en

  • un codice lingua ISO 639-2, ad esempio 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)

La quantità di tempo da attendere prima che le funzioni volatili vengano ricalcolate.
timeZone

string

Il fuso orario del foglio di lavoro, in formato CLDR, ad esempio America/New_York. Se il fuso orario non viene riconosciuto, potrebbe trattarsi di 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 è uguale a questo formato predefinito. Questo campo è di sola lettura.
iterativeCalculationSettings

object (IterativeCalculationSettings)

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

object (SpreadsheetTheme)

Il tema è stato applicato al foglio di lavoro.
importFunctionsExternalUrlAccessAllowed

boolean

Se consentire l'accesso agli URL esterni per le funzioni di importazione e immagine. Leggi solo quando è true. Se è impostato su false, puoi impostarlo su true. Questo valore verrà ignorato e restituirà sempre true se l'amministratore ha attivato la funzionalità di allowlisting.

RecalculationInterval

Un elenco delle possibili opzioni di 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 come vengono risolte le dipendenze circolari con il 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 è attivato e i risultati successivi differiscono di un valore inferiore a questa soglia, i calcoli di arrotondamento si interrompono.

SpreadsheetTheme

Rappresenta il tema del foglio di lavoro

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

string

Il nome della famiglia di caratteri principale.
themeColors[]

object (ThemeColorPair)

Le coppie di colori del tema del foglio di lavoro. Per l'aggiornamento, devi fornire tutte le coppie di colori del tema.

ThemeColorPair

Una coppia che mappa un tipo di colore 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 che rappresenta.

Origine dati

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 con ambito 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 di Sheet connesso all'origine dati. Il campo non può essere modificato una volta impostato.

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

DataSourceSpec

Specifica i dettagli dell'origine dati. Ad esempio, per BigQuery, specifica le informazioni sull'origine BigQuery.

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

  "bigQuery": {
    object (BigQueryDataSourceSpec)
  },
  "looker": {
    object (LookerDataSourceSpec)
  }
}
Campi
parameters[]

object (DataSourceParameter)

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

object (BigQueryDataSourceSpec)

A BigQueryDataSourceSpec.
looker

object (LookerDataSourceSpec)

Un [LookerDatasourceSpec][].

BigQueryDataSourceSpec

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

Rappresentazione JSON 
{
  "projectId": string,

  "querySpec": {
    object (BigQueryQuerySpec)
  },
  "tableSpec": {
    object (BigQueryTableSpec)
  }
}
Campi
projectId

string

L'ID di un progetto Google Cloud abilitato a BigQuery con un account di fatturazione collegato. Per qualsiasi query eseguita sull'origine dati, viene addebitato un costo al progetto.
Campo unione spec. La specifica effettiva. spec può essere solo uno dei seguenti tipi:
querySpec

object (BigQueryQuerySpec)

A BigQueryQuerySpec.
tableSpec

object (BigQueryTableSpec)

A 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, viene utilizzato il valore projectId.
tableId

string

L'ID tabella BigQuery.
datasetId

string

L'ID set di dati BigQuery.

LookerDataSourceSpec

La specifica di un'origine dati di Looker.

Rappresentazione JSON 
{
  "instanceUri": string,
  "model": string,
  "explore": string
}
Campi
instanceUri

string

Un URL dell'istanza di Looker.
model

string

Nome di un modello di Looker.
explore

string

Nome di un'esplorazione del modello di Looker.

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 
{

  "name": string

  "namedRangeId": string,
  "range": {
    object (GridRange)
  }
}
Campi
Campo unione identifier. L'identificatore del parametro. identifier può essere solo uno dei seguenti tipi:
name

string

Parametro denominato. Deve essere un identificatore legittimo per DataSource che lo supporta. Ad esempio, identificatore BigQuery.
Campo unione value. Il valore parametro. value può essere solo uno dei seguenti tipi:
namedRangeId

string

ID di un NamedRange. Le dimensioni devono essere 1x1.
range

object (GridRange)

Un intervallo che contiene il valore del parametro. Le dimensioni devono essere 1x1.

DataSourceRefreshSchedule

Pianificazione dell'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 Fogli, ma l'intervallo è fisso a 4 ore. Ad esempio, se specifichi un'ora di inizio alle 8:00 , l'aggiornamento avrà luogo tra le 8:00 e le 12:00 ogni giorno.

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

  "dailySchedule": {
    object (DataSourceRefreshDailySchedule)
  },
  "weeklySchedule": {
    object (DataSourceRefreshWeeklySchedule)
  },
  "monthlySchedule": {
    object (DataSourceRefreshMonthlySchedule)
  }
}
Campi
enabled

boolean

Vero se la pianificazione dell'aggiornamento è abilitata, falso 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 unione schedule_config. Le configurazioni della pianificazione schedule_config possono essere solo una delle seguenti:
dailySchedule

object (DataSourceRefreshDailySchedule)

Pianificazione aggiornamento giornaliero.
weeklySchedule

object (DataSourceRefreshWeeklySchedule)

Programmazione dell'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 i relativi oggetti di origine dati 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 l'aggiornamento di un'origine dati. Viene utilizzata solo la parte hours. Le dimensioni dell'intervallo di tempo corrispondono per impostazione predefinita a quelle dell'editor di Fogli.

TimeOfDay

Rappresenta un orario della giornata. La data e il fuso orario non sono significativi o sono specificati altrove. Un'API può scegliere di consentire i 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

Le ore di un giorno nel formato 24 ore. Deve essere maggiore o uguale a 0 e in genere minore o uguale a 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 un'ora. Deve essere maggiore o uguale a 0 e minore o uguale a 59.
seconds

integer

Secondi di un minuto. Deve essere maggiore o uguale a 0 e in genere minore o uguale a 59. Un'API potrebbe consentire il valore 60 se consente i secondi intercalari.
nanos

integer

Frazioni di secondi, in nanosecondi. Deve essere maggiore o uguale a 0 e minore o uguale a 999.999.999.

DataSourceRefreshWeeklySchedule

Una pianificazione settimanale per l'aggiornamento dei dati in giorni specifici di 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 l'aggiornamento di un'origine dati. Viene utilizzata solo la parte hours. Le dimensioni dell'intervallo di tempo corrispondono per impostazione predefinita a quelle dell'editor di Fogli.
daysOfWeek[]

enum (DayOfWeek)

I giorni della settimana in cui 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 l'aggiornamento di un'origine dati. Viene utilizzata solo la parte hours. Le dimensioni dell'intervallo di tempo corrispondono per impostazione predefinita a quelle dell'editor di Fogli.
daysOfMonth[]

integer

Giorni del mese da aggiornare. Sono supportati solo i valori da 1 a 28, che corrispondono al giorno 1-28. È necessario specificare almeno un giorno.

Intervallo

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

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

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

string (Timestamp format)

Facoltativo. Inizio inclusivo dell'intervallo.

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

string (Timestamp format)

Facoltativo. Fine esclusiva dell'intervallo.

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

CommentThread

Rappresenta un singolo thread di commenti all'interno di un foglio di lavoro.

Rappresentazione JSON 
{
  "commentId": string,
  "anchorId": string,
  "headPost": {
    object (Post)
  },
  "replies": [
    {
      object (Post)
    }
  ],
  "status": enum (Status),

  "plainTextQuote": string
}
Campi
commentId

string

L'ID univoco del thread di commenti.
anchorId

string

L'ID di CommentAnchor nel foglio a cui è associato questo thread.
headPost

object (Post)

Il primo post nel thread.
replies[]

object (Post)

Risposte al post principale.
status

enum (Status)

Se il thread è aperto o risolto.
Campo unione quote. Il testo citato del documento al momento della creazione del commento. quote può essere solo uno dei seguenti tipi:
plainTextQuote

string

Il testo citato del foglio di lavoro al momento della creazione del commento, formattato come testo normale.

Pubblica

Rappresenta un singolo post in un thread di commenti.

Rappresentazione JSON 
{
  "postId": string,
  "content": string,
  "contentHtml": string,
  "author": {
    object (PostAuthor)
  },
  "createTime": string,
  "updateTime": string,
  "deleted": boolean,
  "fromImportedSpreadsheet": boolean,
  "fromCopiedSpreadsheet": boolean,
  "assigneeEmail": string,
  "commentAction": enum (CommentActionType)
}
Campi
postId

string

Solo output. L'ID univoco del post.
content

string

I contenuti del post.

Deve essere non vuoto se commentAction non è RESOLVE o REOPEN.

Questo contenuto di testo verrà gestito in modo simile ai commenti creati nell'editor Fogli. Avrà comportamenti simili per la formattazione, le notifiche e così via.

Non può superare le 2048 unità di codice UTF-8.
contentHtml

string

Solo output. I contenuti del post in formato HTML.
author

object (PostAuthor)

Solo output. L'utente che ha creato il post.
createTime

string (Timestamp format)

Solo output. L'ora in cui è stato creato il post.
updateTime

string (Timestamp format)

Solo output. L'ora dell'ultimo aggiornamento del post.
deleted

boolean

Solo output. Indica se il post è stato eliminato. Se true, i campi content e author saranno vuoti.
fromImportedSpreadsheet

boolean

Solo output. Se il post proviene da un foglio di lavoro importato. Questo campo non può essere impostato direttamente dai chiamanti.
fromCopiedSpreadsheet

boolean

Solo output. Se il post proviene da un foglio di lavoro copiato. Questo campo non può essere impostato direttamente dai chiamanti.
assigneeEmail

string

Facoltativo. L'email dell'utente che viene assegnato al thread come parte di questo post.

Restituisce un errore 400 Bad Request se:

  • Il thread principale è un CommentThread il cui headPost non ha un assegnatario.

  • commentAction è specificato come RESOLVE o REOPEN.

  • assigneeEmail supera le 2048 unità di codice UTF-8.
commentAction

enum (CommentActionType)

Azione intrapresa durante la creazione del post.

PostAuthor

Rappresenta un utente che ha creato un post di commento.

Rappresentazione JSON 
{
  "displayName": string,
  "me": boolean,
  "anonymous": boolean,
  "user": string
}
Campi
displayName

string

Il nome visualizzato dell'utente. Potrebbe non essere presente se l'autore è anonimo.
me

boolean

Indica se l'utente è l'utente autenticato che ha inviato la richiesta.
anonymous

boolean

Indica se l'utente è anonimo.
user

string

Il nome della risorsa dell'utente autore del post, che può essere utilizzato anche per identificare l'utente nell'API Google People. Formato: users/{user}. Non verrà compilato se il campo anonimo è true o se il post proviene da un foglio di lavoro importato.

CommentActionType

L'azione intrapresa con questa risposta a un thread di commenti.

Enum
COMMENT_ACTION_TYPE_UNSPECIFIED Valore predefinito. Questo valore non viene utilizzato.
NO_COMMENT_ACTION_CHANGE Nessuna modifica all'azione in questo post.
RESOLVE Questo post risolve il thread.
REOPEN Questo post riapre il thread.

Stato

Le opzioni di stato del thread di commenti.

Enum
STATUS_UNSPECIFIED Valore predefinito. Questo valore non viene utilizzato.
OPEN Il thread di commenti è aperto.
RESOLVED Il thread di commenti è stato risolto.

CommentsViewMode

La modalità di visualizzazione dei commenti applicata al foglio di lavoro che indica se i commenti sono inclusi. Fornisce opzioni per leggere il foglio di lavoro con o senza commenti e ancore dei commenti.

Enum
COMMENTS_VIEW_MODE_UNSPECIFIED La modalità di visualizzazione dei commenti non è specificata; viene applicata COMMENTS_VIEW_MODE_OMITTED.
COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS La modalità di visualizzazione dei commenti applicata al foglio di lavoro restituito dipende dall'attuale livello di accesso dell'utente. Se l'utente dispone solo dell'accesso in visualizzazione, viene applicato COMMENTS_VIEW_MODE_OMITTED. In caso contrario, viene applicato COMMENTS_VIEW_MODE_INCLUDED.
COMMENTS_VIEW_MODE_OMITTED Nel foglio di lavoro restituito i commenti sono stati omessi.
COMMENTS_VIEW_MODE_INCLUDED

Il foglio di lavoro restituito include i commenti.

Le richieste di recupero di un foglio di lavoro utilizzando questa modalità restituiranno un errore 403 se l'utente non dispone dell'autorizzazione per visualizzare i commenti.

Metodi

batchUpdate

 Applica uno o più aggiornamenti al foglio di lavoro.

create

 Crea un foglio di lavoro e lo restituisce.

get

 Restituisce il foglio di lavoro con l'ID specificato.

getByDataFilter

 Restituisce il foglio di lavoro con l'ID specificato.