Roku के लिए IMA डीएआई SDK टूल

1. 1. ima
   2. ima.AdBreakInfo
   3. ima.AdEvent
   4. ima.AdInfo
   5. ima.Companion
   6. ima.CuePoint
   7. ima.Error
   8. ima.ErrorEvent
   9. ima.Player
   10. ima.StreamFormat
   11. ima.StreamInfo
   12. ima.StreamManager
   13. ima.StreamRequest
   14. ima.StreamType
   15. ima.WrapperInfo

Class ima

तरीके

disableLogging, getStreamManager, initSdk, requestStream

ये ग्लोबल फ़ंक्शन, IMA SDK को कंट्रोल करते हैं.

disableLogging()

यह SDK लॉगिंग को बंद करता है. लॉगिंग की सुविधा डिफ़ॉल्ट रूप से चालू रहेगी.

getStreamManager()

अगर स्ट्रीम मैनेजर उपलब्ध है, तो उसे दिखाता है. अगर स्ट्रीम मैनेजर अभी तक उपलब्ध नहीं है, तो Invalid वैल्यू दिखेगी. अगर स्ट्रीम मैनेजर बनाते समय कोई गड़बड़ी हुई है, तो एक गड़बड़ी वाला ऑब्जेक्ट दिखता है.

वापस लाता है object: स्ट्रीम मैनेजर या गड़बड़ी वाला ऑब्जेक्ट.

initSdk(settings)

यह एसडीके को शुरू करता है.

पैरामीटर	टाइप	ब्यौरा
settings	object	IMA सेटिंग का वैकल्पिक ऑब्जेक्ट.

requestStream(streamRequest)

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

वैल्यू दिखाता है object: कोई गड़बड़ी या अमान्य वैल्यू, अगर कोई गड़बड़ी नहीं है

पैरामीटर	टाइप	ब्यौरा
streamRequest	object

वापस सबसे ऊपर जाएं

Class ima.AdBreakInfo

फ़ील्ड

adPosition, duration, podIndex, timeOffset, totalAds

तरीके

createAdBreakInfo

इस कुकी में विज्ञापन ब्रेक के बारे में जानकारी होती है. इसे SDK टूल, इवेंट कॉलबैक को पास करता है.

प्रॉपर्टी

नाम	टाइप	ब्यौरा
adPosition		विज्ञापन ब्रेक में विज्ञापन का इंडेक्स. स्टैंडअलोन विज्ञापनों के लिए इंडेक्स 1 है.
duration		सेकंड में ब्रेक की ज़्यादा से ज़्यादा अवधि या अगर इसकी जानकारी नहीं है, तो -1.
podIndex		लाइव स्ट्रीम के लिए, पॉड इंडेक्स के तौर पर ब्रेक आईडी दिखाता है. इसके अलावा, प्रीरोल के लिए 0 दिखाता है. लाइव स्ट्रीम में पोस्टरोल नहीं होते. डिफ़ॉल्ट रूप से, यह -2 पर सेट होता है. मांग पर देखे जाने वाले वीडियो (वीओडी) के लिए, विज्ञापन पॉड का इंडेक्स दिखाता है. प्रीरोल पॉड के लिए, 0 दिखाता है. वीडियो के बीच में दिखने वाले ऐड के लिए, रिटर्न 1, 2, ..., n. पोस्टरोल पॉड के लिए, यह n+1...n+x दिखाता है. अगर यह विज्ञापन किसी पॉड का हिस्सा नहीं है या यह पॉड किसी प्लेलिस्ट का हिस्सा नहीं है, तो डिफ़ॉल्ट रूप से 0 पर सेट होता है.
timeOffset		कॉन्टेंट में पॉड की जगह, सेकंड में. प्री-रोल विज्ञापन के लिए 0, पोस्ट-रोल विज्ञापन के लिए -1, और मिड-रोल विज्ञापन के लिए पॉड का शेड्यूल किया गया समय दिखता है.
totalAds		इस विज्ञापन ब्रेक में मौजूद विज्ञापनों की कुल संख्या. स्टैंड अलोन विज्ञापनों के लिए वैल्यू 1 है.

createAdBreakInfo()

लौटाए जाने वाले प्रॉडक्ट ima.AdBreakInfo:

वापस सबसे ऊपर जाएं

Class ima.AdEvent

फ़ील्ड

AD_PERIOD_ENDED, AD_PERIOD_STARTED, COMPLETE, ERROR, FIRST_QUARTILE, ICON_FALLBACK_IMAGE_CLOSED, ICON_FALLBACK_IMAGE_SHOWN, MIDPOINT, PROGRESS, SKIPPABLE_STATE_CHANGED, SKIPPED, START, THIRD_QUARTILE

विज्ञापन मैनेजर की ओर से ट्रिगर किए गए इवेंट.

प्रॉपर्टी

