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{/15getSystem2}, getDealId, getDescriptiongetDurationgetTitlegetVastMediaHeightgetVastMediaWidthgetWrapperAdIdsgetWrapperAdSystemsgetWrapperCreativeIds

डाइनैमिक विज्ञापन इंसर्शन के दौरान किसी विज्ञापन ऑब्जेक्ट को दिखाने वाली क्लास. यह क्लास 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.AdPro दावाData

फ़ील्ड

adBreakDuration, adPosition, currentTime, duration, totalAds

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

प्रॉपर्टी

नाम	Type	ब्यौरा
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, चलाया गया, शुरू करें

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

प्रॉपर्टी

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

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

फ़ील्ड

assetKey

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

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

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

प्रॉपर्टी

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

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

फ़ील्ड

adProgressData, cuepoints, errorMessage, streamId, सबटाइटल, url

स्ट्रीम डेटा तय करने के लिए क्लास.

प्रॉपर्टी

नाम	Type	ब्यौरा
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_STARTEDAD_PROGRESSCOMPLETECUEPOINTS_CHANGEDFIRST_QUARTILELOADEDMIDPOINTSTREAM_INITIALIZEDTHIRD_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 से इनहेरिट नहीं किया जा सकता. ऐसा इसलिए, क्योंकि यह किसी खास विज्ञापन का मैनेजर नहीं है, बल्कि पूरी स्ट्रीम के लिए एक मैनेजर खाता है

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

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

contentTimeForStreamTime(streamTime)

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

दिखने वाला number: कॉन्टेंट हटाने के बाद, दिखाए गए समय के हिसाब से कॉन्टेंट का समय.

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

onTimedMetadata(metadata)

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

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

previousCuePointForStreamTime(streamTime)

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

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

पैरामीटर	Type	ब्यौरा
streamTime	number	स्ट्रीम किए जाने का समय.

processMetadata(type, data, timestamp)

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

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

requestStream(streamRequest)

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

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

setClickElement(clickElement)

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

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

streamTimeForContentTime(contentTime)

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

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

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

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

फ़ील्ड

adTagParameters, apiKey, streamActivityMonitorId

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

प्रॉपर्टी

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

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

फ़ील्ड

contentSourceId, videoId

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

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

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

प्रॉपर्टी

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

लगातार google.ima.VERSION

SDK टूल के फ़ुल वर्शन वाली स्ट्रिंग.