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

Kapsül Yayınlama 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 PodServingExample'ı 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 – bir IMAPodVODStreamRequest veya IMAPodStreamRequest.
  • IMAStreamManager – Dinamik reklam ekleme akışlarını ve DAI arka ucu ile 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.

Ayrıca, kapsül sunma akışlarını oynatmak için özel bir VTP işleyici uygulamanız gerekir. Bu özel VTP işleyici, hem içerik hem de birleştirilmiş reklamlar içeren bir akış manifesti döndürmek için ihtiyaç duyduğu diğer bilgilerle birlikte akış kimliğini video teknik iş ortağınıza (VTP) gönderir. VTP'niz, özel VTP işleyicinizi nasıl uygulayacağınızla ilgili talimatlar sağlar.

Ö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.

Canlı yayın parametreleri
Ağ kodu Ad Manager 360 hesabınızın ağ kodu.
Örnek: 51636543
Özel Öğe Anahtarı Ad Manager 360'ta kapsül yayınlama etkinliğinizi tanımlayan özel öğe anahtarı. Bu, manifest düzenleyiciniz veya üçüncü taraf kapsül yayınlama iş ortağınız tarafından oluşturulabilir.
Örnek: google-sample
Seç-izle yayını parametreleri
Ağ kodu Ad Manager 360 hesabınızın ağ kodu.
Örnek: 51636543

Yeni bir Xcode projesi oluşturma

Xcode'da, Objective-C kullanarak "PodServingExample" adlı yeni bir iOS projesi oluşturun.

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. PodServingExample.xcodeproj dosyanızla aynı dizinde Podfile adlı bir metin dosyası oluşturun ve aşağıdaki yapılandırmayı ekleyin:

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

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

    pod install --repo-update

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 bakı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.

#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

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.

Ana 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.

@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];
}

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 IMAPodStreamRequest sınıfını kullanın. Seç-izle akışları için IMAPodVODStreamRequest 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.

- (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];
}

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 temsilci yönteminde IMAStreamManagerDelegate ayarlayın. Akış kimliğini özel VTP işleyicinize iletin ve akış manifesti URL'sini alın. Canlı yayınlar için manifest URL'sini video ekranınıza yükleyin ve oynatmaya başlayın. VOD akışları için manifest URL'sini yayın yöneticisinin loadThirdPartyStream yöntemine iletin. Bu yöntem, Ad Manager 360'tan reklam etkinliği verileri ister, ardından manifest URL'sini yükler ve 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.

- (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];
}

Özel VTP işleyicinizi uygulama

Özel VTP işleyicisi, izleyicinin akış kimliğini video teknik iş ortağınıza (VTP) gönderir. Bu işleme, VTP'nizin hem içerik hem de birleştirilmiş reklamlar içeren bir akış manifesti döndürmesi için ihtiyaç duyduğu diğer tüm bilgiler de dahildir. VTP'niz, özel VTP işleyicinizi nasıl uygulayacağınızla ilgili özel talimatlar sağlar.

Örneğin, bir VTP, [[STREAMID]] makrosunu içeren bir manifest şablonu URL'si içerebilir. Bu örnekte işleyici, makronun yerine yayın kimliğini ekler ve ortaya çıkan manifest URL'sini döndürür.

/// 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];
};

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:

- (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];
}

IMA DAI öğelerini temizleme

Akış oynatmayı durdurmak, tüm reklam izlemeyi durdurmak ve yüklü tüm yayın öğelerini serbest bırakmak için IMAStreamManager.destroy() işlevini çağırın.

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.