Questa guida illustra i metodi principali di richiesta e risposta che compongono l'API Documenti Google e illustra come aggiornare un documento in batch.
Puoi richiamare l'API Documenti Google utilizzando una richiesta HTTP o una chiamata a un metodo in una libreria client specifica per una lingua. Questi valori sono in linea di massima equivalenti.
L'API Documenti Google restituisce una risposta HTTP che in genere include il risultato della chiamata della richiesta. Quando si utilizza una libreria client per effettuare le richieste, le risposte vengono restituite in un modo specifico per la lingua.
Metodi di richiesta
L'API Documenti supporta i seguenti metodi:
documents.create: crea un documento di Documenti Google vuoto.documents.get: restituisce un'istanza completa del documento specificato. Puoi analizzare il file JSON restituito per estrarne i contenuti, la formattazione e altre caratteristiche.documents.batchUpdate: invia un elenco di richieste di modifica da applicare atomicamente al documento e restituisce un elenco di risultati.
I metodi documents.get e documents.batchUpdate richiedono un documentId
come parametro per specificare il documento di destinazione. Il metodo documents.create
restituisce un'istanza del documento creato, da cui puoi leggere
documentId. Per maggiori informazioni su documentId, consulta ID documento.
Aggiornamenti batch
Il metodo documents.batchUpdate utilizza un elenco di oggetti request, ognuno dei quali specifica una singola richiesta da eseguire. Ad esempio, formatta un paragrafo e
aggiungi un'immagine in linea. Ogni richiesta viene convalidata prima di essere applicata e vengono elaborate in base all'ordine in cui vengono visualizzate nella richiesta batch.
Tutte le richieste nell'aggiornamento batch vengono applicate a livello atomico. Vale a dire che se una o più richieste non sono valide, l'intero aggiornamento non viene eseguito e non viene applicata nessuna delle modifiche (potenzialmente dipendenti).
Alcuni metodi documents.batchUpdate forniscono risposte con informazioni sulle
richieste applicate. Questi metodi restituiscono un testo
della risposta che
contiene un elenco di oggetti
response. Non è necessario che le altre richieste restituiscano informazioni e mostrino una
risposta vuota. Gli oggetti nell'elenco delle risposte occupano lo stesso ordine di indice della richiesta corrispondente.
Un pattern molto utilizzato per effettuare richieste batch è il seguente:
requests = []
requests.append(first request)
requests.append(second request)
...
body = ... & requests & ...
...batchUpdate(body)
Consulta le best practice per le richieste in batch per i dettagli completi su come eseguire in batch le chiamate all'API di Documenti e la documentazione di riferimento di documents.batchUpdate per i tipi di richieste e risposte.
Operazioni di aggiornamento batch
Esistono vari tipi di richieste di aggiornamento batch. Ecco una suddivisione dei tipi di richiesta, raggruppati in diverse categorie.
Argomenti correlati
- Struttura di un documento di Documenti Google
- Regole e comportamento di modifica strutturale
- Richieste batch