通过 Google 文档，协作者可以 建议 有效延迟了修改等待审批。
当您使用 documents.get 时
方法提取文档内容，但内容可能包含未解析的
建议。如需控制 documents.get 表示建议的方式，请使用
可选
SuggestionsViewMode
参数。此参数提供以下过滤条件：
- 通过
SUGGESTIONS_INLINE获取内容，以便文本处于待删除状态或等待删除状态 是否出现在文档中。 - 以预览形式获取内容，并接受所有建议。
- 以预览形式获取内容，但不提供建议，并且提供所有建议 已被拒绝。
如果您未提供 SuggestionsViewMode，则 Google 文档 API 会使用默认的
设置适合当前用户的权限。
建议与索引
SuggestionsViewMode 非常重要的一个原因是，
视是否存在建议而有所不同，如下所示。
| 包含建议的内容 | 内容（不含建议） |
|---|---|
{
"tabs": [
{
"documentTab": {
"body": {
"content": [
{
"startIndex": 1,
"endIndex": 31,
"paragraph": {
"elements": [
{
"startIndex": 1,
"endIndex": 31,
"textRun": {
"content": "Text preceding the suggestion\n",
"textStyle": {}
}
}
],
"paragraphStyle": {
"namedStyleType": "NORMAL_TEXT",
"direction": "LEFT_TO_RIGHT"
}
}
},
{
"startIndex": 31,
"endIndex": 51,
"paragraph": {
"elements": [
{
"startIndex": 31,
"endIndex": 50,
"textRun": {
"content": "Suggested insertion",
"suggestedInsertionIds": [
"suggest.vcti8ewm4mww"
],
"textStyle": {}
}
},
{
"startIndex": 50,
"endIndex": 51,
"textRun": {
"content": "\n",
"textStyle": {}
}
}
],
"paragraphStyle": {
"namedStyleType": "NORMAL_TEXT",
"direction": "LEFT_TO_RIGHT"
}
}
},
{
"startIndex": 51,
"endIndex": 81,
"paragraph": {
"elements": [
{
"startIndex": 51,
"endIndex": 81,
"textRun": {
"content": "Text following the suggestion\n",
"textStyle": {}
}
}
],
"paragraphStyle": {
"namedStyleType": "NORMAL_TEXT",
"direction": "LEFT_TO_RIGHT"
}
}
}
]
}
}
}
]
},
|
{
"tabs": [
{
"documentTab": {
"body": {
"content": [
{
"startIndex": 1,
"endIndex": 31,
"paragraph": {
"elements": [
{
"startIndex": 1,
"endIndex": 31,
"textRun": {
"content": "Text preceding the suggestion\n",
"textStyle": {}
}
}
],
"paragraphStyle": {
"namedStyleType": "NORMAL_TEXT",
"direction": "LEFT_TO_RIGHT"
}
}
},
{
"startIndex": 31,
"endIndex": 32,
"paragraph": {
"elements": [
{
"startIndex": 31,
"endIndex": 32,
"textRun": {
"content": "\n",
"textStyle": {}
}
}
],
"paragraphStyle": {
"namedStyleType": "NORMAL_TEXT",
"direction": "LEFT_TO_RIGHT"
}
}
},
{
"startIndex": 32,
"endIndex": 62,
"paragraph": {
"elements": [
{
"startIndex": 32,
"endIndex": 62,
"textRun": {
"content": "Text following the suggestion\n",
"textStyle": {}
}
}
],
"paragraphStyle": {
"namedStyleType": "NORMAL_TEXT",
"direction": "LEFT_TO_RIGHT"
}
}
}
]
}
}
}
]
},
|
在上面的响应中，包含行“
建议”显示了使用 SuggestionsViewMode 时的差异。使用
值设为 SUGGESTIONS_INLINE，即该值的 startIndex
ParagraphElement
从 51 开始，endIndex 在 81 停止。如果没有建议，
startIndex 和 endIndex 的范围在 32 - 62 之间。
获取没有建议的内容
以下部分代码示例显示了如何使用
通过设置 SuggestionsViewMode 拒绝所有建议（如果有）
参数设为 PREVIEW_WITHOUT_SUGGESTIONS。
Java
final string SUGGEST_MODE = "PREVIEW_WITHOUT_SUGGESTIONS";
Document doc =
service
.documents()
.get(DOCUMENT_ID)
.setIncludeTabsContent(true)
.setSuggestionsViewMode(SUGGEST_MODE)
.execute();
Python
SUGGEST_MODE = "PREVIEW_WITHOUT_SUGGESTIONS"
result = (
service.documents()
.get(
documentId=DOCUMENT_ID,
includeTabsContent=True,
suggestionsViewMode=SUGGEST_MODE,
)
.execute()
)
省略 SuggestionsViewMode 参数等同于提供
DEFAULT_FOR_CURRENT_ACCESS 作为参数值。
风格建议
文档还可以提供样式建议。这些是针对 而不是更改内容。
与插入或删除文本不同，这些操作不会偏移
索引，虽然它们可能会将
TextRun 转换为更小的清单
但只需添加有关建议的样式更改的注释即可。
其中一种注释是
SuggestedTextStyle、
包括 2 个部分：
textStyle，用于说明如何根据建议设置文本的样式 但没有说明具体变化textStyleSuggestionState，指示建议如何变化textStyle的字段。
以下文档标签摘录部分列出了此内容， 建议的样式更改：
[01] "paragraph": {
[02] "elements": [
[03] {
[04] "endIndex": 106,
[05] "startIndex": 82,
[06] "textRun": {
[07] "content": "Some text that does not ",
[08] "textStyle": {}
[09] }
[10] },
[11] {
[12] "endIndex": 115,
[13] "startIndex": 106,
[14] "textRun": {
[15] "content": "initially",
[16] "suggestedTextStyleChanges": {
[17] "suggest.xymysbs9zldp": {
[18] "textStyle": {
[19] "backgroundColor": {},
[20] "baselineOffset": "NONE",
[21] "bold": true,
[22] "fontSize": {
[23] "magnitude": 11,
[24] "unit": "PT"
[25] },
[26] "foregroundColor": {
[27] "color": {
[28] "rgbColor": {}
[29] }
[30] },
[31] "italic": false,
[32] "smallCaps": false,
[33] "strikethrough": false,
[34] "underline": false
[35] },
[36] "textStyleSuggestionState": {
[37] "boldSuggested": true,
[38] "weightedFontFamilySuggested": true
[39] }
[40] }
[41] },
[42] "textStyle": {
[43] "italic": true
[44] }
[45] }
[46] },
[47] {
[48] "endIndex": 143,
[49] "startIndex": 115,
[50] "textRun": {
[51] "content": " contain any boldface text.\n",
[52] "textStyle": {}
[53] }
[54] }
[55] ],
[56] "paragraphStyle": {
[57] "direction": "LEFT_TO_RIGHT",
[58] "namedStyleType": "NORMAL_TEXT"
[59] }
[60] }
在上述示例中，段落包含 3 条文本，从第 6 行开始， 14 和 50。检查中间文本运行：
- 第 16 行：有一个
suggestedTextStyleChanges对象。 - 第 18 行：
textStyle指定了各种格式。 - 第 36 行：
textStyleSuggestionState表示只有 这个规范就是建议的参数 - 第 42 行：此文本的斜体样式是当前文档的一部分 （不受建议影响）。
只有 textStyleSuggestionState 中设置为 true 的样式地图项是组成部分
。