Method: documents.create

Erstellt ein leeres Dokument mit dem im Antrag 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)

Tabs, die Teil eines Dokuments sind.

Tabs können untergeordnete Tabs enthalten, d. h. einen Tab, der in einen anderen Tab eingebettet 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 Version eines Dokuments Aktualisierungen angewendet werden sollen und wie sich die Anfrage verhalten soll, wenn das Dokument seit dieser Version 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 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 die Revisions-ID zwischen den Aufrufen unverändert ist, hat sich das Dokument nicht geändert. Eine geänderte ID (für dasselbe Dokument und denselben Nutzer) bedeutet in der Regel, 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 auf das Dokument angewendete Vorschlagsansichtsmodus.

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

enum (CommentsViewMode)

Nur Ausgabe. Der auf das Dokument angewendete Ansichtsmodus für Kommentare.

comments[]

object (CommentThread)

Nur Ausgabe. Die mit dem Dokument verknüpften Kommentare. 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 mit dem Dokument verknüpften Vorschläge. 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.

Altes Feld: Verwenden Sie stattdessen Document.tabs.documentTab.body. Damit wird der tatsächliche Dokumentinhalt von allen Tabs verfügbar gemacht, 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 Überschriften im Dokument, die nach Überschrift-ID sortiert sind.

Altes Feld: Verwenden Sie stattdessen Document.tabs.documentTab.headers. Damit wird der tatsächliche Dokumentinhalt von allen Tabs verfügbar gemacht, 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, die nach Fußzeilen-ID sortiert sind.

Altes Feld: Verwenden Sie stattdessen Document.tabs.documentTab.footers. Damit wird der tatsächliche Dokumentinhalt von allen Tabs verfügbar gemacht, 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, die nach Fußnoten-ID sortiert sind.

Altes Feld: Verwenden Sie stattdessen Document.tabs.documentTab.footnotes. Damit wird der tatsächliche Dokumentinhalt von allen Tabs verfügbar gemacht, 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.

Altes Feld: Verwenden Sie stattdessen Document.tabs.documentTab.documentStyle. Damit wird der tatsächliche Dokumentinhalt von allen Tabs verfügbar gemacht, 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, die nach Vorschlags-ID sortiert sind.

Altes Feld: Verwenden Sie stattdessen Document.tabs.documentTab.suggestedDocumentStyleChanges. Damit wird der tatsächliche Dokumentinhalt von allen Tabs verfügbar gemacht, 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 Formatvorlagen des Dokuments.

Altes Feld: Verwenden Sie stattdessen Document.tabs.documentTab.namedStyles. Damit wird der tatsächliche Dokumentinhalt von allen Tabs verfügbar gemacht, 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, die nach Vorschlags-ID sortiert sind.

Altes Feld: Verwenden Sie stattdessen Document.tabs.documentTab.suggestedNamedStylesChanges. Damit wird der tatsächliche Dokumentinhalt von allen Tabs verfügbar gemacht, 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, die nach Listen-ID sortiert sind.

Altes Feld: Verwenden Sie stattdessen Document.tabs.documentTab.lists. Damit wird der tatsächliche Dokumentinhalt von allen Tabs verfügbar gemacht, 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 Namen sortiert.

Altes Feld: Verwenden Sie stattdessen Document.tabs.documentTab.namedRanges. Damit wird der tatsächliche Dokumentinhalt von allen Tabs verfügbar gemacht, 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, die nach Objekt-ID sortiert sind.

Altes Feld: Verwenden Sie stattdessen Document.tabs.documentTab.inlineObjects. Damit wird der tatsächliche Dokumentinhalt von allen Tabs verfügbar gemacht, 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, mit der Objekt-ID als Schlüssel.

Altes Feld: Verwenden Sie stattdessen Document.tabs.documentTab.positionedObjects. Damit wird der tatsächliche Dokumentinhalt von allen Tabs verfügbar gemacht, 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.