Method: documents.create

使用请求中提供的标题创建空白文档。请求中的其他字段（包括所提供的内容）都会被忽略。

返回已创建的文档。

HTTP 请求

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

网址采用 gRPC 转码语法。

请求正文

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

JSON 表示法 
{
  "documentId": string,
  "title": string,
  "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)
    },
    ...
  },
  "revisionId": string,
  "suggestionsViewMode": enum (SuggestionsViewMode),
  "inlineObjects": {
    string: {
      object (InlineObject)
    },
    ...
  },
  "positionedObjects": {
    string: {
      object (PositionedObject)
    },
    ...
  }
}
字段
documentId

string

仅供输出。文档的 ID。
title

string

文档的标题。
body

object (Body)

仅供输出。文档正文。
headers

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

仅供输出。文档中的标头，由标头 ID 进行键控。
footers

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

仅供输出。文档中的页脚，由页脚 ID 键控。
footnotes

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

仅供输出。脚注中的脚注，由脚注 ID 键控。
documentStyle

object (DocumentStyle)

仅供输出。文档的样式。
suggestedDocumentStyleChanges

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

仅供输出。文档样式的建议更改，由建议 ID 键控。
namedStyles

object (NamedStyles)

仅供输出。文档的已命名样式。
suggestedNamedStylesChanges

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

仅供输出。建议的文档样式建议更改，由建议 ID 键控。
lists

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

仅供输出。文档中的列表，由列表 ID 键控。
namedRanges

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

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

string

仅供输出。文档的修订版本 ID。可在更新请求中使用，以指定要为哪个修订版本应用更新，以及在文档自该修订版本以来被修改后请求的行为方式。仅当用户拥有文档的编辑权限时填充。

修订版本 ID 不是序列号，而是不透明字符串。修订版本 ID 的格式可能会随时间而变化。返回的修订版本 ID 仅在其返回后的 24 小时内有效，不能在用户之间共享。如果不同调用之间的修订版本 ID 保持不变，则表示文档未更改。相反，更改后的 ID（用于同一文档和用户）通常是指文档已更新。但是，ID 也可能是由于内部因素（例如 ID 格式更改）而产生的。
suggestionsViewMode

enum (SuggestionsViewMode)

仅供输出。应用于文档的建议查看模式。

注意：编辑文档时，所做更改必须基于包含 SUGGESTIONS_INLINE 的文档。
inlineObjects

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

仅供输出。文档中内嵌的对象，由对象 ID 键控。
positionedObjects

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

仅供输出。文档中已定位的对象，由对象 ID 键控。

响应正文

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

授权范围

需要以下 OAuth 范围之一：

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

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