IMA DAI SDK'sını kullanmaya başlama

IMA SDK'ları, multimedya reklamları web sitelerinize ve uygulamalarınıza entegre etmenizi kolaylaştırır. IMA SDK'ları, VAST ile uyumlu herhangi bir reklam sunucusundan reklam isteyebilir ve uygulamalarınızda reklam oynatmayı yönetebilir. IMA DAI SDK'ları ile uygulamalar, reklam ve içerik videosu (VOD veya canlı içerik) için bir yayın isteği gönderir. Ardından SDK, birleştirilmiş bir video akışı döndürür. Böylece uygulamanızda reklam ve içerik videosu arasında geçiş yapmanız gerekmez.

İlgilendiğiniz DAI çözümünü seçin

Tam kapsamlı DAI

Bu kılavuzda, IMA DAI SDK'sının basit bir video oynatıcı uygulamasına nasıl entegre edileceği gösterilmektedir. Tamamlanmış bir örnek entegrasyonu görüntülemek veya takip etmek istiyorsanız GitHub'dan BasicExample'ı indirin.

IMA DAI'ye genel bakış

IMA DAI'yi uygulamak, bu kılavuzda gösterildiği gibi dört ana SDK bileşenini içerir:

  • IMAAdDisplayContainer – Video oynatma öğesinin üzerinde bulunan ve reklam kullanıcı arayüzü öğelerini barındıran bir kapsayıcı nesne.
  • IMAAdsLoader: Akış isteğinde bulunan ve akış isteği yanıtı nesneleri tarafından tetiklenen etkinlikleri işleyen bir nesne. Uygulamanın ömrü boyunca yeniden kullanılabilecek tek bir reklam yükleyicisi oluşturmanız gerekir.
  • IMAStreamRequest: IMAVODStreamRequest veya IMALiveStreamRequest Bir akış isteğini tanımlayan nesne. Akış istekleri, seç-izle videolar veya canlı yayınlar için olabilir. İstekler, bir içerik kimliğinin yanı sıra API anahtarı veya kimlik doğrulama jetonu ve diğer parametreleri belirtir.
  • IMAStreamManager – Dinamik reklam ekleme akışlarını ve DAI arka ucuyla etkileşimleri yöneten bir nesne. Yayın yöneticisi, izleme ping'lerini de yönetir ve yayın ile reklam etkinliklerini yayıncıya iletir.

Ön koşullar

Başlamadan önce aşağıdakilere sahip olmanız gerekir:

IMA SDK'sından akışınızı istemek için kullanılan parametrelere de ihtiyacınız vardır. İstek parametresi örnekleri için Örnek Akışlar bölümüne bakın.

Canlı yayın parametreleri
Öğe anahtarı Google Ad Manager'da canlı yayınınızı tanımlayan öğe anahtarı.
Örnek: c-rArva4ShKVIAkNfy6HUQ
Seç-izle yayını parametreleri
İçerik kaynağı kimliği Google Ad Manager'daki içerik kaynağı kimliği.
Örnek: 2548831
Video kimliği Google Ad Manager'daki video kimliği.
Örnek: tears-of-steel

Yeni bir Xcode projesi oluşturma

Xcode'da Objective-C kullanarak yeni bir iOS projesi oluşturun. Proje adı olarak BasicExample'ı kullanın.

IMA DAI SDK'sını Xcode projesine ekleme

IMA DAI SDK'sını yüklemek için bu üç yöntemden birini kullanın.

SDK'yı CocoaPods kullanarak yükleme (tercih edilir)

CocoaPods, Xcode projeleri için bir bağımlı yöneticisidir ve IMA DAI SDK'sını yüklemek için önerilen yöntemdir. CocoaPods'u yükleme veya kullanma hakkında daha fazla bilgi için CocoaPods belgelerine bakın. CocoaPods'u yükledikten sonra IMA DAI SDK'sını yüklemek için aşağıdaki talimatları uygulayın:

  1. BasicExample.xcodeproj dosyanızla aynı dizinde Podfile adlı bir metin dosyası oluşturun ve aşağıdaki yapılandırmayı ekleyin:

    Pod dosyası 
    source 'https://github.com/CocoaPods/Specs.git'

platform :ios, '14'

target 'BasicExample' do
  pod 'GoogleAds-IMA-iOS-SDK', '~> 3.23.0'
