Method: documents.create

Crea un documento vuoto utilizzando il titolo indicato nella richiesta. Gli altri campi della richiesta, inclusi i contenuti forniti, vengono ignorati.

Restituisce il documento creato.

Richiesta HTTP

POST https://docs.googleapis.com/v1/documents

L'URL utilizza la sintassi di transcodifica gRPC.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "documentId": string,
  "title": string,
  "tabs": [
    {
      object (Tab)
    }
  ],
  "revisionId": string,
  "suggestionsViewMode": enum (SuggestionsViewMode),
  "commentsViewMode": enum (CommentsViewMode),
  "comments": [
    {
      object (CommentThread)
    }
  ],
  "suggestions": [
    {
      object (SuggestionThread)
    }
  ],
  "body": {
    object (Body)
  },
  "headers": {
    string: {
      object (Header)
    },
    ...
  },
  "footers": {
    string: {
      object (Footer)
    },
    ...
  },
  "footnotes": {
    string: {
      object (Footnote)
    },
    ...
  },
  "documentStyle": {
    object (DocumentStyle)
  },
  "suggestedDocumentStyleChanges": {
    string: {
      object (SuggestedDocumentStyle)
    },
    ...
  },
  "namedStyles": {
    object (NamedStyles)
  },
  "suggestedNamedStylesChanges": {
    string: {
      object (SuggestedNamedStyles)
    },
    ...
  },
  "lists": {
    string: {
      object (List)
    },
    ...
  },
  "namedRanges": {
    string: {
      object (NamedRanges)
    },
    ...
  },
  "inlineObjects": {
    string: {
      object (InlineObject)
    },
    ...
  },
  "positionedObjects": {
    string: {
      object (PositionedObject)
    },
    ...
  }
}
Campi
documentId

string

Solo output. L'ID del documento.
title

string

Il titolo del documento.
tabs[]

object (Tab)

Solo output. Schede che fanno parte di un documento.

Le schede possono contenere schede secondarie, ovvero schede nidificate all'interno di un'altra scheda. Le schede secondarie sono rappresentate dal campo Tab.childTabs.
revisionId

string

Solo output. L'ID revisione del documento. Può essere utilizzato nelle richieste di aggiornamento per specificare a quale revisione di un documento applicare gli aggiornamenti e come deve comportarsi la richiesta se il documento è stato modificato dopo quella revisione. Compilato solo se l'utente dispone dell'accesso in modifica al documento.

L'ID revisione non è un numero sequenziale, ma una stringa opaca. Il formato dell'ID revisione potrebbe cambiare nel tempo. Un ID revisione restituito è garantito valido solo per 24 ore dopo la restituzione e non può essere condiviso tra gli utenti. Se l'ID revisione rimane invariato tra le chiamate, il documento non è stato modificato. Al contrario, un ID modificato (per lo stesso documento e utente) di solito indica che il documento è stato aggiornato. Tuttavia, un ID modificato può anche essere dovuto a fattori interni, come modifiche al formato dell'ID.
suggestionsViewMode

enum (SuggestionsViewMode)

Solo output. La modalità di visualizzazione dei suggerimenti applicata al documento.

Nota: quando modifichi un documento, le modifiche devono basarsi su un documento con SUGGESTIONS_INLINE.
commentsViewMode

enum (CommentsViewMode)

Solo output. La modalità di visualizzazione dei commenti applicata al documento.
comments[]

object (CommentThread)

Solo output. I commenti associati al documento. Compilato solo se il parametro commentsViewMode è impostato in modo da richiedere commenti (ad esempio COMMENTS_VIEW_MODE_INCLUDED).
suggestions[]

object (SuggestionThread)

Solo output. I suggerimenti associati al documento. Compilato solo se il parametro commentsViewMode è impostato in modo da richiedere commenti (ad esempio COMMENTS_VIEW_MODE_INCLUDED).
body

object (Body)

Solo output. Il corpo principale del documento.

Campo legacy: utilizza invece Document.tabs.documentTab.body, che mostra i contenuti effettivi del documento di tutte le schede quando il parametro includeTabsContent è impostato su true. Se false o non impostato, questo campo contiene informazioni sulla prima scheda del documento.
headers

map (key: string, value: object (Header))

Solo output. Le intestazioni del documento, identificate dall'ID intestazione.

