Google IMA डीएआई SDK टूल एपीआई

1. 1. google.ima.dai.api.Ad
   2. google.ima.dai.api.AdPodInfo
   3. google.ima.dai.api.AdProgressData
   4. google.ima.dai.api.CompanionAd
   5. google.ima.dai.api.CuePoint
   6. google.ima.dai.api.LiveStreamRequest
   7. google.ima.dai.api.StreamData
   8. google.ima.dai.api.StreamEvent
   9. google.ima.dai.api.StreamEvent.Type
   10. google.ima.dai.api.StreamManager
   11. google.ima.dai.api.StreamRequest
   12. google.ima.dai.api.VODStreamRequest
   13. google.ima.VERSION

Class google.ima.dai.api.Ad

तरीके

getAdId, getAdPodInfo, getAdSystem, getAdvertiserName, getApiFramework, getCompanionAds, getCreativeAdId, getCreativeId, getDealId, getDescription, getDuration, getTitle, getVastMediaHeight, getVastMediaWidth, getWrapperAdIds, getWrapperAdSystems, getWrapperCreativeIds

यह क्लास, डाइनैमिक विज्ञापन इंसर्शन के दौरान विज्ञापन ऑब्जेक्ट को दिखाती है. यह क्लास, ima.Ad प्रॉपर्टी का सबसेट दिखाती है.

getAdId()

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

getAdPodInfo()

लौटाए जाने वाले प्रॉडक्ट google.ima.dai.api.AdPodInfo:

getAdSystem()

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

getAdvertiserName()

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

getApiFramework()

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

getCompanionAds()

लौटाए जाने वाले प्रॉडक्ट Array.<google.ima.dai.api.CompanionAd>:

getCreativeAdId()

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

getCreativeId()

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

getDealId()

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

getDescription()

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

getDuration()

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

getTitle()

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

getVastMediaHeight()

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

getVastMediaWidth()

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

getWrapperAdIds()

लौटाए जाने वाले प्रॉडक्ट Array.<string>:

getWrapperAdSystems()

लौटाए जाने वाले प्रॉडक्ट Array.<string>:

getWrapperCreativeIds()

लौटाए जाने वाले प्रॉडक्ट Array.<string>:

क्लास google.ima.dai.api.AdPodInfo

तरीके

getAdPosition, getMaxDuration, getPodIndex, getTimeOffset, getTotalAds

यह क्लास, डाइनैमिक विज्ञापन डालने के दौरान विज्ञापन पॉड की जानकारी देने वाले ऑब्जेक्ट को दिखाती है. यह क्लास, ima.AdPodInfo प्रॉपर्टी का सबसेट दिखाता है.

getAdPosition()

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

getMaxDuration()

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

getPodIndex()

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

getTimeOffset()

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

getTotalAds()

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

Class google.ima.dai.api.AdProgressData

फ़ील्ड

adBreakDuration, adPosition, currentTime, duration, totalAds

विज्ञापन की प्रोग्रेस का डेटा तय करने के लिए क्लास.

प्रॉपर्टी

नाम	टाइप	ब्यौरा
adBreakDuration
adPosition
currentTime
duration
totalAds

Class google.ima.dai.api.CompanionAd

तरीके

getAdSlotId, getContent, getContentType, getHeight, getWidth

यह क्लास, डाइनैमिक ऐड इंसर्शन के दौरान कंपैनियन विज्ञापन ऑब्जेक्ट को दिखाती है. यह क्लास, ima.CompanionAd प्रॉपर्टी का सबसेट दिखाता है.

getAdSlotId()

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

getContent()

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

getContentType()

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

getHeight()

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

getWidth()

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

Class google.ima.dai.api.CuePoint

फ़ील्ड

end, played, start

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

प्रॉपर्टी

नाम	टाइप	ब्यौरा
end		इस क्यूपॉइंट के खत्म होने का समय.
played		अगर इस क्यू पॉइंट को चलाया गया है.
start		इस क्यूपॉइंट के शुरू होने का समय.

Class google.ima.dai.api.LiveStreamRequest

फ़ील्ड

assetKey

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

कंस्ट्रक्टर:

पैरामीटर	टाइप	ब्यौरा
opt_liveStreamRequest	Object	ऑब्जेक्ट, जिसमें स्ट्रीम अनुरोध की प्रॉपर्टी पहले से असाइन की गई हैं.

प्रॉपर्टी

नाम	टाइप	ब्यौरा
assetKey		इसका इस्तेमाल यह तय करने के लिए किया जाता है कि कौनसी स्ट्रीम चलाई जानी चाहिए. लाइव स्ट्रीम के अनुरोध की ऐसेट कुंजी एक आइडेंटिफ़ायर है. इसे DFP के यूज़र इंटरफ़ेस (यूआई) में देखा जा सकता है.

क्लास google.ima.dai.api.StreamData

फ़ील्ड

adProgressData, cuepoints, errorMessage, streamId, subtitles, url

स्ट्रीम डेटा के बारे में बताने वाली क्लास.

