सुझावों पर काम करना

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 पर सेट करके, सभी सुझावों को अस्वीकार किया गया है (अगर कोई सुझाव है).

JavaPython

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, जो बताता है कि सुझाए गए बदलाव के बाद टेक्स्ट की स्टाइल कैसी होगी. हालांकि, इसमें यह नहीं बताया जाता कि क्या बदलाव किया गया है.

  • 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 पर सेट किया गया है.