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
The videoId पैरामीटर, एपीआई को यह निर्देश देता है कि वह तय किए गए वीडियो आईडी से जुड़ी टिप्पणियों की थ्रेड दिखाए.
वैकल्पिक पैरामीटर
maxResults unsigned integer
The maxResults पैरामीटर, नतीजों के सेट में दिखाए जाने वाले आइटम की ज़्यादा से ज़्यादा संख्या तय करता है.

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

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

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

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

ध्यान दें: इस पैरामीटर का इस्तेमाल, 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 का इस्तेमाल करें.