प्रॉपर्टी

नाम	टाइप	ब्यौरा
adProgressData		इस कुकी में, फ़िलहाल चल रहे विज्ञापन के समय से जुड़ी जानकारी होती है.
cuepoints		मांग पर उपलब्ध स्ट्रीम के लिए विज्ञापन के क्यू पॉइंट. स्ट्रीम के आगे बढ़ने पर, इनमें बदलाव हो सकता है. यह सिर्फ़ CUEPOINTS_CHANGED AdEvent के लिए इवेंट लिसनर में अपने-आप भर जाएगा.
errorMessage
streamId
subtitles
url

Class google.ima.dai.api.StreamEvent

तरीके

getAd, getStreamData

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

getAd()

Returns google.ima.dai.api.Ad: विज्ञापन की जानकारी के साथ ऑब्जेक्ट दिखाता है.

getStreamData()

लौटाए गए सामान की जानकारी google.ima.dai.api.StreamData: स्ट्रीम की जानकारी के साथ लौटाए गए सामान का ऑब्जेक्ट.

Enum google.ima.dai.api.StreamEvent.Type

फ़ील्ड

AD_BREAK_ENDED, AD_BREAK_STARTED, AD_PROGRESS, CLICK, COMPLETE, CUEPOINTS_CHANGED, ERROR, FIRST_QUARTILE, LOADED, MIDPOINT, STARTED, STREAM_INITIALIZED, THIRD_QUARTILE

IMA SDK के साथ काम करने वाले इवेंट टाइप की सूची.

वैल्यू

मान	ब्यौरा
AD_BREAK_ENDED	विज्ञापन ब्रेक खत्म होने पर ट्रिगर होता है.
AD_BREAK_STARTED	विज्ञापन ब्रेक शुरू होने पर सक्रिय होता है.
AD_PROGRESS	विज्ञापन की प्रोग्रेस में कोई अपडेट होने पर सक्रिय होता है.
CLICK	विज्ञापन चलने के दौरान, क्लिक एलिमेंट पर क्लिक या टैप करने पर यह इवेंट भेजा जाता है.
COMPLETE	विज्ञापन पूरा होने पर सक्रिय होता है.
CUEPOINTS_CHANGED	जब क्यू पॉइंट बदलते हैं, तब मांग पर उपलब्ध स्ट्रीम के लिए भेजा जाता है.
ERROR	यह इवेंट तब ट्रिगर होता है, जब कोई गड़बड़ी होती है.
FIRST_QUARTILE	विज्ञापन के पहले चौथाई हिस्से तक पहुंचने पर सक्रिय होता है.
LOADED	स्ट्रीम मेनिफ़ेस्ट उपलब्ध होने पर ट्रिगर होता है.
MIDPOINT	विज्ञापन के बीच में पहुंचने पर सक्रिय होता है.
STARTED	विज्ञापन के शुरू होने पर ट्रिगर होता है.
STREAM_INITIALIZED	स्ट्रीम शुरू होने पर ट्रिगर होता है.
THIRD_QUARTILE	जब कोई विज्ञापन तीसरे क्वार्टाइल तक पहुंच जाता है, तब यह इवेंट ट्रिगर होता है.

Class google.ima.dai.api.StreamManager

तरीके

contentTimeForStreamTime, onTimedMetadata, previousCuePointForStreamTime, processMetadata, requestStream, setClickElement, streamTimeForContentTime

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

कंस्ट्रक्टर:

पैरामीटर	टाइप	ब्यौरा
videoElement	HTMLVideoElement	वीडियो प्लेयर का असल एलिमेंट.

contentTimeForStreamTime(streamTime)

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

Returns number: विज्ञापन हटा दिए जाने के बाद, यह फ़ंक्शन स्ट्रीम के दिए गए समय के हिसाब से कॉन्टेंट का समय दिखाता है.

पैरामीटर	टाइप	ब्यौरा
streamTime	number	विज्ञापन शामिल करने के बाद स्ट्रीम की अवधि (सेकंड में).

onTimedMetadata(metadata)

प्रोसेस किए गए मेटाडेटा की डिक्शनरी में पास होता है. डिक्शनरी में, उपयोगकर्ता की ओर से तय की गई मेटाडेटा स्ट्रिंग को वैल्यू के तौर पर इस्तेमाल करने के लिए, 'TXXX' कुंजी की ज़रूरत होती है. अगर आपका प्लेयर रॉ मेटाडेटा उपलब्ध कराता है, तो ima.dai.api.StreamManager.processMetadata को कॉल करें.

पैरामीटर	टाइप	ब्यौरा
metadata	Object	मेटाडेटा का शब्दकोश.

previousCuePointForStreamTime(streamTime)

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

वापस लाता है google.ima.dai.api.CuePoint: स्ट्रीम के दिए गए समय के लिए पिछला क्यूपॉइंट.

पैरामीटर	टाइप	ब्यौरा
streamTime	number	स्ट्रीम का वह समय जिस पर वीडियो को ले जाया गया था.

processMetadata(type, data, timestamp)

