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"
}
}
}
]
}
}
}
]
},
|
上述回覆中，包含「Text text 之後」這行文字的段落
建議"會顯示使用 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 的樣式地圖項目才適用
建議。