Documento

Questa guida introduce concetti come i metodi principali che compongono l'API Documenti Google, come accedere a un documento e il flusso di lavoro per la creazione di un documento.

Metodi API

La risorsa documents fornisce metodi che utilizzi per richiamare l'API Docs. I seguenti metodi ti consentono di creare, leggere e aggiornare i documenti di Documenti:

  • Utilizza il metodo documents.create per creare un documento.
  • Utilizza il metodo documents.get per recuperare i contenuti di un documento specificato.
  • Utilizza il metodo documents.batchUpdate per eseguire in modo atomico un insieme di aggiornamenti su un documento specificato.

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 saperne di più sui metodi di risposta e richiesta dell'API Docs, consulta Richieste e risposte.

ID documento

documentId è l'identificatore univoco del documento e può essere ricavato dall'URL di un documento. Si tratta di una stringa particolare contenente lettere, numeri e alcuni caratteri speciali. Gli ID documento sono stabili, anche se il nome del documento cambia.

https://docs.google.com/document/d/DOCUMENT_ID/edit

La seguente espressione regolare può essere utilizzata per estrarre documentId da un URL di Documenti Google:

/document/d/([a-zA-Z0-9-_]+)

Se hai familiarità con l'API Google Drive, documentId corrisponde a id nella risorsa files.

Gestire documenti in Google Drive

I file di Documenti vengono archiviati su Google Drive, il nostro servizio di archiviazione basato sul cloud. Sebbene l'API Documenti abbia i propri metodi autonomi, spesso è necessario utilizzare anche i metodi dell'API Google Drive per interagire con i file Documenti di un utente. Ad esempio, per copiare i file di Documenti, utilizza il metodo files.copy dell'API Drive. Per ulteriori informazioni, consulta Copiare un documento.

Per impostazione predefinita, quando utilizzi l'API Docs, un nuovo documento viene salvato nella cartella principale dell'utente su Drive. Esistono opzioni per salvare un file in una cartella di Drive. Per ulteriori informazioni, vedi Utilizzare le cartelle di Google Drive.

Lavorare con i file di Documenti

Per recuperare un documento da Il mio Drive di un utente, spesso è necessario utilizzare prima il metodo files.list di Drive per recuperare l'ID di un file. La chiamata del metodo senza parametri restituisce un elenco di tutti i file e le cartelle, inclusi gli ID, per l'utente.

Il tipo MIME di un documento indica il tipo e il formato dei dati. Il formato del tipo MIME per Documenti è application/vnd.google-apps.document. Per un elenco dei tipi MIME, vedi Tipi MIME supportati da Google Workspace e Google Drive.

Per cercare solo file di Documenti in base al tipo MIME in Il mio Drive, aggiungi il seguente filtro della stringa di query:

q: mimeType = 'application/vnd.google-apps.document'

Per ulteriori informazioni sui filtri delle stringhe di query, vedi Cercare file e cartelle.

Una volta conosciuto il valore documentId, utilizza il metodo documents.get per recuperare un'istanza completa del documento specificato. Per ulteriori informazioni, consulta la sezione Richieste e risposte.

Per esportare i contenuti in byte dei documenti di Google Workspace, utilizza il metodo files.export di Drive con il documentId del file da esportare e il tipo MIME di esportazione corretto. Per ulteriori informazioni, vedi Esportare i contenuti dei documenti di Google Workspace.

Confrontare i metodi Get e List

La tabella seguente descrive le differenze tra i metodi Drive e Documenti e i dati restituiti da ciascuno:

Operatore Descrizione Utilizzo
drive.files.get Recupera i metadati di un file in base all'ID. Restituisce un'istanza della risorsa files. Ottieni i metadati di un file specifico.
drive.files.list Recupera i file di un utente. Restituisce un elenco di file. Visualizza un elenco dei file utente quando non sai quale file devi modificare.
docs.documents.get Recupera la versione più recente del documento specificato, inclusa tutta la formattazione e il testo. Restituisce un'istanza della risorsa documents. Recupera il documento per un ID documento specifico.

Flusso di lavoro per la creazione di documenti

Creare e compilare un nuovo documento è semplice, poiché non ci sono contenuti esistenti di cui preoccuparsi e non ci sono collaboratori che possono modificare lo stato del documento. A livello concettuale, il funzionamento è illustrato nel seguente diagramma di sequenza:

Workflow per creare e compilare un nuovo documento.
Figura 1. Workflow per creare e compilare un nuovo documento.

Nella Figura 1, un utente che interagisce con la risorsa documents ha il seguente flusso di informazioni:

  1. Un'app chiama il metodo documents.create su un server web.
  2. Il server web invia una risposta HTTP contenente un'istanza del documento creato come risorsa documents.
  3. Se vuoi, l'app chiama il metodo documents.batchUpdate per eseguire in modo atomico un insieme di richieste di modifica per compilare il documento con i dati.
  4. Il server web invia una risposta HTTP. Alcuni metodi documents.batchUpdate forniscono un corpo di risposta con informazioni sulle richieste applicate, mentre altri mostrano una risposta vuota.

Flusso di lavoro di aggiornamento dei documenti

L'aggiornamento di un documento esistente è più complesso. Prima di poter effettuare chiamate significative per aggiornare un documento, devi conoscere il suo stato attuale: quali elementi lo compongono, quali contenuti contengono questi elementi e l'ordine degli elementi all'interno del documento. Il seguente diagramma di sequenza mostra come funziona:

Flusso di lavoro per aggiornare un documento.
Figura 2. Flusso di lavoro per aggiornare un documento.

Nella Figura 2, un utente che interagisce con la risorsa documents ha il seguente flusso di informazioni:

  1. Un'app chiama il metodo documents.get su un server web, con il documentId del file da trovare.
  2. Il server web invia una risposta HTTP contenente un'istanza del documento specificato come risorsa documents. Il JSON restituito contiene i contenuti del documento, la formattazione e altre funzionalità.
  3. L'app analizza il JSON in modo che l'utente possa determinare quali contenuti o formato aggiornare.
  4. L'app chiama il metodo documents.batchUpdate per eseguire in modo atomico un insieme di richieste di modifica per aggiornare il documento.
  5. Il server web invia una risposta HTTP. Alcuni metodi documents.batchUpdate forniscono un corpo di risposta con informazioni sulle richieste applicate, mentre altri mostrano una risposta vuota.

Questo diagramma non prende in considerazione i flussi di lavoro in cui vengono apportati aggiornamenti simultanei da parte di altri collaboratori nello stesso documento. Per saperne di più, consulta la sezione delle best practice Pianificare la collaborazione.