Questa guida illustra i metodi di richiesta e risposta principali che compongono l'API Documenti Google e come aggiornare un documento in batch.
Puoi richiamare l'API Documenti Google utilizzando una richiesta HTTP o un metodo di chiamata in una libreria client specifica per il linguaggio. Sono sostanzialmente equivalenti.
L'API Documenti Google restituisce una risposta HTTP, che in genere include il risultato dell'invocazione della richiesta. Quando utilizzi una libreria client per inviare richieste, le risposte vengono restituite in modo specifico per il linguaggio.
Metodi di richiesta
L'API Docs supporta i seguenti metodi:
documents.create: crea un documento Documenti Google vuoto.documents.get: restituisce un'istanza completa del documento specificato. Puoi analizzare il JSON restituito per estrarre i contenuti del documento, la formattazione e altre funzionalità.documents.batchUpdate: invia un elenco di richieste di modifica da applicare in modo atomico 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 il
documentId. Per maggiori informazioni su documentId, consulta la sezione Document
ID.
Aggiornamenti batch
Il metodo documents.batchUpdate accetta un elenco di oggetti request, ciascuno dei quali specifica una singola richiesta da eseguire. Ad esempio, formatta un paragrafo e poi
aggiungi un'immagine in linea. Ogni richiesta viene convalidata prima di essere applicata e le richieste vengono elaborate in base all'ordine in cui appaiono nella richiesta collettiva.
Tutte le richieste nell'aggiornamento batch vengono applicate in modo atomico. In altre parole, se una richiesta non è valida, l'intero aggiornamento non va a buon fine e nessuna delle modifiche (potenzialmente dipendenti) viene applicata.
Alcuni metodi documents.batchUpdate forniscono risposte con informazioni sulle richieste applicate. Questi metodi restituiscono un corpo
della risposta che contiene un elenco di oggetti response. Le altre richieste non devono restituire informazioni e mostrare una risposta vuota. Gli oggetti nell'elenco di risposta occupano lo stesso ordine di indice della richiesta corrispondente.
Un pattern comune per l'invio di richieste batch è il seguente:
requests = []
requests.append(first request)
requests.append(second request)
...
body = ... & requests & ...
...batchUpdate(body)
Consulta le best practice per le richieste batch per informazioni dettagliate su come raggruppare le chiamate all'API Docs e la documentazione di riferimento documents.batchUpdate per i tipi di richiesta e risposta.
Operazioni di aggiornamento batch
Esistono vari tipi di richieste di aggiornamento collettivo. Ecco una suddivisione dei tipi di richieste, raggruppati in diverse categorie.
Argomenti correlati
- Struttura di un documento di Documenti Google
- Regole e comportamento delle modifiche strutturali
- Richieste batch