Method: documents.get

Gets the latest version of the specified document.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
documentId

string

The ID of the document to retrieve.

Query parameters

Parameters
suggestionsViewMode

enum (SuggestionsViewMode)

The suggestions view mode to apply to the document. This allows viewing the document with all suggestions inline, accepted or rejected. If one is not specified, DEFAULT_FOR_CURRENT_ACCESS is used.
includeTabsContent

boolean

Whether to populate the Document.tabs field instead of the text content fields like body and documentStyle on Document.

  • When true: Document content populates in the Document.tabs field instead of the text content fields in Document.

  • When false: The content of the document's first tab populates the content fields in Document excluding Document.tabs. If a document has only one tab, then that tab is used to populate the document content. Document.tabs will be empty.

If you use a field mask that references the Document.tabs field (or any subfield), the API implicitly treats the request as if you set includeTabsContent to true.
commentsViewMode

enum (CommentsViewMode)

The comments view mode to apply to the document. This allows viewing the document with comments omitted or included. If one is not specified, COMMENTS_VIEW_MODE_OMITTED is used.

If you set commentsViewMode to any value, you must also set includeTabsContent to true or use a field mask that references the Document.tabs field (or any subfield).

If you set commentsViewMode to COMMENTS_VIEW_MODE_INCLUDED, you must also explicitly set suggestionsViewMode to SUGGESTIONS_INLINE.

If you set commentsViewMode to COMMENTS_VIEW_MODE_INCLUDED or COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS, you may not set suggestionsViewMode to PREVIEW_WITHOUT_SUGGESTIONS or PREVIEW_SUGGESTIONS_ACCEPTED.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Document.

Authorization scopes

Requires one of the following OAuth scopes:

  • 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

For more information, see the Authorization guide.