LiveBroadcasts: cuepoint

लाइव ब्रॉडकास्ट में क्यू पॉइंट डालता है. क्यूपॉइंट से विज्ञापन के लिए ब्रेक ट्रिगर हो सकता है.

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

अनुरोध

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

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

अनुमति देना

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

दायरा
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl
https://www.googleapis.com/auth/youtubepartner

पैरामीटर

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

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

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

अनुरोध के मुख्य हिस्से में cuepoint संसाधन दें. यहां दिया गया JSON स्ट्रक्चर, cuepoint संसाधन का फ़ॉर्मैट दिखाता है:

{
    "id": string,
    "insertionOffsetTimeMs": long,
    "walltimeMs": datetime,
    "durationSecs": unsigned integer,
    "cueType": string
  }
 अनुरोध के मुख्य हिस्से में, cueType फ़ील्ड होना ज़रूरी है और इसे cueTypeAd पर सेट करना ज़रूरी है. इन प्रॉपर्टी के लिए भी वैल्यू सेट की जा सकती हैं:
  • durationSecs
  • insertionOffsetTimeMs (walltimeMs सेट होने पर, इसे सेट नहीं किया जाना चाहिए)
  • walltimeMs (insertionOffsetTimeMs सेट होने पर, इसे सेट नहीं किया जाना चाहिए)

प्रॉपर्टी

इस टेबल में, इस संसाधन में दिखने वाली प्रॉपर्टी के बारे में बताया गया है:

प्रॉपर्टी
id string
यह एक वैल्यू है. इसका इस्तेमाल YouTube, क्यू पॉइंट की खास ढंग से पहचान करने के लिए करता है. ध्यान दें कि यह वैल्यू, ज़रूरी id पैरामीटर से अलग है. id पैरामीटर से ब्रॉडकास्ट की पहचान की जाती है. क्यूपॉइंट डालने का अनुरोध करते समय, इस वैल्यू को छोड़ा जा सकता है. वैल्यू, एपीआई के जवाब में अपने-आप भर जाएगी.
insertionOffsetTimeMs long
प्रॉपर्टी की वैल्यू से, मिलीसेकंड में उस समय के ऑफ़सेट की पहचान होती है जब क्यूपॉइंट डाला जाना चाहिए. इस वैल्यू को मॉनिटर स्ट्रीम की शुरुआत से मेज़र किया जाता है. इसकी डिफ़ॉल्ट वैल्यू 0 होती है. इससे पता चलता है कि क्यूपॉइंट को जल्द से जल्द डाला जाना चाहिए. अगर आपके ब्रॉडकास्ट में मॉनिटर स्ट्रीम नहीं है, तो आपको इस पैरामीटर के लिए कोई वैल्यू नहीं देनी चाहिए.

हालांकि, इसकी वैल्यू को मिलीसेकंड में मेज़र किया जाता है, लेकिन यह वैल्यू असल में अनुमानित होती है. YouTube, क्यूपॉइंट को उस समय के करीब से डालेगा.

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

ध्यान दें: अगर आपके ब्रॉडकास्ट में टेस्टिंग वाला चरण था, तो ऑफ़सेट को टेस्टिंग चरण के शुरू होने के समय से मेज़र किया जाता है.

अगर कोई अनुरोध, ऐसा क्यूपॉइंट डालने की कोशिश करता है जो इस प्रॉपर्टी और walltimeMs प्रॉपर्टी के लिए वैल्यू तय करता है, तो एपीआई गड़बड़ी का मैसेज दिखाता है.
walltimeMs integer
प्रॉपर्टी की वैल्यू से पता चलता है कि क्यूपॉइंट को किस समय डाला जाना चाहिए. यह वैल्यू एक इंटीजर होती है, जो युग के टाइमस्टैंप (मिलीसेकंड में) को दिखाती है.

अगर कोई अनुरोध, ऐसा क्यूपॉइंट डालने की कोशिश करता है जो इस प्रॉपर्टी और insertionOffsetTimeMs प्रॉपर्टी, दोनों के लिए वैल्यू तय करता है, तो एपीआई गड़बड़ी दिखाता है.
durationSecs unsigned integer
क्यूपॉइंट की अवधि, सेकंड में. वैल्यू कोई पॉज़िटिव पूर्णांक होना चाहिए. डिफ़ॉल्ट वैल्यू 30 है.
cueType string
क्यूपॉइंट का टाइप. प्रॉपर्टी की वैल्यू cueTypeAd पर सेट होनी चाहिए.

जवाब

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

गड़बड़ियां

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

गड़बड़ी का टाइप गड़बड़ी की जानकारी ब्यौरा
insufficientPermissions (403) insufficientLivePermissions अनुरोध में, लाइव ब्रॉडकास्ट में क्यूपॉइंट डालने की अनुमति नहीं है.
insufficientPermissions (403) liveStreamingNotEnabled अनुरोध को अनुमति देने वाले उपयोगकर्ता के पास, YouTube पर लाइव वीडियो स्ट्रीम करने की सुविधा चालू नहीं है. उपयोगकर्ता को ज़्यादा जानकारी पाने के लिए, लाइव स्ट्रीमिंग शुरू करना और सुविधा पाने की ज़रूरी शर्तें पर जाएं.
rateLimitExceeded (403) userRequestsExceedRateLimit उपयोगकर्ता ने तय समयावधि में बहुत ज़्यादा अनुरोध भेजे हैं.
required (400) idRequired ज़रूरी id पैरामीटर से उस ब्रॉडकास्ट की पहचान होनी चाहिए जिसमें आपको क्यूपॉइंट डालना है.
required (400) cueTypeRequired ज़रूरी cueType फ़ील्ड को एपीआई अनुरोध के मुख्य हिस्से में बताना ज़रूरी है.
notFound (404) liveBroadcastNotFound id पैरामीटर से तय किया गया ब्रॉडकास्ट मौजूद नहीं है.
invalidValue (400) conflictingTimeFields insertionOffsetTimeMs और walltimeMs में से सिर्फ़ एक का इस्तेमाल किया जा सकता है. दोनों वैल्यू सेट करने पर गड़बड़ी होती है. अगर आपने दोनों में से कोई भी वैल्यू सेट नहीं की है, तो YouTube डिफ़ॉल्ट insertionOffsetTimeMs समय (0) का इस्तेमाल करेगा. इसका मतलब है कि क्यूपॉइंट को जल्द से जल्द डाला जाएगा.
invalidValue (400) invalidInsertionOffsetTimeMs cuepoint रिसॉर्स ने insertionOffsetTimeMs प्रॉपर्टी के लिए अमान्य वैल्यू दी है. वैल्यू 0 या कोई पॉज़िटिव इंटिजर होनी चाहिए.
invalidValue (400) invalidWalltimeMs cuepoint रिसॉर्स ने walltimeMs प्रॉपर्टी के लिए अमान्य वैल्यू दी है. वैल्यू कोई पूर्णांक होनी चाहिए, जो किसी युग के टाइमस्टैंप को दिखाती हो (मिलीसेकंड में).
backendError (5xx) serviceUnavailable यह सेवा उपलब्ध नहीं है. कुछ मिनट बाद, फिर से अनुरोध करें.

इसे आज़माएं!

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