IMA DAI SDK 시작하기

IMA SDK를 사용하면 웹사이트와 앱에 멀티미디어 광고를 쉽게 통합할 수 있습니다. IMA SDK는 모든 VAST 호환 광고 서버에서 광고를 요청하고 앱에서 광고 재생을 관리할 수 있습니다. IMA DAI SDK를 사용하면 앱에서 광고 및 콘텐츠 동영상(VOD 또는 라이브 콘텐츠)에 대한 스트림을 요청합니다. 그러면 SDK가 결합된 동영상 스트림을 반환하므로 앱 내에서 광고 동영상과 콘텐츠 동영상 간에 전환을 관리할 필요가 없습니다.

관심 있는 DAI 솔루션 선택하기

DAI 광고 모음 게재

이 가이드에서는 IMA DAI SDK를 간단한 동영상 플레이어 앱에 통합하는 방법을 설명합니다. 완성된 샘플 통합을 보거나 따라 하려면 GitHub에서 PodServingExample을 다운로드하세요.

IMA DAI 개요

IMA DAI를 구현하려면 이 가이드에 설명된 4가지 주요 SDK 구성요소가 필요합니다.

  • IMAAdDisplayContainer – 동영상 재생 요소 위에 있고 광고 UI 요소를 포함하는 컨테이너 객체입니다.
  • IMAAdsLoader: 스트림을 요청하고 스트림 요청 응답 객체에 의해 트리거된 이벤트를 처리하는 객체입니다. 애플리케이션 전체 기간 동안 재사용할 수 있는 광고 로더는 하나만 인스턴스화해야 합니다.
  • IMAStreamRequest IMAPodVODStreamRequest 또는 IMAPodStreamRequest입니다.
  • IMAStreamManager – 동적 광고 삽입 스트림과 DAI 백엔드와의 상호작용을 처리하는 객체입니다. 스트림 관리자는 추적 핑도 처리하고 스트림 및 광고 이벤트를 게시자에게 전달합니다.

또한 포드 게재 스트림을 재생하려면 커스텀 VTP 핸들러를 구현해야 합니다. 이 맞춤 VTP 핸들러는 콘텐츠와 스티치된 광고가 모두 포함된 스트림 매니페스트를 반환하는 데 필요한 다른 정보와 함께 스트림 ID를 동영상 기술 파트너 (VTP)에 전송합니다. VTP에서 맞춤 VTP 핸들러를 구현하는 방법을 안내합니다.

기본 요건

시작하기 전에 다음이 필요합니다.

IMA SDK에서 스트림을 요청하는 데 사용되는 매개변수도 필요합니다.

라이브 스트림 매개변수
네트워크 코드 Ad Manager 360 계정의 네트워크 코드입니다.
예: 51636543
커스텀 애셋 키 Ad Manager 360에서 포드 게재 이벤트를 식별하는 맞춤 애셋 키입니다. 매니페스트 조작기 또는 서드 파티 광고 모음 게재 파트너가 이를 만들 수 있습니다.
예: google-sample
VOD 스트림 매개변수
네트워크 코드 Ad Manager 360 계정의 네트워크 코드입니다.
예: 51636543

새 Xcode 프로젝트 만들기

Xcode에서 Objective-C를 사용하여 'PodServingExample'이라는 새 iOS 프로젝트를 만듭니다.

Xcode 프로젝트에 IMA DAI SDK 추가

다음 세 가지 방법 중 하나를 사용하여 IMA DAI SDK를 설치합니다.

CocoaPods를 사용하여 SDK 설치 (권장)

CocoaPods는 Xcode 프로젝트의 종속 항목 관리자이며 IMA DAI SDK를 설치하는 데 권장되는 방법입니다. CocoaPods 설치 또는 사용에 관한 자세한 내용은 CocoaPods 문서를 참고하세요. CocoaPods를 설치한 후 다음 안내에 따라 IMA DAI SDK를 설치합니다.

  1. PodServingExample.xcodeproj 파일과 동일한 디렉터리에 Podfile이라는 텍스트 파일을 만들고 다음 구성을 추가합니다.

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

  2. Podfile이 포함된 디렉터리에서 다음을 실행합니다.

    pod install --repo-update

Swift Package Manager를 사용하여 SDK 설치

양방향 미디어 광고 SDK는 버전 3.18.4부터 Swift Package Manager를 지원합니다. Swift 패키지를 가져오려면 다음 단계를 따르세요.

  1. Xcode에서 File(파일) > Add Packages(패키지 추가)로 이동하여 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 패키지의 버전을 선택합니다. 새 프로젝트의 경우 Up to Next Major Version(최대 다음 메이저 버전)을 사용하는 것이 좋습니다.