यह कुकी, लाइव स्ट्रीम के लिए टाइम किया गया मेटाडेटा प्रोसेस करती है. अगर आपका वीडियो प्लेयर, टाइमस्टैंप के साथ-साथ पार्स नहीं किया गया मेटाडेटा उपलब्ध कराता है, तो इस विकल्प का इस्तेमाल करें. ऐसा न होने पर, ima.dai.api.StreamManager.onTimedMetadata को कॉल करें.

पैरामीटर	टाइप	ब्यौरा
type	string	मेटाडेटा का टाइप. यह 'ID3' होना चाहिए.
data	Uint8Array	टैग का रॉ डेटा. ID3 के लिए, पूरा टैग होना चाहिए.
timestamp	number	डेटा को प्रोसेस करने का समय.

requestStream(streamRequest)

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

पैरामीटर	टाइप	ब्यौरा
streamRequest	google.ima.dai.api.StreamRequest	इसमें स्ट्रीम मेटाडेटा लोड करने के लिए पैरामीटर शामिल होते हैं.

setClickElement(clickElement)

यह कुकी, विज्ञापन पर क्लिक थ्रू एलिमेंट सेट करती है. इस एलिमेंट का इस्तेमाल, विज्ञापन चलने के दौरान क्लिक या टैप करने के लिए किया जाता है. इससे उपयोगकर्ता को मौजूदा पेज से किसी दूसरे पेज पर रीडायरेक्ट किया जा सकता है.

पैरामीटर	टाइप	ब्यौरा
clickElement	Element	विज्ञापन पर क्लिक थ्रू के तौर पर इस्तेमाल किया गया एलिमेंट.

streamTimeForContentTime(contentTime)

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

Returns number: विज्ञापन डालने के बाद, यह फ़ंक्शन कॉन्टेंट के दिए गए समय के हिसाब से स्ट्रीम का समय दिखाता है.

पैरामीटर	टाइप	ब्यौरा
contentTime	number	विज्ञापनों के बिना कॉन्टेंट देखने का समय (सेकंड में).

Class google.ima.dai.api.StreamRequest

फ़ील्ड

adTagParameters, apiKey, streamActivityMonitorId

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

प्रॉपर्टी

नाम	टाइप	ब्यौरा
adTagParameters		आपके पास स्ट्रीम के अनुरोध पर, विज्ञापन टैग पैरामीटर के सीमित सेट को बदलने का विकल्प होता है. अपनी स्ट्रीम में टारगेटिंग पैरामीटर सप्लाई करना लेख में ज़्यादा जानकारी दी गई है. स्ट्रीम के वैरिएंट को प्राथमिकता देने के लिए, dai-ot और dai-ov पैरामीटर का इस्तेमाल किया जा सकता है. ज़्यादा जानकारी के लिए, स्ट्रीम के वैरिएंट पैरामीटर को बदलना लेख पढ़ें.
apiKey		स्ट्रीम के अनुरोध के लिए एपीआई पासकोड. इसे DFP एडमिन यूज़र इंटरफ़ेस (यूआई) के ज़रिए कॉन्फ़िगर किया जाता है. साथ ही, पब्लिशर को यह सुविधा इसलिए दी जाती है, ताकि वह अपने कॉन्टेंट को अनलॉक कर सके. यह उन ऐप्लिकेशन की पुष्टि करता है जो कॉन्टेंट को ऐक्सेस करने की कोशिश कर रहे हैं.
streamActivityMonitorId		इस आईडी का इस्तेमाल, स्ट्रीम ऐक्टिविटी मॉनिटर की मदद से स्ट्रीम को डीबग करने के लिए किया जाता है. इसका इस्तेमाल, पब्लिशर को स्ट्रीम ऐक्टिविटी मॉनिटर टूल में स्ट्रीम लॉग ढूंढने का आसान तरीका उपलब्ध कराने के लिए किया जाता है.

Class google.ima.dai.api.VODStreamRequest

फ़ील्ड

contentSourceId, videoId

वीओडी स्ट्रीम के अनुरोध की प्रॉपर्टी तय करने के लिए क्लास.

कंस्ट्रक्टर:

पैरामीटर	टाइप	ब्यौरा
opt_VODStreamRequest	Object	ऑब्जेक्ट, जिसमें स्ट्रीम करने का अनुरोध पहले से मौजूद है प्रॉपर्टी असाइन की गई हैं.

प्रॉपर्टी

नाम	टाइप	ब्यौरा
contentSourceId		सीएमएस से पब्लिशर के कॉन्टेंट के लिए यूनीक आइडेंटिफ़ायर. मांग पर स्ट्रीम करने के लिए ज़रूरी है.
videoId		वीडियो कॉन्टेंट के सोर्स के लिए आइडेंटिफ़ायर. मांग पर उपलब्ध स्ट्रीम के लिए ज़रूरी है.

कॉन्स्टेंट google.ima.VERSION

एक स्ट्रिंग, जिसमें एसडीके का पूरा वर्शन शामिल होता है.