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

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

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

पूरी सेवा वाला डीएआई

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

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

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

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

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

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

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

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

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

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

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

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

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

    source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '14'
target "BasicExample" do
  pod 'GoogleAds-IMA-iOS-SDK', '~> 3.23.0'
end

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

    pod install --repo-update`

  3. BasicExample.xcworkspace फ़ाइल खोलकर, यह पुष्टि करें कि इंस्टॉलेशन पूरा हो गया है. साथ ही, यह भी देखें कि इसमें दो प्रोजेक्ट हैं: BasicExample और Pods (CocoaPods से इंस्टॉल की गई डिपेंडेंसी).

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 DAI SDK टूल का इस्तेमाल नहीं करता. साथ ही, इसमें वीडियो चलाने के लिए कोई तरीका भी नहीं होता.

ViewController.m

#import "ViewController.h"

#import <AVKit/AVKit.h>

@interface ViewController ()
@property(nonatomic) AVPlayerViewController *playerViewController;
@end

@implementation ViewController

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

  // Create a stream video player.
  AVPlayer *player = [[AVPlayer alloc] init];
  self.playerViewController = [[AVPlayerViewController alloc] init];
  self.playerViewController.player = player;

  // Attach the video player to the view hierarchy.
  [self addChildViewController:self.playerViewController];
  self.playerViewController.view.frame = self.view.bounds;
  [self.view addSubview:self.playerViewController.view];
  [self.playerViewController didMoveToParentViewController:self];
}

@end

SDK टूल इंपोर्ट करना और IMA इंटरैक्शन के लिए स्टब जोड़ना

अपने प्रोजेक्ट में IMA DAI SDK टूल जोड़ने के बाद, SDK टूल को इंपोर्ट करें और IMA इंटरैक्शन के मुख्य पॉइंट के लिए स्टब जोड़ें.

ViewController.m

#import "ViewController.h"

#import <AVKit/AVKit.h>
#import <GoogleInteractiveMediaAds/GoogleInteractiveMediaAds.h>

@interface ViewController ()
@property(nonatomic) IMAAdsLoader *adsLoader;
@property(nonatomic) UIView *adContainerView;
@property(nonatomic) IMAStreamManager *streamManager;
@property(nonatomic) AVPlayerViewController *playerViewController;
@end

@implementation ViewController

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

  [self setupAdsLoader];

  // Create a stream video player.
  AVPlayer *player = [[AVPlayer alloc] init];
  self.playerViewController = [[AVPlayerViewController alloc] init];
  self.playerViewController.player = player;

  // Attach the video player to the view hierarchy.
  [self addChildViewController:self.playerViewController];
  self.playerViewController.view.frame = self.view.bounds;
  [self.view addSubview:self.playerViewController.view];
  [self.playerViewController didMoveToParentViewController:self];

  [self attachAdContainer];
}

- (void)viewDidAppear:(BOOL)animated {
  [super viewDidAppear:animated];
  [self requestStream];
}

- (void)setupAdsLoader {}

- (void)attachAdContainer {}

- (void)requestStream {}

@end

IMAAdsLoader को लागू करना

इसके बाद, IMAAdsLoader को इंस्टैंशिएट करें और विज्ञापन कंटेनर व्यू को व्यू हैरारकी से अटैच करें.

ViewController.m

- (void)setupAdsLoader {
  self.adsLoader = [[IMAAdsLoader alloc] init];
  self.adsLoader.delegate = self;
}

- (void)attachAdContainer {
  self.adContainerView = [[UIView alloc] init];
  [self.view addSubview:self.adContainerView];
  self.adContainerView.frame = self.view.bounds;
}

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

स्ट्रीम की जानकारी को सेव करने के लिए कुछ कॉन्स्टेंट बनाएं. इसके बाद, अनुरोध करने के लिए स्ट्रीम अनुरोध फ़ंक्शन लागू करें.

ViewController.m

#import <GoogleInteractiveMediaAds/GoogleInteractiveMediaAds.h>

static NSString *const kAssetKey = @"sN_IYUG8STe1ZzhIIE_ksA";
static NSString *const kContentSourceID = @"2548831";
static NSString *const kVideoID = @"tears-of-steel";

@interface ViewController ()
...

- (void)requestStream {
  IMAAVPlayerVideoDisplay *videoDisplay =
      [[IMAAVPlayerVideoDisplay alloc] initWithAVPlayer:self.playerViewController.player];
  IMAAdDisplayContainer *adDisplayContainer =
      [[IMAAdDisplayContainer alloc] initWithAdContainer:self.adContainerView];
  IMALiveStreamRequest *request = [[IMALiveStreamRequest alloc] initWithAssetKey:kAssetKey
                                                              adDisplayContainer:adDisplayContainer
                                                                    videoDisplay:videoDisplay];
  // VOD request. Comment out the IMALiveStreamRequest above and uncomment this IMAVODStreamRequest
  // to switch from a livestream to a VOD stream.
  // IMAVODStreamRequest *request =
  //     [[IMAVODStreamRequest alloc] initWithContentSourceId:kContentSourceID
  //                                                  videoId:kVideoID
  //                                       adDisplayContainer:adDisplayContainer
  //                                             videoDisplay:videoDisplay];
  [self.adsLoader requestStreamWithRequest:request];
}

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

IMAAdsLoader और IMAStreamManager फ़ायर इवेंट, जिन्हें शुरू करने, गड़बड़ियों, और स्ट्रीम की स्थिति में होने वाले बदलावों को मैनेज करने के लिए इस्तेमाल किया जाता है. ये इवेंट, IMAAdsLoaderDelegate और IMAStreamManagerDelegate प्रोटोकॉल पर फ़ायर होते हैं. विज्ञापन लोड होने के इवेंट के लिए सुनें और स्ट्रीम को शुरू करें. अगर कोई विज्ञापन लोड नहीं होता है, तो उसके बजाय बैकअप स्ट्रीम चलाएं.

ViewController.m

static NSString *const kAssetKey = @"sN_IYUG8STe1ZzhIIE_ksA";
static NSString *const kContentSourceID = @"2548831";
static NSString *const kVideoID = @"tears-of-steel";
static NSString *const kBackupStreamURLString =
    @"https://storage.googleapis.com/interactive-media-ads/media/bbb.m3u8";

@interface ViewController () <IMAAdsLoaderDelegate, IMAStreamManagerDelegate>

...
  [self.adsLoader requestStreamWithRequest:request];
}

- (void)playBackupStream {
  NSURL *backupStreamURL = [NSURL URLWithString:kBackupStreamURLString];
  AVPlayerItem *backupStreamItem = [AVPlayerItem playerItemWithURL:backupStreamURL];
  [self.playerViewController.player replaceCurrentItemWithPlayerItem:backupStreamItem];
  [self.playerViewController.player play];
}

#pragma mark - IMAAdsLoaderDelegate

- (void)adsLoader:(IMAAdsLoader *)loader adsLoadedWithData:(IMAAdsLoadedData *)adsLoadedData {
  // Initialize and listen to stream manager's events.
  self.streamManager = adsLoadedData.streamManager;
  self.streamManager.delegate = self;
  [self.streamManager initializeWithAdsRenderingSettings:nil];
  NSLog(@"Stream created with: %@.", self.streamManager.streamId);
}

- (void)adsLoader:(IMAAdsLoader *)loader failedWithErrorData:(IMAAdLoadingErrorData *)adErrorData {
  // Fall back to playing the backup stream.
  NSLog(@"Error loading ads: %@", adErrorData.adError.message);
  [self playBackupStream];
}

#pragma mark - IMAStreamManagerDelegate

- (void)streamManager:(IMAStreamManager *)streamManager didReceiveAdEvent:(IMAAdEvent *)event {}

- (void)streamManager:(IMAStreamManager *)streamManager didReceiveAdError:(IMAAdError *)error {}

- (void)streamManager:(IMAStreamManager *)streamManager
  adDidProgressToTime:(NSTimeInterval)time
           adDuration:(NSTimeInterval)adDuration
           adPosition:(NSInteger)adPosition
             totalAds:(NSInteger)totalAds
      adBreakDuration:(NSTimeInterval)adBreakDuration {}

@end

लॉगिंग और गड़बड़ी वाले इवेंट मैनेज करना

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

ViewController.m

#pragma mark - IMAStreamManagerDelegate

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

      NSLog(@"%@", extendedAdPodInfo);
      break;
    }
    case kIMAAdEvent_AD_BREAK_STARTED: {
      // Prevent user seek through when an ad starts and show the ad controls.
      self.adContainerView.hidden = NO;
      break;
    }
    case kIMAAdEvent_AD_BREAK_ENDED: {
      // Allow user seek through after an ad ends and hide the ad controls.
      self.adContainerView.hidden = YES;
      break;
    }
    default:
      break;
  }
}

- (void)streamManager:(IMAStreamManager *)streamManager didReceiveAdError:(IMAAdError *)error {
  // Fall back to playing the backup stream.
  NSLog(@"StreamManager error: %@", error.message);
  [self playBackupStream];
}

@end

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