IMA डीएआई SDK टूल का इस्तेमाल शुरू करना

IMA SDK की मदद से, मल्टीमीडिया विज्ञापनों को आपकी वेबसाइटों और ऐप्लिकेशन में आसानी से इंटिग्रेट किया जा सकता है. IMA SDK, VAST के मुताबिक किसी भी विज्ञापन सर्वर से विज्ञापनों का अनुरोध कर सकता है. साथ ही, आपके ऐप्लिकेशन में विज्ञापन प्लेबैक को मैनेज कर सकता है. IMA डीएआई SDK टूल की मदद से, ऐप्लिकेशन विज्ञापन और कॉन्टेंट वीडियो के लिए स्ट्रीम का अनुरोध करते हैं, फिर चाहे वह वीओडी (वीडियो ऑन डिमांड) हो या लाइव. इसके बाद, SDK टूल एक साथ वीडियो स्ट्रीम दिखाता है, ताकि आपको अपने ऐप्लिकेशन में विज्ञापन और कॉन्टेंट वीडियो के बीच स्विच करने की प्रोसेस मैनेज न करनी पड़े.

अपनी पसंद का डीएआई सलूशन चुनें

पूरी सेवा पॉड दिखाना

पूरी सेवा डीएआई

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

ध्यान दें: Roku के लिए IMA डीएआई SDK टूल, HLS और DASH दोनों स्ट्रीम के साथ काम करता है. इसमें कोई अंतर नहीं होता.

IMA डीएआई का इस्तेमाल करने के लिए, आपके पास Ad Manager 360 Advanced खाता होना चाहिए. अगर आपके पास Ad Manager खाता है, तो ज़्यादा जानकारी के लिए अपने खाता मैनेजर से संपर्क करें. Ad Manager के लिए साइन अप करने के बारे में जानकारी पाने के लिए, Ad Manager सहायता केंद्र पर जाएं.

ध्यान दें: अन्य प्लैटफ़ॉर्म के साथ इंटिग्रेट करने या IMA क्लाइंट-साइड SDK टूल इस्तेमाल करने के बारे में जानकारी पाने के लिए, इंटरैक्टिव मीडिया विज्ञापन SDK टूल देखें.

IMA डीएआई की खास जानकारी

IMA डीएआई को लागू करने में SDK टूल के दो मुख्य कॉम्पोनेंट शामिल होते हैं, जैसा कि इस गाइड में बताया गया है:

• StreamRequest: स्ट्रीम के अनुरोध के बारे में बताने वाला ऑब्जेक्ट. स्ट्रीम के अनुरोध, मांग पर वीडियो या लाइव स्ट्रीम के लिए हो सकते हैं. अनुरोध में Content ID के साथ-साथ, एपीआई पासकोड या पुष्टि करने वाले टोकन और अन्य पैरामीटर की जानकारी होती है.
• StreamManager: एक ऑब्जेक्ट जो डीएआई बैकएंड के साथ, डाइनैमिक विज्ञापन इंसर्शन स्ट्रीम और इंटरैक्शन मैनेज करता है. स्ट्रीम मैनेजर, पिंग को ट्रैक करने के साथ-साथ स्ट्रीम और विज्ञापन इवेंट को पब्लिशर के पास भेजता है.

ज़रूरी शर्तें

• हमारे काम करने वाले पेज को पढ़ें और पक्का करें कि इस्तेमाल का आपका सही उदाहरण काम करता हो.
• हमारा Roku सैंपल प्लेयर कोड डाउनलोड करें
• यह पुष्टि करने के लिए कि आपका डेवलपमेंट सेट अप काम कर रहा है या नहीं, सैंपल प्लेयर कोड को Roku डिवाइस पर डिप्लॉय करें.

अपना वीडियो चलाएं

सैंपल के तौर पर दिया गया वीडियो प्लेयर, कॉन्टेंट वीडियो को बिना किसी रुकावट के चलता है. अपने Roku प्लेयर पर सैंपल प्लेयर डिप्लॉय करें, ताकि यह पक्का किया जा सके कि आपका डेवलपमेंट एनवायरमेंट सही तरीके से सेट अप हुआ है.

अपने वीडियो प्लेयर को IMA डीएआई स्ट्रीम प्लेयर में बदलें

स्ट्रीम प्लेयर लागू करने के लिए यह तरीका अपनाएं.

Sdk.xml बनाएं

