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

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

डीआई (डायनामिक विज्ञापन) का वह समाधान चुनें जिसमें आपकी दिलचस्पी है

पॉड में डीएआई का इस्तेमाल करना

इस गाइड में, लाइव या वीओडी कॉन्टेंट के लिए डीएआई पॉड सेविंग स्ट्रीम चलाने का तरीका बताया गया है. इसके लिए, HTML5 के लिए IMA डीएआई SDK टूल का इस्तेमाल किया गया है. साथ ही, वीडियो प्लेयर के तौर पर hls.js का इस्तेमाल किया गया है. HLS.js और Safari Playback, दोनों के साथ काम करने वाले पूरे सैंपल इंटिग्रेशन को देखने या फ़ॉलो करने के लिए, एचएलएस पॉड सर्विंग का उदाहरण देखें. DASH.js से जुड़ी सहायता पाने के लिए, DASH पॉड सेव करने का उदाहरण देखें. इन सैंपल ऐप्लिकेशन को HTML5 डीएआई के GitHub रिलीज़ पेज से डाउनलोड किया जा सकता है.

डीएआई पॉड दिखाने की सुविधा के बारे में खास जानकारी

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

• PodStreamRequest / PodVodStreamRequest: यह एक ऑब्जेक्ट है, जो Google के विज्ञापन सर्वर को स्ट्रीम का अनुरोध करता है. अनुरोधों में नेटवर्क कोड की जानकारी दी जाती है. साथ ही, PodStreamRequest के लिए कस्टम एसेट पासकोड और एपीआई पासकोड की ज़रूरत होती है. हालांकि, एपीआई पासकोड देना ज़रूरी नहीं है. दोनों में अन्य वैकल्पिक पैरामीटर शामिल हैं.

• StreamManager: यह एक ऐसा ऑब्जेक्ट है जो वीडियो स्ट्रीम और IMA डीएआई SDK टूल के बीच कम्यूनिकेशन मैनेज करता है. जैसे, ट्रैकिंग पिंग को ट्रिगर करना और स्ट्रीम इवेंट को पब्लिशर को फ़ॉरवर्ड करना.

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

शुरू करने से पहले, आपके पास ये चीज़ें होनी चाहिए:

• तीन खाली फ़ाइलें:

  • dai.html
  • dai.css
  • dai.js

• आपके कंप्यूटर पर Python इंस्टॉल होना चाहिए. इसके अलावा, टेस्टिंग के लिए वेब सर्वर या होस्ट किया गया कोई अन्य डेवलपमेंट एनवायरमेंट भी होना चाहिए

डेवलपमेंट एनवायरमेंट कॉन्फ़िगर करना

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

1. कमांड लाइन का इस्तेमाल करके, उस डायरेक्ट्री में जाकर जहां आपकी index.html फ़ाइल मौजूद है, यह चलाएं:

   python -m http.server 8000

2. किसी वेब ब्राउज़र में, http://localhost:8000/ पर जाएं

   Apache HTTP Server जैसे किसी भी होस्ट किए गए डेवलपमेंट एनवायरमेंट या वेब सर्वर का भी इस्तेमाल किया जा सकता है.

वीडियो प्लेयर बनाना

सबसे पहले, dai.html में बदलाव करके, विज्ञापन के यूज़र इंटरफ़ेस (यूआई) एलिमेंट के लिए इस्तेमाल किया जाने वाला एचटीएमएल5 वीडियो एलिमेंट और डिव बनाएं. dai.css और dai.js फ़ाइलों को लोड करने के साथ-साथ, hls.js वीडियो प्लेयर को इंपोर्ट करने के लिए भी ज़रूरी टैग जोड़ें.

इसके बाद, पेज के एलिमेंट का साइज़ और पोज़िशन तय करने के लिए, dai.css में बदलाव करें. आखिर में, dai.js में, स्ट्रीम के अनुरोध की जानकारी को सेव करने के लिए वैरिएबल तय करें. साथ ही, पेज लोड होने पर चलने के लिए initPlayer() फ़ंक्शन तय करें.

स्ट्रीम के अनुरोध के लिए कॉन्स्टेंट इस तरह के होते हैं:

