यह फ़ंक्शन, YouTube के उन ब्रॉडकास्ट की सूची दिखाता है जो एपीआई अनुरोध के पैरामीटर से मेल खाते हैं.
इस्तेमाल के सामान्य उदाहरण
अनुरोध
एचटीटीपी अनुरोध
GET https://www.googleapis.com/youtube/v3/liveBroadcasts
अनुमति देना
इस अनुरोध के लिए, इनमें से कम से कम किसी एक स्कोप से अनुमति देना ज़रूरी है (पुष्टि करने और अनुमति देने के बारे में ज़्यादा पढ़ें).
दायरा |
---|
https://www.googleapis.com/auth/youtube.readonly |
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
पैरामीटर
इस टेबल में उन पैरामीटर की सूची दी गई है जिनका इस्तेमाल इस क्वेरी में किया जाता है. सूची में दिए गए सभी पैरामीटर, क्वेरी पैरामीटर हैं.
पैरामीटर | ||
---|---|---|
ज़रूरी पैरामीटर | ||
part |
string part पैरामीटर, एक या उससे ज़्यादा liveBroadcast रिसॉर्स प्रॉपर्टी की कॉमा-सेपरेटेड लिस्ट तय करता है, जिसमें एपीआई के रिस्पॉन्स शामिल होंगे. पैरामीटर वैल्यू में id , snippet , contentDetails , monetizationDetails , और status जैसे part नाम शामिल किए जा सकते हैं. |
|
फ़िल्टर (इनमें से कोई एक पैरामीटर बताएं) | ||
broadcastStatus |
string broadcastStatus पैरामीटर, एपीआई से मिले रिस्पॉन्स को फ़िल्टर करता है, ताकि सिर्फ़ खास स्टेटस वाले ब्रॉडकास्ट शामिल किए जा सकें.ये वैल्यू डाली जा सकती हैं:
|
|
id |
string id पैरामीटर, YouTube ब्रॉडकास्ट आईडी की कॉमा-सेपरेटेड लिस्ट के बारे में बताता है, जो उन ब्रॉडकास्ट की पहचान करता है जिन्हें फिर से शामिल किया जा रहा है. liveBroadcast संसाधन में, id प्रॉपर्टी ब्रॉडकास्ट के आईडी की जानकारी देती है. |
|
mine |
boolean mine पैरामीटर का इस्तेमाल, एपीआई को सिर्फ़ वे ब्रॉडकास्ट लौटाने के निर्देश देने के लिए किया जा सकता है जिनके मालिकाना हक की पुष्टि हो चुकी है. सिर्फ़ अपने ब्रॉडकास्ट पाने के लिए, पैरामीटर वैल्यू को true पर सेट करें. |
|
वैकल्पिक पैरामीटर | ||
broadcastType |
string broadcastType पैरामीटर, एपीआई के रिस्पॉन्स को फ़िल्टर करता है, ताकि सिर्फ़ खास टाइप वाले ब्रॉडकास्ट शामिल किए जा सकें. इस पैरामीटर का इस्तेमाल उन अनुरोधों में किया जाना चाहिए जो mine पैरामीटर को true पर सेट करते हैं या जो broadcastStatus पैरामीटर का इस्तेमाल करते हैं. डिफ़ॉल्ट वैल्यू event है.इन वैल्यू को स्वीकार किया जाता है:
|
|
maxResults |
unsigned integer maxResults पैरामीटर से यह तय होता है कि नतीजों के सेट के तौर पर, ज़्यादा से ज़्यादा कितने आइटम दिखाए जाएंगे. 0 से 50 के बीच की वैल्यू स्वीकार की जा सकती है. इसमें ये दोनों वैल्यू भी शामिल हैं. डिफ़ॉल्ट वैल्यू 5 है. |
|
onBehalfOfContentOwner |
string इस पैरामीटर का इस्तेमाल, सिर्फ़ सही तरीके से अनुमति वाले अनुरोध में किया जा सकता है. ध्यान दें: यह पैरामीटर खास तौर पर, YouTube कॉन्टेंट पार्टनर के लिए है. onBehalfOfContentOwner पैरामीटर से पता चलता है कि अनुरोध की अनुमति देने वाले क्रेडेंशियल, YouTube सीएमएस के ऐसे उपयोगकर्ता की पहचान करते हैं जो पैरामीटर वैल्यू में बताए गए कॉन्टेंट के मालिक की ओर से काम कर रहा है. यह पैरामीटर उन YouTube कॉन्टेंट पार्टनर के लिए है जिनके पास कई अलग-अलग YouTube चैनलों का मालिकाना हक है और उन्हें मैनेज करने का अधिकार अलग-अलग है. इस सुविधा की मदद से, कॉन्टेंट के मालिक सिर्फ़ एक बार पुष्टि कर सकते हैं. साथ ही, उन्हें अपने वीडियो और चैनल के पूरे डेटा का ऐक्सेस मिलता है. इसके लिए, उन्हें हर चैनल के लिए पुष्टि करने के क्रेडेंशियल देने की ज़रूरत नहीं होती. उपयोगकर्ता की ओर से प्रमाणित किया गया कॉन्टेंट मैनेजमेंट सिस्टम खाता, किसी खास YouTube कॉन्टेंट के मालिक से जुड़ा होना चाहिए. |
|
onBehalfOfContentOwnerChannel |
string इस पैरामीटर का इस्तेमाल, सिर्फ़ सही तरीके से अनुमति वाले अनुरोध में किया जा सकता है. इस पैरामीटर का इस्तेमाल, सिर्फ़ सही तरीके से अनुमति वाले अनुरोध में किया जा सकता है. ध्यान दें: यह पैरामीटर खास तौर पर, YouTube कॉन्टेंट पार्टनर के लिए है. onBehalfOfContentOwnerChannel पैरामीटर, उस चैनल का YouTube चैनल आईडी बताता है जिसमें वीडियो जोड़ा जा रहा है. यह पैरामीटर तब ज़रूरी होता है, जब किसी अनुरोध में onBehalfOfContentOwner पैरामीटर के लिए कोई वैल्यू तय की जाती है. साथ ही, इसका इस्तेमाल सिर्फ़ उसी पैरामीटर के साथ किया जा सकता है. इसके अलावा, अनुरोध की अनुमति किसी ऐसे कॉन्टेंट मैनेजमेंट सिस्टम खाते का इस्तेमाल करके दी जानी चाहिए जो कॉन्टेंट के उस मालिक से जुड़ा हो जिसे onBehalfOfContentOwner पैरामीटर तय करता है. आखिर में, onBehalfOfContentOwnerChannel पैरामीटर की वैल्यू के तौर पर दिया गया चैनल, कॉन्टेंट के उस मालिक से जुड़ा होना चाहिए जिसके बारे में onBehalfOfContentOwner पैरामीटर तय करता है.यह पैरामीटर उन YouTube कॉन्टेंट पार्टनर के लिए है जिनके पास कई YouTube चैनलों का मालिकाना हक और उन्हें मैनेज करने का अधिकार है. इसकी मदद से कॉन्टेंट के मालिक सिर्फ़ एक बार पुष्टि कर सकते हैं और पैरामीटर वैल्यू में बताए गए चैनल की ओर से कार्रवाइयां कर सकते हैं. इसके लिए, उन्हें हर चैनल के लिए पुष्टि करने के क्रेडेंशियल देने की ज़रूरत नहीं होती. |
|
pageToken |
string pageToken पैरामीटर, नतीजों के सेट में उस खास पेज की पहचान करता है जिसे दिखाया जाना चाहिए. एपीआई से मिले रिस्पॉन्स में, nextPageToken और prevPageToken प्रॉपर्टी ऐसे अन्य पेजों की पहचान करती हैं जिन्हें वापस पाया जा सकता है. |
अनुरोध का मुख्य भाग
इस तरीके को कॉल करते समय, अनुरोध का मुख्य हिस्सा न दें.
जवाब
कामयाब होने पर, यह तरीका इस स्ट्रक्चर का इस्तेमाल करके रिस्पॉन्स का मुख्य हिस्सा दिखाता है:
{ "kind": "youtube#liveBroadcastListResponse", "etag": etag, "nextPageToken": string, "prevPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ liveBroadcast Resource ] }
प्रॉपर्टी
यहां दी गई टेबल में, इस संसाधन में दिखने वाली प्रॉपर्टी के बारे में बताया गया है:
प्रॉपर्टी | |
---|---|
kind |
string यह बताता है कि एपीआई रिसॉर्स किस तरह का है. वैल्यू youtube#liveBroadcastListResponse होगी. |
etag |
etag इस संसाधन का एटैग. |
nextPageToken |
string इस टोकन का इस्तेमाल, pageToken पैरामीटर की वैल्यू के तौर पर किया जा सकता है, ताकि नतीजे के सेट में शामिल अगले पेज पर पहुंचा जा सके. |
prevPageToken |
string नतीजे के सेट में पिछले पेज को वापस पाने के लिए, इस टोकन का इस्तेमाल pageToken पैरामीटर की वैल्यू के तौर पर किया जा सकता है. |
pageInfo |
object pageInfo ऑब्जेक्ट, नतीजे के सेट के लिए पेजिंग की जानकारी इकट्ठा करता है. |
pageInfo.totalResults |
integer नतीजे के सेट किए गए नतीजों की कुल संख्या. |
pageInfo.resultsPerPage |
integer एपीआई से मिले रिस्पॉन्स में शामिल नतीजों की संख्या. |
items[] |
list ब्रॉडकास्ट की ऐसी सूची जो अनुरोध की शर्तों के मुताबिक होती है. |
गड़बड़ियां
नीचे दी गई टेबल में गड़बड़ी के उन मैसेज की पहचान की गई है जो एपीआई, इस तरीके को कॉल करने पर मिल सकता है. ज़्यादा जानकारी के लिए, कृपया गड़बड़ी के मैसेज का दस्तावेज़ देखें.
गड़बड़ी का टाइप | गड़बड़ी की जानकारी | ब्यौरा |
---|---|---|
insufficientPermissions |
insufficientLivePermissions |
अनुरोध को लाइव ब्रॉडकास्ट फिर से पाने की अनुमति नहीं है. |
insufficientPermissions |
liveStreamingNotEnabled |
जिस उपयोगकर्ता ने अनुरोध करने की अनुमति दी है वह YouTube पर लाइव वीडियो स्ट्रीम नहीं कर सकता. उपयोगकर्ता https://www.youtube.com/features पर ज़्यादा जानकारी पा सकते हैं. |
इसे आज़माएं!
इस एपीआई को कॉल करने के लिए, APIs Explorer का इस्तेमाल करें. साथ ही, एपीआई अनुरोध और उसका जवाब देखें.