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

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

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

पॉड में दिखाने के लिए डीएआई

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

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

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

  • IMAAdDisplayContainer – यह एक कंटेनर ऑब्जेक्ट है, जो वीडियो प्लेबैक एलिमेंट के ऊपर होता है. इसमें विज्ञापन के यूज़र इंटरफ़ेस (यूआई) एलिमेंट होते हैं.
  • IMAAdsLoader – ऐसा ऑब्जेक्ट जो स्ट्रीम का अनुरोध करता है और स्ट्रीम के अनुरोध के रिस्पॉन्स ऑब्जेक्ट से ट्रिगर होने वाले इवेंट को मैनेज करता है. आपको सिर्फ़ एक विज्ञापन लोडर इंस्टैंशिएट करना चाहिए. इसका इस्तेमाल, ऐप्लिकेशन के पूरे लाइफ़साइकल के दौरान किया जा सकता है.
  • IMAStreamRequest – IMAPodVODStreamRequest या IMAPodStreamRequest.
  • IMAStreamManager – यह एक ऐसा ऑब्जेक्ट है जो डाइनैमिक ऐड इंसर्शन स्ट्रीम और डीआई बैकएंड के साथ इंटरैक्शन को मैनेज करता है. स्ट्रीम मैनेजर, ट्रैकिंग पिंग को भी मैनेज करता है. साथ ही, पब्लिशर को स्ट्रीम और विज्ञापन इवेंट भी भेजता है.

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

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

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

आपको IMA SDK टूल से स्ट्रीम का अनुरोध करने के लिए इस्तेमाल किए जाने वाले पैरामीटर भी चाहिए.

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

नया Xcode प्रोजेक्ट बनाना

Xcode में, Objective-C का इस्तेमाल करके "PodServingExample" नाम का नया iOS प्रोजेक्ट बनाएं.

Xcode प्रोजेक्ट में IMA DAI SDK टूल जोड़ना

IMA DAI SDK इंस्टॉल करने के लिए, इन तीन में से किसी एक तरीके का इस्तेमाल करें.

CocoaPods का इस्तेमाल करके SDK टूल इंस्टॉल करना (इसका सुझाव दिया जाता है)

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

  1. PodServingExample.xcodeproj फ़ाइल वाली डायरेक्ट्री में, Podfile नाम की एक टेक्स्ट फ़ाइल बनाएं. इसके बाद, नीचे दिया गया कॉन्फ़िगरेशन जोड़ें:

    Podfile 
    source 'https://github.com/CocoaPods/Specs.git'

platform :ios, '14'

target 'PodServingExample' do
  pod 'GoogleAds-IMA-iOS-SDK'
end

    Podfile

  2. Podfile वाली डायरेक्ट्री में जाकर, यह चलाएं:

    pod install --repo-update

Swift Package Manager का इस्तेमाल करके SDK टूल इंस्टॉल करना

इंटरैक्टिव मीडिया विज्ञापन SDK टूल, 3.18.4 वर्शन से Swift Package Manager के साथ काम करता है. Swift पैकेज इंपोर्ट करने के लिए, यह तरीका अपनाएं.

  1. Xcode में, फ़ाइल > पैकेज जोड़ें पर जाकर, IMA DAI SDK Swift पैकेज इंस्टॉल करें.

  2. दिखने वाले प्रॉम्प्ट में, IMA DAI SDK टूल के Swift पैकेज का GitHub रिपॉज़िटरी खोजें:

    https://github.com/googleads/swift-package-manager-google-interactive-media-ads-ios

  3. IMA DAI SDK Swift पैकेज का वह वर्शन चुनें जिसका इस्तेमाल करना है. नए प्रोजेक्ट के लिए, हमारा सुझाव है कि आप अगले मेजर वर्शन तक का इस्तेमाल करें.

इसके बाद, Xcode आपके पैकेज की डिपेंडेंसी को हल करता है और उन्हें बैकग्राउंड में डाउनलोड करता है. पैकेज की डिपेंडेंसी जोड़ने के तरीके के बारे में ज़्यादा जानने के लिए, Apple का लेख पढ़ें.

SDK टूल को मैन्युअल तरीके से डाउनलोड और इंस्टॉल करना

अगर आपको Swift Package Manager या CocoaPods का इस्तेमाल नहीं करना है, तो IMA DAI SDK को डाउनलोड करके, उसे अपने प्रोजेक्ट में मैन्युअल तरीके से जोड़ा जा सकता है.

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

