IMA DAI SDK スタートガイド

IMA SDK を使用すると、ウェブサイトやアプリにマルチメディア広告を簡単に統合できます。IMA SDK は 任意のネットワークから広告をリクエストし、 <ph type="x-smartling-placeholder"></ph> VAST 準拠の広告サーバーを実装し、アプリでの広告再生を管理できます。IMA DAI SDK を使用すると、 広告およびコンテンツ動画(VOD またはライブ コンテンツ)のストリーム リクエスト。すると、SDK は 統合動画ストリームであるため、広告とコンテンツ動画の切り替えを管理する手間が省けます。 確認できます。

ご希望の DAI ソリューションを選択する

<ph type="x-smartling-placeholder"></ph>

フルサービス DAI

このガイドでは、IMA DAI SDK をシンプルな動画に統合する方法を説明します。 プレーヤー アプリ。完成したサンプルを表示または ダウンロードしてください。 GitHub の BasicExample

IMA DAI の概要

IMA DAI の実装には、こちらの 4 つの主な SDK コンポーネントが必要です。 ガイド:

  • IMAAdDisplayContainer: 動画再生要素の上に配置され、広告の UI 要素を格納するコンテナ オブジェクト。
  • IMAAdsLoader: ストリームをリクエストし、ストリーム リクエスト レスポンス オブジェクトによってトリガーされたイベントを処理するオブジェクト。 広告ローダは 1 つのみインスタンス化してください。このローダは、 説明します。
  • IMAStreamRequest IMAVODStreamRequest または IMALiveStreamRequest: ストリーム リクエストを定義するオブジェクト。ストリーミング リクエストはビデオ オンデマンドまたはライブ 使用できます。リクエストでは、Content ID、API キーまたは認証トークン、 あります。
  • IMAStreamManager: ダイナミック広告挿入のストリームと DAI バックエンドとのインタラクションを処理するオブジェクト。「 ストリーム マネージャーはトラッキング ping も処理し、 あります。

前提条件

始める前に、次のものが必要になります。

新しい Xcode プロジェクトを作成する

Xcode で、Objective-C を使用して新しい iOS プロジェクトを作成します。BasicExample を次のように使用します。 指定します。

IMA DAI SDK を Xcode プロジェクトに追加する

IMA DAI SDK をインストールするには、次の 3 つの方法のいずれかを使用します。

CocoaPods を使用して SDK をインストールする(推奨)

CocoaPods は Xcode プロジェクトの依存関係マネージャーであり、 IMA DAI SDK をインストールする方法を確認します。Google Cloud インフラストラクチャの CocoaPods を使用する場合は、CocoaPods のドキュメントをご覧ください。変更後 CocoaPods をインストールしたら、次の手順で CocoaPods を IMA DAI 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 ファイルを作成し、2 つのファイルが含まれていることを確認します。 プロジェクト: BasicExamplePod( CocoaPods)。

Swift Package Manager を使用して SDK をインストールする

Interactive Media Ads SDK は、Swift パッケージ Manager バージョン 3.18.4 以降。詳しくは、 Swift パッケージをインポートします。

  1. Xcode で、IMA DAI SDK Swift パッケージを [ファイル] >パッケージを追加するをご覧ください。

  2. 表示されるプロンプトで、IMA DAI SDK Swift Package 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 をダウンロードし、プロジェクトに手動で追加します。

シンプルな動画プレーヤーを作成する

まず、基本的な動画プレーヤーを実装します。初期状態では、このプレーヤーは IMA DAI 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 DAI SDK をプロジェクトに追加したら、SDK をインポートしてスタブを追加します。 ご覧ください

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

ストリーム イベントを処理する

IMAAdsLoaderIMAStreamManager は、イベントの処理に使用されるイベントを発生させます。 初期化、エラー、ストリーム状態の変化などです。これらのイベントは 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 DAI SDK を使用して広告をリクエストし、表示できるようになりました。宛先 高度な SDK 機能について詳しくは、他のガイドや GitHub のサンプルをご覧ください。