Method: comments.list

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

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

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 तारीख और समय).

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

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

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

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

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

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

string

यह बताता है कि यह किस तरह का संसाधन है. वैल्यू: तय स्ट्रिंग "drive#commentList".

comments[]

object (Comment)

टिप्पणियों की सूची. अगर NextPageToken को पॉप्युलेट किया जाता है, तो यह सूची अधूरी हो सकती है. साथ ही, नतीजों का एक और पेज फ़ेच किया जाना चाहिए.

nextPageToken

string

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

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

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

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

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