नाम	टाइप	ब्यौरा
AD_PERIOD_ENDED		यह इवेंट हर बार तब ट्रिगर होता है, जब स्ट्रीम विज्ञापन या स्लेट से कॉन्टेंट पर स्विच करती है. यह इवेंट तब भी ट्रिगर होगा, जब किसी विज्ञापन को दूसरी बार चलाया जाएगा या जब विज्ञापन में आगे-पीछे किया जाएगा.
AD_PERIOD_STARTED		यह इवेंट तब ट्रिगर होता है, जब स्ट्रीम कॉन्टेंट से विज्ञापन या स्लेट पर स्विच करती है. यह इवेंट तब भी ट्रिगर होगा, जब किसी विज्ञापन को दूसरी बार चलाया जाएगा या जब विज्ञापन में आगे-पीछे किया जाएगा.
COMPLETE		विज्ञापन पूरा चलने के बाद सक्रिय होता है.
ERROR		यह इवेंट तब ट्रिगर होता है, जब कोई गड़बड़ी होती है.
FIRST_QUARTILE		यह इवेंट तब ट्रिगर होता है, जब विज्ञापन का प्लेहेड पहले क्वार्टाइल को पार कर जाता है.
ICON_FALLBACK_IMAGE_CLOSED		यह इवेंट तब ट्रिगर होता है, जब उपयोगकर्ता आइकॉन फ़ॉलबैक इमेज का डायलॉग बॉक्स बंद करता है.
ICON_FALLBACK_IMAGE_SHOWN		यह इवेंट तब ट्रिगर होता है, जब आइकॉन की फ़ॉलबैक इमेज दिखती है.
MIDPOINT		विज्ञापन का प्लेहेड बीच में पहुंचने पर सक्रिय होता है.
PROGRESS		विज्ञापन की प्रोग्रेस में कोई अपडेट होने पर सक्रिय होता है.
SKIPPABLE_STATE_CHANGED		यह इवेंट तब ट्रिगर होता है, जब विज्ञापन को स्किप करने की स्थिति बदलती है.
SKIPPED		जब कोई विज्ञापन स्किप किया जाता है, तब यह इवेंट ट्रिगर होता है.
START		विज्ञापन के चालू होने पर सक्रिय होता है.
THIRD_QUARTILE		विज्ञापन का प्लेहेड तीसरे क्वार्टाइल को पार करने पर ट्रिगर होता है.

वापस सबसे ऊपर जाएं

Class ima.AdInfo

फ़ील्ड

adBreakInfo, adDescription, adId, adSystem, adTitle, advertiserName, companions, creativeAdId, creativeId, currentTime, dealId, duration, skipOffset, universalAdIDRegistry, universalAdIDValue, wrappers

तरीके

createAdInfo

इस कुकी में विज्ञापन के बारे में जानकारी होती है. इसे SDK टूल, इवेंट कॉलबैक को पास करता है.

प्रॉपर्टी

नाम	टाइप	ब्यौरा
adBreakInfo		इस विज्ञापन को जिस पूरे ब्रेक में दिखाया जा रहा है उससे जुड़ी जानकारी.
adDescription		विज्ञापन का ब्यौरा.
adId		विज्ञापन का आईडी या अगर आईडी मौजूद नहीं है, तो खाली स्ट्रिंग.
adSystem		विज्ञापन सिस्टम, क्रिएटिव उपलब्ध करा रहा है.
adTitle		विज्ञापन का टाइटल.
advertiserName		विज्ञापन देने वाले व्यक्ति या कंपनी का नाम, विज्ञापन दिखाने वाली पार्टी के हिसाब से तय किया जाता है.
companions		वीएएसटी रिस्पॉन्स में बताए गए कंपैनियन विज्ञापन.
creativeAdId		किसी विज्ञापन के लिए आईएसआई (इंडस्ट्री स्टैंडर्ड कमर्शियल आइडेंटिफ़ायर) कोड. यह VAST रिस्पॉन्स में चुने गए क्रिएटिव का विज्ञापन आईडी है.
creativeId		विज्ञापन के लिए चुने गए क्रिएटिव का आईडी.
currentTime		विज्ञापन में मौजूद मौजूदा समय, सेकंड में या -1, अगर इसकी जानकारी नहीं है.
dealId		यह फ़ंक्शन, मौजूदा विज्ञापन के लिए रैपर चेन में मौजूद पहले डील आईडी को दिखाता है. यह आईडी, सबसे ऊपर से शुरू होता है.
duration		इस विज्ञापन की अवधि सेकंड में या -1, अगर इसकी जानकारी नहीं है.
skipOffset		विज्ञापन को स्किप किए जा सकने लायक बनने में लगने वाला समय. अगर यह जानकारी उपलब्ध नहीं है, तो वैल्यू -1 होगी.
universalAdIDRegistry		यह एक स्ट्रिंग है. इसका इस्तेमाल, रजिस्ट्री वेबसाइट के उस यूआरएल की पहचान करने के लिए किया जाता है जहां चुने गए क्रिएटिव का यूनिवर्सल विज्ञापन आईडी कैटलॉग किया गया है.
universalAdIDValue		विज्ञापन के लिए चुने गए क्रिएटिव का यूनिवर्सल विज्ञापन आईडी.
wrappers		इस विज्ञापन के लिए रैपर की जानकारी देने वाली ima.WrapperInfo का कलेक्शन. आइटम को आउटर रैपर से इनर रैपर तक के क्रम में रखा जाएगा.

