Method: documents.create

Erstellt ein leeres Dokument mit dem in der Anfrage angegebenen Titel. Andere Felder in der Anfrage, einschließlich aller 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),
  "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)
    },
    ...
  }
}
Felder
documentId

string

Nur Ausgabe. Die ID des Dokuments.
title

string

Der Titel des Dokuments.
tabs[]

object (Tab)

Nur Ausgabe. Tabs, die Teil eines Dokuments sind.

Tabs können untergeordnete Tabs enthalten, d. h. ein Tab, das in einem anderen Tab verschachtelt ist. Untergeordnete Tabs werden durch das Feld Tab.childTabs dargestellt.
revisionId

string

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

Die Revisions-ID ist keine fortlaufende Nummer, sondern ein undurchsichtiger String. Das Format der Revisions-ID kann sich im Laufe der Zeit ändern. Eine zurückgegebene Revisions-ID ist nur 24 Stunden nach der Rückgabe gültig und kann nicht für mehrere Nutzer freigegeben werden. Wenn sich die Revisions-ID zwischen den Aufrufen nicht ändert, wurde 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 aber auch auf interne Faktoren wie Änderungen am ID-Format zurückzuführen sein.
suggestionsViewMode

enum (SuggestionsViewMode)

Nur Ausgabe. Der auf das Dokument angewendete Vorschlagsansichtsmodus.

Hinweis: Beim Bearbeiten eines Dokuments müssen Änderungen auf einem Dokument mit SUGGESTIONS_INLINE basieren.
commentsViewMode

enum (CommentsViewMode)

Nur Ausgabe. Der auf das Dokument angewendete Kommentaransichtsmodus.

comments[]

object (CommentThread)

Nur Ausgabe. Die Kommentare, die mit dem Dokument verknüpft sind. Wird nur ausgefüllt, wenn der Parameter commentsViewMode so festgelegt ist, dass Kommentare erforderlich sind (z. B. COMMENTS_VIEW_MODE_INCLUDED).

suggestions[]

object (SuggestionThread)

Nur Ausgabe. Die Vorschläge, die mit dem Dokument verknüpft sind. Wird nur ausgefüllt, wenn der Parameter commentsViewMode so festgelegt ist, dass Kommentare erforderlich sind (z. B. COMMENTS_VIEW_MODE_INCLUDED).

body

object (Body)

Nur Ausgabe. Der Hauptteil des Dokuments.

Legacy-Feld: Verwenden Sie stattdessen Document.tabs.documentTab.body, das den tatsächlichen Dokumentinhalt aus allen Tabs verfügbar macht, wenn der Parameter includeTabsContent auf true gesetzt ist. Wenn false oder nicht festgelegt, enthält dieses Feld Informationen zum ersten Tab im Dokument.
headers

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

Nur Ausgabe. Die Header im Dokument, nach Header-ID.

Legacy-Feld: Verwenden Sie stattdessen Document.tabs.documentTab.headers, das den tatsächlichen Dokumentinhalt aus allen Tabs verfügbar macht, wenn der Parameter includeTabsContent auf true gesetzt ist. Wenn false oder nicht festgelegt, enthält dieses Feld Informationen zum ersten Tab im Dokument.
footers

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

Nur Ausgabe. Die Fußzeilen im Dokument, nach Fußzeilen-ID.

Legacy-Feld: Verwenden Sie stattdessen Document.tabs.documentTab.footers, das den tatsächlichen Dokumentinhalt aus allen Tabs verfügbar macht, wenn der Parameter includeTabsContent auf true gesetzt ist. Wenn false oder nicht festgelegt, enthält dieses Feld Informationen zum ersten Tab im Dokument.
footnotes

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

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

Legacy-Feld: Verwenden Sie stattdessen Document.tabs.documentTab.footnotes, das den tatsächlichen Dokumentinhalt aus allen Tabs verfügbar macht, wenn der Parameter includeTabsContent auf true gesetzt ist. Wenn false oder nicht festgelegt, enthält dieses Feld Informationen zum ersten Tab im Dokument.
documentStyle

object (DocumentStyle)

Nur Ausgabe. Der Stil des Dokuments.

Legacy-Feld: Verwenden Sie stattdessen Document.tabs.documentTab.documentStyle, das den tatsächlichen Dokumentinhalt aus allen Tabs verfügbar macht, wenn der Parameter includeTabsContent auf true gesetzt ist. Wenn false oder nicht festgelegt, 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, nach Vorschlags-ID.

Legacy-Feld: Verwenden Sie stattdessen Document.tabs.documentTab.suggestedDocumentStyleChanges, das den tatsächlichen Dokumentinhalt aus allen Tabs verfügbar macht, wenn der Parameter includeTabsContent auf true gesetzt ist. Wenn false oder nicht festgelegt, enthält dieses Feld Informationen zum ersten Tab im Dokument.
namedStyles

object (NamedStyles)

Nur Ausgabe. Die benannten Stile des Dokuments.

Legacy-Feld: Verwenden Sie stattdessen Document.tabs.documentTab.namedStyles, das den tatsächlichen Dokumentinhalt aus allen Tabs verfügbar macht, wenn der Parameter includeTabsContent auf true gesetzt ist. Wenn false oder nicht festgelegt, 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, nach Vorschlags-ID.

Legacy-Feld: Verwenden Sie stattdessen Document.tabs.documentTab.suggestedNamedStylesChanges, das den tatsächlichen Dokumentinhalt aus allen Tabs verfügbar macht, wenn der Parameter includeTabsContent auf true gesetzt ist. Wenn false oder nicht festgelegt, enthält dieses Feld Informationen zum ersten Tab im Dokument.
lists

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

Nur Ausgabe. Die Listen im Dokument, nach Listen-ID.

Legacy-Feld: Verwenden Sie stattdessen Document.tabs.documentTab.lists, das den tatsächlichen Dokumentinhalt aus allen Tabs verfügbar macht, wenn der Parameter includeTabsContent auf true gesetzt ist. Wenn false oder nicht festgelegt, enthält dieses Feld Informationen zum ersten Tab im Dokument.
namedRanges

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

Nur Ausgabe. Die benannten Bereiche im Dokument, nach Name.

Legacy-Feld: Verwenden Sie stattdessen Document.tabs.documentTab.namedRanges, das den tatsächlichen Dokumentinhalt aus allen Tabs verfügbar macht, wenn der Parameter includeTabsContent auf true gesetzt ist. Wenn false oder nicht festgelegt, enthält dieses Feld Informationen zum ersten Tab im Dokument.
inlineObjects

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

Nur Ausgabe. Die Inline-Objekte im Dokument, nach Objekt-ID.

Legacy-Feld: Verwenden Sie stattdessen Document.tabs.documentTab.inlineObjects, das den tatsächlichen Dokumentinhalt aus allen Tabs verfügbar macht, wenn der Parameter includeTabsContent auf true gesetzt ist. Wenn false oder nicht festgelegt, enthält dieses Feld Informationen zum ersten Tab im Dokument.
positionedObjects

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

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

Legacy-Feld: Verwenden Sie stattdessen Document.tabs.documentTab.positionedObjects, das den tatsächlichen Dokumentinhalt aus allen Tabs verfügbar macht, wenn der Parameter includeTabsContent auf true gesetzt ist. Wenn false oder nicht festgelegt, enthält dieses Feld Informationen zum ersten Tab im Dokument.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, 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 Autorisierungsleitfaden.