लाइव स्ट्रीम के लिए, क्लाइंट-साइड एचएलएस इंटरस्टीशियल का इस्तेमाल करना

एचएलएस इंटरस्टीशियल स्पेसिफ़िकेशन, वीडियो या ऑडियो स्ट्रीम में विज्ञापन शेड्यूल करने और डालने का एक आसान तरीका है. क्लाइंट-साइड अप्रोच में, आपका ऐप्लिकेशन यह तय करता है कि विज्ञापन ब्रेक के लिए कब अनुरोध करना है और उन्हें कब चलाना है. इसके लिए, वह AVPlayerInterstitialEvent क्लास बनाता है. इस तरीके के लिए, कॉन्टेंट स्ट्रीम के मेनिफ़ेस्ट में EXT-X-DATERANGE टैग की ज़रूरत नहीं होती. क्लाइंट-साइड HLS इंटरस्टीशियल की मदद से, किसी भी कॉन्टेंट में डाइनैमिक तरीके से विज्ञापन डाले जा सकते हैं. इसके लिए, स्ट्रीम मेनिफ़ेस्ट या मीडिया फ़ाइलों में बदलाव करने की ज़रूरत नहीं होती.

इस गाइड में, इंटरैक्टिव मीडिया विज्ञापन (आईएमए) एसडीके को वीडियो प्लेयर ऐप्लिकेशन में इंटिग्रेट करने के बारे में बताया गया है. यह ऐप्लिकेशन, सर्वर गाइडेड ऐड इंसर्शन (एसजीएआई) लाइव स्ट्रीम सेशन बनाता है और क्लाइंट-साइड पर इंटरस्टीशियल विज्ञापन शेड्यूल करता है. ज़्यादा जानकारी के लिए, सर्वर गाइडेड डीएआई देखें.

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

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

  • यूज़र इंटरफ़ेस के लिए Storyboard का इस्तेमाल करके, नया Xcode प्रोजेक्ट. ज़्यादा जानकारी के लिए, किसी ऐप्लिकेशन के लिए Xcode प्रोजेक्ट बनाना लेख पढ़ें.

  • Google IMA SDK. ज़्यादा जानकारी के लिए, DAI के लिए IMA SDK सेट अप करना लेख पढ़ें.

  • लाइव स्ट्रीम के लिए, DAI के अनुरोध से जुड़े ये पैरामीटर:

    • NETWORK_CODE: यह आपका Google Ad Manager नेटवर्क कोड है.
    • CUSTOM_ASSET_KEY: आपकी कस्टम स्ट्रिंग, जो DAI लाइवस्ट्रीम इवेंट की पहचान करती है. लाइव स्ट्रीम वाले इवेंट में, पॉड सर्विंग मेनिफ़ेस्ट का डीएआई टाइप होना चाहिए.

स्टोरीबोर्ड को कॉन्फ़िगर करना

अपनी iPhone.storyboard फ़ाइल में, यह तरीका अपनाएं:

  1. वीडियो प्लेयर और विज्ञापन यूज़र इंटरफ़ेस (यूआई) के लिए कंटेनर के तौर पर UIView ऑब्जेक्ट बनाएं.
  2. UIView ऑब्जेक्ट से कनेक्ट करने के लिए, ViewController क्लास की adUIView प्रॉपर्टी बनाएं.
  3. adUIView ऑब्जेक्ट में, एक UIButton बनाएं, ताकि वह प्ले बटन के तौर पर काम कर सके.
  4. UIButton ऑब्जेक्ट से कनेक्ट करने के लिए, ViewController क्लास की playButton प्रॉपर्टी बनाएं. साथ ही, उपयोगकर्ता के टैप को हैंडल करने के लिए onPlayButtonTouch फ़ंक्शन बनाएं.

विज्ञापन लोडर को शुरू करना