createAdInfo()

लौटाए जाने वाले प्रॉडक्ट ima.AdInfo:

वापस सबसे ऊपर जाएं

Class ima.Companion

फ़ील्ड

adSlotId, apiFramework, companionClickThrough, creativeType, height, trackingEvents, url, width

तरीके

createCompanion

इस कुकी में, विज्ञापन के साथियों के बारे में जानकारी होती है.

प्रॉपर्टी

नाम	टाइप	ब्यौरा
adSlotId		कंपैनियन विज्ञापन के विज्ञापन स्लॉट का आईडी. उपलब्ध न होने पर खाली छोड़ दें.
apiFramework		इस विज्ञापन को दिखाने के लिए ज़रूरी एपीआई या अगर उपलब्ध नहीं है, तो अमान्य.
companionClickThrough		कंपैनियन बैनर का क्लिक-थ्रू यूआरएल.
creativeType		यह क्रिएटिव टाइप को दिखाता है. आम तौर पर, यह माइम टाइप होता है.
height		पिक्सल में कंपैनियन की ऊंचाई. अगर उपलब्ध नहीं है, तो 0.
trackingEvents		ट्रैकिंग इवेंट का मैप. इसमें कुंजी, इवेंट होती है और वैल्यू, उन यूआरएल की सूची होती है जिन पर उस इवेंट के होने पर पिंग किया जाता है.
url		इस कंपैनियन के स्टैटिक संसाधन का यूआरएल.
width		कंपैनियन की चौड़ाई, पिक्सल में. अगर उपलब्ध नहीं है, तो 0.

createCompanion()

लौटाए जाने वाले प्रॉडक्ट ima.Companion:

वापस सबसे ऊपर जाएं

Class ima.CuePoint

फ़ील्ड

end, hasPlayed, start

तरीके

createCuePoint

इस कुकी में किसी क्यू पॉइंट के बारे में जानकारी होती है.

प्रॉपर्टी

नाम	टाइप	ब्यौरा
end		सेकंड में, किसी क्यूपॉइंट के खत्म होने का समय. यह विज्ञापन ब्रेक से जुड़ा है.
hasPlayed		बूलियन से पता चलता है कि क्यूपॉइंट पहले ही चल चुका है.
start		यह किसी क्यूपॉइंट के शुरू होने का समय है. यह समय सेकंड में होता है. यह विज्ञापन ब्रेक से जुड़ा है.

createCuePoint()

लौटाए जाने वाले प्रॉडक्ट ima.CuePoint:

वापस सबसे ऊपर जाएं

Class ima.Error

फ़ील्ड

id, info, type

तरीके

createError

अगर कोई गड़बड़ी होती है, तो ऑब्जेक्ट को गड़बड़ी हैंडलर को पास किया जाता है.

प्रॉपर्टी

नाम	टाइप	ब्यौरा
id		गड़बड़ी का आईडी. गड़बड़ी के कोड की सूची के लिए, ErrorEvent कॉन्स्टेंट देखें.
info		गड़बड़ी के बारे में अतिरिक्त जानकारी.
type		इस ऑब्जेक्ट के टाइप के बारे में बताने के लिए, इसे हमेशा गड़बड़ी के तौर पर सेट करें.

createError()

लौटाए जाने वाले प्रॉडक्ट ima.Error:

वापस सबसे ऊपर जाएं

Class ima.ErrorEvent

फ़ील्ड

BAD_STREAM_REQUEST, COULD_NOT_LOAD_STREAM, ERROR, INVALID_RESPONSE, STREAM_API_KEY_NOT_VALID

एसडीके से वापस भेजी जा सकने वाली सभी गड़बड़ियां.

प्रॉपर्टी

नाम	टाइप	ब्यौरा
BAD_STREAM_REQUEST		स्ट्रीम के अनुरोध में सही जानकारी नहीं दी गई थी.
COULD_NOT_LOAD_STREAM		स्ट्रीम लोड नहीं की जा सकी.
ERROR		कोई गड़बड़ी हुई.
INVALID_RESPONSE		सर्वर से मिला जवाब मान्य नहीं था.
STREAM_API_KEY_NOT_VALID		सर्वर ने दी गई एपीआई कुंजी को स्वीकार नहीं किया.

