टिप्पणियां, किसी फ़ाइल पर उपयोगकर्ता का दिया गया सुझाव, राय या शिकायत होती है. जैसे, किसी वर्ड प्रोसेसिंग दस्तावेज़ के पाठक का, किसी वाक्य को फिर से लिखने का सुझाव देना. टिप्पणियां दो तरह की होती हैं: ऐंकर की गई टिप्पणियां और ऐंकर नहीं की गई टिप्पणियां. ऐंकर की गई टिप्पणी, किसी दस्तावेज़ के किसी खास वर्शन में मौजूद किसी खास जगह से जुड़ी होती है. जैसे, वर्ड प्रोसेसिंग दस्तावेज़ में कोई वाक्य. इसके उलट, बिना ऐंकर वाली टिप्पणी सिर्फ़ दस्तावेज़ से जुड़ी होती है.
जवाब, टिप्पणियों से जुड़े होते हैं. इनसे पता चलता है कि किसी टिप्पणी पर उपयोगकर्ता ने क्या जवाब दिया है. Drive API की मदद से, आपके ऐप्लिकेशन से बनाए गए दस्तावेज़ों पर उपयोगकर्ता टिप्पणियां कर सकते हैं और उन पर जवाब दे सकते हैं. टिप्पणियों और जवाबों को एक साथ बातचीत कहा जाता है.
बिना ऐंकर वाली टिप्पणी जोड़ना
किसी दस्तावेज़ में बिना ऐंकर वाली टिप्पणी जोड़ने के लिए, fileId
पैरामीटर और टिप्पणी वाले comments
रिसॉर्स के साथ comments.create
तरीके को कॉल करें.
टिप्पणी को सादे टेक्स्ट के तौर पर डाला जाता है. हालांकि, जवाब के मुख्य हिस्से में एक htmlContent
फ़ील्ड होता है, जिसमें डिसप्ले के लिए फ़ॉर्मैट किया गया कॉन्टेंट होता है.
टिप्पणी का जवाब देना
किसी टिप्पणी का जवाब देने के लिए, टिप्पणी, fileId
पैरामीटर, और जवाब वाले replies
रिसॉर्स के साथ replies.create
तरीके को कॉल करें.
जवाब को सादे टेक्स्ट के तौर पर डाला जाता है. हालांकि, जवाब के मुख्य हिस्से में एक htmlContent
फ़ील्ड होता है, जिसमें डिसप्ले के लिए फ़ॉर्मैट किया गया कॉन्टेंट होता है.
किसी दस्तावेज़ के नए वर्शन में, ऐंकर की गई टिप्पणी जोड़ना
टिप्पणी जोड़ते समय, हो सकता है कि आप फ़ाइल के किसी हिस्से पर टिप्पणी को ऐंकर करना चाहें. ऐंकर, फ़ाइल में किए गए बदलाव और उस हिस्से के बारे में बताता है जिस पर टिप्पणी की गई है. comments
रिसॉर्स, anchor
फ़ील्ड को JSON स्ट्रिंग के तौर पर दिखाता है.
ऐंकर की गई टिप्पणी जोड़ने के लिए:
(ज़रूरी नहीं). किसी दस्तावेज़ के हर
revisionID
को सूची में शामिल करने के लिए,revisions.list
तरीका इस्तेमाल करें. अगर आपको किसी टिप्पणी को, सबसे नए बदलाव के बजाय किसी दूसरे बदलाव पर अटैच करना है, तो ही यह तरीका अपनाएं. अगर आपको सबसे नए वर्शन का इस्तेमाल करना है, तोrevisionID
के लिएhead
का इस्तेमाल करें.fileID
पैरामीटर, टिप्पणी वालाcomments
संसाधन, औरrevisionID
(r
) और क्षेत्र (a
) वाली JSON ऐंकर स्ट्रिंग के साथcomments.create
तरीके को कॉल करें.
किसी क्षेत्र को तय करने का तरीका, इस बात पर निर्भर करता है कि आपके पास किस तरह का दस्तावेज़ है. ज़्यादा जानकारी के लिए, इलाके की जानकारी देना लेख पढ़ें.
कोई क्षेत्र तय करना
जैसा कि पहले बताया गया है, 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
या किसी खास बदलाव के आईडी से बदलें.
किसी टिप्पणी को बंद करना
किसी टिप्पणी का जवाब देने के बाद, comment.update
तरीके का इस्तेमाल करके, comments
संसाधन में resolved
प्रॉपर्टी को true
पर सेट करें.
जब आपका ऐप्लिकेशन resolved
प्रॉपर्टी को true
पर सेट करता है, तो आपके यूज़र इंटरफ़ेस (यूआई) से यह पता चलना चाहिए कि टिप्पणी को ठीक कर दिया गया है. उदाहरण के लिए, आपका ऐप्लिकेशन:
- टिप्पणी पर आगे कोई जवाब न दिया जा सके. साथ ही, टिप्पणी पर दिए गए सभी जवाबों और मूल टिप्पणी को धुंधला कर दिया जाए.
- वे टिप्पणियां छिपाएं जिनका समाधान हो गया है.
टिप्पणी मिटाना
टिप्पणियां मिटाने के लिए, comments.delete
वाला तरीका अपनाएं. टिप्पणी मिटाने पर, Drive उस टिप्पणी के संसाधन को "deleted": "true"
के तौर पर मार्क कर देता है.
टिप्पणियों की सूची
टिप्पणियों की सूची बनाने के लिए, comments.list
तरीके का इस्तेमाल करें. अगर आपको नतीजों में मिटाई गई टिप्पणियां शामिल करनी हैं, तो includedDeleted
फ़ील्ड को true
पर सेट करें.