Method: documents.create

Crea un documento vuoto utilizzando il titolo specificato nella richiesta. Gli altri campi della richiesta, inclusi eventuali 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,
  "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)
    },
    ...
  },
  "revisionId": string,
  "suggestionsViewMode": enum (SuggestionsViewMode),
  "inlineObjects": {
    string: {
      object (InlineObject)
    },
    ...
  },
  "positionedObjects": {
    string: {
      object (PositionedObject)
    },
    ...
  }
}
Campi
documentId

string

Solo output. ID del documento.
title

string

Il titolo del documento.
body

object (Body)

Solo output. Il corpo principale del documento.
headers

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

Solo output. Le intestazioni del documento, digitate in base all'ID intestazione.
footers

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

Solo output. I piè di pagina nel documento, abbinati a ID piè di pagina.
footnotes

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

Solo output. Le note a piè di pagina nel documento, associate all'ID nota.
documentStyle

object (DocumentStyle)

Solo output. Lo stile del documento.
suggestedDocumentStyleChanges

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

Solo output. Le modifiche suggerite modificano lo stile del documento e sono bloccate in base all'ID suggerimento.
namedStyles

object (NamedStyles)

Solo output. Gli stili denominati del documento.
suggestedNamedStylesChanges

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

Solo output. Le modifiche suggerite vengono apportate agli stili denominati del documento, associati a un ID suggerimento.
lists

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

Solo output. Gli elenchi nel documento, digitati in base all'ID elenco.
namedRanges

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

Solo output. Gli intervalli denominati nel documento, digitati per nome.
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 ha 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 per essere valido solo per 24 ore dopo che è stato restituito e non può essere condiviso tra utenti. Se l'ID revisione è rimasto invariato tra le chiamate, il documento non è cambiato. Al contrario, un ID modificato (per lo stesso documento e lo stesso utente) generalmente significa che il documento è stato aggiornato. Tuttavia, un ID modificato può essere dovuto anche a fattori interni, come le 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 essere basate su un documento con SUGGESTIONS_INLINE.
inlineObjects

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

Solo output. Gli oggetti incorporati nel documento, associati a un ID oggetto.
positionedObjects

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

Solo output. Gli oggetti posizionati nel documento, associati a un ID oggetto.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza 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 alle autorizzazioni.