发送反馈
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
) ,
"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
)
} ,
...
}
}
字段
document Id
string
仅限输出。文档的 ID。
title
string
文档的标题。
tabs[]
object (Tab
)
文档中的标签页。
标签页可以包含子标签页,即嵌套在其他标签页中的标签页。子标签页由 Tab.childTabs
字段表示。
revision Id
string
仅限输出。文档的修订 ID。可在更新请求中使用,用于指定要将更新应用到文档的哪个修订版本,以及如果文档在该修订版本之后被修改,请求应如何处理。仅当用户拥有文档编辑权限时,此字段才会显示内容。
修订版本 ID 不是顺序编号,而是一个不透明字符串。修订 ID 的格式可能会随时间而变化。返回的修订 ID 仅保证在返回后的 24 小时内有效,并且不能在用户之间共享。如果在两次调用之间修订 ID 保持不变,则表示文档未发生更改。反之,如果 ID 发生了更改(对于同一文档和用户),通常表示文档已更新。不过,ID 更改也可能是由内部因素(例如 ID 格式更改)导致的。
suggestions View Mode
enum (SuggestionsViewMode
)
仅限输出。应用于文档的建议查看模式。
注意:修改文档时,必须基于包含 SUGGESTIONS_INLINE
的文档进行更改。
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
或未设置,此字段包含文档中第一个标签页的相关信息。
document Style
object (DocumentStyle
)
仅限输出。文档的样式。
旧版字段:请改用 Document.tabs.documentTab.documentStyle
,当 includeTabsContent
参数设置为 true
时,它会显示所有标签页中的实际文档内容。如果为 false
或未设置,此字段包含文档中第一个标签页的相关信息。
suggested Document Style Changes
map (key: string, value: object (SuggestedDocumentStyle
))
仅限输出。对文档样式的建议更改,按建议 ID 编入键值对。
旧版字段:请改用 Document.tabs.documentTab.suggestedDocumentStyleChanges
,当 includeTabsContent
参数设置为 true
时,它会显示所有标签页中的实际文档内容。如果为 false
或未设置,此字段包含文档中第一个标签页的相关信息。
named Styles
object (NamedStyles
)
仅限输出。文档的命名样式。
旧版字段:请改用 Document.tabs.documentTab.namedStyles
,当 includeTabsContent
参数设置为 true
时,它会显示所有标签页中的实际文档内容。如果为 false
或未设置,此字段包含文档中第一个标签页的相关信息。
suggested Named Styles Changes
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
或未设置,此字段包含文档中第一个标签页的相关信息。
named Ranges
map (key: string, value: object (NamedRanges
))
仅限输出。文档中的命名范围,按名称键值对排列。
旧版字段:请改用 Document.tabs.documentTab.namedRanges
,当 includeTabsContent
参数设置为 true
时,它会显示所有标签页中的实际文档内容。如果为 false
或未设置,此字段包含文档中第一个标签页的相关信息。
inline Objects
map (key: string, value: object (InlineObject
))
仅限输出。文档中的内嵌对象,由对象 ID 键控。
旧版字段:请改用 Document.tabs.documentTab.inlineObjects
,当 includeTabsContent
参数设置为 true
时,它会显示所有标签页中的实际文档内容。如果为 false
或未设置,此字段包含文档中第一个标签页的相关信息。
positioned Objects
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
如需了解详情,请参阅授权指南 。
发送反馈
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可 获得了许可,并且代码示例已根据 Apache 2.0 许可 获得了许可。有关详情,请参阅 Google 开发者网站政策 。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2024-11-09。
需要向我们提供更多信息?
[[["易于理解","easyToUnderstand","thumb-up"],["解决了我的问题","solvedMyProblem","thumb-up"],["其他","otherUp","thumb-up"]],[["没有我需要的信息","missingTheInformationINeed","thumb-down"],["太复杂/步骤太多","tooComplicatedTooManySteps","thumb-down"],["内容需要更新","outOfDate","thumb-down"],["翻译问题","translationIssue","thumb-down"],["示例/代码问题","samplesCodeIssue","thumb-down"],["其他","otherDown","thumb-down"]],["最后更新时间 (UTC):2024-11-09。"],[[["Creates a new Google Docs document with the specified title, leaving all other content blank."],["Uses a POST request to `https://docs.googleapis.com/v1/documents` with the document title in the request body."],["Returns the newly created document object in the response."],["Requires authorization with specific Google Docs or Drive scopes."]]],[]]