CommentThreads: list

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

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

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

अनुरोध

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

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

पैरामीटर

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

पैरामीटर
ज़रूरी पैरामीटर
part string
part पैरामीटर, एक या इससे ज़्यादा commentThread संसाधन प्रॉपर्टी की कॉमा-सेपरेटेड लिस्ट के बारे में बताता है. इस सूची में एपीआई के रिस्पॉन्स शामिल होंगे.

यहां दी गई सूची में part नाम दिए गए हैं, जिन्हें पैरामीटर की वैल्यू में शामिल किया जा सकता है:
  • id
  • replies
  • snippet
फ़िल्टर (इनमें से कोई एक पैरामीटर बताएं)
allThreadsRelatedToChannelId string
allThreadsRelatedToChannelId पैरामीटर, एपीआई को किसी चैनल से जुड़ी सभी टिप्पणी की थ्रेड दिखाने का निर्देश देता है.
id string
id पैरामीटर, टिप्पणी के थ्रेड के आईडी की कॉमा-सेपरेटेड लिस्ट के बारे में बताता है. ऐसा उन संसाधनों के लिए होता है जिन्हें वापस पाया जाना चाहिए.
videoId string
videoId पैरामीटर, एपीआई को किसी वीडियो आईडी से जुड़ी टिप्पणी की थ्रेड दिखाने का निर्देश देता है.
वैकल्पिक पैरामीटर
maxResults unsigned integer
maxResults पैरामीटर से, ऐसे आइटम की ज़्यादा से ज़्यादा संख्या तय होती है जिन्हें नतीजे के सेट में दिखाया जाना चाहिए.

ध्यान दें: इस पैरामीटर का इस्तेमाल, id पैरामीटर के साथ नहीं किया जा सकता. स्वीकार किए जाने वाले मान 1 से 100 तक हैं, जिसमें ये दोनों भी शामिल हैं. डिफ़ॉल्ट वैल्यू 20 है.
moderationStatus string
इस पैरामीटर का इस्तेमाल, सिर्फ़ सही तरीके से अनुमति वाले अनुरोध में किया जा सकता है. इस पैरामीटर को सेट करें, ताकि टिप्पणियों के थ्रेड को मॉडरेशन की किसी खास स्थिति में सीमित किया जा सके.

ध्यान दें: इस पैरामीटर का इस्तेमाल, id पैरामीटर के साथ नहीं किया जा सकता. डिफ़ॉल्ट वैल्यू published है.

ये वैल्यू स्वीकार की जाती हैं:
  • heldForReview – उन टिप्पणी थ्रेड को फिर से पाएं जिनके लिए मॉडरेटर से समीक्षा का इंतज़ार किया जा रहा है. अगर टॉप-लेवल की टिप्पणी या उस टिप्पणी के कम से कम एक जवाब की समीक्षा बाकी है, तो जवाब में टिप्पणी की थ्रेड शामिल की जा सकती है.
  • likelySpam – स्पैम होने की संभावना वाली टिप्पणी की थ्रेड वापस पाएं. अगर टॉप लेवल की कोई टिप्पणी या उस टिप्पणी के कम से कम एक जवाब को स्पैम माना जाता है, तो जवाब में टिप्पणी की थ्रेड शामिल की जा सकती है.
  • published – पब्लिश की गई टिप्पणियों के थ्रेड वापस पाएं. यह डिफ़ॉल्ट मान है. अगर टिप्पणी की टॉप-लेवल की टिप्पणी पब्लिश की गई है, तो जवाब में टिप्पणी की थ्रेड शामिल की जा सकती है.
order string
order पैरामीटर उस क्रम के बारे में बताता है जिसमें एपीआई के रिस्पॉन्स में टिप्पणी की थ्रेड को सूची में शामिल किया जाना चाहिए. मान्य मान हैं:
  • time - टिप्पणी की थ्रेड समय के हिसाब से क्रम में लगाई जाती हैं. यह डिफ़ॉल्ट व्यवहार है.
  • relevance - टिप्पणी की थ्रेड प्रासंगिकता के हिसाब से क्रम में लगाई जाती हैं.
ध्यान दें: इस पैरामीटर का इस्तेमाल id पैरामीटर के साथ नहीं किया जा सकता.
pageToken string
pageToken पैरामीटर, नतीजे के सेट में उस खास पेज की पहचान करता है जिसे दिखाया जाना चाहिए. एपीआई के रिस्पॉन्स में, nextPageToken प्रॉपर्टी, नतीजे के अगले पेज की पहचान करती है, जिसे वापस लाया जा सकता है.

ध्यान दें: इस पैरामीटर का इस्तेमाल, id पैरामीटर के साथ करने के लिए नहीं किया जा सकता.
searchTerms string
searchTerms पैरामीटर, एपीआई को यह निर्देश देता है कि एपीआई से मिले रिस्पॉन्स को सिर्फ़ उन टिप्पणियों को शामिल किया जाए जिनमें खोज के लिए तय किए गए शब्द शामिल हों.

ध्यान दें: इस पैरामीटर का इस्तेमाल, id पैरामीटर के साथ नहीं किया जा सकता.
textFormat string
इस पैरामीटर की वैल्यू को html या plainText पर सेट करें, ताकि एपीआई को उपयोगकर्ताओं की टिप्पणियां वापस करने के निर्देश दिए जा सकें. ये टिप्पणियां, एचटीएमएल फ़ॉर्मैट वाले या सादे टेक्स्ट में की जा सकती हैं. डिफ़ॉल्ट वैल्यू html है.

ये वैल्यू स्वीकार की जाती हैं:
  • html – एचटीएमएल फ़ॉर्मैट में टिप्पणियां दिखाता है. यह डिफ़ॉल्ट मान है.
  • plainText – टिप्पणियों को सादे टेक्स्ट फ़ॉर्मैट में दिखाता है.

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

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

जवाब

अगर यह तरीका काम करता है, तो यह इस स्ट्रक्चर का इस्तेमाल करके रिस्पॉन्स का मुख्य हिस्सा दिखाता है:

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

प्रॉपर्टी

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

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

गड़बड़ियां

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

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

इसे आज़माएं!

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