Method: documents.create

使用请求中给定的标题创建空白文档。请求中的其他字段（包括任何提供的内容）将被忽略。

返回创建的文档。

HTTP 请求

POST https://docs.googleapis.com/v1/documents

网址采用 gRPC 转码语法。

请求正文

请求正文中包含结构如下的数据：

JSON 表示法 
{
  "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)
    },
    ...
  }
}
字段
documentId

string

仅限输出。文档的 ID。
title

string

文档的标题。
tabs[]

object (Tab)

属于文档一部分的标签页。

标签页可以包含子标签页，即嵌套在另一个标签页中的标签页。子标签页由 Tab.childTabs 字段表示。
revisionId

string

仅限输出。文档的修订版本 ID。可在更新请求中使用，以指定要将更新应用于哪个文档修订版本，以及如果文档自该修订版本以来已进行编辑，请求应如何运行。仅当用户对文档具有修改权限时才会填充。

修订版本 ID 不是连续编号，而是一个不透明的字符串。修订版本 ID 的格式可能会随时间而变化。返回的修订版本 ID 仅保证在返回后 24 小时内有效，并且不能在用户之间共享。如果调用之间的修订版本 ID 没有变化，则表示文档没有变化。相反，如果 ID 发生变化（对于同一文档和用户），通常意味着文档已更新。不过，ID 发生变化也可能是由于内部因素（例如 ID 格式变化）所致。
suggestionsViewMode

enum (SuggestionsViewMode)

仅限输出。应用于文档的建议视图模式。

注意：在编辑文档时，更改必须基于具有 SUGGESTIONS_INLINE 的文档。
commentsViewMode

enum (CommentsViewMode)

仅限输出。应用于文档的评论视图模式。
comments[]

object (CommentThread)

仅限输出。与文档关联的评论。仅当 commentsViewMode 参数设置为需要评论时（例如 COMMENTS_VIEW_MODE_INCLUDED）才会填充。
suggestions[]

object (SuggestionThread)

仅限输出。与文档关联的建议。仅当 commentsViewMode 参数设置为需要评论时（例如 COMMENTS_VIEW_MODE_INCLUDED）才会填充。
body

object (Body)

仅限输出。文档的正文。

旧版字段：请改用 Document.tabs.documentTab.body，当 includeTabsContent 参数设置为 true 时，该字段会显示所有标签页中的实际文档内容。如果设置为 false 或未设置，此字段将包含有关文档中第一个标签页的信息。
headers

map (key: string, value: object (Header))

仅限输出。文档中的页眉，按页眉 ID 键控。

旧版字段：请改用 Document.tabs.documentTab.headers，当 includeTabsContent 参数设置为 true 时，该字段会显示所有标签页中的实际文档内容。如果设置为 false 或未设置，此字段将包含有关文档中第一个标签页的信息。
footers

map (key: string, value: object (Footer))

仅限输出。文档中的页脚，按页脚 ID 键控。

旧版字段：请改用 Document.tabs.documentTab.footers，当 includeTabsContent 参数设置为 true 时，该字段会显示所有标签页中的实际文档内容。如果设置为 false 或未设置，此字段将包含有关文档中第一个标签页的信息。
footnotes

map (key: string, value: object (Footnote))

仅限输出。文档中的脚注，按脚注 ID 键控。

旧版字段：请改用 Document.tabs.documentTab.footnotes，当 includeTabsContent 参数设置为 true 时，该字段会显示所有标签页中的实际文档内容。如果设置为 false 或未设置，此字段将包含有关文档中第一个标签页的信息。
documentStyle

object (DocumentStyle)

仅限输出。文档的样式。

旧版字段：请改用 Document.tabs.documentTab.documentStyle，当 includeTabsContent 参数设置为 true 时，该字段会显示所有标签页中的实际文档内容。如果设置为 false 或未设置，此字段将包含有关文档中第一个标签页的信息。
suggestedDocumentStyleChanges

map (key: string, value: object (SuggestedDocumentStyle))

仅限输出。对文档样式的建议更改，按建议 ID 键控。

旧版字段：请改用 Document.tabs.documentTab.suggestedDocumentStyleChanges，当 includeTabsContent 参数设置为 true 时，该字段会显示所有标签页中的实际文档内容。如果设置为 false 或未设置，此字段将包含有关文档中第一个标签页的信息。
namedStyles

object (NamedStyles)

仅限输出。文档的命名样式。

旧版字段：请改用 Document.tabs.documentTab.namedStyles，当 includeTabsContent 参数设置为 true 时，该字段会显示所有标签页中的实际文档内容。如果设置为 false 或未设置，此字段将包含有关文档中第一个标签页的信息。
suggestedNamedStylesChanges

map (key: string, value: object (SuggestedNamedStyles))

仅限输出。对文档命名样式的建议更改，按建议 ID 键控。

旧版字段：请改用 Document.tabs.documentTab.suggestedNamedStylesChanges，当 includeTabsContent 参数设置为 true 时，该字段会显示所有标签页中的实际文档内容。如果设置为 false 或未设置，此字段将包含有关文档中第一个标签页的信息。
lists

map (key: string, value: object (List))

仅限输出。文档中的列表，按列表 ID 键控。

旧版字段：请改用 Document.tabs.documentTab.lists，当 includeTabsContent 参数设置为 true 时，该字段会显示所有标签页中的实际文档内容。如果设置为 false 或未设置，此字段将包含有关文档中第一个标签页的信息。
namedRanges

map (key: string, value: object (NamedRanges))

仅限输出。文档中的命名范围，按名称键控。

旧版字段：请改用 Document.tabs.documentTab.namedRanges，当 includeTabsContent 参数设置为 true 时，该字段会显示所有标签页中的实际文档内容。如果设置为 false 或未设置，此字段将包含有关文档中第一个标签页的信息。
inlineObjects

map (key: string, value: object (InlineObject))

仅限输出。文档中的内嵌对象，按对象 ID 键控。

旧版字段：请改用 Document.tabs.documentTab.inlineObjects，当 includeTabsContent 参数设置为 true 时，该字段会显示所有标签页中的实际文档内容。如果设置为 false 或未设置，此字段将包含有关文档中第一个标签页的信息。
positionedObjects

map (key: string, value: object (PositionedObject))

仅限输出。文档中的定位对象，按对象 ID 键控。

旧版字段：请改用 Document.tabs.documentTab.positionedObjects，当 includeTabsContent 参数设置为 true 时，该字段会显示所有标签页中的实际文档内容。如果设置为 false 或未设置，此字段将包含有关文档中第一个标签页的信息。

响应正文

如果成功，响应正文将包含一个新创建的 Document 实例。

授权范围

需要以下 OAuth 范围之一：

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

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