Channels: list

ध्यान दें: YouTube की नीति में हुए बदलाव को दिखाने के लिए, channel रिसॉर्स की statistics.subscriberCount प्रॉपर्टी की वैल्यू को अपडेट किया गया है. इस बदलाव का असर, सदस्यों की संख्या दिखाने के तरीके पर पड़ता है. ज़्यादा जानकारी के लिए, बदलाव का इतिहास या YouTube सहायता केंद्र पर जाएं.

अनुरोध की शर्तों से मेल खाने वाले शून्य या उससे ज़्यादा channel संसाधनों का कलेक्शन दिखाता है.

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

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

अनुरोध

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

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

अनुमति देना

channel संसाधन का auditDetails हिस्सा वापस लाने वाले अनुरोध में, अनुमति वाला ऐसा टोकन होना चाहिए जिसमें https://www.googleapis.com/auth/youtubepartner-channel-audit स्कोप शामिल हो. इसके अलावा, एमसीएन के चैनल को स्वीकार या अस्वीकार करने के बाद या टोकन जारी होने की तारीख से दो हफ़्ते के अंदर, उस स्कोप का इस्तेमाल करने वाले सभी टोकन रद्द कर दिए जाने चाहिए.

पैरामीटर

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

पैरामीटर
ज़रूरी पैरामीटर
part	string part पैरामीटर, एक या उससे ज़्यादा channel संसाधन प्रॉपर्टी की सूची देता है. यह सूची, कॉमा लगाकर अलग की जाती है. यह सूची, एपीआई के रिस्पॉन्स में शामिल की जाएगी. अगर पैरामीटर में ऐसी प्रॉपर्टी की पहचान की जाती है जिसमें चाइल्ड प्रॉपर्टी शामिल हैं, तो चाइल्ड प्रॉपर्टी को रिस्पॉन्स में शामिल किया जाएगा. उदाहरण के लिए, किसी channel रिसॉर्स में, contentDetails प्रॉपर्टी में अन्य प्रॉपर्टी शामिल होती हैं, जैसे कि uploads प्रॉपर्टी. इसलिए, अगर part=contentDetails सेट किया जाता है, तो एपीआई रिस्पॉन्स में वे सभी नेस्ट की गई प्रॉपर्टी भी शामिल होंगी. यहां दी गई सूची में वे part नाम शामिल हैं जिन्हें पैरामीटर वैल्यू में शामिल किया जा सकता है: auditDetails brandingSettings contentDetails contentOwnerDetails id localizations snippet statistics status topicDetails
फ़िल्टर (इनमें से किसी एक पैरामीटर की जानकारी दें)
categoryId	string इस पैरामीटर का इस्तेमाल बंद कर दिया गया है. categoryId पैरामीटर में, YouTube की गाइड की कैटगरी की जानकारी दी गई है. इसका इस्तेमाल, उस कैटगरी से जुड़े YouTube चैनलों का अनुरोध करने के लिए किया जा सकता है.
forHandle	string forHandle पैरामीटर, YouTube हैंडल की जानकारी देता है. इससे उस हैंडल से जुड़े चैनल का अनुरोध किया जाता है. पैरामीटर की वैल्यू के आगे @ सिंबल जोड़ा जा सकता है. उदाहरण के लिए, "Google for Developers" चैनल का संसाधन पाने के लिए, forHandle पैरामीटर की वैल्यू को GoogleDevelopers या @GoogleDevelopers पर सेट करें.
forUsername	string forUsername पैरामीटर, YouTube उपयोगकर्ता नाम की जानकारी देता है. इससे उस उपयोगकर्ता नाम से जुड़े चैनल का अनुरोध किया जाता है.
id	string id पैरामीटर, वापस लाए जा रहे संसाधनों के लिए, कॉमा लगाकर अलग किए गए YouTube चैनल आईडी की सूची दिखाता है. channel रिसॉर्स में, id प्रॉपर्टी से चैनल का YouTube चैनल आईडी पता चलता है.
managedByMe	boolean इस पैरामीटर का इस्तेमाल सिर्फ़ अनुमति वाले अनुरोध में किया जा सकता है. ध्यान दें: यह पैरामीटर सिर्फ़ YouTube कॉन्टेंट पार्टनर के लिए है. इस पैरामीटर की वैल्यू को true पर सेट करें, ताकि एपीआई को सिर्फ़ कॉन्टेंट के मालिक के मैनेज किए गए उन चैनलों को दिखाने का निर्देश दिया जा सके जिनके बारे में onBehalfOfContentOwner पैरामीटर में बताया गया है. उपयोगकर्ता की पुष्टि, कॉन्टेंट के मालिक से लिंक किए गए सीएमएस खाते के तौर पर की जानी चाहिए. साथ ही, onBehalfOfContentOwner की जानकारी देनी होगी.
mine	boolean इस पैरामीटर का इस्तेमाल सिर्फ़ अनुमति वाले अनुरोध में किया जा सकता है. इस पैरामीटर की वैल्यू को true पर सेट करें, ताकि एपीआई को सिर्फ़ ऐसे चैनलों की जानकारी दिखाने का निर्देश दिया जा सके जिनका मालिकाना हक पुष्टि किए गए उपयोगकर्ता के पास है.
ज़रूरी नहीं पैरामीटर
hl	string hl पैरामीटर, एपीआई को किसी खास ऐप्लिकेशन भाषा के लिए, स्थानीय भाषा में उपलब्ध संसाधन का मेटाडेटा पाने का निर्देश देता है. यह भाषा, YouTube की वेबसाइट पर काम करती हो. पैरामीटर की वैल्यू, i18nLanguages.list तरीके से लौटाई गई सूची में शामिल भाषा कोड होनी चाहिए. अगर उस भाषा में स्थानीय भाषा के हिसाब से संसाधन की जानकारी उपलब्ध है, तो संसाधन के snippet.localized ऑब्जेक्ट में स्थानीय भाषा के हिसाब से वैल्यू होंगी. हालांकि, अगर स्थानीय भाषा के हिसाब से जानकारी उपलब्ध नहीं है, तो snippet.localized ऑब्जेक्ट में संसाधन की जानकारी, संसाधन की डिफ़ॉल्ट भाषा में होगी.
maxResults	unsigned integer maxResults पैरामीटर से यह तय होता है कि नतीजे के सेट में कितने आइटम दिखाए जाएं. 0 से 50 तक की वैल्यू ही स्वीकार की जाती हैं. डिफ़ॉल्ट वैल्यू 5 है.
onBehalfOfContentOwner	string इस पैरामीटर का इस्तेमाल सिर्फ़ अनुमति वाले अनुरोध में किया जा सकता है. ध्यान दें: यह पैरामीटर सिर्फ़ YouTube के कॉन्टेंट पार्टनर के लिए है. onBehalfOfContentOwner पैरामीटर से पता चलता है कि अनुरोध के लिए दिए गए क्रेडेंशियल, YouTube CMS के उस उपयोगकर्ता की पहचान करते हैं जो पैरामीटर की वैल्यू में बताए गए कॉन्टेंट के मालिक की ओर से काम कर रहा है. यह पैरामीटर, YouTube कॉन्टेंट पार्टनर के लिए है. इनके पास कई अलग-अलग YouTube चैनलों का मालिकाना हक होता है और वे उन्हें मैनेज करते हैं. इसकी मदद से, कॉन्टेंट के मालिक एक बार पुष्टि करके अपने सभी वीडियो और चैनल का डेटा ऐक्सेस कर सकते हैं. इसके लिए, उन्हें हर चैनल के लिए पुष्टि करने के क्रेडेंशियल देने की ज़रूरत नहीं होती. उपयोगकर्ता जिस सीएमएस खाते से पुष्टि करता है वह YouTube कॉन्टेंट के मालिक से लिंक होना चाहिए.
pageToken	string pageToken पैरामीटर, नतीजों के सेट में मौजूद उस पेज की पहचान करता है जिसे दिखाना है. एपीआई रिस्पॉन्स में, nextPageToken और prevPageToken प्रॉपर्टी उन दूसरे पेजों की पहचान करती हैं जिन्हें वापस लाया जा सकता है.

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

