Google ドキュメントでは、共同編集者が提案を行うことができますが、その提案は実質的に承認を待たずに延期されます。
documents.get メソッドを使用してドキュメント コンテンツを取得すると、未解決の提案がコンテンツに含まれることがあります。documents.get が提案をどのように表すかを制御するには、オプションの SuggestionsViewMode パラメータを使用します。このパラメーターでは、次のフィルタ条件を使用できます。
SUGGESTIONS_INLINEでコンテンツを取得すると、削除または挿入が保留中のテキストがドキュメントに表示されます。- すべての候補を受け入れたプレビューとしてコンテンツを取得します。
- 候補のない、すべての候補が拒否されたコンテンツをプレビューとして取得する。
SuggestionsViewMode を指定しない場合、現在のユーザーの権限に適したデフォルト設定が使用されます。
提案とインデックス
SuggestionsViewMode が重要である理由の 1 つは、次に示すように、提案があるかどうかによってレスポンスのインデックスが変化する可能性があるためです。
| 候補があるコンテンツ | 候補のないコンテンツ |
|---|---|
{
"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"
}
}
},
|
{
"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
最終文字列 SUGGEST_MODE = "PREVIEW_WITHOUT_SUGGESTIONS"; ドキュメント doc = service.documents().get(DOCUMENT_ID).setSuggestionsViewMode(SUGGEST_MODE).execute()
Python
SUGGEST_MODE="PREVIEW_WITHOUT_SUGGESTIONS" result = service.documents().get(documentId=DOCUMENT_ID, 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] }
上の例では、段落は 6 行目、14 行目、50 行目から始まる 3 つのテキストで構成されています。中間のテキスト run を確認します。
- 16 行目:
suggestedTextStyleChangesオブジェクトがあります。 - 18 行目:
textStyleは、さまざまな書式を指定します。 - 36 行目:
textStyleSuggestionStateは、この仕様の太字部分のみが提案であることを示しています。 - 42 行目: このテキストの斜体のスタイルは現在のドキュメントの一部であり、提案の影響を受けません。
textStyleSuggestionState で true に設定されたスタイル対象物のみが提案に含まれます。