वापस सबसे ऊपर जाएं

Class ima.Player

तरीके

adBreakEnded, adBreakStarted, allVideoComplete, createPlayer, loadUrl, streamInitialized

adBreakEnded(adBreakInfo)

ज़रूरी नहीं. यह तब कॉल किया जाता है, जब विज्ञापन ब्रेक खत्म हो जाता है.

पैरामीटर	टाइप	ब्यौरा
adBreakInfo	ima.AdBreakInfo	इस कुकी में विज्ञापन ब्रेक के बारे में जानकारी होती है.

adBreakStarted(adBreakInfo)

ज़रूरी नहीं. यह तब कॉल किया जाता है, जब विज्ञापन ब्रेक शुरू हो जाता है.

पैरामीटर	टाइप	ब्यौरा
adBreakInfo	ima.AdBreakInfo	इस कुकी में विज्ञापन ब्रेक के बारे में जानकारी होती है.

allVideoComplete()

ज़रूरी नहीं. जब पूरा वीडियो चल जाता है, तब इस इवेंट को कॉल किया जाता है.

createPlayer()

यह एक खाली IMA Player ऑब्जेक्ट बनाता है. विज्ञापन चलाने के लिए, आपको loadUrl फ़ंक्शन लागू करना होगा. अन्य फ़ंक्शन ज़रूरी नहीं हैं.

वापसी ima.Player:

loadUrl(streamInfo)

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

पैरामीटर	टाइप	ब्यौरा
streamInfo	ima.StreamInfo	इसमें कॉन्टेंट चलाने के लिए ज़रूरी जानकारी होती है.

streamInitialized(streamInfo)

यह तब कॉल किया जाता है, जब स्ट्रीम शुरू हो जाती है.

पैरामीटर	टाइप	ब्यौरा
streamInfo	ima.StreamInfo	इसमें कॉन्टेंट चलाने के लिए ज़रूरी जानकारी होती है.

वापस सबसे ऊपर जाएं

Class ima.StreamFormat

फ़ील्ड

DASH, HLS

इससे स्ट्रीम का फ़ॉर्मैट तय होता है.

प्रॉपर्टी

नाम	टाइप	ब्यौरा
DASH
HLS

वापस सबसे ऊपर जाएं

Class ima.StreamInfo

फ़ील्ड

format, manifest, streamId, streamType, subtitles

तरीके

createStreamInfo

एसडीके से प्लेयर को स्ट्रीम के बारे में भेजी गई जानकारी.

प्रॉपर्टी

नाम	टाइप	ब्यौरा
format		वीडियो का फ़ॉर्मैट: hls या dash. इसे ima.StreamFormat में तय किया गया है.
manifest		स्ट्रीम का यूआरएल.
streamId		स्ट्रीम का यूनीक आईडी.
streamType		वीडियो का टाइप: लाइव या मांग पर देखा जाने वाला वीडियो. इसे ima.StreamType में तय किया गया है.
subtitles		अगर सबटाइटल उपलब्ध हैं, तो उन्हें भी शामिल करें. अगर ऐसा नहीं है, तो अमान्य है.

createStreamInfo()

लौटाए जाने वाले प्रॉडक्ट ima.StreamInfo:

वापस सबसे ऊपर जाएं

Class ima.StreamManager

तरीके

addEventListener, createStreamManager, enableInteractiveAds, getContentTime, getCuePoints, getPreviousCuePoint, getStreamTime, loadThirdPartyStream, onMessage, replaceAdTagParameters, start

स्ट्रीम के प्लेबैक को मैनेज करने के लिए ऑब्जेक्ट.

addEventListener(event, callback)

यह फ़ंक्शन, बताए गए इवेंट के लिए लिसनर जोड़ता है. साथ काम करने वाले इवेंट के लिए, AdEvents कॉन्स्टेंट देखें.

पैरामीटर	टाइप	ब्यौरा
event	string
callback	function

createStreamManager(streamRequest, streamInitResponse)

लौटाए जाने वाले प्रॉडक्ट ima.StreamManager:

पैरामीटर	टाइप	ब्यौरा
streamRequest	ima.StreamRequest
streamInitResponse	ima.StreamInitResponse

enableInteractiveAds()

यह सुविधा काम नहीं करती. इसके बजाय, कंपैनियन विज्ञापन से डेटा को सीधे तौर पर आरएएफ़ को पास करें. अब यह सुविधा काम नहीं करती.

getContentTime(streamTime)

यह फ़ंक्शन, वीओडी स्ट्रीम के लिए मिलीसेकंड में समय पाता है. यह समय, कॉन्टेंट में बिना विज्ञापनों के समय को दिखाता है. ज़्यादा जानकारी के लिए, अक्सर पूछे जाने वाले सवाल देखें. -1 में मौजूदा स्ट्रीम के टाइम पास के लिए कॉन्टेंट का समय पाने के लिए.

