LiveBroadcasts: control

ध्यान दें: liveBroadcasts.control तरीका बंद कर दिया गया है और यह 1 अक्टूबर, 2020 या उसके बाद काम करना बंद कर देगा. इस तारीख के बाद, इस तरीके के लिए किए गए सभी कॉल, 'रोका गया' (403) गड़बड़ी वाला मैसेज दिखाएंगे. साथ ही, बाद में इस तरीके को पूरी तरह से हटा दिया जाएगा.

क्लाइंट अब भी YouTube के डेटा डालने वाले सर्वर पर भेजे गए वीडियो में ओवरले जोड़कर, अपनी स्लेटिंग लागू कर सकते हैं. रोक लगाने की सूचना देखें.

ब्रॉडकास्ट स्ट्रीम में दिखाए जा सकने वाले स्लेट की सेटिंग को कंट्रोल करता है.

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

अनुरोध

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

POST https://www.googleapis.com/youtube/v3/liveBroadcasts/control

अनुमति

इस अनुरोध के लिए, इनमें से कम से कम एक स्कोप के साथ अनुमति देना ज़रूरी है (पुष्टि करने और अनुमति देने के बारे में ज़्यादा पढ़ें).

स्कोप
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

पैरामीटर

इस टेबल में वे पैरामीटर दिए गए हैं जो इस क्वेरी पर काम करते हैं. सूची में शामिल सभी पैरामीटर, क्वेरी पैरामीटर हैं.

पैरामीटर
ज़रूरी पैरामीटर
id string
id पैरामीटर YouTube लाइव ब्रॉडकास्ट आईडी के बारे में बताता है, जो उस ब्रॉडकास्ट की खास तौर पर पहचान करता है जिसमें स्लेट को अपडेट किया जा रहा है.
part string
part पैरामीटर, एक या इससे ज़्यादा liveBroadcast संसाधन प्रॉपर्टी की ऐसी सूची के बारे में बताता है जिसे कॉमा लगाकर अलग किया गया है. यह सूची, एपीआई के रिस्पॉन्स में शामिल होती है. पैरामीटर वैल्यू में शामिल किए जा सकने वाले part नाम, id, snippet, contentDetails, और status हैं.
वैकल्पिक पैरामीटर
displaySlate boolean
displaySlate पैरामीटर से पता चलता है कि स्लेट को चालू किया जा रहा है या बंद किया जा रहा है.
offsetTimeMs unsigned long
स्लेट में बदलाव होने पर, offsetTimeMs पैरामीटर पॉज़िटिव टाइम ऑफ़सेट की जानकारी देता है. वैल्यू को ब्रॉडकास्ट की मॉनिटर स्ट्रीम की शुरुआत से मिलीसेकंड में मापा जाता है. इसी समय से ब्रॉडकास्ट के लिए टेस्टिंग का चरण शुरू होता है. भले ही, इसे मिलीसेकंड में तय किया गया है, लेकिन असल में यह वैल्यू अनुमान के तौर पर होती है. साथ ही, YouTube अनुरोध की गई कार्रवाई को उस समय के हिसाब से जितना हो सके उतना करीब से पूरा कर देता है.

अगर इस पैरामीटर के लिए कोई वैल्यू नहीं दी जाती है, तो YouTube जल्द से जल्द कार्रवाई करता है. ज़्यादा जानकारी के लिए, शुरू करने का तरीका गाइड देखें.

अहम जानकारी: आपको इस पैरामीटर की वैल्यू सिर्फ़ तब तय करनी चाहिए, जब आपकी ब्रॉडकास्ट स्ट्रीम में देरी हो.
onBehalfOfContentOwner string
इस पैरामीटर का इस्तेमाल, सिर्फ़ सही तरीके से अनुमति वाले अनुरोध में किया जा सकता है. ध्यान दें: यह पैरामीटर खास तौर पर YouTube कॉन्टेंट पार्टनर के लिए है.

onBehalfOfContentOwner पैरामीटर से पता चलता है कि अनुरोध की अनुमति देने वाले क्रेडेंशियल, YouTube सीएमएस के किसी ऐसे उपयोगकर्ता की पहचान करते हैं जो पैरामीटर वैल्यू में बताए गए कॉन्टेंट के मालिक की ओर से काम कर रहा है. यह पैरामीटर उन YouTube कॉन्टेंट पार्टनर के लिए है जिनके पास कई अलग-अलग YouTube चैनलों का मालिकाना हक होता है और उन्हें मैनेज करने का अधिकार होता है. इससे कॉन्टेंट के मालिकों को एक बार पुष्टि करने के साथ-साथ, अपने वीडियो और चैनल के पूरे डेटा का ऐक्सेस मिल जाता है. इसके लिए, उन्हें हर चैनल के लिए पुष्टि करने वाले क्रेडेंशियल देने की ज़रूरत नहीं पड़ती. उपयोगकर्ता जिस कॉन्टेंट मैनेजमेंट सिस्टम से पुष्टि करता है वह खाता, YouTube कॉन्टेंट के उस मालिक से जुड़ा होना चाहिए.
onBehalfOfContentOwnerChannel string
इस पैरामीटर का इस्तेमाल, सिर्फ़ सही तरीके से अनुमति वाले अनुरोध में किया जा सकता है. इस पैरामीटर का इस्तेमाल, सिर्फ़ सही तरीके से अनुमति वाले अनुरोध में किया जा सकता है. ध्यान दें: यह पैरामीटर खास तौर पर YouTube कॉन्टेंट पार्टनर के लिए है.