अपने मुख्य व्यू कंट्रोलर में वीडियो प्लेयर लागू करें. इसके लिए, यूज़र इंटरफ़ेस (यूआई) व्यू में रैप किए गए एवी प्लेयर का इस्तेमाल करें. IMA SDK, विज्ञापन के यूज़र इंटरफ़ेस (यूआई) एलिमेंट दिखाने के लिए, यूआई व्यू का इस्तेमाल करता है.

ViewController.m 
#import "ViewController.h"

#import <AVKit/AVKit.h>

/// Content URL.
static NSString *const kBackupContentUrl =
    @"http://devimages.apple.com/iphone/samples/bipbop/bipbopall.m3u8";

@interface ViewController ()
/// Play button.
@property(nonatomic, weak) IBOutlet UIButton *playButton;

@property(nonatomic, weak) IBOutlet UIView *videoView;
/// Video player.
@property(nonatomic, strong) AVPlayer *videoPlayer;
@end

@implementation ViewController

- (void)viewDidLoad {
  [super viewDidLoad];
  self.view.backgroundColor = [UIColor blackColor];

  // Load AVPlayer with the path to your content.
  NSURL *contentURL = [NSURL URLWithString:kBackupContentUrl];
  self.videoPlayer = [AVPlayer playerWithURL:contentURL];

  // Create a player layer for the player.
  AVPlayerLayer *playerLayer = [AVPlayerLayer playerLayerWithPlayer:self.videoPlayer];

  // Size, position, and display the AVPlayer.
  playerLayer.frame = self.videoView.layer.bounds;
  [self.videoView.layer addSublayer:playerLayer];
}

- (IBAction)onPlayButtonTouch:(id)sender {
  [self.videoPlayer play];
  self.playButton.hidden = YES;
}

@end

ViewController.m

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

अपने व्यू कंट्रोलर में IMA SDK इंपोर्ट करें. साथ ही, विज्ञापन लोडर और स्ट्रीम मैनेजर इवेंट को मैनेज करने के लिए, IMAAdsLoaderDelegate और IMAStreamManagerDelegate प्रोटोकॉल अपनाएं.

IMA SDK टूल के मुख्य कॉम्पोनेंट को सेव करने के लिए, ये निजी प्रॉपर्टी जोड़ें:

  • IMAAdsLoader - आपके ऐप्लिकेशन के पूरे लाइफ़टाइम के दौरान, स्ट्रीम के अनुरोधों को मैनेज करता है.
  • IMAAdDisplayContainer - विज्ञापन के यूज़र इंटरफ़ेस एलिमेंट को डालने और मैनेज करने की सुविधा देता है.
  • IMAAVPlayerVideoDisplay - यह IMA SDK टूल और आपके मीडिया प्लेयर के बीच कम्यूनिकेट करता है. साथ ही, समय के हिसाब से मेटाडेटा को मैनेज करता है.
  • IMAStreamManager - यह स्ट्रीम चलाने की सुविधा को मैनेज करता है और विज्ञापन से जुड़े इवेंट को ट्रिगर करता है.

व्यू लोड होने के बाद, विज्ञापन लोडर, विज्ञापन डिसप्ले कंटेनर, और वीडियो डिसप्ले को शुरू करें.

ViewController.m 
@import GoogleInteractiveMediaAds;

// ...

@interface ViewController () <IMAAdsLoaderDelegate, IMAStreamManagerDelegate>
/// The entry point for the IMA DAI SDK to make DAI stream requests.
@property(nonatomic, strong) IMAAdsLoader *adsLoader;
/// The container where the SDK renders each ad's user interface elements and companion slots.
@property(nonatomic, strong) IMAAdDisplayContainer *adDisplayContainer;
/// The reference of your video player for the IMA DAI SDK to monitor playback and handle timed
/// metadata.
@property(nonatomic, strong) IMAAVPlayerVideoDisplay *imaVideoDisplay;
/// References the stream manager from the IMA DAI SDK after successful stream loading.
@property(nonatomic, strong) IMAStreamManager *streamManager;

// ...

@end

@implementation ViewController

