Method: spreadsheets.batchUpdate

Applica uno o più aggiornamenti al foglio di lavoro.

Ogni request viene convalidato prima di essere applicato. Se una richiesta non è valida, l'intera richiesta non andrà a buon fine e non verrà applicato nulla.

Alcune richieste hanno replies per fornirti informazioni su come vengono applicate. Le risposte rispecchieranno le richieste. Ad esempio, se hai applicato 4 aggiornamenti e il terzo aveva una risposta, la risposta avrà 2 risposte vuote, la risposta effettiva e un'altra risposta vuota, in quest'ordine.

A causa della natura collaborativa dei fogli di lavoro, non è garantito che il foglio di lavoro rifletta esattamente le modifiche al termine dell'operazione, ma è garantito che gli aggiornamenti nella richiesta verranno applicati insieme in modo atomico. Le tue modifiche potrebbero essere alterate rispetto a quelle dei collaboratori. Se non ci sono collaboratori, il foglio di lavoro dovrebbe riflettere le tue modifiche.

Richiesta HTTP

POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}:batchUpdate

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
spreadsheetId

string

Il foglio di lavoro a cui applicare gli aggiornamenti.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "requests": [
    {
      object (Request)
    }
  ],
  "includeSpreadsheetInResponse": boolean,
  "responseRanges": [
    string
  ],
  "responseIncludeGridData": boolean,
  "commentsViewMode": enum (CommentsViewMode)
}
Campi
requests[]

object (Request)

Un elenco di aggiornamenti da applicare al foglio di lavoro. Le richieste verranno applicate nell'ordine in cui sono specificate. Se una richiesta non è valida, non verrà applicata alcuna richiesta.
includeSpreadsheetInResponse

boolean

Determina se la risposta all'aggiornamento deve includere la risorsa foglio di lavoro.
responseRanges[]

string

Limita gli intervalli inclusi nel foglio di lavoro delle risposte. Significativo solo se includeSpreadsheetInResponse è "true".
responseIncludeGridData

boolean

True se devono essere restituiti i dati della griglia. Significativo solo se includeSpreadsheetInResponse è "true". Questo parametro viene ignorato se nella richiesta è stata impostata una maschera del campo.
commentsViewMode

enum (CommentsViewMode)

La modalità di visualizzazione dei commenti da applicare al foglio di lavoro. In questo modo, è possibile visualizzare il foglio di lavoro con i commenti omessi o inclusi. Se non ne viene specificato uno, viene utilizzato COMMENTS_VIEW_MODE_OMITTED. Significativo solo se includeSpreadsheetInResponse è "true".

Corpo della risposta

La risposta per l'aggiornamento batch di un foglio di lavoro.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "spreadsheetId": string,
  "replies": [
    {
      object (Response)
    }
  ],
  "updatedSpreadsheet": {
    object (Spreadsheet)
  },
  "commentUpdateState": enum (CommentUpdateState)
}
Campi
spreadsheetId

string

Il foglio di lavoro a cui sono stati applicati gli aggiornamenti.
replies[]

object (Response)

La risposta agli aggiornamenti. Corrisponde 1:1 agli aggiornamenti, anche se le risposte ad alcune richieste potrebbero essere vuote.
updatedSpreadsheet

object (Spreadsheet)

Il foglio di lavoro dopo l'applicazione degli aggiornamenti. Questo valore viene impostato solo se BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response è true.
commentUpdateState

enum (CommentUpdateState)

Se gli aggiornamenti dei commenti sono stati applicati nella richiesta batch.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets

Per ulteriori informazioni, consulta la Guida all'autorizzazione.

CommentUpdateState

Lo stato degli aggiornamenti dei commenti nella richiesta batch.

Enum
COMMENT_UPDATE_STATE_UNSPECIFIED Lo stato degli aggiornamenti dei commenti non è specificato.
NO_UPDATES_REQUESTED Nella richiesta batch non sono stati richiesti aggiornamenti dei commenti.
ALL_SAVED Tutti gli aggiornamenti dei commenti richiesti sono stati applicati nella richiesta batch.
ALL_FAILED_UNKNOWN_REASON Tutti gli aggiornamenti dei commenti richiesti non sono riusciti.