onBehalfOfContentOwnerChannel पैरामीटर से उस चैनल का YouTube चैनल आईडी पता चलता है जिसमें वीडियो जोड़ा जा रहा है. इस पैरामीटर की ज़रूरत तब होती है, जब किसी अनुरोध में onBehalfOfContentOwner पैरामीटर के लिए कोई वैल्यू तय की जाती है. साथ ही, इसका इस्तेमाल सिर्फ़ उस पैरामीटर के साथ किया जा सकता है. इसके अलावा, अनुरोध की अनुमति किसी ऐसे कॉन्टेंट मैनेजमेंट सिस्टम खाते से मिली होनी चाहिए जो कॉन्टेंट के उस मालिक से जुड़ा हो जिसे onBehalfOfContentOwner पैरामीटर तय करता है. आखिर में, onBehalfOfContentOwnerChannel पैरामीटर वैल्यू के ज़रिए तय किया गया चैनल, कॉन्टेंट के उस मालिक से जुड़ा होना चाहिए जिसे onBehalfOfContentOwner पैरामीटर तय करता है.

यह पैरामीटर उन YouTube कॉन्टेंट पार्टनर के लिए है जिनके पास कई अलग-अलग YouTube चैनल हैं और उन्हें मैनेज करते हैं. इस सुविधा की मदद से, कॉन्टेंट के मालिक एक बार पुष्टि कर सकते हैं और पैरामीटर वैल्यू में दिए गए चैनल की ओर से कार्रवाइयां कर सकते हैं. इसके लिए, उन्हें हर अलग चैनल के लिए पुष्टि करने वाले क्रेडेंशियल देने की ज़रूरत नहीं है.
walltime datetime
walltime पैरामीटर से पता चलता है कि तय समय पर स्लेट में बदलाव होने पर, वॉल क्लॉक का समय कितना होगा. यह वैल्यू ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) फ़ॉर्मैट में होती है.

अनुरोध का मुख्य भाग

इस तरीके को कॉल करते समय, अनुरोध का मुख्य हिस्सा न दें.

जवाब

अगर यह तरीका काम करता है, तो जवाब के मुख्य हिस्से में liveBroadcast संसाधन दिखता है.

गड़बड़ियां

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

गड़बड़ी का टाइप गड़बड़ी की जानकारी ब्यौरा
backendError errorDisplaySlate अनुरोध की गई कार्रवाई को पूरा करते समय कोई गड़बड़ी हुई.
forbidden (403) liveBroadcastControlNotAllowed अनुरोध की गई कार्रवाई की अनुमति सिर्फ़ तब दी जाती है, जब ब्रॉडकास्ट की स्थिति live पर सेट हो.
insufficientPermissions insufficientLivePermissions उपयोगकर्ता को अनुरोध की गई कार्रवाई करने की अनुमति नहीं है. ऐसा हो सकता है कि उसके पास लाइव स्ट्रीम करने की अनुमति न हो.
insufficientPermissions liveStreamingNotEnabled जिस उपयोगकर्ता ने अनुरोध करने की अनुमति दी है वह YouTube पर लाइव वीडियो स्ट्रीम नहीं कर सकता. इस बारे में ज़्यादा जानकारी पाने के लिए, https://www.youtube.com/features पर जाएं.
invalidValue (400) conflictingTimeFields offsetTimeMs और walltime में से सिर्फ़ एक के बारे में बताया जा सकता है.
invalidValue (400) invalidOffsetTimeMs offsetTimeMs पैरामीटर की वैल्यू अमान्य है. पैरामीटर का मान पॉज़िटिव होना चाहिए. हालांकि, पैरामीटर को सिर्फ़ तब तय किया जा सकता है, जब ब्रॉडकास्ट की मॉनिटर स्ट्रीम चालू हो.
invalidValue (400) invalidWalltime walltime पैरामीटर की वैल्यू अमान्य है.
notFound (404) liveBroadcastNotFound id पैरामीटर से मिला ब्रॉडकास्ट मौजूद नहीं है.
required (400) actionRequired एपीआई अनुरोध में, कम से कम एक कार्रवाई के बारे में बताना ज़रूरी है. इस समय, सिर्फ़ स्लेट को चालू या बंद करने की क्षमता ही काम करती है.
required (400) idRequired ज़रूरी id पैरामीटर को अपडेट किए जा रहे ब्रॉडकास्ट की पहचान करनी होगी.

इसे आज़माएं!

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