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

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

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

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

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

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

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

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

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

शुरू करने से पहले, आपको इनकी ज़रूरत होगी:

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

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

Xcode प्रोजेक्ट में IMA डीएआई SDK टूल जोड़ें

IMA डीएआई SDK टूल को इंस्टॉल करने के लिए, इन तीन तरीकों में से किसी एक का इस्तेमाल करें.

CocoaPods का इस्तेमाल करके SDK टूल इंस्टॉल करें (पसंदीदा)

CocoaPods, Xcode प्रोजेक्ट के लिए डिपेंडेंसी मैनेजर है. साथ ही, यह IMA डीएआई SDK टूल इंस्टॉल करने का सुझाया गया तरीका है. CocoaPods को इंस्टॉल या इस्तेमाल करने के बारे में ज़्यादा जानकारी के लिए, CocoaPods का दस्तावेज़ देखें. CocoaPods को इंस्टॉल करने के बाद, IMA डीएआई 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.xcworkspace और BasicExample.xcworkspace (CocoaPods की ओर से इंस्टॉल की गई डिपेंडेंसी).

Swift पैकेज मैनेजर का इस्तेमाल करके SDK टूल इंस्टॉल करें

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

  1. Xcode में, IMA डीएआई SDK टूल का Swift पैकेज इंस्टॉल करें. इसके लिए, फ़ाइल > पैकेज जोड़ें पर जाएं.

  2. स्क्रीन पर दिखने वाले प्रॉम्प्ट में, IMA डीएआई SDK स्विफ़्ट पैकेज GitHub डेटा स्टोर करने की जगह खोजें:

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

  3. आपको जिस IMA डीएआई SDK स्विफ़्ट पैकेज का इस्तेमाल करना है उसका वर्शन चुनें. नए प्रोजेक्ट के लिए, हम अगला मेजर वर्शन इस्तेमाल करने का सुझाव देते हैं.

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

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

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

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

सबसे पहले, बेसिक वीडियो प्लेयर लागू करें. शुरुआत में, यह प्लेयर IMA डीएआई 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 डीएआई 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 डीएआई SDK टूल से विज्ञापनों का अनुरोध कर रहे हैं और उन्हें दिखा रहे हैं. SDK टूल की बेहतर सुविधाओं के बारे में जानने के लिए, अन्य गाइड या GitHub पर दिए गए सैंपल देखें.