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

क्लास ima

तरीके

disableLogging, getStreamManager, initSdk, requestStream

IMA SDK को कंट्रोल करने वाले ग्लोबल फ़ंक्शन.

disableLogging()

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

getStreamManager()

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

object दिखाता है: स्ट्रीम मैनेजर या गड़बड़ी का ऑब्जेक्ट.

initSdk(settings)

SDK टूल को शुरू करता है.

पैरामीटर	टाइप	ब्यौरा
settings	object	IMA सेटिंग ऑब्जेक्ट, जो ज़रूरी नहीं है.

requestStream(streamRequest)

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

object दिखाता है: गड़बड़ी होने पर गड़बड़ी का मैसेज या गड़बड़ी न होने पर अमान्य

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

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

क्लास 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:

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

क्लास 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 Manager से ट्रिगर होने वाले इवेंट.

प्रॉपर्टी

नाम	टाइप	ब्यौरा
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		विज्ञापन के प्लेलिस्ट में तीसरे क्वार्टाइल तक पहुंचने पर ट्रिगर होता है.

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

क्लास 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		किसी विज्ञापन के लिए ISCI (इंडस्ट्री स्टैंडर्ड कमर्शियल आइडेंटिफ़ायर) कोड. यह VAST रिस्पॉन्स में चुने गए क्रिएटिव का Ad-ID है.
creativeId		विज्ञापन के लिए चुने गए क्रिएटिव का आईडी.
currentTime		विज्ञापन में चलने का मौजूदा समय सेकंड में. अगर यह जानकारी उपलब्ध नहीं है, तो -1 दिखाया जाता है.
dealId		मौजूदा विज्ञापन के लिए, सबसे ऊपर से शुरू होकर रैपर चेन में मौजूद पहला डील आईडी दिखाता है.
duration		इस एक विज्ञापन की अवधि सेकंड में. अगर अवधि की जानकारी नहीं है, तो -1.
skipOffset		विज्ञापन को स्किप किए जाने की सुविधा चालू होने में लगने वाला समय. अगर यह जानकारी उपलब्ध नहीं है, तो -1 डालें.
universalAdIDRegistry		यह एक स्ट्रिंग है, जिसका इस्तेमाल रजिस्ट्री वेबसाइट के यूआरएल की पहचान करने के लिए किया जाता है. इस वेबसाइट पर, चुने गए क्रिएटिव का यूनिवर्सल विज्ञापन आईडी कैटलॉग किया जाता है.
universalAdIDValue		विज्ञापन के लिए चुने गए क्रिएटिव का यूनिवर्सल विज्ञापन आईडी.
wrappers		इस विज्ञापन के लिए, रैपर की जानकारी वाला ima.WrapperInfo कलेक्शन. क्रम, बाहरी रैपर से अंदरूनी रैपर तक होगा.

createAdInfo()

लौटाए गए प्रॉडक्ट ima.AdInfo:

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

क्लास ima.Companion

फ़ील्ड

apiFramework, creativeType, height, trackingEvents, url, width

तरीके

createCompanion

इसमें किसी विज्ञापन के साथ दिखने वाले विज्ञापनों की जानकारी होती है.

प्रॉपर्टी

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

createCompanion()

लौटाए गए प्रॉडक्ट ima.Companion:

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

क्लास ima.CuePoint

फ़ील्ड

end, hasPlayed, start

तरीके

createCuePoint

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

प्रॉपर्टी

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

createCuePoint()

लौटाए गए प्रॉडक्ट ima.CuePoint:

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

क्लास ima.Error

फ़ील्ड

id, info, type

तरीके

createError

गड़बड़ी होने पर, गड़बड़ी को मैनेज करने वाले फ़ंक्शन को पास किया गया ऑब्जेक्ट.

प्रॉपर्टी

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

createError()

लौटाए गए प्रॉडक्ट ima.Error:

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

क्लास ima.ErrorEvent

फ़ील्ड

BAD_STREAM_REQUEST, COULD_NOT_LOAD_STREAM, ERROR, INVALID_RESPONSE, STREAM_API_KEY_NOT_VALID

SDK टूल से मिलने वाली सभी गड़बड़ियां.

प्रॉपर्टी

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

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

क्लास ima.Player

तरीके

adBreakEnded, adBreakStarted, allVideoComplete, createPlayer, loadUrl

adBreakEnded(adBreakInfo)

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

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

adBreakStarted(adBreakInfo)

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

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

allVideoComplete()

ज़रूरी नहीं. वीडियो पूरा होने पर कॉल किया जाता है.

createPlayer()

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

Returns ima.Player:

loadUrl(streamInfo)

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

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

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

क्लास ima.StreamFormat

फ़ील्ड

DASH, HLS

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

प्रॉपर्टी

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

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

क्लास ima.StreamInfo

फ़ील्ड

format, manifest, streamId, streamType, subtitles

तरीके

createStreamInfo

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

प्रॉपर्टी

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

createStreamInfo()

लौटाए गए प्रॉडक्ट ima.StreamInfo:

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

क्लास 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 प्रॉपर्टी हमेशा गलत होती है.

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

getPreviousCuePoint(time)

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

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()

स्ट्रीम चलाना शुरू करता है.

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

क्लास 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		ज़रूरी नहीं. इन कुंजियों का इस्तेमाल, स्ट्रीम के अनुरोधों की पुष्टि करने के लिए किया जा सकता है. डीएआई की पुष्टि करने वाली कुंजियों को 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		क्लाइंट ऐप्लिकेशन पर वीडियो चलाने के लिए ज़िम्मेदार वीडियो ऑब्जेक्ट (जैसे, वीडियो roSGNode). इस ऑब्जेक्ट से अलग-अलग डेटा के लिए पोल किया जाएगा, ताकि लाइव एचएलएस आईडी3 इवेंट के लिए सही समय तय किया जा सके.
videoStitcherSessionOptions		सेशन के विकल्पों का इस्तेमाल, VideoStitcher streamRequests के लिए वीडियो स्टिचर के खास पैरामीटर सेट करने के लिए किया जाता है.

createLiveStreamRequest(assetKey, apiKey, networkCode)

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

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

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

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

पॉड लाइव 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)

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

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

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

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

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

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

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

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

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

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

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

createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode)

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

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

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

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

क्लास ima.StreamType

फ़ील्ड

लाइव, वीओडी

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

प्रॉपर्टी

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

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

क्लास ima.WrapperInfo

फ़ील्ड

adId, adSystem, creativeAdId, creativeId, dealId

तरीके

createWrapperInfo

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

प्रॉपर्टी

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

createWrapperInfo()

लौटाए गए प्रॉडक्ट ima.WrapperInfo:

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