Method: documents.get

Ruft die aktuelle Version des angegebenen Dokuments ab.

HTTP-Anfrage

GET https://docs.googleapis.com/v1/documents/{documentId}

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
documentId

string

Die ID des abzurufenden Dokuments.

Suchparameter

Parameter
suggestionsViewMode

enum (SuggestionsViewMode)

Der Vorschlagsansichtsmodus, der auf das Dokument angewendet werden soll. So können Sie das Dokument mit allen Vorschlägen inline, angenommen oder abgelehnt ansehen. Wenn keine angegeben ist, wird DEFAULT_FOR_CURRENT_ACCESS verwendet.
includeTabsContent

boolean

Gibt an, ob das Feld Document.tabs anstelle der Textinhaltsfelder wie body und documentStyle für Document ausgefüllt werden soll.

  • Wenn true: Der Dokumentinhalt wird im Feld Document.tabs anstelle der Textinhaltsfelder in Document eingefügt.

  • Wenn false: Die Inhaltsfelder in Document werden mit dem Inhalt des ersten Tabs des Dokuments gefüllt, mit Ausnahme von Document.tabs. Wenn ein Dokument nur einen Tab hat, wird dieser Tab verwendet, um den Dokumentinhalt zu generieren. Document.tabs ist leer.

Wenn Sie eine Feldmaske verwenden, die auf das Feld Document.tabs (oder ein beliebiges Unterfeld) verweist, behandelt die API die Anfrage implizit so, als ob Sie includeTabsContent auf true gesetzt hätten.
commentsViewMode

enum (CommentsViewMode)

Der Kommentaransichtsmodus, der auf das Dokument angewendet werden soll. So können Sie das Dokument mit oder ohne Kommentare aufrufen. Wenn keine angegeben ist, wird COMMENTS_VIEW_MODE_OMITTED verwendet.

Wenn Sie commentsViewMode auf einen beliebigen Wert festlegen, müssen Sie auch includeTabsContent auf true setzen oder eine Feldmaske verwenden, die auf das Feld Document.tabs (oder ein beliebiges Unterfeld) verweist.

Wenn Sie commentsViewMode auf COMMENTS_VIEW_MODE_INCLUDED setzen, müssen Sie auch suggestionsViewMode explizit auf SUGGESTIONS_INLINE setzen.

Wenn Sie commentsViewMode auf COMMENTS_VIEW_MODE_INCLUDED oder COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS festlegen, dürfen Sie suggestionsViewMode nicht auf PREVIEW_WITHOUT_SUGGESTIONS oder PREVIEW_SUGGESTIONS_ACCEPTED festlegen.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Document.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie im Autorisierungsleitfaden.