Method: documents.batchUpdate

Applica uno o più aggiornamenti al documento.

Ogni request viene convalidato prima di essere applicato. Se una qualsiasi richiesta non è valida, l'intera richiesta avrà esito negativo e non verrà applicato nulla.

Alcune richieste hanno replies per fornirti alcune informazioni su come vengono applicate. Le altre richieste non devono restituire informazioni; ognuna restituisce una risposta vuota. L'ordine delle risposte corrisponde a quello delle richieste.

Ad esempio, supponi di chiamare batchUpdate con quattro aggiornamenti e solo il terzo restituisce informazioni. La risposta conterrà due risposte vuote, la risposta alla terza richiesta e un'altra risposta vuota, in questo ordine.

Poiché altri utenti potrebbero aver modificato il documento, quest'ultimo potrebbe non rispecchiare esattamente le tue modifiche: le tue modifiche potrebbero essere alterate rispetto a quelle dei collaboratori. Se non ci sono collaboratori, il documento dovrebbe rispecchiare le tue modifiche. In ogni caso, è garantito che gli aggiornamenti nella tua richiesta vengano applicati insieme a livello atomico.

Richiesta HTTP

POST https://docs.googleapis.com/v1/documents/{documentId}:batchUpdate

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
documentId

string

L'ID del documento da aggiornare.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "requests": [
    {
      object (Request)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
Campi
requests[]

object (Request)

Un elenco di aggiornamenti da applicare al documento.
writeControl

object (WriteControl)

Consente di controllare il modo in cui vengono eseguite le richieste di scrittura.

Corpo della risposta

Messaggio di risposta da una richiesta documents.batchUpdate.

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

Rappresentazione JSON 
{
  "documentId": string,
  "replies": [
    {
      object (Response)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
Campi
documentId

string

L'ID del documento a cui sono stati applicati gli aggiornamenti.
replies[]

object (Response)

La risposta agli aggiornamenti. Questa mappa mappa 1:1 con gli aggiornamenti, anche se le risposte ad alcune richieste potrebbero essere vuote.
writeControl

object (WriteControl)

Il controllo di scrittura aggiornato dopo l'applicazione della richiesta.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la Guida all'autorizzazione.

WriteControl

Consente di controllare il modo in cui vengono eseguite le richieste di scrittura.

Rappresentazione JSON 
{

  // Union field control can be only one of the following:
  "requiredRevisionId": string,
  "targetRevisionId": string
  // End of list of possible types for union field control.
}
Campi
Campo unione control. Determina la revisione del documento in cui scrivere e il comportamento della richiesta se la revisione non è quella corrente del documento. Se non viene specificato nessuno dei due campi, gli aggiornamenti vengono applicati all'ultima revisione. control può essere solo uno dei seguenti:
requiredRevisionId

string

Il valore facoltativo revision ID del documento a cui viene applicata la richiesta di scrittura. Se non si tratta dell'ultima revisione del documento, la richiesta non viene elaborata e restituisce un errore 400 di richiesta errata.

Quando in una risposta viene restituito un ID revisione obbligatorio, questo indica l'ID revisione del documento dopo l'applicazione della richiesta.
targetRevisionId

string

La destinazione facoltativa revision ID del documento a cui viene applicata la richiesta di scrittura.

Se le modifiche del collaboratore sono state apportate dopo che il documento è stato letto utilizzando l'API, le modifiche prodotte da questa richiesta di scrittura vengono applicate alle modifiche del collaboratore. Ciò porta a una nuova revisione del documento che incorpora sia le modifiche del collaboratore sia le modifiche nella richiesta, con il server Documenti che risolve le modifiche in conflitto. Quando utilizzi l'ID revisione target, il client API può essere considerato un altro collaboratore del documento.

L'ID revisione di destinazione può essere utilizzato solo per scrivere nelle versioni recenti di un documento. Se la revisione di destinazione è troppo indietro rispetto all'ultima revisione, la richiesta non viene elaborata e viene restituito un errore di richiesta non valida (400). La richiesta dovrebbe essere tentata di nuovo dopo aver recuperato l'ultima versione del documento. In genere, un ID revisione rimane valido per l'utilizzo come revisione target per diversi minuti dopo la lettura, ma per i documenti modificati di frequente questa finestra potrebbe essere più breve.