완료하면 Xcode에서 패키지 종속 항목을 확인하고 백그라운드에서 다운로드하기 시작합니다. 패키지 종속 항목을 추가하는 방법에 관한 자세한 내용은 Apple 도움말을 참고하세요.

SDK 수동 다운로드 및 설치

Swift Package Manager 또는 CocoaPods를 사용하지 않으려면 IMA DAI SDK를 다운로드하여 프로젝트에 수동으로 추가하면 됩니다.

간단한 동영상 플레이어 만들기

UI 뷰로 래핑된 AV 플레이어를 사용하여 기본 뷰 컨트롤러에 동영상 플레이어를 구현합니다. IMA SDK는 UI 뷰를 사용하여 광고 UI 요소를 표시합니다.

#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

광고 로더 초기화

IMA SDK를 뷰 컨트롤러로 가져오고 IMAAdsLoaderDelegateIMAStreamManagerDelegate 프로토콜을 채택하여 광고 로더 및 스트림 관리자 이벤트를 처리합니다.

주요 IMA SDK 구성요소를 저장하는 다음과 같은 비공개 속성을 추가합니다.

  • IMAAdsLoader - 앱의 전체 기간에 걸쳐 스트림 요청을 관리합니다.
  • IMAAdDisplayContainer - 광고 사용자 인터페이스 요소 삽입 및 관리를 처리합니다.
  • IMAAVPlayerVideoDisplay - IMA SDK와 미디어 플레이어 간에 통신하고 시간 메타데이터를 처리합니다.
  • IMAStreamManager: 스트림 재생을 관리하고 광고 관련 이벤트를 실행합니다.

뷰가 로드된 후 광고 로더, 광고 디스플레이 컨테이너, 동영상 디스플레이를 초기화합니다.

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

스트림 요청

사용자가 재생 버튼을 누르면 새 스트림을 요청합니다. 라이브 스트림에는 IMAPodStreamRequest 클래스를 사용하세요. VOD 스트림의 경우 IMAPodVODStreamRequest 클래스를 사용합니다.

스트림 요청에는 스트림 매개변수와 광고 디스플레이 컨테이너 및 동영상 디스플레이 참조가 필요합니다.

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

스트림 로드 이벤트 수신 대기

IMAAdsLoader 클래스는 스트림 요청의 초기화에 성공하거나 실패할 때 IMAAdsLoaderDelegate 메서드를 호출합니다.

adsLoadedWithData 대리자 메서드에서 IMAStreamManagerDelegate를 설정합니다. 스트림 ID를 맞춤 VTP 핸들러에 전달하고 스트림 매니페스트 URL을 가져옵니다. 라이브 스트림의 경우 매니페스트 URL을 동영상 디스플레이에 로드하고 재생을 시작합니다. VOD 스트림의 경우 매니페스트 URL을 스트림 관리자의 loadThirdPartyStream 메서드에 전달합니다. 이 메서드는 Ad Manager 360에서 광고 이벤트 데이터를 요청한 후 매니페스트 URL을 로드하고 재생을 시작합니다.

failedWithErrorData 대리자 메서드에서 오류를 로깅합니다. 원하는 경우 백업 스트림을 재생합니다. DAI 권장사항을 참고하세요.

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

맞춤 VTP 핸들러 구현

맞춤 VTP 핸들러는 시청자의 스트림 ID를 동영상 기술 파트너 (VTP)에 콘텐츠와 스티치된 광고가 모두 포함된 스트림 매니페스트를 반환하는 데 필요한 기타 정보와 함께 전송합니다. VTP에서 맞춤 VTP 핸들러를 구현하는 방법에 관한 구체적인 안내를 제공합니다.

예를 들어 VTP에는 [[STREAMID]] 매크로가 포함된 매니페스트 템플릿 URL이 포함될 수 있습니다. 이 예에서 핸들러는 매크로 대신 스트림 ID를 삽입하고 결과 매니페스트 URL을 반환합니다.

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

광고 이벤트 수신

IMAStreamManagerIMAStreamManagerDelegate 메서드를 호출하여 스트림 이벤트와 오류를 애플리케이션에 전달합니다.

이 예에서는 기본 광고 이벤트를 콘솔에 로깅합니다.

- (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 애셋 정리

스트림 재생을 중지하고, 모든 광고 추적을 중지하고, 로드된 모든 스트림 애셋을 해제하려면 IMAStreamManager.destroy()를 호출합니다.

앱을 실행합니다. 실행에 성공하면 IMA SDK로 Google DAI 스트림을 요청하고 재생할 수 있습니다. 고급 SDK 기능에 대해 자세히 알아보려면 왼쪽 사이드바에 나열된 다른 가이드 또는 GitHub의 샘플을 참고하세요.