वापसी Integer: स्ट्रीम के दिए गए समय के हिसाब से कॉन्टेंट का समय.

पैरामीटर	टाइप	ब्यौरा
streamTime	Integer	स्ट्रीम में मौजूद समय.

getCuePoints()

यह विज्ञापन के लिए सभी ब्रेक से जुड़े सभी क्यू पॉइंट दिखाता है. यह सुविधा सिर्फ़ मांग पर उपलब्ध वीडियो कॉन्टेंट के लिए मान्य है. इसमें विज्ञापन के लिए ब्रेक की सभी जानकारी पहले से उपलब्ध होती है. सभी समय, स्ट्रीम के समय को सेकंड में दिखाते हैं. Cloud Stitching API स्ट्रीम के लिए, हर ima.CuePoint की hasPlayed प्रॉपर्टी हमेशा false होती है.

वापस लाता है Object: सभी क्यू पॉइंट वाला एक ऐरे.

getPreviousCuePoint(time)

इस समय से पहले के क्यू पॉइंट की जानकारी देता है. इस क्यू पॉइंट से पता चलता है कि विज्ञापन ब्रेक है. सभी समय, स्ट्रीम के समय को सेकंड में दिखाते हैं.

Returns ima.CuePoint: यह एक ऐसा ऑब्जेक्ट है जिसमें start, end, और hasPlayed शामिल हैं. अगर कोई क्यू पॉइंट उपलब्ध नहीं है, तो अमान्य वैल्यू दिखाता है.

पैरामीटर	टाइप	ब्यौरा
time	Float	समय देखने के लिए, -1 मौजूदा समय दिखाता है. साथ ही, अन्य सभी स्ट्रीम के लिए Invalid दिखाता है.

getStreamTime(contentTime)

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

लौटाए गए सामान की कुल कीमत Integer: यह स्ट्रीम करने का वह समय है जब सामान लौटाया गया था.

पैरामीटर	टाइप	ब्यौरा
contentTime	Integer	कॉन्टेंट का समय.

loadThirdPartyStream(streamManifest, streamSubtitle)

यह विज्ञापन का मेटाडेटा लोड करता है और दिए गए streamManifestUrl और streamSubtitle डेटा के साथ loadUrl फ़ंक्शन को कॉल करता है. यह फ़ंक्शन सिर्फ़ तब काम करता है, जब स्ट्रीम के अनुरोध का टाइप ima.StreamType.POD_VOD हो.

पैरामीटर	टाइप	ब्यौरा
streamManifest	string	विज्ञापन स्टिच किए गए स्ट्रीम मेनिफ़ेस्ट का यूआरएल.
streamSubtitle	ifArray>|Invalid	स्ट्रीम से जुड़े सबटाइटल या Invalid अगर कोई नहीं है.

onMessage(msg)

यह Video ऑब्जेक्ट से आने वाले सभी मैसेज को मैनेज करता है. roMessagePort पर मिले हर मैसेज के लिए, इसे कॉल किया जाना चाहिए.

पैरामीटर	टाइप	ब्यौरा
msg	object	roVideo पोर्ट से मिला मैसेज.

replaceAdTagParameters(adTagParameters)

यह पैरामीटर, लाइव स्ट्रीम के लिए विज्ञापन के आने वाले अनुरोधों के लिए इस्तेमाल किए जाने वाले सभी विज्ञापन टैग पैरामीटर को बदल देता है. ध्यान दें कि यह कॉल, वीओडी स्ट्रीम के लिए कोई कार्रवाई नहीं करता है.

पैरामीटर	टाइप	ब्यौरा
adTagParameters	string	विज्ञापन टैग के नए पैरामीटर.

start()

इससे स्ट्रीम चलना शुरू हो जाती है.

वापस सबसे ऊपर जाएं

Class ima.StreamRequest

फ़ील्ड

adTagParameters, adUiNode, apiKey, assetKey, authToken, contentSourceId, customAssetKey, format, networkCode, player, ppid, streamActivityMonitorId, videoId, videoObject, videoStitcherSessionOptions

तरीके

createLiveStreamRequest, createPodLiveStreamRequest, createPodVodStreamRequest, createStreamRequest, createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest, createVideoStitcherVodStreamRequestWithVodConfig, createVodStreamRequest

इस कुकी का इस्तेमाल, स्ट्रीम के अनुरोध की प्रॉपर्टी तय करने के लिए किया जाता है.

प्रॉपर्टी

