このページは Cloud Translation API によって翻訳されました。

IMA DAI SDK スタートガイド

IMA SDK を使用すると、ウェブサイトやアプリにマルチメディア広告を簡単に統合できます。IMA SDK では、 VAST 準拠の広告サーバーに広告をリクエストして、アプリでの広告再生を管理できます。IMA DAI SDK を使用すると、アプリは広告とコンテンツ動画（VOD またはライブコンテンツ）のストリームリクエストを行います。これにより、SDK は結合された動画ストリームを返すため、アプリ内で広告とコンテンツ動画の切り替えを管理する必要はありません。

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

フルサービス 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 13 以降
CocoaPods（推奨）、Swift Package Manager、またはダウンロードした IMA DAI SDK for iOS のコピー

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

Xcode で、Objective-C を使用して新しい iOS プロジェクトを作成します。BasicExample をプロジェクト名として使用します。

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

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

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

CocoaPods は Xcode プロジェクトの依存関係マネージャーで、IMA DAI SDK のインストールにおすすめです。CocoaPods のインストールや使用方法について詳しくは、CocoaPods のドキュメントをご覧ください。CocoaPods をインストールしたら、次の手順で IMA DAI SDK をインストールします。

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
```
Podfile を含むディレクトリから、次のコマンドを実行します。
```
pod install --repo-update`
```
インストールが成功したことを確認するために、BasicExample.xcworkspace ファイルを開き、BasicExample と Pods（CocoaPods によってインストールされた依存関係）の 2 つのプロジェクトが含まれていることを確認します。

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

Interactive Media Ads SDK は、バージョン 3.18.4 以降、Swift Package Manager をサポートしています。Swift パッケージをインポートする手順は次のとおりです。

Xcode で、[ファイル] > [パッケージを追加] に移動して、IMA DAI SDK Swift パッケージをインストールします。
表示されるプロンプトで、IMA DAI SDK Swift Package GitHub リポジトリを検索します。
```
https://github.com/googleads/swift-package-manager-google-interactive-media-ads-ios
```
使用する IMA DAI SDK Swift パッケージのバージョンを選択します。新しいプロジェクトの場合は、[Up to Next Major Version] を使用することをおすすめします。

完了すると、Xcode はパッケージの依存関係を解決し、バックグラウンドでダウンロードします。パッケージの依存関係を追加する方法について詳しくは、Apple の記事をご覧ください。

SDK を手動でダウンロードしてインストールする

Swift Package Manager や CocoaPods を使用しない場合は、IMA DAI SDK をダウンロードして、手動でプロジェクトに追加できます。

手順を表示

iOS IMA ダウンロードページから、IMA DAI SDK の最新バージョンをダウンロードして展開します。
BasicExample.xcodeproj を開きます。
左側のペインでプロジェクト名をクリックします。
中央ペインで [Build Phases] をクリックします。
[Link Binary With Libraries] セクションを開きます。
ライブラリリストの下部にあるプラスアイコン [+] をクリックします。
[その他を追加] をクリックします。
ダウンロードした SDK を展開したディレクトリで、[GoogleInteractiveMediaAds.framework] を選択し、[Open] をクリックします。
ライブラリリストの下部にあるプラスアイコン [+] をもう一度クリックします。
[ステータス] 列で、GoogleInteractiveMediaAds.framework が Required に設定されていることを確認します。
ビルド設定に -ObjC リンカーフラグを含めます。詳細については、 Apple QA1490 をご覧ください。

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

まず、基本的な動画プレーヤーを実装します。初期状態で、このプレーヤーには 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 をインポートして、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

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

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

IMAAdsLoader と IMAStreamManager は、初期化、エラー、ストリーム状態の変更を処理するために使用されるイベントを起動します。これらのイベントは、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 のサンプルをご覧ください。

IMA DAI SDK スタートガイド

フルサービス DAI

IMA DAI の概要

前提条件

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

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

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

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

SDK を手動でダウンロードしてインストールする

手順を表示

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

SDK をインポートし、IMA インタラクション用のスタブを追加する

IMAAdsLoader を実装する

ストリーム リクエストを行う

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

ロギングイベントとエラーイベントを処理する

ストリームリクエストを行う

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