टिप्पणियां, किसी फ़ाइल पर उपयोगकर्ता का दिया गया सुझाव, राय या शिकायत होती है. जैसे, किसी वर्ड प्रोसेसिंग दस्तावेज़ के पाठक का, किसी वाक्य को फिर से लिखने का सुझाव देना. टिप्पणियां दो तरह की होती हैं: ऐंकर की गई टिप्पणियां और ऐंकर नहीं की गई टिप्पणियां. ऐंकर की गई टिप्पणी, किसी दस्तावेज़ के किसी खास वर्शन में मौजूद किसी खास जगह से जुड़ी होती है. जैसे, वर्ड प्रोसेसिंग दस्तावेज़ में कोई वाक्य. इसके उलट, बिना ऐंकर वाली टिप्पणी सिर्फ़ दस्तावेज़ से जुड़ी होती है.
जवाब, टिप्पणियों से जुड़े होते हैं. इनसे पता चलता है कि उपयोगकर्ता ने टिप्पणी पर क्या जवाब दिया है. Drive API की मदद से, आपके ऐप्लिकेशन से बनाए गए दस्तावेज़ों पर उपयोगकर्ता टिप्पणियां कर सकते हैं और उन पर जवाब दे सकते हैं. टिप्पणियों और जवाबों को एक साथ बातचीत कहा जाता है.
fields पैरामीटर सेट करना ज़रूरी है, ताकि comments संसाधन में दिए गए हर तरीके को कॉल करते समय, रिस्पॉन्स में दिखाए जाने वाले फ़ील्ड की सूची बनाई जा सके. पैरामीटर को छोड़ने पर,
यह तरीका गड़बड़ी का मैसेज दिखाता है. अपनी ज़रूरत के हिसाब से फ़ील्ड दिखाने के लिए, खास फ़ील्ड दिखाना लेख पढ़ें.
बिना ऐंकर वाली टिप्पणी जोड़ना
किसी दस्तावेज़ में बिना ऐंकर वाली टिप्पणी जोड़ने के लिए, fileId पैरामीटर और टिप्पणी वाले comments रिसॉर्स के साथ create() तरीके को कॉल करें.
टिप्पणी को सादे टेक्स्ट के तौर पर डाला जाता है. हालांकि, जवाब के मुख्य हिस्से में एक htmlContent फ़ील्ड होता है, जिसमें डिसप्ले के लिए फ़ॉर्मैट किया गया कॉन्टेंट होता है.
टिप्पणी का जवाब देना
किसी टिप्पणी का जवाब देने के लिए, fileId और
commentId पैरामीटर के साथ,
replies संसाधन पर replies.create() तरीके का इस्तेमाल करें. अनुरोध का मुख्य हिस्सा, जवाब जोड़ने के लिए content फ़ील्ड का इस्तेमाल करता है.
जवाब को सादे टेक्स्ट के तौर पर डाला जाता है. हालांकि, जवाब के मुख्य हिस्से में एक htmlContent फ़ील्ड होता है. इसमें, डिसप्ले के लिए फ़ॉर्मैट किया गया कॉन्टेंट होता है.
यह तरीका, fields फ़ील्ड में मौजूद फ़ील्ड दिखाता है.
एक उदाहरण दिखाएं
अनुरोध
इस उदाहरण में, हम fileId और commentId पाथ पैरामीटर और कई फ़ील्ड देते हैं.
POST https://www.googleapis.com/drive/v3/files/FILE_ID/comments/COMMENT_ID/replies?fields=id,comment
अनुरोध का मुख्य हिस्सा
{
"content": "This is a reply to a comment."
}किसी टिप्पणी को बंद करना
किसी टिप्पणी का जवाब पोस्ट करके ही उसे हल किया जा सकता है.
किसी टिप्पणी को ठीक करने के लिए, fileId और
commentId पैरामीटर के साथ,
replies संसाधन पर
replies.create() तरीके का इस्तेमाल करें.
अनुरोध के मुख्य हिस्से में, टिप्पणी को हल करने के लिए action फ़ील्ड का इस्तेमाल किया जाता है. content फ़ील्ड को सेट करके भी, टिप्पणी का जवाब जोड़ा जा सकता है.
जब किसी टिप्पणी का समाधान हो जाता है, तो Drive उस टिप्पणी के संसाधन को resolved: true के तौर पर मार्क करता है. मिटाई गई टिप्पणियों के उलट, जवाब दी गई टिप्पणियों में htmlContent या content फ़ील्ड शामिल हो सकते हैं.
जब आपका ऐप्लिकेशन किसी टिप्पणी को हल कर देता है, तो आपके यूज़र इंटरफ़ेस (यूआई) से यह पता चलना चाहिए कि टिप्पणी को हल कर दिया गया है. उदाहरण के लिए, आपका ऐप्लिकेशन:
- उस पर आगे कोई जवाब न दिया जा सके. साथ ही, उस पर दिए गए सभी जवाबों और मूल टिप्पणी को धुंधला कर दिया जाए.
- वे टिप्पणियां छिपाएं जिनका समाधान हो गया है.
एक उदाहरण दिखाएं
अनुरोध
इस उदाहरण में, हम fileId और commentId पाथ पैरामीटर और कई फ़ील्ड देते हैं.
POST https://www.googleapis.com/drive/v3/files/FILE_ID/comments/COMMENT_ID/replies?fields=id,comment
अनुरोध का मुख्य हिस्सा
{
"action": "resolve",
"content": "This comment has been resolved."
}किसी दस्तावेज़ के नए वर्शन में, ऐंकर की गई टिप्पणी जोड़ना
टिप्पणी जोड़ते समय, हो सकता है कि आप फ़ाइल के किसी हिस्से पर टिप्पणी को ऐंकर करना चाहें. ऐंकर, फ़ाइल में किए गए बदलाव और उस हिस्से के बारे में बताता है जिस पर टिप्पणी की गई है. comments संसाधन, anchor फ़ील्ड को JSON स्ट्रिंग के तौर पर दिखाता है.
ऐंकर की गई टिप्पणी जोड़ने के लिए:
(ज़रूरी नहीं). किसी दस्तावेज़ के हर
revisionIDको सूची में शामिल करने के लिए,revisions.list()तरीका इस्तेमाल करें. अगर आपको किसी टिप्पणी को, सबसे नए बदलाव के बजाय किसी दूसरे बदलाव पर अटैच करना है, तो ही यह तरीका अपनाएं. अगर आपको सबसे नए वर्शन का इस्तेमाल करना है, तोrevisionIDके लिएheadका इस्तेमाल करें.fileIDपैरामीटर, टिप्पणी वालाcommentsरिसॉर्स, औरrevisionID(r) और क्षेत्र (a) वाली JSON ऐंकर स्ट्रिंग के साथ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 या किसी खास बदलाव के आईडी से बदलें.
टिप्पणी पाना
किसी फ़ाइल पर टिप्पणी पाने के लिए, comments संसाधन पर get()
तरीका का इस्तेमाल करें. साथ ही, fileId और commentId पैरामीटर का इस्तेमाल करें. अगर आपको टिप्पणी का आईडी नहीं पता है, तो list() तरीके का इस्तेमाल करके सभी टिप्पणियों की सूची देखी जा सकती है.
यह तरीका, comments संसाधन का एक इंस्टेंस दिखाता है.
नतीजों में मिटाई गई टिप्पणियां शामिल करने के लिए, includedDeleted क्वेरी पैरामीटर को true पर सेट करें.
एक उदाहरण दिखाएं
अनुरोध
इस उदाहरण में, हम fileId और commentId पाथ पैरामीटर और कई फ़ील्ड देते हैं.
GET https://www.googleapis.com/drive/v3/files/FILE_ID/comments/COMMENT_ID?fields=id,comment,modifiedTime,resolved
टिप्पणियों की सूची
किसी फ़ाइल पर की गई टिप्पणियों की सूची देखने के लिए, fileId पैरामीटर के साथ comments संसाधन पर list() तरीका इस्तेमाल करें. यह तरीका, टिप्पणियों की सूची दिखाता है.
टिप्पणियों के पेजेशन को पसंद के मुताबिक बनाने या उन्हें फ़िल्टर करने के लिए, ये क्वेरी पैरामीटर पास करें:
includeDeleted: मिटाई गई टिप्पणियों को शामिल करने के लिए, इसेtrueपर सेट करें. मिटाई गई टिप्पणियों मेंhtmlContentयाcontentफ़ील्ड शामिल नहीं होते.pageSize: हर पेज पर टिप्पणियों की ज़्यादा से ज़्यादा संख्या.pageToken: सूची के पिछले कॉल से मिला पेज टोकन. अगला पेज देखने के लिए, यह टोकन दें.startModifiedTime: नतीजों की टिप्पणियों के लिए,modifiedTimeफ़ील्ड की कम से कम वैल्यू.
एक उदाहरण दिखाएं
अनुरोध
इस उदाहरण में, हम fileId पाथ पैरामीटर, includeDeleted क्वेरी पैरामीटर, और कई फ़ील्ड देते हैं.
GET https://www.googleapis.com/drive/v3/files/FILE_ID/comments?includeDeleted=true&fields=(id,comment,kind,modifiedTime,resolved)
टिप्पणी अपडेट करना
किसी फ़ाइल पर की गई टिप्पणी को अपडेट करने के लिए, fileId और commentId पैरामीटर के साथ comments संसाधन पर update() तरीके का इस्तेमाल करें. अनुरोध का मुख्य हिस्सा, टिप्पणी अपडेट करने के लिए content फ़ील्ड का इस्तेमाल करता है.
यह तरीका, fields क्वेरी पैरामीटर में दिए गए फ़ील्ड दिखाता है.
एक उदाहरण दिखाएं
अनुरोध
इस उदाहरण में, हम fileId और commentId पाथ पैरामीटर और कई फ़ील्ड देते हैं.
PATCH https://www.googleapis.com/drive/v3/files/FILE_ID/comments/COMMENT_ID?fields=id,comment
अनुरोध का मुख्य हिस्सा
{
"content": "This comment is now updated."
}टिप्पणी मिटाना
किसी फ़ाइल पर की गई टिप्पणी मिटाने के लिए, fileId और commentId पैरामीटर के साथ comments संसाधन पर delete() तरीके का इस्तेमाल करें.
जब कोई टिप्पणी मिटाई जाती है, तो Drive उस टिप्पणी के संसाधन को deleted: true के तौर पर मार्क करता है. मिटाई गई टिप्पणियों में htmlContent या content फ़ील्ड शामिल नहीं होते.
एक उदाहरण दिखाएं
अनुरोध
इस उदाहरण में, हम fileId और commentId पाथ पैरामीटर देते हैं.
DELETE https://www.googleapis.com/drive/v3/files/FILE_ID/comments/COMMENT_ID