नाम	टाइप	ब्यौरा
adTagParameters		ज़रूरी नहीं. आपके पास स्ट्रीम के अनुरोध पर, विज्ञापन टैग पैरामीटर के सीमित सेट को बदलने का विकल्प होता है. अपनी स्ट्रीम में टारगेटिंग पैरामीटर जोड़ना लेख में ज़्यादा जानकारी दी गई है. स्ट्रीम के वैरिएंट को प्राथमिकता देने के लिए, dai-ot और dai-ov पैरामीटर का इस्तेमाल भी किया जा सकता है. ज़्यादा जानकारी के लिए, स्ट्रीम के वैरिएंट पैरामीटर बदलना लेख पढ़ें.
adUiNode		यह सीन ग्राफ़ नोड है, जहां विज्ञापन का यूज़र इंटरफ़ेस (यूआई) दिखता है. विज्ञापन दिखाने के दौरान, IMA इस एलिमेंट पर यह विज्ञापन क्यों दिखाया जा रहा है और स्किप करें बटन जैसे एलिमेंट जोड़ता है. यह एलिमेंट, पूरे वीडियो एलिमेंट पर ओवरले होना चाहिए.
apiKey		ज़रूरी नहीं. इन कुंजियों का इस्तेमाल, स्ट्रीम के अनुरोधों की पुष्टि करने के लिए किया जा सकता है. DAI ऑथेंटिकेशन कुंजियां, DFP यूज़र इंटरफ़ेस (यूआई) में सेट अप की जानी चाहिए.
assetKey		लाइव स्ट्रीम के लिए ज़रूरी है. इस कुकी का इस्तेमाल यह तय करने के लिए किया जाता है कि कौनसी स्ट्रीम चलाई जानी चाहिए. लाइव स्ट्रीम के अनुरोध की ऐसेट कुंजी एक आइडेंटिफ़ायर है. इसे DFP के यूज़र इंटरफ़ेस (यूआई) में देखा जा सकता है.
authToken		यह स्ट्रीम के अनुरोध के लिए अनुमति देने वाला टोकन है. इसका इस्तेमाल, एपीआई पासकोड की जगह किया जाता है, ताकि कॉन्टेंट के इस्तेमाल की अनुमति देने की प्रक्रिया को ज़्यादा सुरक्षित बनाया जा सके. पब्लिशर, इस टोकन के आधार पर अलग-अलग कॉन्टेंट स्ट्रीम के लिए अनुमतियों को कंट्रोल कर सकता है.
contentSourceId		मांग पर उपलब्ध स्ट्रीम के लिए ज़रूरी है. cmsid, DFP यूज़र इंटरफ़ेस (यूआई) में मौजूद DFP वीडियो कॉन्टेंट सोर्स से मिलता है.
customAssetKey		कस्टम ऐसेट कुंजी का इस्तेमाल यह तय करने के लिए किया जाता है कि कौनसा स्ट्रीम चलाया जाना चाहिए. पॉड के ज़रिए स्ट्रीम करने के अनुरोधों के लिए, कस्टम ऐसेट कुंजियां ज़रूरी होती हैं.
format		स्ट्रीम का फ़ॉर्मैट. यह डिफ़ॉल्ट रूप से ima.StreamFormat.HLS पर सेट होता है.
networkCode		स्ट्रीम का अनुरोध करने वाले पब्लिशर का नेटवर्क कोड. createPodLiveStreamRequest या createPodVodStreamRequest का इस्तेमाल करके, पॉड दिखाने के लिए किए गए स्ट्रीम अनुरोधों के लिए नेटवर्क कोड ज़रूरी होते हैं. createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest या createVideoStitcherVodStreamRequestWithVodConfig का इस्तेमाल करके किए गए क्लाउड स्टिचिंग स्ट्रीम के अनुरोधों के लिए भी इन कोड की ज़रूरत होती है. ये कोड वैकल्पिक हैं. हालांकि, createLiveStreamRequest या createVodStreamRequest के ज़रिए किए गए फ़ुल सर्विस स्ट्रीम के अनुरोधों के लिए, इनका इस्तेमाल करने का सुझाव दिया जाता है. नेटवर्क कोड जोड़ने से, Ad Manager के यूज़र इंटरफ़ेस (यूआई) में चुनी गई सेटिंग लागू होती हैं. जैसे, प्रोग्राम के हिसाब से विज्ञापनों को सीमित तौर पर दिखाने की सुविधा चालू करना. पॉड सर्विंग और क्लाउड स्टिचिंग के लिए, नेटवर्क कोड जोड़ने से स्ट्रीम का पता चलता है और उसे चलाया जाता है. नेटवर्क कोड ढूंढने के लिए, यह लेख पढ़ें.
player		प्लेयर इंटरफ़ेस का एक वर्शन.
ppid		समर्थन नहीं होना या रुकना. adTagParameters का इस्तेमाल करें. ज़रूरी नहीं. DFP ऑडियंस पब्लिशर का भेजा गया आईडी.
streamActivityMonitorId		इस आईडी का इस्तेमाल, स्ट्रीम ऐक्टिविटी मॉनिटर की मदद से स्ट्रीम को डीबग करने के लिए किया जाता है. इसका इस्तेमाल, पब्लिशर को स्ट्रीम ऐक्टिविटी मॉनिटर टूल में स्ट्रीम लॉग ढूंढने का आसान तरीका उपलब्ध कराने के लिए किया जाता है.
videoId		मांग पर उपलब्ध स्ट्रीम के लिए ज़रूरी है. वीडियो कॉन्टेंट के सोर्स के लिए आइडेंटिफ़ायर.
videoObject		यह वीडियो ऑब्जेक्ट (जैसे, Video roSGNode) है, जो क्लाइंट ऐप्लिकेशन पर वीडियो चलाने के लिए ज़िम्मेदार होता है. इस ऑब्जेक्ट को अलग-अलग डेटा के लिए पोल किया जाएगा, ताकि Live HLS ID3 इवेंट को सही समय पर इस्तेमाल किया जा सके.
videoStitcherSessionOptions		सेशन के विकल्पों का इस्तेमाल, VideoStitcher streamRequests के लिए VideoStitcher से जुड़े खास पैरामीटर सेट करने के लिए किया जाता है.

