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

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

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

पॉड के तौर पर काम करने वाला डीएआई

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

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

IMA डीएआई 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 एचटीटीपी सर्वर के तौर पर.

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

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

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

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

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

• STREAM_URL: सिर्फ़ लाइव स्ट्रीम के लिए इस्तेमाल किया जाता है. वीडियो स्ट्रीम का यूआरएल, जो आपके मेनिफ़ेस्ट मैनिप्युलेटर या पॉड सर्विंग का इस्तेमाल करने वाले तीसरे पक्ष के पार्टनर ने दिया है. इसे ऐसा होना चाहिए इसके लिए, आपको पहले IMA डीएआई SDK टूल से मिला स्ट्रीम आईडी डालना होगा कोई अनुरोध करो. इस मामले में, स्ट्रीम के यूआरएल में एक प्लेसहोल्डर, [[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);
}

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

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

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

अगर HLS.js प्लेयर का इस्तेमाल किया जा रहा है, तो यह सुनें HLS.js FRAG_PARSING_METADATA इवेंट को ID3 मेटाडेटा के तौर पर पाने और उसे 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 Player का इस्तेमाल लाइव स्ट्रीम चलाने की सुविधा, मेटाडेटा इवेंट को सुनने के लिए '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' स्ट्रिंग का इस्तेमाल करें. फिर, StreamManager.processMetadata() स्ट्रिंग 'urn:google:dai:2018' के साथ.

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 इवेंट में इवेंट लिसनर जोड़ें जब विज्ञापन के लिए ब्रेक के दौरान SDK टूल रुक जाए, तब वीडियो चलाना फिर से शुरू किया जा सके.

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';
  }
}

हो गया! इस समय, पॉड सर्विंग स्ट्रीम में विज्ञापनों का अनुरोध किया जा रहा है और उन्हें दिखाया जा रहा है: HTML5 के लिए IMA डीएआई SDK टूल. SDK टूल की ज़्यादा बेहतर सुविधाओं के बारे में जानने के लिए, दूसरी गाइड या GitHub पर मौजूद सैंपल देखें.