LiveBroadcasts: list

यह एपीआई अनुरोध के पैरामीटर से मेल खाने वाले YouTube ब्रॉडकास्ट की सूची दिखाता है.

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

अनुरोध

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

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

अनुमति देना

इस अनुरोध के लिए, कम से कम इनमें से किसी एक स्कोप के साथ अनुमति देना ज़रूरी है. प्रमाणीकरण और अनुमति देने के बारे में ज़्यादा जानने के लिए, OAuth 2.0 प्रमाणीकरण लागू करना लेख पढ़ें.

दायरा
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 पैरामीटर, एपीआई के जवाब को फ़िल्टर करता है, ताकि उसमें सिर्फ़ तय की गई स्थिति वाले ब्रॉडकास्ट शामिल हों. इसके लिए, ये वैल्यू इस्तेमाल की जा सकती हैं: active – फ़िलहाल लाइव ब्रॉडकास्ट दिखाएं. all – सभी ब्रॉडकास्ट दिखाएं. completed – वे ब्रॉडकास्ट दिखाएं जो पहले ही खत्म हो चुके हैं. upcoming – वे ब्रॉडकास्ट दिखाएं जो अभी शुरू नहीं हुए हैं.
id	string id पैरामीटर, YouTube ब्रॉडकास्ट आईडी की कॉमा लगाकर अलग की गई लिस्ट तय करता है. इससे उन ब्रॉडकास्ट की पहचान होती है जिन्हें वापस लाया जा रहा है. liveBroadcast संसाधन में, id प्रॉपर्टी ब्रॉडकास्ट का आईडी तय करती है.
mine	boolean mine पैरामीटर का इस्तेमाल करके, एपीआई को सिर्फ़ पुष्टि किए गए उपयोगकर्ता के ब्रॉडकास्ट दिखाने के लिए कहा जा सकता है. सिर्फ़ अपने ब्रॉडकास्ट वापस पाने के लिए, पैरामीटर वैल्यू को true पर सेट करें.
वैकल्पिक पैरामीटर
broadcastType	string The broadcastType पैरामीटर, एपीआई से मिली जानकारी को फ़िल्टर करता है, ताकि उसमें सिर्फ़ तय किए गए टाइप वाले ब्रॉडकास्ट शामिल हों. इस पैरामीटर का इस्तेमाल उन अनुरोधों में किया जाना चाहिए जिनमें mine पैरामीटर की वैल्यू true पर सेट की गई हो या जिनमें broadcastStatus पैरामीटर का इस्तेमाल किया गया हो. डिफ़ॉल्ट वैल्यू event है. इसके लिए, ये वैल्यू इस्तेमाल की जा सकती हैं: all – सभी ब्रॉडकास्ट दिखाएं. event – सिर्फ़ शेड्यूल किए गए इवेंट ब्रॉडकास्ट दिखाएं. persistent – सिर्फ़ परसिस्टेंट ब्रॉडकास्ट दिखाएं.
maxResults	unsigned integer maxResults पैरामीटर, नतीजों के सेट में दिखाए जाने वाले आइटम की ज़्यादा से ज़्यादा संख्या तय करता है. इसके लिए, 0 से 50 तक की वैल्यू इस्तेमाल की जा सकती हैं. डिफ़ॉल्ट वैल्यू 5 है.
onBehalfOfContentOwner	string इस पैरामीटर का इस्तेमाल, सिर्फ़ अनुमति वाले अनुरोध में किया जा सकता है. ध्यान दें: यह पैरामीटर, सिर्फ़ YouTube के कॉन्टेंट पार्टनर के लिए है. The onBehalfOfContentOwner पैरामीटर से पता चलता है कि अनुरोध की अनुमति देने वाले क्रेडेंशियल, YouTube के कॉन्टेंट मैनेजमेंट सिस्टम (सीएमएस) के किसी ऐसे उपयोगकर्ता की पहचान करते हैं जो पैरामीटर वैल्यू में तय किए गए कॉन्टेंट के मालिक की ओर से काम कर रहा है. यह पैरामीटर, YouTube के उन कॉन्टेंट पार्टनर के लिए है जो YouTube के कई अलग-अलग चैनलों के मालिक हैं और उन्हें मैनेज करते हैं. इससे, कॉन्टेंट के मालिक एक बार पुष्टि करके, अपने सभी वीडियो और चैनल के डेटा का ऐक्सेस पा सकते हैं. इसके लिए, उन्हें हर चैनल के लिए अनुमति देने वाले क्रेडेंशियल देने की ज़रूरत नहीं होती. जिस सीएमएस खाते से उपयोगकर्ता पुष्टि करता है वह, तय किए गए YouTube कॉन्टेंट के मालिक से लिंक होना चाहिए.
onBehalfOfContentOwnerChannel	string इस पैरामीटर का इस्तेमाल, सिर्फ़ अनुमति वाले अनुरोध में किया जा सकता है. ध्यान दें: यह पैरामीटर, सिर्फ़ YouTube के कॉन्टेंट पार्टनर के लिए है. onBehalfOfContentOwnerChannel पैरामीटर, उस YouTube चैनल का चैनल आईडी तय करता है जिसमें कोई वीडियो जोड़ा जा रहा है. यह पैरामीटर तब ज़रूरी होता है, जब किसी अनुरोध में onBehalfOfContentOwner पैरामीटर के लिए कोई वैल्यू तय की गई हो. इसका इस्तेमाल, सिर्फ़ उस पैरामीटर के साथ किया जा सकता है. इसके अलावा, अनुरोध को कॉन्टेंट मैनेजमेंट सिस्टम के किसी ऐसे खाते का इस्तेमाल करके अनुमति दी जानी चाहिए जो उस कॉन्टेंट के मालिक से लिंक हो जिसे onBehalfOfContentOwner पैरामीटर तय करता है. आखिर में, onBehalfOfContentOwnerChannel पैरामीटर वैल्यू में तय किया गया YouTube चैनल, उस कॉन्टेंट के मालिक से लिंक होना चाहिए जिसे onBehalfOfContentOwner पैरामीटर तय करता है. यह पैरामीटर, YouTube के उन कॉन्टेंट पार्टनर के लिए है जो 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 यह इस संसाधन का Etag है.
nextPageToken	string यह टोकन, नतीजों के सेट में मौजूद अगले पेज को वापस पाने के लिए, pageToken पैरामीटर की वैल्यू के तौर पर इस्तेमाल किया जा सकता है.
prevPageToken	string यह टोकन, नतीजों के सेट में मौजूद पिछले पेज को वापस पाने के लिए, pageToken पैरामीटर की वैल्यू के तौर पर इस्तेमाल किया जा सकता है.
pageInfo	object pageInfo ऑब्जेक्ट, नतीजों के सेट के लिए पेजिंग की जानकारी कैप्सूल करता है.
pageInfo.totalResults	integer नतीजों के सेट में मौजूद नतीजों की कुल संख्या.
pageInfo.resultsPerPage	integer एपीआई से मिली जानकारी में शामिल नतीजों की संख्या.
items[]	list अनुरोध की ज़रूरी शर्तों से मेल खाने वाले ब्रॉडकास्ट की सूची.

गड़बड़ियां

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

गड़बड़ी का टाइप	गड़बड़ी की जानकारी	ब्यौरा
insufficientPermissions	insufficientLivePermissions	अनुरोध को लाइव ब्रॉडकास्ट वापस पाने की अनुमति नहीं है.
insufficientPermissions	liveStreamingNotEnabled	जिस उपयोगकर्ता ने अनुरोध को अनुमति दी है उसके पास, YouTube पर लाइव वीडियो स्ट्रीम करने की अनुमति नहीं है. ज़्यादा जानकारी के लिए, सुविधा की ज़रूरी शर्तें देखें.

इसे आज़माएं!

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