Questa guida introduce i metodi principali di richiesta e risposta che compongono il l'API Documenti Google e come aggiornare un documento in batch.
Puoi richiamare l'API Google Documenti utilizzando una richiesta HTTP o un metodo in una libreria client specifica per una lingua. Questi valori sono in linea di massima equivalenti.
L'API Google Documenti restituisce una risposta HTTP che generalmente include il risultato della chiamata della richiesta. Quando utilizzi una libreria client per effettuare le richieste, 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: restituisci un un'istanza completa del documento specificato. Puoi analizzare il file JSON restituito per estrarre i contenuti, la formattazione e altre caratteristiche del documento.documents.batchUpdate: Invia un elenco di richieste di modifica da applicare atomicamente al documento e restituiscono un elenco di risultati.
I metodi documents.get e documents.batchUpdate richiedono un documentId
parametro per specificare il documento di destinazione. Il metodo documents.create
restituisce un'istanza del documento creato, da cui puoi leggere
documentId. Per ulteriori informazioni su documentId, consulta la sezione Documento
ID.
Aggiornamenti batch
La documents.batchUpdate
prende un elenco di
request oggetti, ciascuno
che specifica una singola richiesta da eseguire. Ad esempio, formatta un paragrafo e poi
aggiungere un'immagine in linea. Ogni richiesta viene convalidata prima di essere applicata e
vengono elaborate in base all'ordine in cui appaiono nella richiesta batch.
Tutte le richieste nell'aggiornamento batch vengono applicate a livello atomico. Vale a dire che se ci sono richieste non è valido, l'intero aggiornamento non andrà a buon fine e nessuno dei problemi (potenzialmente dipendenti) vengono applicate.
Alcuni metodi di documents.batchUpdate forniscono risposte con informazioni su
le richieste applicate. Questi metodi restituiscono una risposta
del testo,
contiene un elenco di response
di oggetti strutturati. Non è necessario che le altre richieste restituiscano informazioni e mostrino un campo vuoto
rispondere. Gli oggetti nell'elenco delle risposte occupano lo stesso ordine di indice dell'ordine
a una 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)
Per informazioni dettagliate, consulta le best practice per le richieste in batch
come raggruppare le chiamate all'API di Documenti e
documents.batchUpdate
documentazione di riferimento per i tipi di richiesta e risposta.
Operazioni di aggiornamento batch
Esistono vari tipi di richieste di aggiornamento batch. Ecco un'analisi dettagliata tipi di richiesta, raggruppati in diverse categorie.
Argomenti correlati
- Struttura di un documento di Documenti Google
- Regole e comportamento di modifica strutturale
- Richieste batch