इस तरीके को कॉल करते समय, अनुरोध बॉडी न दें.

जवाब

अगर एपीआई सही से जुड़ जाता है, तो यह तरीका इस स्ट्रक्चर के साथ रिस्पॉन्स बॉडी दिखाता है:

{
  "kind": "youtube#channelListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    channel Resource
  ]
}

प्रॉपर्टी

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

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

गड़बड़ियां

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

गड़बड़ी का टाइप	गड़बड़ी की जानकारी	ब्यौरा
badRequest (400)	invalidCriteria	इनमें से ज़्यादा से ज़्यादा एक फ़िल्टर इस्तेमाल किया जा सकता है:id, categoryId, mine, managedByMe, forHandle, forUsername. onBehalfOfContentOwner पैरामीटर की मदद से कॉन्टेंट के मालिक की पुष्टि करने के लिए, सिर्फ़ id या managedByMe का इस्तेमाल किया जा सकता है.
forbidden (403)	channelForbidden	id पैरामीटर से तय किया गया चैनल, अनुरोध के साथ काम नहीं करता या अनुरोध को सही तरीके से अनुमति नहीं दी गई है.
notFound (404)	categoryNotFound	categoryId पैरामीटर से पहचानी गई कैटगरी नहीं मिली. मान्य वैल्यू की सूची पाने के लिए, guideCategories.list तरीके का इस्तेमाल करें.
notFound (404)	channelNotFound	id पैरामीटर में दिया गया चैनल नहीं मिला.

इसे आज़माएं!

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