Google Docs API (docs:v1)

2026-09-26

1 updated method

Updates

    Methods

  • ▼ ▲ docs.documents.get

      Parameters :

        commentsViewMode

          Enum :

        • COMMENTS_VIEW_MODE_UNSPECIFIED
        • COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS
        • COMMENTS_VIEW_MODE_OMITTED
        • COMMENTS_VIEW_MODE_INCLUDED

          • Location : query

          Enum Descriptions :

        • The CommentsViewMode is unspecified. COMMENTS_VIEW_MODE_OMITTED is applied.
        • The CommentsViewMode applied to the returned document depends on the user's current access level. If the user only has view access, COMMENTS_VIEW_MODE_OMITTED is applied. Otherwise, COMMENTS_VIEW_MODE_INCLUDED is applied.
        • The returned document has comments omitted.
        • The returned document has comments included. Requests to retrieve a document using this mode will return a 403 error if the user does not have permission to view comments. When set, suggestions_view_mode must also be set to SUGGESTIONS_INLINE. Returns a 400 bad request error otherwise.

          • Type : string

          Description : 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 comments_view_mode to any value, you must also set include_tabs_content to `true` or use a field mask that references the Document.tabs field (or any subfield). If you set comments_view_mode to COMMENTS_VIEW_MODE_INCLUDED, you must also explicitly set suggestions_view_mode to SUGGESTIONS_INLINE. If you set comments_view_mode to COMMENTS_VIEW_MODE_INCLUDED or COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS, you may not set suggestions_view_mode to PREVIEW_WITHOUT_SUGGESTIONS or PREVIEW_SUGGESTIONS_ACCEPTED. [Developer Preview](https://developers.google.com/workspace/preview).