• BACKUP_STREAM: विज्ञापन प्रोसेस में कोई गंभीर गड़बड़ी होने पर, बैकअप स्ट्रीम चलाने के लिए यूआरएल.

• STREAM_URL: सिर्फ़ लाइव स्ट्रीम के लिए इस्तेमाल किया जाता है. पॉड सर्विंग का इस्तेमाल करने वाले आपके मेनिफ़ेस्ट मैनिप्ulator या तीसरे पक्ष के पार्टनर से मिला वीडियो स्ट्रीम यूआरएल. अनुरोध करने से पहले, आपको IMA डीएआई एसडीके से मिला स्ट्रीम आईडी डालना होगा. इस मामले में, स्ट्रीम के यूआरएल में एक प्लेसहोल्डर, [[STREAMID]] शामिल होता है. अनुरोध करने से पहले, इसे स्ट्रीम आईडी से बदल दिया जाता है.

• NETWORK_CODE: आपके Ad Manager 360 खाते का नेटवर्क कोड.

• CUSTOM_ASSET_KEY: सिर्फ़ लाइव स्ट्रीम के लिए इस्तेमाल किया जाता है. कस्टम एसेट की, जो Ad Manager 360 में आपके पॉड दिखाने वाले इवेंट की पहचान करती है. इसे आपका मेनिफ़ेस्ट मैनिप्युलेटर या तीसरे पक्ष का पॉड सर्विंग पार्टनर बना सकता है.

• API_KEY: सिर्फ़ लाइव स्ट्रीम के लिए इस्तेमाल किया जाता है. यह एक वैकल्पिक एपीआई पासकोड है. IMA डीएआई SDK से स्ट्रीम आईडी पाने के लिए, इसकी ज़रूरत पड़ सकती है.

dai.html

<html>
<head>
  <script src="https://cdn.jsdelivr.net/npm/hls.js@latest"></script>
  <script src="dai.js"></script>
  <link rel="stylesheet" href="dai.css" type="text/css">
</head>
<body onLoad="initPlayer()">
  <h2>IMA DAI SDK Demo (HLS.JS)</h2>
    <video id="video"></video>
    <div id="ad-ui"></div>
</body>
</html>

dai.css

#video,
#ad-ui {
  width: 640px;
  height: 360px;
  position: absolute;
  top: 35px;
  left: 0;
}

#ad-ui {
  cursor: pointer;
}

dai.js

var BACKUP_STREAM =
    'https://storage.googleapis.com/interactive-media-ads/media/bbb.m3u8'

// Stream Config.
const STREAM_URL = "https://encodersim.sandbox.google.com/masterPlaylist/...&stream_id=[[STREAMID]]";
const NETWORK_CODE = "51636543";
const CUSTOM_ASSET_KEY = "google-sample";
const API_KEY = "";

var hls = new Hls(); // hls.js video player
var videoElement;
var adUiElement;

function initPlayer() {
  videoElement = document.getElementById('video');
  adUiElement = document.getElementById('adUi');
}

IMA डीएआई SDK टूल लोड करना

इसके बाद, dai.html में स्क्रिप्ट टैग का इस्तेमाल करके, dai.js के टैग से पहले डीआई फ़्रेमवर्क जोड़ें.

dai.html

<html>
<head>
  <script src="https://cdn.jsdelivr.net/npm/hls.js@latest"></script>
  <script type="text/javascript" src="//imasdk.googleapis.com/js/sdkloader/ima3_dai.js"></script>
  <script src="dai.js"></script>
  <link rel="stylesheet" href="dai.css" type="text/css">
</head>
...

StreamManager को शुरू करना और लाइव या वीओडी स्ट्रीम का अनुरोध करना

function initPlayer() {
  videoElement = document.getElementById('video');
  adUiElement = document.getElementById('adUi');
  streamManager = new google.ima.dai.api.StreamManager(videoElement, adUiElement)

  requestLivePodStream(NETWORK_CODE, CUSTOM_ASSET_KEY, API_KEY);
}

