टिप्पणियां और जवाब मैनेज करना

टिप्पणियां, किसी फ़ाइल के बारे में उपयोगकर्ता से मिले सुझाव/राय या शिकायत होती है. जैसे, वर्ड प्रोसेसिंग दस्तावेज़ पढ़ने वाला कोई व्यक्ति, किसी वाक्य को फिर से लिखने का सुझाव देता है. टिप्पणियां दो तरह की होती हैं: ऐंकर की गई टिप्पणियां और ऐंकर नहीं की गई टिप्पणियां. ऐंकर की गई टिप्पणी, किसी खास जगह से जुड़ी होती है. जैसे, किसी दस्तावेज़ के किसी वर्शन में मौजूद वर्ड-प्रोसेसिंग दस्तावेज़ का कोई वाक्य. इसके उलट, किसी टेक्स्ट से न जुड़ी टिप्पणी सिर्फ़ दस्तावेज़ से जुड़ी होती है.

जवाब, टिप्पणियों से जुड़े होते हैं. इनसे पता चलता है कि किसी व्यक्ति ने टिप्पणी का जवाब दिया है. Drive API की मदद से, आपके ऐप्लिकेशन से बनाए गए दस्तावेज़ों में टिप्पणियां और जवाब जोड़े जा सकते हैं. टिप्पणियों और उनके जवाबों को मिलाकर, बातचीत कहा जाता है.

comments रिसॉर्स पर मौजूद सभी तरीकों (delete को छोड़कर) के लिए, आपको fields system parameter को सेट करना ज़रूरी है. इससे यह तय किया जा सकेगा कि रिस्पॉन्स में कौनसा फ़ील्ड दिखाना है. Drive के ज़्यादातर तरीकों में, यह कार्रवाई सिर्फ़ डिफ़ॉल्ट फ़ील्ड के अलावा अन्य फ़ील्ड को वापस लाने के लिए ज़रूरी होती है. हालांकि, comments संसाधन के लिए यह ज़रूरी है. अगर पैरामीटर को शामिल नहीं किया जाता है, तो यह तरीका गड़बड़ी दिखाता है. ज़्यादा जानकारी के लिए, चुनिंदा फ़ील्ड की वैल्यू वापस पाना लेख पढ़ें.

बिना ऐंकर की गई टिप्पणी जोड़ना

किसी दस्तावेज़ में बिना ऐंकर की गई टिप्पणी जोड़ने के लिए, create तरीके को fileId पैरामीटर और टिप्पणी वाला comments संसाधन के साथ कॉल करें.

टिप्पणी को सादे टेक्स्ट के तौर पर डाला जाता है. हालांकि, जवाब के मुख्य हिस्से में 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 स्ट्रिंग के तौर पर तय करता है.

किसी खास जगह से जुड़ी टिप्पणी जोड़ने के लिए:

  1. (ज़रूरी नहीं). किसी दस्तावेज़ के लिए हर revisionID की सूची बनाने के लिए, revisions.list तरीके को कॉल करें. इस चरण को सिर्फ़ तब अपनाएं, जब आपको किसी टिप्पणी को सबसे नए वर्शन के अलावा किसी दूसरे वर्शन से जोड़ना हो. अगर आपको सबसे नए वर्शन का इस्तेमाल करना है, तो revisionID के लिए head का इस्तेमाल करें.

  2. fileID पैरामीटर के साथ create तरीके को कॉल करें. इसमें 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 संसाधन पर 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

टिप्पणियां देखना

किसी फ़ाइल पर की गई टिप्पणियों की सूची बनाने के लिए, comments संसाधन पर list तरीके का इस्तेमाल करें. इसके लिए, fileId पैरामीटर का इस्तेमाल करें. इस तरीके से, टिप्पणियों की सूची मिलती है.

टिप्पणियों के पेज नंबर बदलने या उन्हें फ़िल्टर करने के लिए, ये क्वेरी पैरामीटर पास करें:

  • 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 फ़ील्ड का इस्तेमाल किया जाता है.

comments संसाधन पर मौजूद बूलियन resolved फ़ील्ड को सिर्फ़ पढ़ा जा सकता है. किसी टिप्पणी को सिर्फ़ उसका जवाब देकर बंद किया जा सकता है. ज़्यादा जानकारी के लिए, टिप्पणी को हल करना लेख पढ़ें.

यह तरीका, 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