अपने प्रोजेक्ट में MainScene.xml के साथ-साथ Sdk.xml नाम की एक नई फ़ाइल जोड़ें और यहां दिया गया बॉयलरप्लेट जोड़ें:

Sdk.xml

<?xml version = "1.0" encoding = "utf-8" ?>

<component name = "imasdk" extends = "Task">
<interface>
</interface>
<script type = "text/brightscript">
<![CDATA[
  ' Your code goes here.
]]>
</script>
</component>

आपको इस पूरी गाइड में, इन दोनों फ़ाइलों में बदलाव करना होगा.

Roku विज्ञापन फ़्रेमवर्क लोड करें

IMA डीएआई SDK टूल, Roku विज्ञापन फ़्रेमवर्क पर निर्भर करता है. फ़्रेमवर्क लोड करने के लिए, manifest और Sdk.xml में ये जोड़ें:

मेनिफ़ेस्ट

bs_libs_required=roku_ads_lib,googleima3

Sdk.xml

Library "Roku_Ads.brs"
Library "IMA3.brs"

IMA डीएआई SDK टूल लोड करें

IMA डाइनैमिक ऐड इंसर्शन स्ट्रीम को लोड करने का पहला चरण है, IMA डीएआई SDK टूल को लोड करना और शुरू करना. नीचे दी गई इमेज, IMA डीएआई SDK टूल की स्क्रिप्ट लोड करती है.

Sdk.xml

<interface>
  <field id="sdkLoaded" type="Boolean" />
  <field id="errors" type="stringarray" />
</interface>
...
Sub init()
  m.top.functionName = "runThread"
End Sub

Sub runThread()
  if not m.top.sdkLoaded
    loadSdk()
  End If
End Sub

Sub loadSdk()
    If m.sdk = invalid
      m.sdk = New_IMASDK()
    End If
    m.top.sdkLoaded = true
End Sub

अब MainScene.xml में यह टास्क शुरू करें और कॉन्टेंट स्ट्रीम लोड करने के लिए कॉल हटाएं.

MainScene.xml

function init()
  m.video = m.top.findNode("myVideo")
  m.video.notificationinterval = 1
  loadImaSdk()
end function

function loadImaSdk() as void
  m.sdkTask = createObject("roSGNode", "imasdk")
  m.sdkTask.observeField("sdkLoaded", "onSdkLoaded")
  m.sdkTask.observeField("errors", "onSdkLoadedError")

  m.sdkTask.control = "RUN"
end function

Sub onSdkLoaded(message as Object)
  print "----- onSdkLoaded --- control ";message
End Sub

Sub onSdkLoadedError(message as Object)
  print "----- errors in the sdk loading process --- ";message
End Sub

IMA स्ट्रीम प्लेयर बनाएं

इसके बाद, IMA स्ट्रीम प्लेयर बनाने के लिए आपको मौजूदा roVideoScreen का इस्तेमाल करना होगा. यह स्ट्रीम प्लेयर, कॉलबैक के तीन तरीके लागू करता है: loadUrl, adBreakStarted, और adBreakEnded. इसके अलावा, स्ट्रीम लोड होने पर ट्रिक प्ले को बंद कर दें. इससे उपयोगकर्ता, विज्ञापन के लिए ब्रेक शुरू होने के इवेंट के चालू होने से पहले ही, शुरू होने से पहले विज्ञापन को स्किप कर सकते हैं.

Sdk.xml

<interface>
  <field id="sdkLoaded" type="Boolean" />
  <field id="errors" type="stringarray" />
  <field id="urlData" type="assocarray" />
  <field id="adPlaying" type="Boolean" />
  <field id="video" type="Node" />
</interface>
...
Sub setupVideoPlayer()
  sdk = m.sdk
  m.player = sdk.createPlayer()
  m.player.top = m.top
  m.player.loadUrl = Function(urlData)
    m.top.video.enableTrickPlay = false
    m.top.urlData = urlData
  End Function
  m.player.adBreakStarted = Function(adBreakInfo as Object)
    print "---- Ad Break Started ---- "
    m.top.adPlaying = True
    m.top.video.enableTrickPlay = false
  End Function
  m.player.adBreakEnded = Function(adBreakInfo as Object)
    print "---- Ad Break Ended ---- "
    m.top.adPlaying = False
    m.top.video.enableTrickPlay = true
  End Function
End Sub

स्ट्रीम का अनुरोध करना और उसे लागू करना

