Questa guida illustra i metodi principali di richiesta e risposta che compongono l'API Documenti Google e come puoi aggiornare un documento in batch.
Puoi richiamare l'API Google Docs utilizzando una richiesta HTTP o una chiamata di metodo in una libreria client specifica per la lingua. Questi due termini sono sostanzialmente equivalenti.
L'API Google Docs restituisce una risposta HTTP, che in genere include il risultato della chiamata della richiesta. Quando si utilizza una libreria client per effettuare richieste, le risposte vengono restituite in un modo specifico per la lingua.
Metodi di richiesta
L'API Docs supporta i seguenti metodi:
documents.create: crea un documento di Documenti Google vuoto.documents.get: restituisci un'istanza completa del documento specificato. Puoi analizzare il codice JSON restituito per estrarre i contenuti, la formattazione e altre caratteristiche.documents.batchUpdate: invia un elenco di richieste di modifica da applicare a livello atomico al documento e restituisci 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, dalla quale puoi leggere il documentId. Per maggiori informazioni su documentId, consulta ID documento.
Aggiornamenti collettivi
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 le
richieste vengono elaborate in base all'ordine in cui vengono visualizzate nella richiesta batch.
Tutte le richieste nell'aggiornamento batch vengono applicate a livello atomico. Ciò significa che se una qualsiasi richiesta non è valida, l'intero aggiornamento non andrà 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 risposte occupano lo stesso ordine di indice della richiesta corrispondente.
Un pattern molto utilizzato per effettuare richieste in batch è simile al seguente:
requests = []
requests.append(first request)
requests.append(second request)
...
body = ... & requests & ...
...batchUpdate(body)
Consulta le best practice per le richieste in batch per dettagli completi su
come raggruppare le chiamate API Docs e la
documentazione di riferimento documents.batchUpdate
per i tipi di richieste e risposte.
Operazioni di aggiornamento batch
Esistono vari tipi di richieste di aggiornamento batch. Ecco un'analisi dei tipi di richieste, raggruppati in diverse categorie.
Argomenti correlati
- Struttura di un documento di Documenti Google
- Regole e comportamento di modifica strutturale
- Richieste batch