टिप्पणियां, किसी फ़ाइल के बारे में उपयोगकर्ता के दिए गए सुझाव होते हैं. उदाहरण के लिए, वर्ड प्रोसेसिंग दस्तावेज़ का कोई पाठक जो किसी वाक्य को अलग तरीके से लिखने का सुझाव देता है. टिप्पणियां दो तरह की होती हैं: ऐंकर की गई टिप्पणियां और ऐंकर की गई टिप्पणियां. ऐंकर की गई टिप्पणी किसी खास जगह से जुड़ी होती है. जैसे, वर्ड प्रोसेसिंग दस्तावेज़ में किसी दस्तावेज़ के किसी खास वर्शन में वाक्य. इसके ठीक उलट, बिना ऐंकर की गई टिप्पणी सिर्फ़ दस्तावेज़ से जुड़ी होती है.
जवाब, टिप्पणियों के साथ जुड़े होते हैं और टिप्पणी पर उपयोगकर्ता के दिए गए जवाब को दिखाते हैं. Drive API का इस्तेमाल करके उपयोगकर्ता, आपके ऐप्लिकेशन के बनाए गए दस्तावेज़ों पर टिप्पणियां और जवाब जोड़ सकते हैं. जिन टिप्पणियों पर जवाब दिए जाते हैं उन्हें चर्चा कहा जाता है.
बिना ऐंकर की गई टिप्पणी जोड़ें
किसी दस्तावेज़ में बिना ऐंकर वाली टिप्पणी जोड़ने के लिए, fileId पैरामीटर के साथ comments.create तरीके को कॉल करें. साथ ही, टिप्पणी वाले comments संसाधन को भी कॉल करें.
टिप्पणी को सामान्य टेक्स्ट के तौर पर डाला जाता है. हालांकि, जवाब के मुख्य हिस्से में htmlContent फ़ील्ड होता है, जिसमें दिखाने के लिए फ़ॉर्मैट किया गया कॉन्टेंट होता है.
टिप्पणी का जवाब दें
किसी टिप्पणी का जवाब देने के लिए, टिप्पणी के साथ replies.create तरीके को कॉल करें. साथ ही, fileId पैरामीटर और replies संसाधन को कॉल करें, जिसमें जवाब मौजूद है.
जवाब को सादे टेक्स्ट के तौर पर डाला जाता है. हालांकि, जवाब के मुख्य हिस्से में htmlContent फ़ील्ड होता है, जिसमें दिखाने के लिए फ़ॉर्मैट किया गया कॉन्टेंट होता है.
दस्तावेज़ के नए वर्शन में ऐंकर की गई टिप्पणी जोड़ें
जब कोई टिप्पणी जोड़ी जाती है, तो हो सकता है कि आपको उसे फ़ाइल में किसी इलाके से ऐंकर करना पड़े. ऐंकर फ़ाइल में फ़ाइल में किए गए बदलाव और जगह के बारे में बताता है. यह वह जगह होती है जहां कोई टिप्पणी मौजूद होती है. comments संसाधन, anchor फ़ील्ड को JSON स्ट्रिंग के तौर पर बताता है.
ऐंकर की गई टिप्पणी जोड़ने के लिए:
(ज़रूरी नहीं). किसी दस्तावेज़ के हर
revisionIDको शामिल करने के लिए,revisions.listतरीके का इस्तेमाल करें. यह चरण सिर्फ़ तब अपनाएं, जब आपको नए बदलाव के अलावा किसी भी बदलाव के लिए टिप्पणी को ऐंकर करना हो. अगर आपको नए वर्शन का इस्तेमाल करना है, तोrevisionIDके लिएheadका इस्तेमाल करें.comments.createवाले तरीके को कॉल करने के लिए,fileIDपैरामीटर का इस्तेमाल करें.commentsमें टिप्पणी मौजूद संसाधन औरrevisionID(r) और क्षेत्र (a) वाली JSON ऐंकर स्ट्रिंग.
क्षेत्र तय करने का तरीका इस बात पर निर्भर करता है कि आपको किस तरह के दस्तावेज़ पर काम करना है. ज़्यादा जानकारी के लिए, क्षेत्र तय करें पर जाएं.
क्षेत्र तय करें
जैसा कि पहले बताया गया है, JSON ऐंकर स्ट्रिंग में revisionID (r) और क्षेत्र (a) शामिल है. क्षेत्र (a) एक JSON कलेक्शन है. इसमें क्षेत्र की कैटगरी तय करने वाले टूल मौजूद हैं. यह उस फ़ॉर्मैट और जगह के बारे में बताता है जहां पर टिप्पणी को ऐंकर किया गया है. कैटगरी तय करने वाला टूल, किसी इमेज के लिए दो डाइमेंशन वाला रेक्टैंगल हो सकता है. इसके अलावा, दस्तावेज़ में टेक्स्ट की कोई लाइन या वीडियो में कुल समय को भी कैटगरी में बांटा जा सकता है. क्षेत्र तय करने के लिए, क्षेत्र
क्लासिफ़ायर चुनें. यह उस कॉन्टेंट के टाइप से मेल खाता है जिस पर आपको ऐंकर करने की कोशिश की जा रही है. उदाहरण
के लिए, अगर आपका कॉन्टेंट टेक्स्ट है, तो txt या line रीजन क्लासिफ़ायर का इस्तेमाल किया जा सकता है.
Drive API में क्षेत्र की कैटगरी तय करने वाले टूल की सूची के लिए, क्षेत्र क्लासिफ़ायर देखें.
नीचे दिए गए उदाहरण में एक JSON ऐंकर स्ट्रिंग दिखाई गई है, जो दस्तावेज़ के दो अलग-अलग हिस्सों में लाइनों पर टिप्पणियों को ऐंकर करती है:
- पहला एरिया लाइन 12 (
'n':12) से शुरू होता है और तीन लाइन ('l':3) तक बढ़ता है. - दूसरी जगह सिर्फ़ पंक्ति 18 (
'n':18, 'l':1`) को कवर करती है.
{
'r': 'REVISION_ID',
'a': [
{
'line':
{
'n': 12,
'l': 3,
}
},
{
'line':
{
'n': 18,
'l': 1,
}
}]
}
REVISION_ID को head या किसी खास बदलाव के आईडी से बदलें.
टिप्पणी का समाधान करें
किसी टिप्पणी का जवाब दिए जाने के बाद, comments संसाधन में resolved प्रॉपर्टी को true पर सेट करने के लिए, comment.update तरीके का इस्तेमाल करें.
जब आपका ऐप्लिकेशन, resolved प्रॉपर्टी को true पर सेट करता है, तो आपके यूज़र इंटरफ़ेस (यूआई) से यह पता चलना चाहिए कि टिप्पणी का जवाब दिया जा चुका है. उदाहरण के लिए, आपका ऐप्लिकेशन ये काम कर सकता है:
- और जवाब न दें और पिछले सभी जवाबों के साथ-साथ मूल टिप्पणी की रोशनी कम करें.
- ऐसी टिप्पणियां छिपाएं जिन्हें बंद किया जा चुका है.
टिप्पणी मिटाना
टिप्पणियां मिटाने के लिए, comments.delete तरीके का इस्तेमाल करें. जब किसी टिप्पणी को मिटाया जाता है, तो Drive उस टिप्पणी को "deleted": "true" के तौर पर मार्क करता है.
टिप्पणियों की सूची बनाएं
टिप्पणियों की सूची बनाने के लिए, comments.list तरीके का इस्तेमाल करें. अगर आपको मिटाई गई टिप्पणियों को नतीजों में शामिल करना है, तो includedDeleted फ़ील्ड को true पर सेट करें.