अब आपके पास स्ट्रीम प्लेयर है, तो स्ट्रीम का अनुरोध किया जा सकता है और उसे लागू किया जा सकता है. इस उदाहरण में, लाइव स्ट्रीम और वीओडी (वीडियो ऑन डिमांड) स्ट्रीम का डेटा शामिल है. इसमें वीओडी स्ट्रीम का इस्तेमाल किया गया है. हालांकि, selectedStream को m.testVodStream से m.testLiveStream में बदलकर, लाइव स्ट्रीम का इस्तेमाल किया जा सकता है.

AdUI, जैसे कि adChoices आइकॉन के साथ काम करने के लिए आपको उस नोड को एक रेफ़रंस भी भेजना होगा जिसमें आपके कॉन्टेंट का वीडियो शामिल है.

MainScene.xml

function init()
  m.video = m.top.findNode("myVideo")
  m.video.notificationinterval = 1
  m.testLiveStream = {
    title: "Livestream",
    assetKey: "sN_IYUG8STe1ZzhIIE_ksA",
    apiKey: "",
    type: "live"
  }
  m.testVodStream = {
    title: "VOD stream"
    contentSourceId: "2548831",
    videoId: "tears-of-steel",
    apiKey: "",
    type: "vod"
  }
  loadImaSdk()
end function

function loadImaSdk() as void
  m.sdkTask = createObject("roSGNode", "imasdk")
  m.sdkTask.observeField("sdkLoaded", "onSdkLoaded")
  m.sdkTask.observeField("errors", "onSdkLoadedError")

  selectedStream = m.testVodStream
  m.videoTitle = selectedStream.title
  m.sdkTask.streamData = selectedStream

  m.sdkTask.video = m.video
  m.sdkTask.control = "RUN"
end function

Sdk.xml

<interface>
  <field id="sdkLoaded" type="Boolean" />
  <field id="errors" type="stringarray" />
  <field id="urlData" type="assocarray" />
  <field id="adPlaying" type="Boolean" />
  <field id="video" type="Node" />
  <field id="streamData" type="assocarray" />
  <field id="streamManagerReady" type="Boolean" />
</interface>
...
Sub runThread()
  if not m.top.sdkLoaded
    loadSdk()
  End If
  if not m.top.streamManagerReady
    loadStream()
  End If
End Sub

Sub loadStream()
  sdk = m.sdk
  sdk.initSdk()
  setupVideoPlayer()

  request = {}
  streamData = m.top.streamData
  if streamData.type = "live"
    request = sdk.CreateLiveStreamRequest(streamData.assetKey, streamData.apiKey)
  else if streamData.type = "vod"
    request = sdk.CreateVodStreamRequest(streamData.contentSourceId, streamData.videoId, streamData.apiKey)
  else
    request = sdk.CreateStreamRequest()
  end if

  request.player = m.player
  request.videoObject = m.top.video
  ' Required to support UI elements for 'Why This Ad?' and skippability
  request.adUiNode = m.top.video

  requestResult = sdk.requestStream(request)
  If requestResult &lt;&gt; Invalid
    print "Error requesting stream ";requestResult
  Else
    m.streamManager = Invalid
    While m.streamManager = Invalid
      sleep(50)
      m.streamManager = sdk.getStreamManager()
    End While
    If m.streamManager = Invalid or m.streamManager["type"] &lt;&gt; Invalid or m.streamManager["type"] = "error"
      errors = CreateObject("roArray", 1, True)
      print "error ";m.streamManager["info"]
      errors.push(m.streamManager["info"])
      m.top.errors = errors
    Else
      m.top.streamManagerReady = True
      addCallbacks()
      m.streamManager.start()
    End If
  End If
End Sub

इवेंट लिसनर जोड़ें और स्ट्रीम शुरू करें

अपनी स्ट्रीम का अनुरोध करने के बाद, आपको सिर्फ़ कुछ काम करना होगा: विज्ञापन की प्रोग्रेस को ट्रैक करने के लिए, इवेंट सुनने वालों को जोड़ें, अपनी स्ट्रीम शुरू करें, और Roku मैसेज को SDK टूल पर फ़ॉरवर्ड करने के लिए.

अहम जानकारी: विज्ञापन को सही तरीके से चलाने के लिए, आपको सभी मैसेज SDK टूल पर फ़ॉरवर्ड करने होंगे.

MainScene.xml