createLiveStreamRequest(assetKey, apiKey, networkCode)

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

लौटाए गए सामान की कुल कीमत ima.StreamRequest: ima.StreamRequest ऑब्जेक्ट, जिसमें लाइव प्रॉपर्टी की ज़रूरी वैल्यू मौजूद हों.

पैरामीटर	टाइप	ब्यौरा
assetKey	string
apiKey	string	यह पैरामीटर, दिखाई गई ima.StreamRequest की ima.StreamRequest.apiKey प्रॉपर्टी को असाइन किया जाता है. अगर कोई एपीआई पासकोड मौजूद नहीं है, तो एक खाली स्ट्रिंग पास करें.
networkCode	string	स्ट्रीम का अनुरोध करने वाले पब्लिशर के लिए नेटवर्क कोड. नेटवर्क कोड शामिल करना ज़रूरी नहीं है, लेकिन हमारा सुझाव है कि आप ऐसा करें.

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

यह Pod Live ima.StreamRequest की ज़रूरी प्रॉपर्टी को शुरू करता है. इस एपीआई का इस्तेमाल करने पर, ima.StreamType से जुड़ी अन्य प्रॉपर्टी को अनदेखा कर दिया जाता है. अगर ज़रूरी पैरामीटर में कोई वैल्यू नहीं दी गई है, तो गड़बड़ी की जानकारी लॉग की जाती है. साथ ही, एपीआई सामान्य StreamRequest दिखाता है. इसमें किसी भी प्रॉपर्टी को अनदेखा नहीं किया जाता.

यह StreamRequest दिखाता है: ज़रूरी PodLive प्रॉपर्टी वाला ima.StreamRequest ऑब्जेक्ट.

पैरामीटर	टाइप	ब्यौरा
customAssetKey	string
networkCode	string
apiKey	string	यह एक वैकल्पिक पैरामीटर है, जिसे ima.StreamRequest की ima.StreamRequest.apiKey प्रॉपर्टी को असाइन किया जाता है. डिफ़ॉल्ट रूप से, इसकी वैल्यू खाली स्ट्रिंग होती है.

createPodVodStreamRequest(networkCode)

यह कुकी, ima.StreamRequest की ज़रूरी प्रॉपर्टी को शुरू करती है. ऐसा तब किया जाता है, जब तीसरे पक्ष के वीडियो स्टिचिंग सॉफ़्टवेयर के साथ डीएआई पॉड सर्विंग का इस्तेमाल करके, वीओडी स्ट्रीम रजिस्टर की जाती है. यह फ़ंक्शन, अनुरोध के टाइप को ima.StreamType.POD_VOD पर सेट करता है. साथ ही, यह उन सभी ज़रूरी प्रॉपर्टी की पुष्टि करता है जिनमें डेटा मौजूद नहीं है. पुष्टि नहीं होने पर, डीबग कंसोल में गड़बड़ी लॉग की जाएगी.

वैल्यू दिखाता है StreamRequest: एक ima.StreamRequest ऑब्जेक्ट. अगर सभी ज़रूरी प्रॉपर्टी दी गई हैं, तो अनुरोध का टाइप ima.StreamType.POD_VOD पर सेट हो जाता है.

पैरामीटर	टाइप	ब्यौरा
networkCode	string	Google Ad Manager नेटवर्क कोड

createStreamRequest()

ima.StreamRequest दिखाता है: एक खाली ima.StreamRequest ऑब्जेक्ट.

createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken)

