Comments: list

एपीआई अनुरोध के पैरामीटर से मेल खाने वाली टिप्पणियों की सूची दिखाता है.

कोटा पर असर: इस तरीके को कॉल करने पर, 1 यूनिट का कोटा खर्च होता है.

इस्तेमाल के सामान्य उदाहरण

अनुरोध

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

GET https://www.googleapis.com/youtube/v3/comments

पैरामीटर

यहां दी गई टेबल में उन पैरामीटर की सूची दी गई है जिनका इस्तेमाल इस क्वेरी में किया जा सकता है. यहां दिए गए सभी पैरामीटर, क्वेरी पैरामीटर हैं.

पैरामीटर
ज़रूरी पैरामीटर
part	string part पैरामीटर, एक या उससे ज़्यादा comment संसाधन प्रॉपर्टी की कॉमा लगाकर अलग की गई सूची के बारे में बताता है. इसे एपीआई से मिले जवाब में शामिल किया जाएगा. यहां दी गई सूची में, part के वे नाम शामिल हैं जिन्हें पैरामीटर वैल्यू में शामिल किया जा सकता है: id snippet
फ़िल्टर (इनमें से सिर्फ़ एक पैरामीटर की जानकारी दें)
id	string id पैरामीटर, उन संसाधनों के लिए कॉमा लगाकर अलग की गई टिप्पणी आईडी की सूची तय करता है जिन्हें वापस पाया जा रहा है. comment संसाधन में, id प्रॉपर्टी से टिप्पणी के आईडी के बारे में पता चलता है.
parentId	string parentId पैरामीटर, उस टिप्पणी का आईडी बताता है जिसके जवाबों को वापस लाना है. ध्यान दें: फ़िलहाल, YouTube पर सिर्फ़ सबसे ऊपर दिखने वाली टिप्पणियों का जवाब दिया जा सकता है. हालांकि, आने वाले समय में जवाबों के जवाब देने की सुविधा उपलब्ध हो सकती है.
वैकल्पिक पैरामीटर
maxResults	unsigned integer maxResults पैरामीटर से, नतीजों के सेट में ज़्यादा से ज़्यादा आइटम तय किए जाते हैं. ध्यान दें: इस पैरामीटर का इस्तेमाल, id पैरामीटर के साथ नहीं किया जा सकता. 1 से 100 तक की वैल्यू डाली जा सकती हैं. डिफ़ॉल्ट वैल्यू 20 है.
pageToken	string pageToken पैरामीटर, नतीजों के सेट में मौजूद किसी ऐसे पेज की पहचान करता है जिसे दिखाया जाना चाहिए. एपीआई से मिली जानकारी में, nextPageToken प्रॉपर्टी से नतीजे के अगले पेज की पहचान की जाती है. इस पेज को वापस पाया जा सकता है. ध्यान दें: इस पैरामीटर का इस्तेमाल, id पैरामीटर के साथ नहीं किया जा सकता.
textFormat	string इस पैरामीटर से पता चलता है कि एपीआई को टिप्पणियों को एचटीएमएल या सादे टेक्स्ट के तौर पर दिखाना चाहिए या नहीं. डिफ़ॉल्ट वैल्यू html है. इन वैल्यू का इस्तेमाल किया जा सकता है: html – टिप्पणियों को एचटीएमएल फ़ॉर्मैट में दिखाता है. यह डिफ़ॉल्ट मान है. plainText – इससे टिप्पणियां, सादे टेक्स्ट फ़ॉर्मैट में दिखती हैं.

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

इस तरीके को कॉल करते समय, अनुरोध का मुख्य हिस्सा न दें.

जवाब

अगर यह तरीका सही से काम करता है, तो जवाब के मुख्य हिस्से में नीचे दिया गया स्ट्रक्चर शामिल होता है:

{
  "kind": "youtube#commentListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    comment Resource
  ]
}

प्रॉपर्टी

यहां दी गई टेबल में, इस संसाधन में दिखने वाली प्रॉपर्टी के बारे में बताया गया है:

प्रॉपर्टी
kind	string इससे एपीआई संसाधन के टाइप की पहचान होती है. वैल्यू youtube#commentListResponse होगी.
etag	etag इस संसाधन का ETag.
nextPageToken	string यह टोकन, pageToken पैरामीटर की वैल्यू के तौर पर इस्तेमाल किया जा सकता है. इससे नतीजों के सेट में अगला पेज वापस पाया जा सकता है.
pageInfo	object pageInfo ऑब्जेक्ट, नतीजों के सेट के लिए पेजिंग की जानकारी को इनकैप्सुलेट करता है.
pageInfo.totalResults	integer नतीजों के सेट में मौजूद नतीजों की कुल संख्या.
pageInfo.resultsPerPage	integer एपीआई से मिली जानकारी में शामिल नतीजों की संख्या.
items[]	list अनुरोध की शर्तों से मेल खाने वाली टिप्पणियों की सूची.

गड़बड़ियां

यहां दी गई टेबल में, गड़बड़ी के उन मैसेज के बारे में बताया गया है जो इस तरीके को कॉल करने पर, एपीआई से मिल सकते हैं. ज़्यादा जानकारी के लिए, कृपया गड़बड़ी के मैसेज वाला दस्तावेज़ देखें.

गड़बड़ी का टाइप	गड़बड़ी की जानकारी	ब्यौरा
badRequest (400)	operationNotSupported	आईडी फ़िल्टर, सिर्फ़ Google+ पर की गई टिप्पणियों के साथ काम करता है.
forbidden (403)	forbidden	ज़रूरी अनुमतियां न होने की वजह से, अनुरोध की गई एक या इससे ज़्यादा टिप्पणियां नहीं देखी जा सकीं. ऐसा हो सकता है कि अनुरोध को सही तरीके से अनुमति न मिली हो.
notFound (404)	commentNotFound	चुनी गई एक या उससे ज़्यादा टिप्पणियां नहीं मिलीं. अनुरोध के id और parentId पैरामीटर की वैल्यू की जांच करके पक्का करें कि वे सही हों.

इसे आज़माएं!

इस एपीआई को कॉल करने के लिए, APIs Explorer का इस्तेमाल करें. साथ ही, एपीआई अनुरोध और रिस्पॉन्स देखें.