function loadImaSdk() as void
  m.sdkTask = createObject("roSGNode", "imasdk")
  m.sdkTask.observeField("sdkLoaded", "onSdkLoaded")
  m.sdkTask.observeField("errors", "onSdkLoadedError")

  selectedStream = m.testVodStream
  m.videoTitle = selectedStream.title
  m.sdkTask.streamData = selectedStream

  m.sdkTask.observeField("urlData", "urlLoadRequested")
  m.sdkTask.video = m.video
  m.sdkTask.control = "RUN"
end function

Sub urlLoadRequested(message as Object)
  print "Url Load Requested ";message
  data = message.getData()

  playStream(data.manifest)
End Sub

Sub playStream(url as Object)
  vidContent = createObject("RoSGNode", "ContentNode")
  vidContent.url = url
  vidContent.title = m.videoTitle
  vidContent.streamformat = "hls"
  m.video.content = vidContent
  m.video.setFocus(true)
  m.video.visible = true
  m.video.control = "play"
  m.video.EnableCookies()
End Sub

Sdk.xml

Sub runThread()
  if not m.top.sdkLoaded
    loadSdk()
  End If
  if not m.top.streamManagerReady
    loadStream()
  End If
  If m.top.streamManagerReady
    runLoop()
  End If
End Sub

Sub runLoop()
  m.top.video.timedMetaDataSelectionKeys = ["*"]

  m.port = CreateObject("roMessagePort")

  ' Listen to all fields.

  ' IMPORTANT: Failure to listen to the position and timedmetadata fields
  ' could result in ad impressions not being reported.
  fields = m.top.video.getFields()
  for each field in fields
    m.top.video.observeField(field, m.port)
  end for

  while True
    msg = wait(1000, m.port)
    if m.top.video = invalid
      print "exiting"
      exit while
    end if

    m.streamManager.onMessage(msg)
    currentTime = m.top.video.position
    If currentTime > 3 And not m.top.adPlaying
       m.top.video.enableTrickPlay = true
    End If
  end while
End Sub

Function addCallbacks() as Void
  m.streamManager.addEventListener(m.sdk.AdEvent.ERROR, errorCallback)
  m.streamManager.addEventListener(m.sdk.AdEvent.START, startCallback)
  m.streamManager.addEventListener(m.sdk.AdEvent.FIRST_QUARTILE, firstQuartileCallback)
  m.streamManager.addEventListener(m.sdk.AdEvent.MIDPOINT, midpointCallback)
  m.streamManager.addEventListener(m.sdk.AdEvent.THIRD_QUARTILE, thirdQuartileCallback)
  m.streamManager.addEventListener(m.sdk.AdEvent.COMPLETE, completeCallback)
End Function

Function startCallback(ad as Object) as Void
  print "Callback from SDK -- Start called - "
End Function

Function firstQuartileCallback(ad as Object) as Void
  print "Callback from SDK -- First quartile called - "
End Function

Function midpointCallback(ad as Object) as Void
  print "Callback from SDK -- Midpoint called - "
End Function

Function thirdQuartileCallback(ad as Object) as Void
  print "Callback from SDK -- Third quartile called - "
End Function

Function completeCallback(ad as Object) as Void
  print "Callback from SDK -- Complete called - "
End Function

Function errorCallback(error as Object) as Void
  print "Callback from SDK -- Error called - "; error
  m.errorState = True
End Function

स्किप किए जा सकने वाले विज्ञापनों के लिए सहायता जोड़ें (ज़रूरी नहीं)

स्किप किए जा सकने वाले विज्ञापनों के साथ काम करने के लिए, आपको IMA डीएआई SDK के प्लेयर ऑब्जेक्ट में seek तरीका जोड़ना होगा. यह तरीका, प्रोसेस करके वीडियो को फ़्लोटिंग पॉइंट सेकंड में तय की गई जगह पर भेजता है.

स्किप किए जा सकने वाले विज्ञापनों को दिखाने के लिए, आपको यह भी पक्का करना होगा कि आपने अनुरोध में adUiNode को सेट किया हो.

Sdk.xml

  m.player.loadUrl = Function(urlData)
    m.top.video.enableTrickPlay = false
    m.top.urlData = urlData
  End Function

  m.player.seek = Function(timeSeconds as Float)
     print "---- SDK requested seek to ----" ; timeSeconds
     m.top.video.seekMode = "accurate"
     m.top.video.seek = timeSeconds
  End Function

  m.player.adBreakStarted = Function(adBreakInfo as Object)
    print "---- Ad Break Started ---- "
    m.top.adPlaying = True
    m.top.video.enableTrickPlay = false
  End Function