डीएआई की पूरी सेवा के साथ सेट अप करना

प्लैटफ़ॉर्म चुनें: HTML5 Android iOS tvOS Cast Roku

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

आईएमए डीएआई के बारे में खास जानकारी

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

  • StreamRequest— VODStreamRequest या LiveStreamRequest: यह एक ऐसा ऑब्जेक्ट है जो स्ट्रीम के अनुरोध के बारे में बताता है. स्ट्रीम के अनुरोध, मांग पर वीडियो या लाइव स्ट्रीम के लिए हो सकते हैं. लाइव स्ट्रीम के अनुरोधों में ऐसेट कुंजी की जानकारी दी जाती है. वहीं, वीओडी के अनुरोधों में कॉन्टेंट मैनेजमेंट सिस्टम आईडी और वीडियो आईडी की जानकारी दी जाती है. दोनों तरह के अनुरोधों में, एपीआई पासकोड को शामिल किया जा सकता है. इसकी ज़रूरत, चुनिंदा स्ट्रीम को ऐक्सेस करने के लिए होती है. साथ ही, इनमें Google Ad Manager नेटवर्क कोड को भी शामिल किया जा सकता है. इसकी ज़रूरत, IMA SDK को होती है, ताकि वह Google Ad Manager की सेटिंग में बताए गए विज्ञापन आइडेंटिफ़ायर को मैनेज कर सके.
  • StreamManager: यह एक ऐसा ऑब्जेक्ट है जो डाइनैमिक ऐड इंसर्शन स्ट्रीम और डीएआई बैकएंड के साथ इंटरैक्शन को मैनेज करता है. स्ट्रीम मैनेजर, ट्रैकिंग पिंग को भी मैनेज करता है. साथ ही, स्ट्रीम और विज्ञापन इवेंट को पब्लिशर को फ़ॉरवर्ड करता है.

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

  • तीन खाली फ़ाइलें
    • dai.html
    • dai.css
    • dai.js
  • आपके कंप्यूटर पर Python इंस्टॉल होना चाहिए या टेस्टिंग के लिए वेब सर्वर होना चाहिए

डेवलपमेंट सर्वर शुरू करना

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

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

    python -m http.server 8000

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

    इसके अलावा, किसी दूसरे वेब सर्वर का भी इस्तेमाल किया जा सकता है. जैसे, Apache HTTP Server.

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

सबसे पहले, dai.html में बदलाव करके, एचटीएमएल5 वीडियो एलिमेंट और क्लिकथ्रू के लिए इस्तेमाल किया जाने वाला div बनाएं. यहां दिए गए उदाहरण में, आईएमए डीएआई एसडीके को इंपोर्ट किया गया है. ज़्यादा जानकारी के लिए, आईएमए डीएआई एसडीके इंपोर्ट करना लेख पढ़ें.

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

<html>
<head>
  <script src="https://cdn.jsdelivr.net/npm/hls.js@latest"></script>
  <script src="//imasdk.googleapis.com/js/sdkloader/ima3_dai.js"></script>
  <script src="dai.js"></script>
  <link rel="stylesheet" href="dai.css">
</head>
<body onLoad="initPlayer()">
  <h2>IMA SDK DAI Demo (HLS.JS)</h2>
  <video id="video"></video>
  <div id="adUi"></div>
  <button id="play-button">Play</button>
</body>
</html>


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

#adUi {
  cursor: pointer;
}

#play-button {
  position: absolute;
  top: 400px;
  left: 15px;
}

// This stream will be played if ad-enabled playback fails.
const BACKUP_STREAM =
    'http://storage.googleapis.com/testtopbox-public/video_content/bbb/' +
    'master.m3u8';

// Live stream asset key.
// const TEST_ASSET_KEY = 'c-rArva4ShKVIAkNfy6HUQ';

// VOD content source and video IDs.
const TEST_CONTENT_SOURCE_ID = '2548831';
const TEST_VIDEO_ID = 'tears-of-steel';

// Ad Manager network code.
const NETWORK_CODE = '21775744923';
const API_KEY = null;

// StreamManager which will be used to request ad-enabled streams.
let streamManager;

// hls.js video player
const hls = new Hls();

// Video element
let videoElement;

// Ad UI element
let adUiElement;

// The play/resume button
let playButton;

// Whether the stream is currently in an ad break.
let adBreak = false;

/**
 * Initializes the video player.
 */
