LiveBroadcasts: cuepoint

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

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

अनुरोध

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

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

अनुमति देना

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

स्कोप
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 पैरामीटर से अलग होती है जो ब्रॉडकास्ट की पहचान करता है. क्यूपॉइंट डालने का अनुरोध भेजते समय, यह वैल्यू छोड़ी जा सकती है. एपीआई के रिस्पॉन्स में यह वैल्यू अपने-आप भर जाएगी.
insertionOffsetTimeMs	long क्यूपॉइंट डालने के बाद, प्रॉपर्टी वैल्यू में मिलीसेकंड में टाइम ऑफ़सेट की पहचान की जाती है. वैल्यू को मॉनिटर स्ट्रीम की शुरुआत से मेज़र किया जाता है और इसकी डिफ़ॉल्ट वैल्यू 0 है. इससे पता चलता है कि क्यू पॉइंट जल्द से जल्द डाला जाना चाहिए. अगर आपके ब्रॉडकास्ट में मॉनिटर स्ट्रीम नहीं है, तो आपको इस पैरामीटर के लिए कोई वैल्यू तय नहीं करनी चाहिए. यह वैल्यू मिलीसेकंड में मापी जाती है, लेकिन वैल्यू असल में एक अनुमान होती है. YouTube उस समय के लिए, क्यूपॉइंट को ज़्यादा से ज़्यादा बारीकी से शामिल करता है. इस फ़ील्ड के लिए शून्य के अलावा, किसी और वैल्यू का इस्तेमाल सिर्फ़ तब किया जा सकता है, जब ब्रॉडकास्ट स्ट्रीम देर से हो. अगर आपकी ब्रॉडकास्ट स्ट्रीम में देरी नहीं होती है, तो 0 ही मान्य वैल्यू है. ज़्यादा जानकारी के लिए, इस्तेमाल शुरू करना गाइड देखें. ध्यान दें: अगर आपके ब्रॉडकास्ट में जांच का फ़ेज़ था, तो ऑफ़सेट को टेस्टिंग के शुरू होने के समय से मेज़र किया जाता है. अगर अनुरोध में इस प्रॉपर्टी और walltimeMs प्रॉपर्टी के लिए वैल्यू की जानकारी देने वाले क्यू पॉइंट डालने की कोशिश की जाती है, तो एपीआई गड़बड़ी वाला मैसेज दिखाता है.
walltimeMs	integer प्रॉपर्टी की वैल्यू, दीवार के उस समय के बारे में बताती है जब क्यूपॉइंट डालना है. वैल्यू एक पूर्णांक है, जो epp टाइमस्टैंप (मिलीसेकंड में) के बारे में बताता है. अगर अनुरोध करने पर, इस प्रॉपर्टी और insertionOffsetTimeMs प्रॉपर्टी के लिए वैल्यू की जानकारी देने वाला क्यूपॉइंट डालने की कोशिश की जाती है, तो एपीआई गड़बड़ी वाला मैसेज दिखाता है.
durationSecs	unsigned integer क्यूपॉइंट की अवधि, सेकंड में. मान ऐसी पॉज़िटिव संख्या होनी चाहिए जिसमें दशमलव न हों. डिफ़ॉल्ट वैल्यू 30 है.
cueType	string क्यूपॉइंट का टाइप. प्रॉपर्टी की वैल्यू cueTypeAd पर सेट होनी चाहिए.

जवाब

अगर इस तरीके का इस्तेमाल किया जाता है, तो जवाब के मुख्य हिस्से में cuepoint रिसॉर्स शामिल किया जाता है.

गड़बड़ियां

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

गड़बड़ी का टाइप	गड़बड़ी की जानकारी	जानकारी
insufficientPermissions (403)	insufficientLivePermissions	अनुरोध को लाइव ब्रॉडकास्ट में क्यू पॉइंट डालने की अनुमति नहीं है.
insufficientPermissions (403)	liveStreamingNotEnabled	जिस उपयोगकर्ता ने अनुरोध को अनुमति दी है वह YouTube पर लाइव वीडियो स्ट्रीम नहीं कर सकता. ज़्यादा जानकारी के लिए, https://support.google.com/youtube/answer/2474026 और https://www.youtube.com/features पर जाएं.
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 प्रॉपर्टी के लिए एक अमान्य वैल्यू दी है. वैल्यू, एक पूर्णांक होना चाहिए, जो epoch टाइमस्टैंप (मिलीसेकंड में) के बारे में बताता हो.
backendError (5xx)	serviceUnavailable	सेवा उपलब्ध नहीं है. कुछ देर बाद अनुरोध करें.

इसे आज़माएं!

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