Channels: list

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

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

कोटा पर असर: इस तरीके को कॉल करने पर, 1 यूनिट का कोटा खर्च होता है.

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

अनुरोध

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

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