function initPlayer() {
  videoElement = document.getElementById('video');
  playButton = document.getElementById('play-button');
  adUiElement = document.getElementById('adUi');
  createStreamManager();
  listenForMetadata();

  // Show the video controls when the video is paused during an ad break,
  // and hide them when ad playback resumes.
  videoElement.addEventListener('pause', () => {
    if (adBreak) {
      showVideoControls();
    }
  });
  videoElement.addEventListener('play', () => {
    if (adBreak) {
      hideVideoControls();
    }
  });

  playButton.addEventListener('click', () => {
    console.log('initiatePlayback');
    requestStream();
    // Hide this play button after the first click to request the stream.
    playButton.style.display = 'none';
  });
}

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

/**
 * Hides the video controls.
 */
function hideVideoControls() {
  videoElement.controls = false;
  adUiElement.style.display = 'block';
}

/**
 * Shows the video controls.
 */
function showVideoControls() {
  videoElement.controls = true;
  adUiElement.style.display = 'none';
}

आईएमए डीएआई एसडीके लोड करना

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

<script src="//imasdk.googleapis.com/js/sdkloader/ima3_dai.js"></script>

StreamManager को शुरू करना

विज्ञापनों के सेट का अनुरोध करने के लिए, ima.dai.api.StreamManager बनाएं. यह डीएआई स्ट्रीम का अनुरोध करने और उन्हें मैनेज करने के लिए ज़िम्मेदार होता है. कंस्ट्रक्टर, विज्ञापन पर होने वाले क्लिक को मैनेज करने के लिए, वीडियो एलिमेंट और विज्ञापन के यूज़र इंटरफ़ेस (यूआई) एलिमेंट का इस्तेमाल करता है.

/**
 * Create the StreamManager and listen to stream events.
 */
function createStreamManager() {
  streamManager =
      new google.ima.dai.api.StreamManager(videoElement, adUiElement);
  streamManager.addEventListener(
      google.ima.dai.api.StreamEvent.Type.LOADED, onStreamEvent);
  streamManager.addEventListener(
      google.ima.dai.api.StreamEvent.Type.ERROR, onStreamEvent);
  streamManager.addEventListener(
      google.ima.dai.api.StreamEvent.Type.AD_BREAK_STARTED, onStreamEvent);
  streamManager.addEventListener(
      google.ima.dai.api.StreamEvent.Type.AD_BREAK_ENDED, onStreamEvent);
}

स्ट्रीम का अनुरोध करना

स्ट्रीम का अनुरोध करने के लिए फ़ंक्शन तय करें. इस उदाहरण में, वीओडी और लाइव स्ट्रीम, दोनों के लिए फ़ंक्शन शामिल हैं. ये फ़ंक्शन, VODStreamRequest क्लास और LiveStreamRequest क्लास के इंस्टेंस बनाते हैं. streamRequest इंस्टेंस मिलने के बाद, स्ट्रीम अनुरोध इंस्टेंस के साथ streamManager.requestStream() वाले तरीके को कॉल करें.

/**
 * Makes a stream request and plays the stream.
 */
function requestStream() {
  requestVODStream(TEST_CONTENT_SOURCE_ID, TEST_VIDEO_ID, NETWORK_CODE, API_KEY);
  // Uncomment line below and comment one above to request a LIVE stream.
  // requestLiveStream(TEST_ASSET_KEY, NETWORK_CODE, API_KEY);
}

/**
 * Requests a Live stream with ads.
 * @param {string} assetKey
 * @param {?string} networkCode
 * @param {?string} apiKey
 */
function requestLiveStream(assetKey, networkCode, apiKey) {
  const streamRequest = new google.ima.dai.api.LiveStreamRequest();
  streamRequest.assetKey = assetKey;
  streamRequest.networkCode = networkCode;
  streamRequest.apiKey = apiKey;
  streamManager.requestStream(streamRequest);
}

/**
 * Requests a VOD stream with ads.
 * @param {string} cmsId
 * @param {string} videoId
 * @param {?string} networkCode
 * @param {?string} apiKey
 */
function requestVODStream(cmsId, videoId, networkCode, apiKey) {
  const streamRequest = new google.ima.dai.api.VODStreamRequest();
  streamRequest.contentSourceId = cmsId;
  streamRequest.videoId = videoId;
  streamRequest.networkCode = networkCode;
  streamRequest.apiKey = apiKey;
  streamManager.requestStream(streamRequest);
}