मुख्य व्यू कंट्रोलर के viewDidLoad इवेंट में, यह तरीका अपनाएं:

  1. AVPlayer और AVPlayerLayer क्लास का इस्तेमाल करके, वीडियो प्लेयर सेट अप करें.
  2. IMAAdDisplayContainer और IMAAVPlayerVideoDisplay ऑब्जेक्ट बनाएं. विज्ञापन दिखाने वाला कंटेनर, IMA DAI SDK के लिए adUIView तय करता है, ताकि विज्ञापन यूज़र इंटरफ़ेस (यूआई) के सबव्यू डाले जा सकें. वीडियो डिसप्ले ऑब्जेक्ट, IMA DAI SDK के विज्ञापन लॉजिक और AVFoundation के प्लेबैक सिस्टम के बीच एक पुल की तरह काम करता है. यह वीडियो विज्ञापनों के प्लेबैक को ट्रैक करता है.
  3. विज्ञापन दिखाने और विज्ञापन के यूज़र इंटरफ़ेस (यूआई) को स्थानीय भाषा में दिखाने की सेटिंग के साथ IMAAdsLoader ऑब्जेक्ट को शुरू करें.

इस उदाहरण में, ads loader को एक खाली IMASettings ऑब्जेक्ट के साथ शुरू किया गया है:

import AVFoundation
import GoogleInteractiveMediaAds
import UIKit

