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

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

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

फ़ील्ड

adBreakDuration, adPosition, currentTime, duration, totalAds

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

प्रॉपर्टी

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

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

तरीके

getAdSlotId, getContent, getContentType, getHeight, getWidth

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

getAdSlotId()

लौटाए गए प्रॉडक्ट string:

getContent()

लौटाए गए प्रॉडक्ट string:

getContentType()

लौटाए गए प्रॉडक्ट string:

getHeight()

लौटाए गए प्रॉडक्ट number:

getWidth()

लौटाए गए प्रॉडक्ट number:

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

फ़ील्ड

खत्म, चलाया गया, शुरू करें

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

प्रॉपर्टी

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

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

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

तरीके

getAd, getStreamData

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

getAd()

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

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

तरीके

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

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

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

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

contentTimeForStreamTime(streamTime)

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

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

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

onTimedMetadata(metadata)

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

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

previousCuePointForStreamTime(streamTime)

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

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)

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

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

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

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

फ़ील्ड

adTagParameters, apiKey, streamActivityMonitorId

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

प्रॉपर्टी

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

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

फ़ील्ड

contentSourceId, videoId

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

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

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

प्रॉपर्टी

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

Google.ima.VERSION का कॉन्स्टेंट

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