Documento

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

Metodi dell'API

La risorsa documents fornisce i metodi che utilizzi per richiamare l'API Documenti. I seguenti metodi 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.
  • Usa il metodo documents.batchUpdate per eseguire atomicamente un set 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 documentId. Per ulteriori informazioni sulle richieste e sui metodi di risposta dell'API Documenti, vedi Richieste e risposte.

ID documento

documentId è l'identificatore univoco del documento e può essere ricavato dall'URL di un documento. È 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 conosci 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 su 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 di Documenti di un utente. Ad esempio, per copiare i file di Documenti, utilizza il metodo files.copy dell'API Drive. Per maggiori informazioni, vedi Copiare un documento esistente.

Per impostazione predefinita, quando utilizzi l'API Documenti, 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 Lavorare con le cartelle di Google Drive.

Lavora 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 per Google Workspace e Google Drive.

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

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

Per ulteriori informazioni sui filtri per le stringhe di query, consulta Cercare file e cartelle.

Quando conosci documentId, utilizza il metodo documents.get per recuperare un'istanza completa del documento specificato. Per ulteriori informazioni, consulta Richieste e risposte.

Per esportare i contenuti 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 maggiori informazioni, vedi Esportare i contenuti dei documenti di Google Workspace.

Confronta i metodi Get e List

Nella tabella seguente vengono descritte le differenze tra i metodi di Drive e Documenti e i dati restituiti con 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 per un file specifico.
drive.files.list Restituisce i file di un utente. Restituisce un elenco di file. Recupera un elenco di file utente quando non sai con certezza quale file devi modificare.
docs.documents.get Recupera la versione più recente del documento specificato, inclusi tutta la formattazione e il testo. Restituisce un'istanza della risorsa documents. Ottieni il documento per un ID documento specifico.

Flusso di lavoro per la creazione di documenti

Creare e compilare un nuovo documento è molto semplice, poiché non sono presenti contenuti di cui preoccuparsi e non ci sono collaboratori in grado di modificare lo stato del documento. Concettualmente, questo funziona come mostrato nel seguente diagramma di sequenza:

flusso di lavoro per creare e compilare un nuovo documento.
Figura 1. Flusso di lavoro per creare e compilare un nuovo documento.

Nella Figura 1, un utente che interagisce con la risorsa documents presenta 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. Facoltativamente, l'app chiama il metodo documents.batchUpdate per eseguire atomicamente un insieme di richieste di modifica per completare il documento con i dati.
  4. Il server web invia una risposta HTTP. Alcuni metodi documents.batchUpdate forniscono un corpo della risposta con informazioni sulle richieste applicate, mentre altri mostrano una risposta vuota.

Flusso di lavoro di aggiornamento dei documenti

Aggiornare un documento esistente è più complesso. Prima di poter effettuare chiamate significative per aggiornare un documento, devi conoscere il suo stato attuale: da quali elementi lo compongono, quali contenuti sono presenti 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 l'aggiornamento di 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 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 il contenuto del documento, la formattazione e altre funzionalità.
  3. L'app analizza il file JSON in modo che l'utente possa determinare quali contenuti o formato aggiornare.
  4. L'app chiama il metodo documents.batchUpdate per eseguire atomicamente un set di richieste di modifica per aggiornare il documento.
  5. Il server web invia una risposta HTTP. Alcuni metodi documents.batchUpdate forniscono un corpo della risposta con informazioni sulle richieste applicate, mentre altri mostrano una risposta vuota.

Questo diagramma non considera i flussi di lavoro in cui gli aggiornamenti simultanei di altri collaboratori vengono eseguiti nello stesso documento. Per ulteriori informazioni, consulta la sezione delle best practice Pianificare la collaborazione.