Pierwsze kroki z pakietem IMA DAI SDK

Pakiety IMA SDK ułatwiają integrację reklam multimedialnych z witrynami i aplikacjami. Pakiety IMA SDK mogą wysyłać żądania reklam z dowolnego serwera reklam zgodnego z VAST i zarządzać odtwarzaniem reklam w aplikacjach. Dzięki pakietom SDK IMA DAI aplikacje wysyłają żądania strumienia danych wideo z reklam i treści wideo – VOD lub treści na żywo. Pakiet SDK zwraca połączony strumień wideo, więc nie musisz już zarządzać przełączaniem się między reklamą a treścią wideo w aplikacji.

Wybierz rozwiązanie DAI, które Cię interesuje

DAI z pełną obsługą

Ten przewodnik pokazuje, jak zintegrować pakiet IMA DAI SDK z prostą aplikacją odtwarzacza wideo. Jeśli chcesz obejrzeć ukończoną integrację z przykładem, pobierz plik BasicExample z GitHuba.

Omówienie IMA DAI

Implementacja IMA DAI obejmuje 3 główne komponenty SDK, jak pokazano w tym przewodniku:

  • IMAAdDisplayContainer: obiekt kontenera umieszczony nad elementem odtwarzania filmu, w którym znajdują się elementy interfejsu reklamy.
  • IMAAdsLoader: obiekt, który wysyła żądania strumieniowania i obsługuje zdarzenia uruchamiane przez obiekty odpowiedzi na żądania strumienia. Utwórz tylko jeden program wczytujący reklamy, którego można używać wielokrotnie przez cały czas używania aplikacji.
  • IMAStreamRequest – IMAVODStreamRequest lub IMALiveStreamRequest: obiekt definiujący żądanie strumienia. Żądania strumieni mogą dotyczyć wideo na żądanie lub transmisji na żywo. Żądania określają identyfikator treści, a także klucz interfejsu API lub token uwierzytelniania i inne parametry.
  • IMAStreamManager: obiekt, który obsługuje strumienie dynamicznego wstawiania reklam i interakcje z backendem DAI. Menedżer strumienia obsługuje też pingi śledzące oraz przekazuje do wydawcy strumienie i zdarzenia reklamowe.

Wymagania wstępne

Zanim zaczniesz, musisz mieć:

Utwórz nowy projekt Xcode

Utwórz w Xcode nowy projekt na tvOS przy użyciu Objective-C. Jako nazwy projektu użyj BasicExample.

Dodaj pakiet IMA DAI SDK do projektu Xcode

Użyj jednej z tych 3 metod, by zainstalować pakiet IMA DAI SDK.

Zainstaluj pakiet SDK za pomocą CocoaPods (zalecane)

CocoaPods to menedżer zależności w projektach Xcode i zalecana metoda instalacji pakietu IMA DAI SDK. Więcej informacji o instalowaniu i używaniu CocoaPods znajdziesz w dokumentacji CocoaPods. Po zainstalowaniu CocoaPods postępuj zgodnie z tymi instrukcjami, aby zainstalować pakiet IMA DAI SDK:

  1. W tym samym katalogu co plik BasicExample.xcodeproj utwórz plik tekstowy o nazwie BasicExample.xcodeproj i dodaj tę konfigurację:

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

  2. W katalogu zawierającym plik Podfile uruchom polecenie:

    pod install --repo-update`

  3. Sprawdź, czy instalacja się udała. Otwórz plik BasicExample.xcworkspace i sprawdź, czy zawiera on 2 projekty: BasicExample i Pods (zależności zainstalowane przez CocoaPods).

Zainstaluj pakiet SDK za pomocą menedżera pakietów Swift

Pakiet Interactive Media Ads SDK obsługuje Swift Package Manager od wersji 4.8.2. Wykonaj te czynności, aby zaimportować pakiet Swift.

  1. W Xcode zainstaluj pakiet GoogleInteractiveMediaAds Swift, klikając File > Add Packages (Plik > Dodaj pakiety).

  2. W wyświetlonym oknie wyszukaj repozytorium pakietu GoogleInteractiveMediaAds Swift na GitHubie:

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

  3. Wybierz wersję pakietu GoogleInteractiveMediaAds Swift, którego chcesz użyć. W przypadku nowych projektów zalecamy użycie wersji aż do następnej wersji głównej.

Gdy skończysz, Xcode sprawdza zależności pakietów i pobiera je w tle. Więcej informacji o dodawaniu zależności pakietów znajdziesz w artykule Apple.

Ręczne pobieranie i instalowanie pakietu SDK

Jeśli nie chcesz używać Menedżera pakietów Swift ani CocoaPods, możesz pobrać pakiet IMA DAI SDK i ręcznie dodać go do projektu.

Utwórz prosty odtwarzacz wideo

Najpierw zaimplementuj podstawowy odtwarzacz wideo. Początkowo ten odtwarzacz nie używa pakietu IMA DAI SDK ani nie zawiera żadnej metody wyzwalania odtwarzania.

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

Zaimportuj pakiet SDK i dodaj niego na potrzeby interakcji IMA

Po dodaniu pakietu IMA DAI SDK do projektu zaimportuj ten pakiet i dodaj wersje pośrednie dla głównych punktów interakcji 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

Implementowanie pakietu IMAAdsLoader

Następnie utwórz instancję IMAAdsLoader i podłącz widok kontenera reklamy do hierarchii widoków.

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

Prześlij prośbę o transmisję

Utwórz kilka stałych do przechowywania informacji o strumieniu, a potem zaimplementuj funkcję żądania strumienia, aby wysłać żądanie.

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

Obsługuj zdarzenia strumienia

IMAAdsLoader i IMAStreamManager uruchamiają zdarzenia, które służą do obsługi inicjowania, błędów i zmian stanu strumienia. Te zdarzenia są wywoływane przez protokoły IMAAdsLoaderDelegate i IMAStreamManagerDelegate. Nasłuchuj zdarzenia wczytania reklam i zainicjuj strumień. Jeśli nie uda się wczytać reklamy, odtwórz strumień zapasowy.

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

Obsługa zdarzeń logowania i błędów

Przedstawiciel menedżera strumienia może obsługiwać kilka zdarzeń, ale w przypadku implementacji podstawowych najważniejsze zastosowania to: rejestrowanie zdarzeń, zapobieganie przewijaniu podczas odtwarzania reklam i obsługa błędów.

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

Znakomicie. Zamawiasz i wyświetlasz reklamy za pomocą pakietu IMA DAI SDK. Więcej informacji o bardziej zaawansowanych funkcjach pakietu SDK znajdziesz w innych przewodnikach lub w przykładach na GitHubie.