在 Google 文档中，协作者可以提出建议，这些建议实际上是等待批准的延迟编辑。
使用 documents.get 方法提取文档内容时，该内容可能包含未解决的建议。如需控制 documents.get 表示建议的方式，请使用可选的 SuggestionsViewMode 参数。此参数支持以下过滤条件：
- 使用
SUGGESTIONS_INLINE获取内容，以便在文档中显示待删除或待插入的文字。 - 获取预览内容，其中包含所有已接受的建议。
- 获取内容作为预览，不显示建议，所有建议均被拒绝。
如果您未提供 SuggestionsViewMode，Google Docs 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，则 ParagraphElement 的 startIndex 从 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，它由两部分组成：
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 的样式特征才会纳入建议。