Campo legacy: utilizza invece Document.tabs.documentTab.headers, che mostra i contenuti effettivi del documento di tutte le schede quando il parametro includeTabsContent è impostato su true. Se false o non impostato, questo campo contiene informazioni sulla prima scheda del documento.
footers

map (key: string, value: object (Footer))

Solo output. I piè di pagina del documento, identificati dall'ID piè di pagina.

Campo legacy: utilizza invece Document.tabs.documentTab.footers, che mostra i contenuti effettivi del documento di tutte le schede quando il parametro includeTabsContent è impostato su true. Se false o non impostato, questo campo contiene informazioni sulla prima scheda del documento.
footnotes

map (key: string, value: object (Footnote))

Solo output. Le note a piè di pagina nel documento, identificate dall'ID nota a piè di pagina.

Campo legacy: utilizza invece Document.tabs.documentTab.footnotes, che mostra i contenuti effettivi del documento di tutte le schede quando il parametro includeTabsContent è impostato su true. Se false o non impostato, questo campo contiene informazioni sulla prima scheda del documento.
documentStyle

object (DocumentStyle)

Solo output. Lo stile del documento.

Campo legacy: utilizza invece Document.tabs.documentTab.documentStyle, che mostra i contenuti effettivi del documento di tutte le schede quando il parametro includeTabsContent è impostato su true. Se false o non impostato, questo campo contiene informazioni sulla prima scheda del documento.
suggestedDocumentStyleChanges

map (key: string, value: object (SuggestedDocumentStyle))

Solo output. Le modifiche suggerite allo stile del documento, identificate dall'ID suggerimento.

Campo legacy: utilizza invece Document.tabs.documentTab.suggestedDocumentStyleChanges, che mostra i contenuti effettivi del documento di tutte le schede quando il parametro includeTabsContent è impostato su true. Se false o non impostato, questo campo contiene informazioni sulla prima scheda del documento.
namedStyles

object (NamedStyles)

Solo output. Gli stili denominati del documento.

Campo legacy: utilizza invece Document.tabs.documentTab.namedStyles, che mostra i contenuti effettivi del documento di tutte le schede quando il parametro includeTabsContent è impostato su true. Se false o non impostato, questo campo contiene informazioni sulla prima scheda del documento.
suggestedNamedStylesChanges

map (key: string, value: object (SuggestedNamedStyles))

Solo output. Le modifiche suggerite agli stili denominati del documento, identificate dall'ID suggerimento.

Campo legacy: utilizza invece Document.tabs.documentTab.suggestedNamedStylesChanges, che mostra i contenuti effettivi del documento di tutte le schede quando il parametro includeTabsContent è impostato su true. Se false o non impostato, questo campo contiene informazioni sulla prima scheda del documento.
lists

map (key: string, value: object (List))

Solo output. Gli elenchi nel documento, identificati dall'ID elenco.

Campo legacy: utilizza invece Document.tabs.documentTab.lists, che mostra i contenuti effettivi del documento di tutte le schede quando il parametro includeTabsContent è impostato su true. Se false o non impostato, questo campo contiene informazioni sulla prima scheda del documento.
namedRanges

map (key: string, value: object (NamedRanges))

Solo output. Gli intervalli denominati nel documento, identificati per nome.

Campo legacy: utilizza invece Document.tabs.documentTab.namedRanges, che mostra i contenuti effettivi del documento di tutte le schede quando il parametro includeTabsContent è impostato su true. Se false o non impostato, questo campo contiene informazioni sulla prima scheda del documento.
inlineObjects

map (key: string, value: object (InlineObject))

Solo output. Gli oggetti in linea nel documento, identificati dall'ID oggetto.

Campo legacy: utilizza invece Document.tabs.documentTab.inlineObjects, che mostra i contenuti effettivi del documento di tutte le schede quando il parametro includeTabsContent è impostato su true. Se false o non impostato, questo campo contiene informazioni sulla prima scheda del documento.
positionedObjects

map (key: string, value: object (PositionedObject))

Solo output. Gli oggetti posizionati nel documento, identificati dall'ID oggetto.

Campo legacy: utilizza invece Document.tabs.documentTab.positionedObjects, che mostra i contenuti effettivi del documento di tutte le schede quando il parametro includeTabsContent è impostato su true. Se false o non impostato, questo campo contiene informazioni sulla prima scheda del documento.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di Document appena creata.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/documents
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file

Per ulteriori informazioni, consulta la guida all'autorizzazione.