추천 사용

Google Docs에서는 공동작업자가 승인을 기다리는 효과적인 지연된 수정인 제안을 할 수 있습니다.

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로 설정하여 모든 추천 (있는 경우)이 거부된 문서를 미리보기로 가져오는 방법을 보여줍니다.

자바Python

final string SUGGEST_MODE = "PREVIEW_WITHOUT_SUGGESTIONS";
Document doc =
    service
        .documents()
        .get(DOCUMENT_ID)
        .setIncludeTabsContent(true)
        .setSuggestionsViewMode(SUGGEST_MODE)
        .execute();

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: 제안된 변경사항 후 텍스트의 스타일이 지정되는 방식을 설명하지만 변경된 사항은 언급하지 않습니다.

  • 추천이 textStyle의 필드를 변경하는 방식을 나타내는 textStyleSuggestionState입니다.

추천 스타일 변경사항이 포함된 다음 문서 탭 추출에서 확인할 수 있습니다.

[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개의 텍스트 실행으로 구성됩니다. 가운데 텍스트 실행을 살펴봅니다.

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

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