एपीआई अनुरोध पैरामीटर से मेल खाने वाले 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 संसाधन प्रॉपर्टी की ऐसी सूची के बारे में बताता है जिसे कॉमा लगाकर अलग किया गया है. यह सूची, एपीआई के रिस्पॉन्स में शामिल होती है. पैरामीटर की वैल्यू में part के ये नाम शामिल किए जा सकते हैं: id , snippet , contentDetails , monetizationDetails , और status . |
|
फ़िल्टर (इनमें से कोई एक पैरामीटर बताएं) | ||
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 का इस्तेमाल करें. साथ ही, एपीआई अनुरोध और रिस्पॉन्स देखें.