// The main view controller for the sample app.
class ViewController:
  UIViewController, IMAAdsLoaderDelegate, IMAStreamManagerDelegate
{

  private enum StreamParameters {
    static let contentStream =
      "https://devstreaming-cdn.apple.com/videos/streaming/examples/bipbop_16x9/bipbop_16x9_variant.m3u8"

    // Find your [Google Ad Manager network code](https://support.google.com/admanager/answer/7674889)
    // or use the test network code and custom asset key with the DAI type "Pod serving manifest"
    // from [DAI sample streams](https://developers.google.com/ad-manager/dynamic-ad-insertion/streams#pod_serving_dai).

    /// Google Ad Manager network code.
    static let networkCode = "21775744923"

    /// Google DAI livestream custom asset key.
    static let customAssetKey = "sgai-hls-live"

    // Set your ad break duration.
    static let adBreakDurationMs = 10000
  }

  /// The play button to start the stream.
  /// It is hidden when the stream starts playing.
  @IBOutlet private weak var playButton: UIButton!

  /// The view to display the ad UI elements: countdown, skip button, etc.
  /// It is hidden when the stream starts playing.
  @IBOutlet private weak var adUIView: UIView!

  /// The reference of your ad UI view for the IMA SDK to create the ad's user interface elements.
  private var adDisplayContainer: IMAAdDisplayContainer!

  /// The AVPlayer instance that plays the content and the ads.
  private var player: AVPlayer!

  /// The reference of your video player for the IMA SDK to play and monitor the ad breaks.
  private var videoDisplay: IMAAVPlayerVideoDisplay!

  /// The entry point of the IMA SDK to make stream requests to Google Ad Manager.
  private var adsLoader: IMAAdsLoader!

  /// The reference of the ad stream manager, set when the ad stream is loaded.
  /// The IMA SDK requires a strong reference to the stream manager for the entire duration of
  /// the ad break.
  private var streamManager: IMAStreamManager?

  /// The ad stream session ID, set when the ad stream is loaded.
  private var adStreamSessionId: String?

  override func viewDidLoad() {

    // Initialize the IMA SDK.
    let adLoaderSettings = IMASettings()
    adsLoader = IMAAdsLoader(settings: adLoaderSettings)

    // Set up the video player and the container view.
    player = AVPlayer()
    let playerLayer = AVPlayerLayer(player: player)
    playerLayer.frame = adUIView.bounds
    adUIView.layer.addSublayer(playerLayer)
    playButton.layer.zPosition = CGFloat.greatestFiniteMagnitude

    // Create an object to monitor the stream playback.
    videoDisplay = IMAAVPlayerVideoDisplay(avPlayer: player)

    super.viewDidLoad()

    // Create a container object for ad UI elements.
    // See [example in video ads](https://support.google.com/admanager/answer/2695279#zippy=%2Cexample-in-video-ads)
    adDisplayContainer = IMAAdDisplayContainer(
      adContainer: adUIView, viewController: self, companionSlots: nil)

    // Specify the delegate for hanlding ad events of the stream session.
    adsLoader.delegate = self
  }
ViewController.swift

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

कॉन्टेंट स्ट्रीम के लिए विज्ञापनों का अनुरोध करने के लिए, IMAPodStreamRequest ऑब्जेक्ट बनाएं और इसे अपने IMAAdsLoader इंस्टेंस को पास करें. इसके अलावा, अपनी स्ट्रीम के लिए डीएआई के विकल्प और टारगेटिंग पैरामीटर उपलब्ध कराने के लिए, adTagParameters प्रॉपर्टी सेट करें.

इस उदाहरण में, viewDidAppear इवेंट में loadAdStream तरीके को कॉल किया गया है:

override func viewDidAppear(_ animated: Bool) {
  super.viewDidAppear(animated)

  loadAdStream()
  loadContentStream()
}

private func loadContentStream() {
  guard let contentURL = URL(string: StreamParameters.contentStream) else {
    print("Failed to load content stream. The URL is invalid.")
    return
  }
  let item = AVPlayerItem(url: contentURL)
  player.replaceCurrentItem(with: item)
}

/// Makes a stream request to Google Ad Manager.
private func loadAdStream() {
  let streamRequest = IMAPodStreamRequest(
    networkCode: StreamParameters.networkCode,
    customAssetKey: StreamParameters.customAssetKey,
    adDisplayContainer: adDisplayContainer,
    videoDisplay: videoDisplay,
    pictureInPictureProxy: nil,
    userContext: nil)

  // Register a streaming session on Google Ad Manager DAI servers.
  adsLoader.requestStream(with: streamRequest)
}
ViewController.swift

अपने प्रोडक्शन ऐप्लिकेशन में, उपयोगकर्ता के कॉन्टेंट स्ट्रीम चुनने के बाद loadAdStream तरीके को कॉल करें.

स्ट्रीम लोड होने से जुड़े इवेंट मैनेज करना

स्ट्रीम के अनुरोध के पूरा होने या न होने की स्थिति को मैनेज करने के लिए, IMAAdsLoaderDelegate प्रोटोकॉल लागू करें:

  • कार्रवाई पूरी होने पर, आपको IMAAdsLoadedData ऑब्जेक्ट मिलता है. इसमें IMAStreamManager शामिल होता है. यह कुकी, मौजूदा DAI सेशन के लिए streamManager.streamId वैल्यू को सेव करती है.
  • अगर ऐसा नहीं होता है, तो गड़बड़ी को लॉग करें.

यहां दिए गए उदाहरण में, स्ट्रीम लोड होने वाले इवेंट को हैंडल करने और स्ट्रीम लोड न होने वाले इवेंट को लॉग करने का तरीका बताया गया है:

// MARK: - IMAAdsLoaderDelegate
func adsLoader(_ loader: IMAAdsLoader, adsLoadedWith adsLoadedData: IMAAdsLoadedData) {
  guard let streamManager = adsLoadedData.streamManager else {
    // Report a bug on [IMA SDK forum](https://groups.google.com/g/ima-sdk).
    print("Failed to retrieve stream manager from ads loaded data.")
    return
  }
  // Save the stream manager to handle ad events of the stream session.
  self.streamManager = streamManager
  streamManager.delegate = self
  let adRenderingSettings = IMAAdsRenderingSettings()
  // Uncomment the next line to enable the current view controller to get notified of ad clicks.
  // adRenderingSettings.linkOpenerDelegate = self
  // Initialize the stream manager to create ad UI elements.
  streamManager.initialize(with: adRenderingSettings)

  guard streamManager.streamId != nil else {
    // Report a bug on [IMA SDK forum](https://groups.google.com/g/ima-sdk).
    print("Failed to retrieve stream ID from stream manager.")
    return
  }
  // Save the ad stream session ID to construct ad pod requests.
  adStreamSessionId = streamManager.streamId
}

func adsLoader(_ loader: IMAAdsLoader, failedWith adErrorData: IMAAdLoadingErrorData) {
  guard let errorMessage = adErrorData.adError.message else {
    print("Stream registration failed with unknown error.")
    return
  }
  print("Stream registration failed with error: \(errorMessage)")
}

// MARK: - IMAStreamManagerDelegate
func streamManager(_ streamManager: IMAStreamManager, didReceive error: IMAAdError) {
  guard let errorMessage = error.message else {
    print("Ad stream failed to load with unknown error.")
    return
  }
  print("Ad stream failed to load with error: \(errorMessage)")
}
ViewController.swift

विज्ञापन दिखाने का समय शेड्यूल करना

विज्ञापन ब्रेक शेड्यूल करने के लिए, AVPlayerInterstitialEvent ऑब्जेक्ट बनाएं. इवेंट ऑब्जेक्ट की templateItems प्रॉपर्टी को AVPlayerItem ऑब्जेक्ट की एक ऐरे पर सेट करें. इसमें हर आइटम ऑब्जेक्ट, विज्ञापन पॉड के मेनिफ़ेस्ट यूआरएल को सेव करता है.

विज्ञापन पॉड मेनिफ़ेस्ट यूआरएल बनाने के लिए, तरीका: एचएलएस पॉड मेनिफ़ेस्ट दस्तावेज़ पढ़ें.

उदाहरण के तौर पर, यहां दिए गए उदाहरण में कॉन्टेंट की लाइव स्ट्रीम के मौजूदा समय का इस्तेमाल करके, पॉड आइडेंटिफ़ायर स्ट्रिंग जनरेट की गई है. generatePodIdentifier फ़ंक्शन, पॉड आइडेंटिफ़ायर को ad_break_id/mid-roll-{minute} के तौर पर दिखाता है.

/// Generates a pod identifier based on the current time.
///
/// See [HLS pod manifest parameters](https://developers.google.com/ad-manager/dynamic-ad-insertion/api/pod-serving/reference/live#path_parameters_3).
///
/// - Returns: The pod identifier in either the format of "pod/{integer}" or "ad_break_id/{string}".
private func generatePodIdentifier(from currentSeconds: Int) -> String {
  let minute = Int(currentSeconds / 60) + 1
  return "ad_break_id/mid-roll-\(minute)"
}
ViewController.swift

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

नीचे दिए गए उदाहरण में, विज्ञापन के लिए ब्रेक को शेड्यूल किया गया है. इससे उपयोगकर्ता के 'चलाएं' बटन पर क्लिक करने के दो मिनट के अंदर विज्ञापन दिखने लगेगा:

/// Schedules ad insertion shortly before ad break starts.
private func scheduleAdInsertion() {

  guard let streamID = self.adStreamSessionId else {
    print("The ad stream ID is not set. Skipping all ad breaks of the current stream session.")
    return
  }

  let currentSeconds = Int(Date().timeIntervalSince1970)
  var secondsToAdBreakStart = 60 - currentSeconds % 60
  // If there is less than 30 seconds remaining in the current minute, schedule the ad insertion
  // for the next minute instead.
  if secondsToAdBreakStart < 30 {
    secondsToAdBreakStart += 60
  }

  guard let primaryPlayerCurrentItem = player.currentItem else {
    print(
      "Failed to get the player item of the content stream. Skipping an ad break in \(secondsToAdBreakStart) seconds."
    )
    return
  }

  let adBreakStartTime = CMTime(
    seconds: CMTimeGetSeconds(player.currentTime())
      + Double(secondsToAdBreakStart), preferredTimescale: 1)

  // Create an identifier to construct the ad pod request for the next ad break.
  let adPodIdentifier = generatePodIdentifier(from: currentSeconds)

  guard
    let adPodManifestUrl = URL(
      string:
        "https://dai.google.com/linear/pods/v1/hls/network/\(StreamParameters.networkCode)/custom_asset/\(StreamParameters.customAssetKey)/\(adPodIdentifier).m3u8?stream_id=\(streamID)&pd=\(StreamParameters.adBreakDurationMs)"
    )
  else {
    print("Failed to generate the ad pod manifest URL. Skipping insertion of \(adPodIdentifier).")
    return
  }

  let interstitialEvent = AVPlayerInterstitialEvent(
    primaryItem: primaryPlayerCurrentItem,
    identifier: adPodIdentifier,
    time: adBreakStartTime,
    templateItems: [AVPlayerItem(url: adPodManifestUrl)],
    restrictions: [],
    resumptionOffset: .zero)
  let interstitialEventController = AVPlayerInterstitialEventController(primaryPlayer: player)
  interstitialEventController.events = [interstitialEvent]
  print(
    "Ad break scheduled to start in \(secondsToAdBreakStart) seconds. Ad break manifest URL: \(adPodManifestUrl)."
  )
}
ViewController.swift

scheduleAdInsertion तरीके से, विज्ञापन ब्रेक शुरू होने का समय कैलकुलेट किया जाता है. साथ ही, विज्ञापन पॉड के मेनिफ़ेस्ट का यूआरएल बनाया जाता है. AVPlayerInterstitialEvent ऑब्जेक्ट बनाने के लिए, इस यूआरएल का इस्तेमाल करें.

अगर चाहें, तो विज्ञापन दिखाने के दौरान उपयोगकर्ता को स्किप करने या रिवाइंड करने से रोकने के लिए, AVPlayerInterstitialEvent.Restrictions स्ट्रक्चर का इस्तेमाल करें.

विज्ञापन इवेंट मैनेज करना

विज्ञापन इवेंट मैनेज करने के लिए, IMAStreamManagerDelegate प्रोटोकॉल लागू करें. इस तरीके से, विज्ञापन ब्रेक के शुरू और खत्म होने का समय ट्रैक किया जा सकता है. साथ ही, अलग-अलग विज्ञापनों के बारे में जानकारी पाई जा सकती है.

func streamManager(_ streamManager: IMAStreamManager, didReceive event: IMAAdEvent) {
  switch event.type {
  case IMAAdEventType.STARTED:
    // Log extended data.
    if let ad = event.ad {
      let extendedAdPodInfo = String(
        format: "Showing ad %zd/%zd, bumper: %@, title: %@, "
          + "description: %@, contentType:%@, pod index: %zd, "
          + "time offset: %lf, max duration: %lf.",
        ad.adPodInfo.adPosition,
        ad.adPodInfo.totalAds,
        ad.adPodInfo.isBumper ? "YES" : "NO",
        ad.adTitle,
        ad.adDescription,
        ad.contentType,
        ad.adPodInfo.podIndex,
        ad.adPodInfo.timeOffset,
        ad.adPodInfo.maxDuration)

      print("\(extendedAdPodInfo)")
    }
    break
  case IMAAdEventType.AD_BREAK_STARTED:
    print("Ad break started.")
    break
  case IMAAdEventType.AD_BREAK_ENDED:
    print("Ad break ended.")
    break
  case IMAAdEventType.AD_PERIOD_STARTED:
    print("Ad period started.")
    break
  case IMAAdEventType.AD_PERIOD_ENDED:
    print("Ad period ended.")
    break
  default:
    break
  }
}
ViewController.swift

अपना ऐप्लिकेशन चलाएं. अगर यह सही तरीके से काम करता है, तो पॉड दिखाने वाले मेनिफ़ेस्ट स्ट्रीम का इस्तेमाल करके, पेज पर अचानक दिखने वाले विज्ञापनों का अनुरोध किया जा सकता है और उन्हें चलाया जा सकता है.