Method: documents.batchUpdate

Applica uno o più aggiornamenti al documento.

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

Alcune richieste hanno replies per darti alcune informazioni su come vengono applicate. Non è necessario restituire le informazioni di altre richieste, ognuna delle quali restituisce una risposta vuota. L'ordine delle risposte corrisponde a quello delle richieste.

Ad esempio, supponiamo che tu chiami batchUpdate con quattro aggiornamenti e che solo il terzo restituisca informazioni. La risposta avrebbe due risposte vuote, la risposta alla terza richiesta e un'altra risposta vuota, in questo ordine.

Poiché altri utenti potrebbero modificare il documento, quest'ultimo potrebbe non riflettere esattamente le tue modifiche: le tue modifiche potrebbero essere alterate rispetto alle modifiche dei collaboratori. Se non ci sono collaboratori, il documento dovrebbe riflettere le modifiche che hai apportato. In ogni caso, l'applicazione degli aggiornamenti nella tua richiesta è garantita 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 l'esecuzione delle richieste di scrittura.

Corpo della risposta

Messaggio di risposta di 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 degli aggiornamenti. Questo 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 alle autorizzazioni.

WriteWrite

Consente di controllare l'esecuzione delle 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 come deve comportarsi la richiesta se questa revisione non è quella attuale del documento. Se non viene specificato nessuno dei due campi, gli aggiornamenti verranno applicati alla revisione più recente. control può essere solo uno dei seguenti:
requiredRevisionId

string

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

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

string

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

Se si sono verificate modifiche dei collaboratori dopo che il documento è stato letto utilizzando l'API, le modifiche prodotte da questa richiesta di scrittura vengono applicate alle modifiche dei collaboratori. Questo comporta una nuova revisione del documento che incorpora sia le modifiche dei collaboratori che le modifiche alla richiesta, con il server di Documenti che risolve le modifiche in conflitto. Quando utilizzi l'ID revisione target, il client API può essere considerato come un altro collaboratore del documento.

L'ID revisione target 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 restituisce un errore di richiesta non corretta 400. Riprova a effettuare la richiesta dopo aver recuperato la versione più recente del documento. In genere un ID revisione rimane valido per l'uso come revisione target per alcuni minuti dopo la sua lettura, ma per i documenti modificati di frequente questa finestra potrebbe essere più breve.