Method: documents.get

获取指定文档的最新版本。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
documentId

string

要检索的文档的 ID。

查询参数

参数
suggestionsViewMode

enum (SuggestionsViewMode)

要应用于文档的建议视图模式。这样一来,您就可以查看文档,其中所有建议都以嵌入方式显示,无论建议是被接受还是被拒绝。如果未指定,则使用 DEFAULT_FOR_CURRENT_ACCESS。

includeTabsContent

boolean

是否在 Document 上填充 Document.tabs 字段,而不是文本内容字段(如 body 和 documentStyle)。

  • 当值为 true 时:文档内容会填充到 Document.tabs 字段中,而不是 Document 中的文本内容字段。

  • 当 false 时:文档第一个标签页的内容会填充 Document 中的内容字段(不包括 Document.tabs)。如果文档只有一个标签页,则该标签页用于填充文档内容。Document.tabs 将为空。

如果您使用的字段掩码引用了 Document.tabs 字段(或任何子字段),则 API 会隐式将该请求视为您将 includeTabsContent 设置为 true。

commentsViewMode

enum (CommentsViewMode)

要应用于文档的评论视图模式。这样一来,您就可以选择查看省略或包含注释的文档。如果未指定,则使用 COMMENTS_VIEW_MODE_OMITTED。

如果您将 commentsViewMode 设置为任何值,则还必须将 includeTabsContent 设置为 true,或者使用引用 Document.tabs 字段(或任何子字段)的字段掩码。

如果您将 commentsViewMode 设置为 COMMENTS_VIEW_MODE_INCLUDED,则还必须明确将 suggestionsViewMode 设置为 SUGGESTIONS_INLINE。

如果您将 commentsViewMode 设置为 COMMENTS_VIEW_MODE_INCLUDED 或 COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS,则不得将 suggestionsViewMode 设置为 PREVIEW_WITHOUT_SUGGESTIONS 或 PREVIEW_SUGGESTIONS_ACCEPTED。

请求正文

请求正文必须为空。

响应正文

如果成功,则响应正文包含一个 Document 实例。

授权范围

需要以下 OAuth 范围之一:

  • 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

如需了解详情,请参阅授权指南。