- (void)viewDidLoad {
  [super viewDidLoad];

  // ...

  self.adsLoader = [[IMAAdsLoader alloc] initWithSettings:nil];
  self.adsLoader.delegate = self;

  // Create an ad display container for rendering each ad's user interface elements and companion
  // slots.
  self.adDisplayContainer =
      [[IMAAdDisplayContainer alloc] initWithAdContainer:self.videoView
                                          viewController:self
                                          companionSlots:nil];

  // Create an IMAAVPlayerVideoDisplay to give the SDK access to your video player.
  self.imaVideoDisplay = [[IMAAVPlayerVideoDisplay alloc] initWithAVPlayer:self.videoPlayer];
}
ViewController.m

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

जब कोई उपयोगकर्ता प्ले बटन दबाता है, तो स्ट्रीम का नया अनुरोध करें. लाइव स्ट्रीम के लिए, IMAPodStreamRequest क्लास का इस्तेमाल करें. वीओडी स्ट्रीम के लिए, IMAPodVODStreamRequest क्लास का इस्तेमाल करें.

स्ट्रीम के अनुरोध के लिए, आपके स्ट्रीम पैरामीटर के साथ-साथ आपके विज्ञापन डिसप्ले कंटेनर और वीडियो डिसप्ले का रेफ़रंस भी ज़रूरी है.

ViewController.m 
- (IBAction)onPlayButtonTouch:(id)sender {
  [self requestStream];
  self.playButton.hidden = YES;
}

- (void)requestStream {
  // Create a stream request.
  IMAStreamRequest *request;
  if (kStreamType == StreamTypeLive) {
    // Live stream request. Replace the network code and custom asset key with your values.
    request = [[IMAPodStreamRequest alloc] initWithNetworkCode:kNetworkCode
                                                customAssetKey:kCustomAssetKey
                                            adDisplayContainer:adDisplayContainer
                                                  videoDisplay:self.videoDisplay
                                         pictureInPictureProxy:nil
                                                   userContext:nil];
  } else {
    // VOD request. Replace the network code with your value.
    request = [[IMAPodVODStreamRequest alloc] initWithNetworkCode:@kNetworkCode
                                               adDisplayContainer:adDisplayContainer
                                                     videoDisplay:self.videoDisplay
                                            pictureInPictureProxy:nil
                                                      userContext:nil];
  }
  [self.adsLoader requestStreamWithRequest:request];
}
ViewController.m

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

IMAAdsLoader क्लास, स्ट्रीम अनुरोध के शुरू होने या पूरा न होने पर, IMAAdsLoaderDelegate तरीकों को कॉल करती है.

adsLoadedWithData delegate मेथड में, अपनी IMAStreamManagerDelegate सेट करें. स्ट्रीम आईडी को अपने कस्टम VTP हैंडलर को पास करें और स्ट्रीम के मेनिफ़ेस्ट का यूआरएल पाएं. लाइव स्ट्रीम के लिए, अपने वीडियो डिसप्ले में मेनिफ़ेस्ट यूआरएल लोड करें और वीडियो चलाना शुरू करें. वीओडी स्ट्रीम के लिए, मेनिफ़ेस्ट यूआरएल को स्ट्रीम मैनेजर के loadThirdPartyStream तरीके पर पास करें. यह तरीका, Ad Manager 360 से विज्ञापन इवेंट डेटा का अनुरोध करता है. इसके बाद, मेनिफ़ेस्ट यूआरएल को लोड करता है और वीडियो चलाना शुरू करता है.

failedWithErrorData के delegate तरीके में, गड़बड़ी को लॉग करें. इसके अलावा, बैकअप स्ट्रीम भी चलाई जा सकती है. डीआई के सबसे सही तरीके देखें.

ViewController.m 
- (void)adsLoader:(IMAAdsLoader *)loader adsLoadedWithData:(IMAAdsLoadedData *)adsLoadedData {
  NSLog(@"Stream created with: %@.", adsLoadedData.streamManager.streamId);
  self.streamManager = adsLoadedData.streamManager;
  self.streamManager.delegate = self;

  // Build the Pod serving Stream URL.
  NSString *streamID = adsLoadedData.streamManager.streamId;
  // Your custom VTP handler takes the stream ID and returns the stream manifest URL.
  NSString *urlString = gCustomVTPHandler(streamID);
  NSURL *streamUrl = [NSURL URLWithString:urlString];
  if (kStreamType == StreamTypeLive) {
    // Load live streams directly into the AVPlayer.
    [self.videoDisplay loadStream:streamUrl withSubtitles:@[]];
    [self.videoDisplay play];
  } else {
    // Load VOD streams using the `loadThirdPartyStream` method in IMA SDK's stream manager.
    // The stream manager loads the stream, requests metadata, and starts playback.
    [self.streamManager loadThirdPartyStream:streamUrl streamSubtitles:@[]];
  }
}

