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 के काेड में दिखाना 
{
  "items": [
    {
      object (Comment)
    }
  ],
  "kind": string,
  "selfLink": string,
  "nextLink": string,
  "nextPageToken": string
}
फ़ील्ड
items[]

object (Comment)

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

string

यह हमेशा drive#commentList होता है.
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

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