Comments: list

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

कोटा पर असर: इस तरीके का इस्तेमाल करने पर एक यूनिट की कोटे की कीमत लागू होती है.

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

अनुरोध

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

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
इस संसाधन का ईटैग.
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 का इस्तेमाल करें. साथ ही, एपीआई अनुरोध और रिस्पॉन्स देखें.