एपीआई अनुरोध के पैरामीटर से मेल खाने वाली टिप्पणियों की सूची दिखाता है.
कोटा असर: इस तरीके को कॉल करने पर कोटा लागत एक इकाई हो जाती है.
इस्तेमाल के सामान्य उदाहरण
अनुरोध करें
एचटीटीपी अनुरोध
GET https://www.googleapis.com/youtube/v3/comments
पैरामीटर
इस टेबल में ऐसे पैरामीटर दिए गए हैं जो क्वेरी के साथ काम करते हैं. सूची में दिए गए सभी पैरामीटर, क्वेरी पैरामीटर हैं.
पैरामीटर | ||
---|---|---|
ज़रूरी पैरामीटर | ||
part |
string part पैरामीटर में एक या उससे ज़्यादा comment संसाधन प्रॉपर्टी की कॉमा-सेपरेटेड लिस्ट होती है, जिसे एपीआई रिस्पॉन्स में शामिल किया जाएगा.नीचे दी गई सूची में part नाम शामिल हैं, जिन्हें आप पैरामीटर वैल्यू में शामिल कर सकते हैं:
|
|
फ़िल्टर (इनमें से किसी एक पैरामीटर के बारे में बताएं) | ||
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 है.मान्य वैल्यू ये हैं:
|
अनुरोध का मुख्य भाग
इस तरीके को कॉल करते समय, अनुरोध का मुख्य हिस्सा न दें.
जवाब
अगर अनुरोध कामयाब रहता है, तो इस रिस्पॉन्स के साथ रिस्पॉन्स का फ़ॉर्मैट नीचे दिया गया है:
{ "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 का इस्तेमाल करें.