추천 사용

Google 문서를 사용하면 공동작업자는 제안을 할 수 있으며, 제안은 승인을 기다리며 수정은 사실상 지연됩니다.

documents.get 메서드를 사용하여 문서 콘텐츠를 가져오면 콘텐츠에 해결되지 않은 추천이 포함될 수 있습니다. documents.get가 추천을 표시하는 방식을 제어하려면 선택사항인 SuggestionsViewMode 매개변수를 사용하세요. 이 매개변수와 함께 사용할 수 있는 필터 조건은 다음과 같습니다.

  • SUGGESTIONS_INLINE를 사용하여 콘텐츠를 가져오면 삭제 또는 삽입 대기 중인 텍스트가 문서에 표시됩니다.
  • 모든 제안사항이 수락된 콘텐츠를 미리보기로 표시합니다.
  • 모든 추천이 거부된 상태에서 추천 없이 콘텐츠를 미리보기로 가져옵니다.

SuggestionsViewMode를 제공하지 않으면 Google Docs API에서 현재 사용자의 권한에 적합한 기본 설정을 사용합니다.

추천 및 색인

SuggestionsViewMode가 중요한 이유는 아래와 같이 추천이 있는지에 따라 응답의 색인이 달라질 수 있기 때문입니다.

추천 콘텐츠가 있는 콘텐츠 추천 콘텐츠가 없는 콘텐츠 
{
 "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를 사용할 경우 'Text 다음의 텍스트' 라인이 포함된 단락이 차이를 보여줍니다. 값이 SUGGESTIONS_INLINE로 설정되면 ParagraphElement의 startIndex는 51에서 시작하고 endIndex는 81에서 중지됩니다. 추천이 없으면 startIndex과 endIndex의 범위는 32~62입니다.

추천 없이 콘텐츠 받기

다음의 부분 코드 샘플은 SuggestionsViewMode 매개변수를 PREVIEW_WITHOUT_SUGGESTIONS로 설정하여 모든 제안이 거부된 경우 문서를 미리보기로 가져오는 방법을 보여줍니다.

Java

최종 문자열 SUGGEST_MODE = "PREVIEW_WITHOUT_SUGGESTIONS"; Document 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로, 다음 두 부분으로 구성됩니다.

  • 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번 줄에서 시작하여 세 번의 텍스트 실행으로 구성됩니다. 중간 텍스트 실행을 살펴봅니다.

  • 16행: suggestedTextStyleChanges 객체가 있습니다.
  • 18행: textStyle는 다양한 형식을 지정합니다.
  • 36행: textStyleSuggestionState는 이 사양에서 굵게 표시된 부분만 추천임을 알려줍니다.
  • 42행: 이 텍스트 실행의 기울임꼴 스타일은 현재 문서의 일부이며 추천 항목의 영향을 받지 않습니다.

textStyleSuggestionState에서 true로 설정된 스타일 지형지물만 추천에 포함됩니다.