- (void)adsLoader:(IMAAdsLoader *)loader failedWithErrorData:(IMAAdLoadingErrorData *)adErrorData {
  // Log the error and play the backup content.
  NSLog(@"AdsLoader error, code:%ld, message: %@", adErrorData.adError.code,
        adErrorData.adError.message);
  [self.videoPlayer play];
}
ViewController.m

अपना कस्टम VTP हैंडलर लागू करना

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

उदाहरण के लिए, किसी वीटीपी में मेनिफ़ेस्ट टेंप्लेट का ऐसा यूआरएल शामिल हो सकता है जिसमें मैक्रो [[STREAMID]] हो. इस उदाहरण में, हैंडलर मैक्रो के बजाय स्ट्रीम आईडी डालता है और नतीजे के तौर पर मेनिफ़ेस्ट यूआरएल दिखाता है.

ViewController.m 
/// Custom VTP Handler.
///
/// Returns the stream manifest URL from the video technical partner or manifest manipulator.
static NSString *(^gCustomVTPHandler)(NSString *) = ^(NSString *streamID) {
  // Insert synchronous code here to retrieve a stream manifest URL from your video tech partner
  // or manifest manipulation server.
  // This example uses a hardcoded URL template, containing a placeholder for the stream
  // ID and replaces the placeholder with the stream ID.
  NSString *manifestUrl = @"YOUR_MANIFEST_URL_TEMPLATE";
  return [manifestUrl stringByReplacingOccurrencesOfString:@"[[STREAMID]]"
                                                withString:streamID];
};
ViewController.m

विज्ञापन इवेंट सुनना

IMAStreamManager, स्ट्रीम इवेंट और गड़बड़ियों को आपके ऐप्लिकेशन पर भेजने के लिए, IMAStreamManagerDelegate तरीकों को कॉल करता है.

इस उदाहरण के लिए, कंसोल में मुख्य विज्ञापन इवेंट लॉग करें:

ViewController.m 
- (void)streamManager:(IMAStreamManager *)streamManager didReceiveAdEvent:(IMAAdEvent *)event {
  NSLog(@"Ad event (%@).", event.typeString);
  switch (event.type) {
    case kIMAAdEvent_STARTED: {
      // Log extended data.
      NSString *extendedAdPodInfo = [[NSString alloc]
          initWithFormat:@"Showing ad %ld/%ld, bumper: %@, title: %@, description: %@, contentType:"
                         @"%@, pod index: %ld, time offset: %lf, max duration: %lf.",
                         (long)event.ad.adPodInfo.adPosition, (long)event.ad.adPodInfo.totalAds,
                         event.ad.adPodInfo.isBumper ? @"YES" : @"NO", event.ad.adTitle,
                         event.ad.adDescription, event.ad.contentType,
                         (long)event.ad.adPodInfo.podIndex, event.ad.adPodInfo.timeOffset,
                         event.ad.adPodInfo.maxDuration];

      NSLog(@"%@", extendedAdPodInfo);
      break;
    }
    case kIMAAdEvent_AD_BREAK_STARTED: {
      NSLog(@"Ad break started");
      break;
    }
    case kIMAAdEvent_AD_BREAK_ENDED: {
      NSLog(@"Ad break ended");
      break;
    }
    case kIMAAdEvent_AD_PERIOD_STARTED: {
      NSLog(@"Ad period started");
      break;
    }
    case kIMAAdEvent_AD_PERIOD_ENDED: {
      NSLog(@"Ad period ended");
      break;
    }
    default:
      break;
  }
}

- (void)streamManager:(IMAStreamManager *)streamManager didReceiveAdError:(IMAAdError *)error {
  NSLog(@"StreamManager error with type: %ld\ncode: %ld\nmessage: %@", error.type, error.code,
        error.message);
  [self.videoPlayer play];
}
ViewController.m

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

स्ट्रीम चलाना बंद करने, विज्ञापन ट्रैकिंग बंद करने, और लोड की गई सभी स्ट्रीम ऐसेट को रिलीज़ करने के लिए, IMAStreamManager.destroy() को कॉल करें.

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