Method: comments.list

किसी फ़ाइल की टिप्पणियों की सूची बनाता है.

एचटीटीपी अनुरोध

GET https://www.googleapis.com/drive/v2/files/{fileId}/comments

यूआरएल में gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल किया गया है.

पाथ पैरामीटर

पैरामीटर
fileId

string

फ़ाइल का आईडी.

क्वेरी पैरामीटर

पैरामीटर
includeDeleted

boolean

अगर यह सेट है, तो सभी टिप्पणियां और जवाब दिखेंगे. इनमें मिटाई गई टिप्पणियां और जवाब भी शामिल होंगे. हालांकि, इनमें कॉन्टेंट नहीं दिखेगा.
maxResults

integer

जवाब में शामिल की जाने वाली बातचीत की ज़्यादा से ज़्यादा संख्या. इसका इस्तेमाल पेजिंग के लिए किया जाता है.
pageToken

string

कंटिन्यूएशन टोकन, जिसका इस्तेमाल बड़े नतीजों के सेट को पेज करने के लिए किया जाता है. नतीजों का अगला पेज पाने के लिए, इस पैरामीटर को पिछले जवाब से मिली "nextPageToken" वैल्यू पर सेट करें.
updatedMin

string

इस टाइमस्टैंप के बाद अपडेट की गई बातचीत ही दिखेंगी. आरएफ़सी 3339 टाइमस्टैंप के तौर पर फ़ॉर्मैट किया गया.

अनुरोध का मुख्य भाग

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

जवाब का मुख्य भाग

Google Drive में मौजूद किसी फ़ाइल पर की गई टिप्पणियों की सूची.

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.

JSON के काेड में दिखाना 
{
  "kind": string,
  "selfLink": string,
  "nextLink": string,
  "items": [
    {
      object (Comment)
    }
  ],
  "nextPageToken": string
}
फ़ील्ड
kind

string

यह हमेशा drive#commentList होती है.
items[]

object (Comment)

टिप्पणियों की सूची. अगर nextPageToken की वैल्यू मौजूद है, तो हो सकता है कि यह सूची पूरी न हो. ऐसे में, नतीजों का एक और पेज फ़ेच किया जाना चाहिए.
nextPageToken

string

टिप्पणियों के अगले पेज का पेज टोकन. अगर टिप्पणियों की सूची खत्म हो गई है, तो यह विकल्प नहीं दिखेगा. अगर किसी वजह से टोकन अस्वीकार कर दिया जाता है, तो उसे खारिज कर दिया जाना चाहिए. साथ ही, नतीजों के पहले पेज से पेजेशन को फिर से शुरू किया जाना चाहिए.

अनुमति के दायरे

इसके लिए, OAuth के इनमें से किसी एक स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/docs
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/drive.meet.readonly
  • https://www.googleapis.com/auth/drive.readonly

कुछ स्कोप पर पाबंदी होती है. साथ ही, इनका इस्तेमाल करने के लिए आपके ऐप्लिकेशन को सुरक्षा से जुड़ी समीक्षा कराने की ज़रूरत होती है. ज़्यादा जानकारी के लिए, अनुमति से जुड़ी गाइड देखें.