Method: documents.create

Erstellt ein leeres Dokument mit dem in der Anfrage angegebenen Titel. Andere Felder in der Anfrage, einschließlich der bereitgestellten 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,
  "tabs": [
    {
      object (Tab)
    }
  ],
  "revisionId": string,
  "suggestionsViewMode": enum (SuggestionsViewMode),
  "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)
    },
    ...
  }
}
Felder
documentId

string

Nur Ausgabe. Die ID des Dokuments.
title

string

Der Titel des Dokuments.
tabs[]

object (Tab)

Tabs, die Teil eines Dokuments sind.

Tabs können untergeordnete Tabs enthalten, also einen Tab, der in einem anderen Tab verschachtelt ist. Untergeordnete Tabs werden durch das Feld Tab.childTabs dargestellt.
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 nach der Rückgabe nur 24 Stunden lang gültig und kann nicht mit anderen Nutzern geteilt werden. Wenn die Überarbeitungs-ID zwischen den Aufrufen unverändert bleibt, hat sich das Dokument nicht geändert. Umgekehrt bedeutet eine geänderte ID (für dasselbe Dokument und denselben Nutzer) normalerweise, dass das Dokument aktualisiert wurde. Eine geänderte ID kann jedoch auch auf interne Faktoren wie Änderungen des ID-Formats zurückzuführen sein.
suggestionsViewMode

enum (SuggestionsViewMode)

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

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

object (Body)

Nur Ausgabe. Der Hauptteil des Dokuments.

Altes Feld: Verwenden Sie stattdessen Document.tabs.documentTab.body. Damit wird der tatsächliche Dokumentinhalt aus allen Tabs angezeigt, wenn der Parameter includeTabsContent auf true gesetzt ist. Wenn false festgelegt oder nicht konfiguriert ist, enthält dieses Feld Informationen zum ersten Tab im Dokument.
headers

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

Nur Ausgabe. Die Header im Dokument, mit Header-ID versehen.

Altes Feld: Verwenden Sie stattdessen Document.tabs.documentTab.headers. Damit wird der tatsächliche Dokumentinhalt aus allen Tabs angezeigt, wenn der Parameter includeTabsContent auf true gesetzt ist. Wenn false festgelegt oder nicht konfiguriert ist, enthält dieses Feld Informationen zum ersten Tab im Dokument.
footers

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

Nur Ausgabe. Die Fußzeilen im Dokument, mit einer Fußzeilen-ID versehen.

Altes Feld: Verwenden Sie stattdessen Document.tabs.documentTab.footers. Damit wird der tatsächliche Dokumentinhalt aus allen Tabs angezeigt, wenn der Parameter includeTabsContent auf true gesetzt ist. Wenn false festgelegt oder nicht konfiguriert ist, enthält dieses Feld Informationen zum ersten Tab im Dokument.
footnotes

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

Nur Ausgabe. Die Fußnoten im Dokument, mit Fußnoten-ID versehen.

Altes Feld: Verwenden Sie stattdessen Document.tabs.documentTab.footnotes. Damit wird der tatsächliche Dokumentinhalt aus allen Tabs angezeigt, wenn der Parameter includeTabsContent auf true gesetzt ist. Wenn false festgelegt oder nicht konfiguriert ist, enthält dieses Feld Informationen zum ersten Tab im Dokument.
documentStyle

object (DocumentStyle)

Nur Ausgabe. Der Stil des Dokuments.

Altes Feld: Verwenden Sie stattdessen Document.tabs.documentTab.documentStyle. Damit wird der tatsächliche Dokumentinhalt aus allen Tabs angezeigt, wenn der Parameter includeTabsContent auf true gesetzt ist. Wenn false festgelegt oder nicht konfiguriert ist, enthält dieses Feld Informationen zum ersten Tab im Dokument.
suggestedDocumentStyleChanges

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

Nur Ausgabe. Die vorgeschlagenen Änderungen am Stil des Dokuments, unterstützt durch die Vorschlags-ID.

Altes Feld: Verwenden Sie stattdessen Document.tabs.documentTab.suggestedDocumentStyleChanges. Damit wird der tatsächliche Dokumentinhalt aus allen Tabs angezeigt, wenn der Parameter includeTabsContent auf true gesetzt ist. Wenn false festgelegt oder nicht konfiguriert ist, enthält dieses Feld Informationen zum ersten Tab im Dokument.
namedStyles

object (NamedStyles)

Nur Ausgabe. Die benannten Stile des Dokuments.

Altes Feld: Verwenden Sie stattdessen Document.tabs.documentTab.namedStyles. Damit wird der tatsächliche Dokumentinhalt aus allen Tabs angezeigt, wenn der Parameter includeTabsContent auf true gesetzt ist. Wenn false festgelegt oder nicht konfiguriert ist, enthält dieses Feld Informationen zum ersten Tab im Dokument.
suggestedNamedStylesChanges

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

Nur Ausgabe. Die vorgeschlagenen Änderungen an den benannten Stilen des Dokuments, codiert durch Vorschlags-ID.

Altes Feld: Verwenden Sie stattdessen Document.tabs.documentTab.suggestedNamedStylesChanges. Damit wird der tatsächliche Dokumentinhalt aus allen Tabs angezeigt, wenn der Parameter includeTabsContent auf true gesetzt ist. Wenn false festgelegt oder nicht konfiguriert ist, enthält dieses Feld Informationen zum ersten Tab im Dokument.
lists

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

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

Altes Feld: Verwenden Sie stattdessen Document.tabs.documentTab.lists. Damit wird der tatsächliche Dokumentinhalt aus allen Tabs angezeigt, wenn der Parameter includeTabsContent auf true gesetzt ist. Wenn false festgelegt oder nicht konfiguriert ist, enthält dieses Feld Informationen zum ersten Tab im Dokument.
namedRanges

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

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

Altes Feld: Verwenden Sie stattdessen Document.tabs.documentTab.namedRanges. Damit wird der tatsächliche Dokumentinhalt aus allen Tabs angezeigt, wenn der Parameter includeTabsContent auf true gesetzt ist. Wenn false festgelegt oder nicht konfiguriert ist, enthält dieses Feld Informationen zum ersten Tab im Dokument.
inlineObjects

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

Nur Ausgabe. Die Inline-Objekte im Dokument, die mit der Objekt-ID versehen sind.

Altes Feld: Verwenden Sie stattdessen Document.tabs.documentTab.inlineObjects. Damit wird der tatsächliche Dokumentinhalt aus allen Tabs angezeigt, wenn der Parameter includeTabsContent auf true gesetzt ist. Wenn false festgelegt oder nicht konfiguriert ist, enthält dieses Feld Informationen zum ersten Tab im Dokument.
positionedObjects

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

Nur Ausgabe. Die positionierten Objekte im Dokument, angegeben durch die Objekt-ID.

Altes Feld: Verwenden Sie stattdessen Document.tabs.documentTab.positionedObjects. Damit wird der tatsächliche Dokumentinhalt aus allen Tabs angezeigt, wenn der Parameter includeTabsContent auf true gesetzt ist. Wenn false festgelegt oder nicht konfiguriert ist, enthält dieses Feld Informationen zum ersten Tab im Dokument.

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 im Leitfaden zur Autorisierung.