Method: documents.create

Erstellt ein leeres Dokument mit dem in der Anfrage angegebenen Titel. Andere Felder in der Anfrage, einschließlich bereitgestellter Inhalte, werden ignoriert.

Gibt das erstellte Dokument zurück.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "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)
    },
    ...
  }
}
Felder
documentId

string

Nur Ausgabe. Die ID des Dokuments.
title

string

Der Titel des Dokuments.
body

object (Body)

Nur Ausgabe. Der Hauptteil des Dokuments.
headers

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

Nur Ausgabe. Die Überschriften im Dokument, aufgeschlüsselt nach Header-ID.
footers

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

Nur Ausgabe. Die Fußzeilen im Dokument, die mit der Fußzeilen-ID versehen sind.
footnotes

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

Nur Ausgabe. Die Fußnoten im Dokument, die mit einer Fußnoten-ID versehen sind.
documentStyle

object (DocumentStyle)

Nur Ausgabe. Der Stil des Dokuments.
suggestedDocumentStyleChanges

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

Nur Ausgabe. Die vorgeschlagenen Änderungen am Stil des Dokuments, aufgeschlüsselt nach Vorschlags-ID.
namedStyles

object (NamedStyles)

Nur Ausgabe. Die benannten Stile des Dokuments.
suggestedNamedStylesChanges

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

Nur Ausgabe. Die vorgeschlagenen Änderungen an den benannten Stilen des Dokuments, aufgeschlüsselt nach Vorschlags-ID.
lists

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

Nur Ausgabe. Die Listen im Dokument, aufgeschlüsselt nach Listen-ID.
namedRanges

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

Nur Ausgabe. Die benannten Bereiche im Dokument, aufgeschlüsselt nach Namen.
revisionId

string

Nur Ausgabe. Die Überarbeitungs-ID des Dokuments. Kann in Aktualisierungsanfragen verwendet werden, um anzugeben, auf welche Überarbeitung eines Dokuments Aktualisierungen angewendet werden sollen und wie sich die Anfrage verhalten soll, wenn das Dokument seit dieser Überarbeitung bearbeitet wurde. Wird nur ausgefüllt, wenn der Nutzer Bearbeitungszugriff auf das Dokument hat.

Die Überarbeitungs-ID ist keine fortlaufende Nummer, sondern ein intransparenter String. Das Format der Überarbeitungs-ID kann sich im Laufe der Zeit ändern. Eine zurückgegebene Überarbeitungs-ID ist garantiert nur 24 Stunden lang gültig und kann nicht mit anderen Nutzern geteilt werden. Wenn die Überarbeitungs-ID zwischen Aufrufen unverändert ist, hat sich das Dokument nicht geändert. Umgekehrt bedeutet eine geänderte ID (für dasselbe Dokument und denselben Nutzer) in der Regel, dass das Dokument aktualisiert wurde. Eine geänderte ID kann jedoch auch durch interne Faktoren wie Änderungen des ID-Formats verursacht werden.
suggestionsViewMode

enum (SuggestionsViewMode)

Nur Ausgabe. Der Ansichtsmodus für Vorschläge wurde auf das Dokument angewendet.

Hinweis: Wenn Sie ein Dokument bearbeiten, müssen die Änderungen auf einem Dokument mit SUGGESTIONS_INLINE basieren.
inlineObjects

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

Nur Ausgabe. Die Inline-Objekte im Dokument, aufgeschlüsselt nach Objekt-ID.
positionedObjects

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

Nur Ausgabe. Die positionierten Objekte im Dokument, aufgeschlüsselt nach Objekt-ID.

Antworttext

Bei Erfolg enthält der Antworttext eine neu erstellte Instanz von Document.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie in der Übersicht zu OAuth 2.0.