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

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"
        }
       }
      }
     ]
    }
   }
  }
 ]
},

ऊपर दिए गए जवाब में, "Text following the suggestion" लाइन वाले पैराग्राफ़ में, SuggestionsViewMode का इस्तेमाल करने पर दिखने वाला अंतर दिखाया गया है. SUGGESTIONS_INLINE पर सेट की गई वैल्यू के साथ, ParagraphElement का startIndex 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 है. इसमें दो हिस्से होते हैं:

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