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

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 पर सेट करने पर, startIndex का ParagraphElement 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 पर सेट होती है.