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

ये वैल्यू शामिल की जा सकती हैं:
  • active – मौजूदा लाइव ब्रॉडकास्ट दिखाएं.
  • all – सभी ब्रॉडकास्ट दिखाएं.
  • completed – वे प्रसारण वापस करें जो पहले ही खत्म हो चुके हैं.
  • upcoming – ऐसे ब्रॉडकास्ट दिखाएं जो अभी तक शुरू नहीं हुए हैं.
id string
id पैरामीटर, YouTube ब्रॉडकास्ट आईडी की ऐसी सूची के बारे में बताता है जिसे कॉमा लगाकर अलग किया गया हो. यह आईडी, हासिल किए जा रहे ब्रॉडकास्ट की पहचान करता है. liveBroadcast संसाधन में, id प्रॉपर्टी ब्रॉडकास्ट आईडी के बारे में बताती है.
mine boolean
mine पैरामीटर का इस्तेमाल करके, एपीआई को यह निर्देश दिया जा सकता है कि वह सिर्फ़ पुष्टि किए गए उपयोगकर्ता के मालिकाना हक वाले ब्रॉडकास्ट दिखाए. सिर्फ़ अपने ब्रॉडकास्ट फिर से पाने के लिए, पैरामीटर वैल्यू को true पर सेट करें.
वैकल्पिक पैरामीटर
broadcastType string
broadcastType पैरामीटर, एपीआई के रिस्पॉन्स को फ़िल्टर करता है, ताकि सिर्फ़ बताए गए टाइप वाले ब्रॉडकास्ट शामिल किए जा सकें. इस पैरामीटर का इस्तेमाल उन अनुरोधों में किया जाना चाहिए जिनमें mine पैरामीटर को true पर सेट किया गया हो या जो broadcastStatus पैरामीटर का इस्तेमाल करते हों. डिफ़ॉल्ट वैल्यू event है.

ये वैल्यू स्वीकार की जा सकती हैं:
  • all – सभी ब्रॉडकास्ट दिखाएं.
  • event – सिर्फ़ शेड्यूल किए गए इवेंट का ब्रॉडकास्ट लौटाएं.
  • persistent – सिर्फ़ स्थायी ब्रॉडकास्ट दिखाएं.
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 पर लाइव वीडियो स्ट्रीम करने में सक्षम नहीं है. ज़्यादा जानकारी के लिए, सुविधा के लिए ज़रूरी शर्तें देखें.

इसे आज़माएं!

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