function requestLivePodStream(networkCode, customAssetKey, apiKey) {
  // clear HLS.js instance, if in use
  if (hls) {
    hls.destroy();
  }

  // Generate a Pod Serving live Stream Request
  const streamRequest = new google.ima.dai.api.PodStreamRequest();
  streamRequest.networkCode = networkCode;
  streamRequest.customAssetKey = customAssetKey;
  streamRequest.apiKey = apiKey;
  streamRequest.format = 'hls';
  streamManager.requestStream(streamRequest);
}

function initPlayer() {
  videoElement = document.getElementById('video');
  adUiElement = document.getElementById('adUi');
  streamManager = new google.ima.dai.api.StreamManager(videoElement, adUiElement)

  requestVodPodStream(NETWORK_CODE);
}

function requestVodPodStream(networkCode) {
  // clear HLS.js instance, if in use
  if (hls) {
    hls.destroy();
  }

  // Generate a Pod Serving VOD Stream Request
  const streamRequest = new google.ima.dai.api.PodVodStreamRequest();
  streamRequest.networkCode = networkCode;
  streamRequest.format = 'hls';
  streamManager.requestStream(streamRequest);
}

स्ट्रीम इवेंट मैनेज करना

var isAdBreak;

function initPlayer() {
  videoElement = document.getElementById('video');
  adUiElement = document.getElementById('adUi');
  streamManager = new google.ima.dai.api.StreamManager(videoElement, adUiElement);
  
  streamManager.addEventListener(
    [google.ima.dai.api.StreamEvent.Type.STREAM_INITIALIZED,
    google.ima.dai.api.StreamEvent.Type.ERROR,
    google.ima.dai.api.StreamEvent.Type.AD_BREAK_STARTED,
    google.ima.dai.api.StreamEvent.Type.AD_BREAK_ENDED],
    onStreamEvent,
    false);
...
function onStreamEvent(e) {
  switch (e.type) {
    case google.ima.dai.api.StreamEvent.Type.STREAM_INITIALIZED:
      console.log('Stream initialized');
      loadStream(e.getStreamData().streamId);
      break;
    case google.ima.dai.api.StreamEvent.Type.ERROR:
      console.log('Error loading stream, playing backup stream.' + e);
      loadStream('');
      break;
    case google.ima.dai.api.StreamEvent.Type.AD_BREAK_STARTED:
      console.log('Ad Break Started');
      isAdBreak = true;
      videoElement.controls = false;
      adUiElement.style.display = 'block';
      break;
    case google.ima.dai.api.StreamEvent.Type.AD_BREAK_ENDED:
      console.log('Ad Break Ended');
      isAdBreak = false;
      videoElement.controls = true;
      adUiElement.style.display = 'none';
      break;
    default:
      break;
  }
}

function loadStream(streamID) {
  var url;
  if(streamID) {
    url = STREAM_URL.replace('[[STREAMID]]', streamID);
  } else {
    console.log('Stream Initialization Failed');
    url = BACKUP_STREAM;
  }
  console.log('Loading:' + url);
  hls.loadSource(url);
  hls.attachMedia(videoElement);
}

var isAdBreak;

function initPlayer() {
  videoElement = document.getElementById('video');
  adUiElement = document.getElementById('adUi');
  streamManager = new google.ima.dai.api.StreamManager(videoElement, adUiElement);
  
  streamManager.addEventListener(
    [google.ima.dai.api.StreamEvent.Type.STREAM_INITIALIZED,
    google.ima.dai.api.StreamEvent.Type.ERROR,
    google.ima.dai.api.StreamEvent.Type.AD_BREAK_STARTED,
    google.ima.dai.api.StreamEvent.Type.AD_BREAK_ENDED],
    onStreamEvent,
    false);
...
function onStreamEvent(e) {
  switch (e.type) {
    case google.ima.dai.api.StreamEvent.Type.STREAM_INITIALIZED:
      const streamId = e.getStreamData().streamId;
      // 'vtpInterface' is a place holder for your own video technology
      //  partner (VTP) API calls.
      vtpInterface.requestStreamURL({
        'streamId': streamId,
      })
      .then( (vtpStreamUrl) => {
        streamUrl = vtpStreamUrl;
        streamManager.loadStreamMetadata();
      }, (error) => {
        // Handle the error.
      });
      break;
    case google.ima.dai.api.StreamEvent.Type.LOADED:
      loadStream(streamUrl);
      break;
    case google.ima.dai.api.StreamEvent.Type.ERROR:
      console.log('Error loading stream, playing backup stream.' + e);
      loadStream();
      break;
    case google.ima.dai.api.StreamEvent.Type.AD_BREAK_STARTED:
      console.log('Ad Break Started');
      isAdBreak = true;
      videoElement.controls = false;
      adUiElement.style.display = 'block';
      break;
    case google.ima.dai.api.StreamEvent.Type.AD_BREAK_ENDED:
      console.log('Ad Break Ended');
      isAdBreak = false;
      videoElement.controls = true;
      adUiElement.style.display = 'none';
      break;
    default:
      break;
  }
}

function loadStream(url) {
  if(url) {
    console.log('Loading:' + url);
    hls.loadSource(url);
  } else {
    console.log('Stream Initialization Failed');
    hls.loadSource(BACKUP_STREAM);
  }
  hls.attachMedia(videoElement);
}

स्ट्रीम का मेटाडेटा मैनेज करना

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

एचएलएस स्ट्रीम फ़ॉर्मैट (लाइव और वीओडी स्ट्रीम, HLS.js प्लेयर)

अगर HLS.js प्लेयर का इस्तेमाल किया जा रहा है, तो ID3 मेटाडेटा पाने के लिए HLS.js FRAG_PARSING_METADATA इवेंट को सुनें और उसे StreamManager.processMetadata() के साथ SDK टूल को पास करें.

वीडियो लोड होने और तैयार होने के बाद, उसे अपने-आप चलाने के लिए, HLS.js MANIFEST_PARSED इवेंट को सुनें. इससे वीडियो चलाने की प्रोसेस शुरू हो जाएगी.

function loadStream(streamID) {
  hls.loadSource(url);
  hls.attachMedia(videoElement);
  
  // Timed metadata is passed HLS stream events to the streamManager.
  hls.on(Hls.Events.FRAG_PARSING_METADATA, parseID3Events);
  hls.on(Hls.Events.MANIFEST_PARSED, startPlayback);
}

function parseID3Events(event, data) {
  if (streamManager && data) {
    // For each ID3 tag in the metadata, pass in the type - ID3, the
    // tag data (a byte array), and the presentation timestamp (PTS).
    data.samples.forEach((sample) => {
      streamManager.processMetadata('ID3', sample.data, sample.pts);
    });
  }
}

function startPlayback() {
  console.log('Video Play');
  videoElement.play();
}

DASH.js (DASH स्ट्रीम फ़ॉर्मैट, लाइव और वीओडी स्ट्रीम टाइप)

अगर DASH.js प्लेयर का इस्तेमाल किया जा रहा है, तो लाइव या वीओडी स्ट्रीम के लिए ID3 मेटाडेटा को सुनने के लिए, आपको अलग-अलग स्ट्रिंग का इस्तेमाल करना होगा:

• लाइव स्ट्रीम: 'https://developer.apple.com/streaming/emsg-id3'
• वीओडी स्ट्रीम: 'urn:google:dai:2018'

StreamManager.processMetadata() की मदद से, SDK टूल को ID3 मेटाडेटा पास करें.

वीडियो के सभी कॉन्टेंट के लोड होने और तैयार होने के बाद, वीडियो के कंट्रोल अपने-आप दिखाने के लिए, DASH.js MANIFEST_LOADED इवेंट को सुनें.

const googleLiveSchema = 'https://developer.apple.com/streaming/emsg-id3';
const googleVodSchema = 'urn:google:dai:2018';
dashPlayer.on(googleLiveSchema, processMetadata);
dashPlayer.on(googleVodSchema, processMetadata);
dashPlayer.on(dashjs.MediaPlayer.events.MANIFEST_LOADED, loadlistener);

function processMetadata(metadataEvent) {
  const messageData = metadataEvent.event.messageData;
  const timestamp = metadataEvent.event.calculatedPresentationTime;

  // Use StreamManager.processMetadata() if your video player provides raw
  // ID3 tags, as with dash.js.
  streamManager.processMetadata('ID3', messageData, timestamp);
}

function loadlistener() {
  showControls();

  // This listener must be removed, otherwise it triggers as addional
  // manifests are loaded. The manifest is loaded once for the content,
  // but additional manifests are loaded for upcoming ad breaks.
  dashPlayer.off(dashjs.MediaPlayer.events.MANIFEST_LOADED, loadlistener);
}

लाइव स्ट्रीम के साथ Shaka Player (DASH स्ट्रीम फ़ॉर्मैट)

अगर लाइव स्ट्रीम चलाने के लिए Shaka प्लेयर का इस्तेमाल किया जा रहा है, तो मेटाडेटा इवेंट सुनने के लिए स्ट्रिंग 'emsg' का इस्तेमाल करें. इसके बाद, StreamManager.onTimedMetadata() को कॉल करने के लिए, इवेंट मैसेज के डेटा का इस्तेमाल करें.

shakaPlayer.addEventListener('emsg', (event) => onEmsgEvent(event));

function onEmsgEvent(metadataEvent) {
  // Use StreamManager.onTimedMetadata() if your video player provides
  // processed metadata, as with Shaka player livestreams.
  streamManager.onTimedMetadata({'TXXX': metadataEvent.detail.messageData});
}

वीओडी स्ट्रीम (DASH स्ट्रीम फ़ॉर्मैट) वाला Shaka Player

अगर वीओडी स्ट्रीम चलाने के लिए Shaka प्लेयर का इस्तेमाल किया जा रहा है, तो मेटाडेटा इवेंट सुनने के लिए 'timelineregionenter' स्ट्रिंग का इस्तेमाल करें. इसके बाद, स्ट्रिंग 'urn:google:dai:2018' के साथ StreamManager.processMetadata() के लिए, अपने कॉल में इवेंट मैसेज डेटा का इस्तेमाल करें.

shakaPlayer.addEventListener('timelineregionenter', (event) => onTimelineEvent(event));

function onTimelineEvent(metadataEvent) {
  const detail = metadataEvent.detail;
  if ( detail.eventElement.attributes &&
       detail.eventElement.attributes['messageData'] &&
       detail.eventElement.attributes['messageData'].value ) {
        const mediaId = detail.eventElement.attributes['messageData'].value;
        const pts = detail.startTime;
        // Use StreamManager.processMetadata() if your video player provides raw
        // ID3 tags, as with Shaka player VOD streams.
        streamManager.processMetadata('urn:google:dai:2018', mediaId, pts);
       }
}

प्लेयर इवेंट मैनेज करना

वीडियो एलिमेंट के pause और start इवेंट में इवेंट लिसनर जोड़ें, ताकि उपयोगकर्ता विज्ञापन के ब्रेक के दौरान एसडीके टूल के रुकने पर, वीडियो चलाना फिर से शुरू कर सके.

function loadStream(streamUrl) {
  ...
  
  videoElement.addEventListener('pause', onStreamPause);
  videoElement.addEventListener('play', onStreamPlay);
}

function onStreamPause() {
  console.log('paused');
  if (isAdBreak) {
    videoElement.controls = true;
    adUiElement.style.display = 'none';
  }
}

function onStreamPlay() {
  console.log('played');
  if (isAdBreak) {
    videoElement.controls = false;
    adUiElement.style.display = 'block';
  }
}

IMA DAI ऐसेट को हटाना

IMA DAI SDK की मदद से, पॉड सेर्विंग स्ट्रीम में विज्ञापनों का अनुरोध करने और उन्हें दिखाने के बाद, हमारा सुझाव है कि पॉड सेर्विंग सेशन पूरा होने के बाद, सभी संसाधनों को हटा दें. स्ट्रीम का प्लेबैक रोकने, विज्ञापन की सभी ट्रैकिंग रोकने, और लोड की गई सभी स्ट्रीम ऐसेट को रिलीज़ करने के लिए, StreamManager.destroy() को कॉल करें.

SDK की ज़्यादा बेहतर सुविधाओं के बारे में जानने के लिए, अन्य गाइड या GitHub पर सैंपल देखें.