end

    Podfile

  2. Podfile dosyasını içeren dizinden şunları çalıştırın:

    pod install --repo-update`

  3. BasicExample.xcworkspace dosyasını açıp iki proje içerdiğini doğrulayarak yüklemenin başarılı olduğunu doğrulayın: BasicExample ve Pods (CocoaPods tarafından yüklenen bağımlılıklar).

Swift Package Manager'ı kullanarak SDK'yı yükleme

Interactive Media Ads SDK'sı, 3.18.4 sürümünden itibaren Swift Package Manager'ı destekler. Swift paketini içe aktarmak için aşağıdaki adımları uygulayın.

  1. Xcode'da File > Add Packages (Dosya > Paket Ekle) bölümüne giderek IMA DAI SDK Swift Paketi'ni yükleyin.

  2. Görünen istemde, IMA DAI SDK Swift Paketi GitHub deposunu arayın:

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

  3. Kullanmak istediğiniz IMA DAI SDK Swift paketinin sürümünü seçin. Yeni projeler için Sonraki Büyük Sürüme Kadar seçeneğini kullanmanızı öneririz.

İşlem tamamlandığında Xcode, paket bağımlılıklarınıza çözüm bulur ve bunları arka planda indirir. Paket bağımlılıkları ekleme hakkında daha fazla bilgi için Apple'ın makalesine göz atın.

SDK'yı manuel olarak indirip yükleme

Swift Package Manager veya CocoaPods'u kullanmak istemiyorsanız IMA DAI SDK'sını indirip projenize manuel olarak ekleyebilirsiniz.

Basit bir video oynatıcı oluşturma

Kullanıcı arayüzü görünümüne yerleştirilmiş bir AV oynatıcı kullanarak ana görüntü kontrol cihazınızda bir video oynatıcı uygulayın. IMA SDK, reklam kullanıcı arayüzü öğelerini görüntülemek için kullanıcı arayüzü görünümünü kullanır.

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

Reklam yükleyiciyi başlatma

IMA SDK'sını görüntüleme denetleyicinize aktarın ve reklam yükleyici ile yayın yöneticisi etkinliklerini işlemek için IMAAdsLoaderDelegate ve IMAStreamManagerDelegate protokollerini kullanın.

Önemli IMA SDK bileşenlerini depolamak için aşağıdaki özel mülkleri ekleyin:

  • IMAAdsLoader: Uygulamanızın kullanım süresi boyunca yayın isteklerini yönetir.
  • IMAAdDisplayContainer: Reklam kullanıcı arayüzü öğelerinin eklenmesini ve yönetilmesini sağlar.
  • IMAAVPlayerVideoDisplay: IMA SDK ile medya oynatıcınız arasında iletişim kurar ve zamanlanmış meta verileri işler.
  • IMAStreamManager: Akış oynatmayı yönetir ve reklamla ilgili etkinlikleri tetikler.

Görüntü yüklendikten sonra reklam yükleyiciyi, reklam görüntüleme kapsayıcısını ve video görüntülemeyi başlatın.

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

Akış isteği gönderme

Kullanıcı oynat düğmesine bastığında yeni bir yayın isteği gönderin. Canlı yayınlar için IMALiveStreamRequest sınıfını kullanın. Seç-izle akışları için IMAVODStreamRequest sınıfını kullanın.

Yayın isteği, yayın parametrelerinizin yanı sıra reklam görüntüleme kapsayıcınız ve video görüntüleme referansı gerektirir.

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

- (void)requestStream {
  // Create a stream request. Use one of "Live stream request" or "VOD request", depending on your
  // type of stream.
  IMAStreamRequest *request;
  // Switch this variable to NO to make a VOD request.
  BOOL useLiveStream = YES;
  if (useLiveStream) {
    // Live stream request. Replace the asset key with your value.
    request = [[IMALiveStreamRequest alloc] initWithAssetKey:@"c-rArva4ShKVIAkNfy6HUQ"
                                          adDisplayContainer:self.adDisplayContainer
                                                videoDisplay:self.imaVideoDisplay
                                                 userContext:nil];
  } else {
    // VOD request. Replace the content source ID and video ID with your values.
    request = [[IMAVODStreamRequest alloc] initWithContentSourceID:@"2548831"
                                                           videoID:@"tears-of-steel"
                                                adDisplayContainer:self.adDisplayContainer
                                                      videoDisplay:self.imaVideoDisplay
                                                       userContext:nil];
  }
  [self.adsLoader requestStreamWithRequest:request];
}
ViewController.m

Akış yükleme etkinliklerini dinleme

IMAAdsLoader sınıfı, akış isteğinin başarılı bir şekilde başlatılması veya başarısız olması durumunda IMAAdsLoaderDelegate yöntemlerini çağırır.

adsLoadedWithData vekalet yönteminde IMAStreamManagerDelegate değerinizi ayarlayın ve yayın yöneticisini başlatın. Akış yöneticisi, başlatıldığında oynatmayı başlatır.

failedWithErrorData vekalet yönteminde hatayı günlüğe kaydedin. Dilerseniz yedek akışı oynatabilirsiniz. DAI ile ilgili en iyi uygulamalara göz atın.

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

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

Reklam etkinliklerini dinleme

IMAStreamManager, akış etkinliklerini ve hatalarını uygulamanıza aktarmak için IMAStreamManagerDelegate yöntemlerini çağırır.

Bu örnekte, birincil reklam etkinliklerini konsola kaydedin:

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

Uygulamanızı çalıştırın. Başarılı olursa IMA SDK'sı ile Google DAI akışları isteyebilir ve oynatabilirsiniz. Daha gelişmiş SDK özellikleri hakkında bilgi edinmek için sol kenar çubuğunda listelenen diğer kılavuzları veya GitHub'daki örnekleri inceleyin.