Channels: list

ध्यान दें: channel संसाधन की statistics.subscriberCount प्रॉपर्टी की वैल्यू को अपडेट किया गया है. ऐसा YouTube की नीति में हुए बदलाव को दिखाने के लिए किया गया है. इसका असर, सदस्यों की संख्या दिखाने के तरीके पर पड़ता है. ज़्यादा जानकारी के लिए, कृपया बदलावों का इतिहास या 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 सीएमएस के किसी ऐसे उपयोगकर्ता की पहचान करते हैं जो पैरामीटर वैल्यू में बताए गए कॉन्टेंट के मालिक की ओर से काम कर रहा है. यह पैरामीटर उन 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
इस संसाधन का ईटैग.
nextPageToken string
नतीजे के सेट का अगला पेज वापस पाने के लिए, pageToken पैरामीटर की वैल्यू के तौर पर इस्तेमाल किया जा सकने वाला टोकन.
prevPageToken string
इस टोकन का इस्तेमाल, pageToken पैरामीटर की वैल्यू के तौर पर किया जा सकता है, ताकि नतीजे के सेट के पिछले पेज को वापस पाया जा सके. ध्यान दें कि अगर एपीआई अनुरोध से जुड़े एपीआई के अनुरोध में, managedByMe पैरामीटर को true पर सेट किया जाता है, तो इस प्रॉपर्टी को एपीआई के रिस्पॉन्स में शामिल नहीं किया जाता.
pageInfo object
pageInfo ऑब्जेक्ट, नतीजे के सेट के लिए पेजिंग की जानकारी इकट्ठा करता है.
pageInfo.totalResults integer
नतीजे के सेट में मौजूद नतीजों की कुल संख्या.
pageInfo.resultsPerPage integer
एपीआई से मिले रिस्पॉन्स में शामिल नतीजों की संख्या.
items[] list
अनुरोध की शर्तों को पूरा करने वाले चैनलों की सूची.

गड़बड़ियां

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

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