Method: comments.list

किसी फ़ाइल में की गई टिप्पणियों की सूची दिखाता है. ज़्यादा जानकारी के लिए, टिप्पणियां और उनके जवाब मैनेज करना लेख पढ़ें.

ज़रूरी है: fields पैरामीटर सेट होना चाहिए. आपको जिन फ़ील्ड की ज़रूरत है उन्हें वापस पाने के लिए, चुनिंदा फ़ील्ड वापस पाना लेख पढ़ें.

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

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

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

पाथ पैरामीटर

पैरामीटर
fileId

string

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

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

पैरामीटर
includeDeleted

boolean

मिटाई गई टिप्पणियों को शामिल करना है या नहीं. मिटाई गई टिप्पणियों में, उनका ओरिजनल कॉन्टेंट शामिल नहीं होगा.
pageSize

integer

हर पेज पर ज़्यादा से ज़्यादा कितनी टिप्पणियां दिखानी हैं.
pageToken

string

यह टोकन, अगले पेज पर पिछली सूची के अनुरोध को जारी रखने के लिए होता है. इसे पिछले जवाब के 'nextPageToken' की वैल्यू पर सेट किया जाना चाहिए.
startModifiedTime

string

नतीजे में की गई टिप्पणियों के लिए, 'modifiedTime' की कम से कम वैल्यू (RFC 3339 के हिसाब से तारीख और समय).

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

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

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

किसी फ़ाइल पर की गई टिप्पणियों की सूची.

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

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

object (Comment)

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

string

इससे पता चलता है कि यह किस तरह का संसाधन है. वैल्यू: तय की गई स्ट्रिंग "drive#commentList".
nextPageToken

string

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

अनुमति के स्कोप

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

  • 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

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