यह Video Stitcher Live StreamRequest की ज़रूरी प्रॉपर्टी को शुरू करता है. इस एपीआई का इस्तेमाल करने पर, StreamType से जुड़ी किसी भी अन्य प्रॉपर्टी को अनदेखा कर दिया जाता है. अगर ज़रूरी पैरामीटर में कोई वैल्यू नहीं दी गई है, तो गड़बड़ी की जानकारी लॉग की जाती है. साथ ही, एपीआई सामान्य StreamRequest दिखाता है. इसमें किसी भी प्रॉपर्टी को अनदेखा नहीं किया जाता.

रिटर्न ima.StreamRequest: ima.StreamRequest object with required VideoStitcherLive properties.

पैरामीटर	टाइप	ब्यौरा
customAssetKey	string
networkCode	string
liveConfigId	string
region	string
projectNumber	string
oAuthToken	string

createVideoStitcherVodStreamRequest(adTagUrl, networkCode, contentSourceUrl, region, projectNumber, oAuthToken)

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

रिटर्न ima.StreamRequest: ima.StreamRequest ऑब्जेक्ट, जिसमें VideoStitcherVod की ज़रूरी प्रॉपर्टी होती हैं.

पैरामीटर	टाइप	ब्यौरा
adTagUrl	string
networkCode	string
contentSourceUrl	string
region	string
projectNumber	string
oAuthToken	string

createVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken)

यह फ़ंक्शन, क्लाउड वीडियो स्टिचिंग की सुविधा का इस्तेमाल करके बनाए गए vodConfigId का इस्तेमाल करके, वीडियो स्टिचिंग की सुविधा वाले वीओडी StreamRequest की ज़रूरी प्रॉपर्टी को शुरू करता है. इस एपीआई का इस्तेमाल करने पर, StreamType से जुड़ी अन्य प्रॉपर्टी को अनदेखा कर दिया जाता है. अगर ज़रूरी पैरामीटर में कोई वैल्यू नहीं दी गई है, तो गड़बड़ी की जानकारी लॉग की जाती है. साथ ही, एपीआई सामान्य StreamRequest दिखाता है. इसमें किसी भी प्रॉपर्टी को अनदेखा नहीं किया जाता.

रिटर्न ima.StreamRequest: ima.StreamRequest ऑब्जेक्ट, जिसमें VideoStitcherVod की ज़रूरी प्रॉपर्टी होती हैं.

पैरामीटर	टाइप	ब्यौरा
vodConfigId	string
networkCode	string
region	string
projectNumber	string
oAuthToken	string

createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode)

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

Returns ima.StreamRequest: ima.StreamRequest ऑब्जेक्ट, जिसमें वीओडी की ज़रूरी प्रॉपर्टी होती हैं.

पैरामीटर	टाइप	ब्यौरा
contentSourceId	string
videoId	string
apiKey	string	यह पैरामीटर, दिखाई गई ima.StreamRequest की ima.StreamRequest.apiKey प्रॉपर्टी को असाइन किया जाता है. अगर कोई एपीआई पासकोड मौजूद नहीं है, तो एक खाली स्ट्रिंग पास करें.
networkCode	string	स्ट्रीम का अनुरोध करने वाले पब्लिशर के लिए नेटवर्क कोड. नेटवर्क कोड शामिल करना ज़रूरी नहीं है, लेकिन हमारा सुझाव है कि आप ऐसा करें.

वापस सबसे ऊपर जाएं

Class ima.StreamType

फ़ील्ड

LIVE, VOD

इससे उस स्ट्रीम के टाइप के बारे में पता चलता है जिसे प्लेयर को चलाने के लिए कहा गया है. प्रीरोल और वीओडी, स्ट्रीम की शुरुआत से चलने चाहिए.

प्रॉपर्टी

नाम	टाइप	ब्यौरा
LIVE		वीडियो लाइव है.
VOD		वीडियो ऑन डिमांड है.

वापस सबसे ऊपर जाएं

Class ima.WrapperInfo

फ़ील्ड

adId, adSystem, creativeAdId, creativeId, dealId

तरीके

createWrapperInfo

इस कुकी में रैपर के बारे में जानकारी होती है.

प्रॉपर्टी

नाम	टाइप	ब्यौरा
adId		विज्ञापन का आईडी या अगर आईडी मौजूद नहीं है, तो खाली स्ट्रिंग.
adSystem		विज्ञापन सिस्टम का बताया गया नाम या अगर इसकी जानकारी नहीं है, तो खाली स्ट्रिंग.
creativeAdId		क्रिएटिव पर मौजूद विज्ञापन आईडी या अगर इसकी जानकारी नहीं है, तो खाली स्ट्रिंग.
creativeId		क्रिएटिव का आईडी या अगर आईडी की जानकारी नहीं है, तो खाली स्ट्रिंग.
dealId		डील का आईडी या अगर आईडी नहीं पता है, तो खाली स्ट्रिंग.

createWrapperInfo()

लौटाए जाने वाले प्रॉडक्ट ima.WrapperInfo:

वापस सबसे ऊपर जाएं