स्ट्रीम के अनुरोध के दोनों तरीकों में, एपीआई पासकोड का इस्तेमाल करना ज़रूरी नहीं है. अगर सुरक्षित स्ट्रीम का इस्तेमाल किया जा रहा है, तो आपको डीएआई की पुष्टि करने वाली कुंजी बनानी होगी. ज़्यादा जानकारी के लिए, डीएआई वीडियो स्ट्रीम के अनुरोधों की पुष्टि करना लेख पढ़ें. इस उदाहरण में, किसी भी स्ट्रीम को डीएआई की पुष्टि करने वाली कुंजी का इस्तेमाल करके सुरक्षित नहीं किया गया है. इसलिए, apiKey का इस्तेमाल नहीं किया गया है.

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

आपको टाइम किए गए मेटाडेटा इवेंट को सुनने के लिए एक हैंडलर भी जोड़ना होगा. साथ ही, इवेंट को StreamManager क्लास में फ़ॉरवर्ड करना होगा, ताकि आईएमए, विज्ञापन के लिए ब्रेक के दौरान विज्ञापन इवेंट दिखा सके:

/**
 * Set up metadata listeners to pass metadata to the StreamManager.
 */
function listenForMetadata() {
  // Timed metadata is handled differently by different video players, and the
  // IMA SDK provides two ways to pass in metadata,
  // StreamManager.processMetadata() and StreamManager.onTimedMetadata().
  //
  // Use StreamManager.onTimedMetadata() if your video player parses
  // the metadata itself.
  // Use StreamManager.processMetadata() if your video player provides raw
  // ID3 tags, as with hls.js.
  hls.on(Hls.Events.FRAG_PARSING_METADATA, function(event, data) {
    if (streamManager && data) {
      // For each ID3 tag in our metadata, we pass in the type - ID3, the
      // tag data (a byte array), and the presentation timestamp (PTS).
      data.samples.forEach(function(sample) {
        streamManager.processMetadata('ID3', sample.data, sample.pts);
      });
    }
  });
}

इस गाइड में, स्ट्रीम प्लेबैक के लिए hls.js प्लेयर का इस्तेमाल किया गया है. हालांकि, मेटाडेटा को लागू करने का तरीका, आपके इस्तेमाल किए जा रहे प्लेयर के टाइप पर निर्भर करता है.

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

वीडियो के मुख्य इवेंट के लिए, इवेंट लिसनर लागू करें. इस उदाहरण में, onStreamEvent() फ़ंक्शन को कॉल करके, LOADED, ERROR, AD_BREAK_STARTED, और AD_BREAK_ENDED इवेंट को मैनेज किया गया है. यह फ़ंक्शन, स्ट्रीम लोड होने, स्ट्रीम से जुड़ी गड़बड़ियों, और विज्ञापन चलने के दौरान प्लेयर कंट्रोल बंद करने की सुविधा को मैनेज करता है. IMA SDK के लिए, यह ज़रूरी है.

/**
 * Responds to a stream event.
 * @param {!google.ima.dai.api.StreamEvent} e
 */
function onStreamEvent(e) {
  switch (e.type) {
    case google.ima.dai.api.StreamEvent.Type.LOADED:
      console.log('Stream loaded');
      loadUrl(e.getStreamData().url);
      break;
    case google.ima.dai.api.StreamEvent.Type.ERROR:
      console.log('Error loading stream, playing backup stream.' + e);
      loadUrl(BACKUP_STREAM);
      break;
    case google.ima.dai.api.StreamEvent.Type.AD_BREAK_STARTED:
      console.log('Ad Break Started');
      adBreak = true;
      hideVideoControls();
      break;
    case google.ima.dai.api.StreamEvent.Type.AD_BREAK_ENDED:
      console.log('Ad Break Ended');
      adBreak = false;
      showVideoControls();
      break;
    default:
      break;
  }
}

/**
 * Loads and plays a Url.
 * @param {string} url
 */
function loadUrl(url) {
  console.log('Loading:' + url);
  hls.loadSource(url);
  hls.attachMedia(videoElement);
  hls.on(Hls.Events.MANIFEST_PARSED, function() {
    console.log('Video Play');
    videoElement.play();
  });
}

स्ट्रीम लोड होने पर, वीडियो प्लेयर loadUrl() फ़ंक्शन का इस्तेमाल करके, दिए गए यूआरएल को लोड करता है और चलाता है.

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