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

使ってみる

IMA SDK を使用すると、ウェブサイトやアプリにマルチメディア広告を簡単に統合できます。IMA SDK は任意のネットワークから広告をリクエストし、 <ph type="x-smartling-placeholder"></ph> VAST 準拠の広告サーバーを実装し、アプリでの広告再生を管理できます。IMA クライアントサイド SDK では広告の再生は SDK で処理され、コンテンツ動画の再生は制御できる。広告はアプリのコンテンツ動画プレーヤーの上に別の動画プレーヤーを配置します。

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

IMA クライアントサイドの概要

IMA クライアントサイドの実装には、次の 4 つの主要な SDK コンポーネントが含まれます。次のとおりです。

IMAAdDisplayContainer: 広告がレンダリングされるコンテナオブジェクト。
IMAAdsLoader: 広告をリクエストし、広告リクエストレスポンスからのイベントを処理するオブジェクト。必要なのは 1 つの広告ローダをインスタンス化して、アプリのライフサイクルを通じて再利用できるようにします。
IMAAdsRequest: 広告リクエストを定義するオブジェクト。広告リクエストでは、VAST 広告タグの URL と追加パラメータを使用できます
IMAAdsManager: 広告リクエストへのレスポンスを含むオブジェクト。広告の再生の制御を行い、イベントを記録します。

前提条件

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

Xcode 13 以降
CocoaPods（推奨）、Swift Package Manager、またはダウンロードした tvOS 用 IMA SDK

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

Xcode で、Objective-C または Swift を使用して新しい tvOS プロジェクトを作成します。使用 BasicExample を指定します。

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

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

CocoaPods は Xcode プロジェクトの依存関係マネージャーであり、メソッドをご覧ください。Google Cloud 上で Terraform を使用して CocoaPods については、CocoaPods のドキュメントをご覧ください。一旦 CocoaPods をインストールしている場合は、次の手順で IMA SDK をインストールします。

BasicExample.xcodeproj ファイルと同じディレクトリにテキストを作成します。 Podfile というファイルを作成し、次の構成を追加します。
```
source 'https://github.com/CocoaPods/Specs.git'
platform :tvos, '14'
target "BasicExample" do
  pod 'GoogleAds-IMA-tvOS-SDK', '~> 4.13.0'
end
```
Podfile を含むディレクトリから pod install --repo-update を実行します。
[ BasicExample.xcworkspace ファイルを開いて、次の 2 つのプロジェクトが含まれていることを確認します。 BasicExample と Pod（CocoaPods によってインストールされた依存関係）

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

Interactive Media Ads SDK は、Swift パッケージ Manager バージョン 4.8.2 以降。詳しくは、 Swift パッケージをインポートする手順は以下のとおりです。

Xcode で、IMA SDK Swift パッケージをインストールします。 [ファイル] >Add Packages...」というメッセージが表示されます。
表示されたプロンプトで、「IMA SDK Swift Package GitHub」を検索します。リポジトリ:
```
https://github.com/googleads/swift-package-manager-google-interactive-media-ads-tvos
```
使用する IMA SDK Swift パッケージのバージョンを選択します。新しいプロジェクトでは、[Up to Next Major Version] を使用することをおすすめします。

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

SDK の手動ダウンロードとインストール

CocoaPods を使用しない場合は、IMA SDK をダウンロードし、プロジェクトに追加します。

手順を表示/非表示

<ph type="x-smartling-placeholder"></ph>より tvOS IMA ダウンロードページを開いて、最新バージョンの SDK をダウンロードして展開します。 tvOS IMA SDK
BasicExample.xcodeproj を開きます。
左側のペインでプロジェクト名をクリックします。
中央ペインで [Build Phases] をクリックします。
[Link Binary With Libraries] セクションを開きます。
ライブラリリストの下部にあるプラスアイコンをクリックします。 [+]。
[その他を追加] をクリックします。
ダウンロードした SDK を展開したディレクトリで、[ GoogleInteractiveMediaAds.framework に移動し、開く。
ライブラリリストの下部にあるプラスアイコンをクリックします。もう一度 [+] を押します。
[ステータス] 列で、 GoogleInteractiveMediaAds.framework の設定 Required。
ビルド設定に -ObjC リンカーフラグを含めます。対象詳細については、以下をご覧ください。 <ph type="x-smartling-placeholder"></ph> Apple QA1490。

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

まず、基本的な動画プレーヤーを実装します。このプレーヤーは、初期状態では IMA SDK が含まれています。また、再生をトリガーするメソッドはまだ含まれていません。

ViewController.m

Objective-C

#import "ViewController.h"

#import <AVKit/AVKit.h>

NSString *const kContentURLString =
    @"https://storage.googleapis.com/interactive-media-ads/media/stock.mp4";

@interface ViewController ()
@property(nonatomic) AVPlayerViewController *contentPlayerViewController;
@end

@implementation ViewController

- (void)viewDidLoad {
  [super viewDidLoad];
  self.view.backgroundColor = UIColor.blackColor;
  [self setupContentPlayer];
}

- (void)setupContentPlayer {
  // Create a content video player.
  NSURL *contentURL = [NSURL URLWithString:kContentURLString];
  AVPlayer *player = [AVPlayer playerWithURL:contentURL];
  self.contentPlayerViewController = [[AVPlayerViewController alloc] init];
  self.contentPlayerViewController.player = player;
  self.contentPlayerViewController.view.frame = self.view.bounds;

  // Attach content video player to view hierarchy.
  [self showContentPlayer];
}

// Add the content video player as a child view controller.
- (void)showContentPlayer {
  [self addChildViewController:self.contentPlayerViewController];
  self.contentPlayerViewController.view.frame = self.view.bounds;
  [self.view insertSubview:self.contentPlayerViewController.view atIndex:0];
  [self.contentPlayerViewController didMoveToParentViewController:self];
}

// Remove and detach the content video player.
- (void)hideContentPlayer {
  // The whole controller needs to be detached so that it doesn't capture events from the remote.
  [self.contentPlayerViewController willMoveToParentViewController:nil];
  [self.contentPlayerViewController.view removeFromSuperview];
  [self.contentPlayerViewController removeFromParentViewController];
}

@end

Swift

import AVFoundation
import UIKit

class ViewController: UIViewController {
  static let ContentURLString = "https://storage.googleapis.com/interactive-media-ads/media/stock.mp4"

  var playerViewController: AVPlayerViewController!

  override func viewDidLoad() {
    super.viewDidLoad()
    self.view.backgroundColor = UIColor.black;
    setUpContentPlayer()
  }

  func setUpContentPlayer() {
    // Load AVPlayer with path to your content.
    let contentURL! = URL(string: ViewController.ContentURLString)
    let player = AVPlayer(url: contentURL)
    playerViewController = AVPlayerViewController()
    playerViewController.player = player

    showContentPlayer()
  }

  func showContentPlayer() {
    self.addChild(playerViewController)
    playerViewController.view.frame = self.view.bounds
    self.view.insertSubview(playerViewController.view, at: 0)
    playerViewController.didMove(toParent:self)
  }

  func hideContentPlayer() {
    // The whole controller needs to be detached so that it doesn't capture  events from the remote.
    playerViewController.willMove(toParent:nil)
    playerViewController.view.removeFromSuperview()
    playerViewController.removeFromParent()
  }
}

4. IMA SDK をインポートする

次に、既存のインポートします。

ViewController.m

Objective-C

#import "ViewController.h"

#import <AVKit/AVKit.h>
#import <GoogleInteractiveMediaAds/GoogleInteractiveMediaAds.h>
NSString *const kContentURLString =
    @"https://storage.googleapis.com/interactive-media-ads/media/stock.mp4";

Swift

import AVFoundation
import GoogleInteractiveMediaAds
import UIKit

class ViewController: UIViewController {
  static let ContentURLString = "https://storage.googleapis.com/interactive-media-ads/media/stock.mp4"

5. コンテンツプレイヘッドトラッカーとストリーム終了オブザーバーを実装する

ミッドロール広告を再生するには、IMA SDK で現在の位置をトラッキングする必要があります。追加できますそのためには、Terraform でモジュールを IMAContentPlayhead。この例に示すように AVPlayer を使用している場合は、 SDK には、この処理を行うための IMAAVPlayerContentPlayhead クラスが用意されています。 AVPlayer を使用していない場合は、次に IMAContentPlayhead を実装する必要があります。独自のクラスを作成します

また、コンテンツの再生が完了したら SDK に通知して、ポストロール広告を表示できますそのためには、次のように contentComplete を呼び出します。 IMAAdsLoader、AVPlayerItemDidPlayToEndTimeNotification を使用。

ViewController.m

Objective-C

...

@interface ViewController ()
@property(nonatomic) IMAAVPlayerContentPlayhead *contentPlayhead;
@property(nonatomic) AVPlayerViewController *contentPlayerViewController;
@end

...

- (void)setupContentPlayer {
  // Create a content video player.
  NSURL *contentURL = [NSURL URLWithString:kContentURLString];
  AVPlayer *player = [AVPlayer playerWithURL:contentURL];
  self.contentPlayerViewController = [[AVPlayerViewController alloc] init];
  self.contentPlayerViewController.player = player;
  self.contentPlayerViewController.view.frame = self.view.bounds;
  self.contentPlayhead =
      [[IMAAVPlayerContentPlayhead alloc] initWithAVPlayer:self.contentPlayerViewController.player];

  // Track end of content.
  AVPlayerItem *contentPlayerItem = self.contentPlayerViewController.player.currentItem;
  [NSNotificationCenter.defaultCenter addObserver:self
                                         selector:@selector(contentDidFinishPlaying:)
                                             name:AVPlayerItemDidPlayToEndTimeNotification
                                           object:contentPlayerItem];

  // Attach content video player to view hierarchy.
  [self showContentPlayer];
}

...

- (void)contentDidFinishPlaying:(NSNotification *)notification {}

- (void)dealloc {
  [NSNotificationCenter.defaultCenter removeObserver:self];
}

@end

Swift

...

class ViewController: UIViewController {
  static let ContentURLString = "https://storage.googleapis.com/interactive-media-ads/media/stock.mp4"

  var contentPlayhead: IMAAVPlayerContentPlayhead?
  var playerViewController: AVPlayerViewController!

  deinit {
    NotificationCenter.default.removeObserver(self)
  }

...

  func setUpContentPlayer() {
    // Load AVPlayer with path to your content.
    let contentURL! = URL(string: ViewController.ContentURLString)
    let player = AVPlayer(url: contentURL)
    playerViewController = AVPlayerViewController()
    playerViewController.player = player

    // Set up your content playhead and contentComplete callback.
    contentPlayhead = IMAAVPlayerContentPlayhead(avPlayer: player)
    NotificationCenter.default.addObserver(
      self,
      selector: #selector(ViewController.contentDidFinishPlaying(_:)),
      name: NSNotification.Name.AVPlayerItemDidPlayToEndTime,
      object: player.currentItem);

    showContentPlayer()
  }

...

  @objc func contentDidFinishPlaying(_ notification: Notification) {
    adsLoader.contentComplete()
  }
}

6. 広告ローダを初期化して広告リクエストを行う

広告のセットをリクエストするには、IMAAdsLoader インスタンスを作成する必要があります。このローダを使用して、関連付けられた IMAAdsRequest オブジェクトを広告タグ URL を入力します。

リソース全体で IMAAdsLoader のインスタンスを 1 つだけ維持することをおすすめします。アプリのライフサイクル全体を管理できます。追加の広告リクエストを行うには、 IMAAdsRequest オブジェクトですが、同じ IMAAdsLoader を再利用します。詳細情報詳しくは、IMA SDK に関するよくある質問をご覧ください。

ViewController.m

Objective-C

...

NSString *const kContentURLString =
    @"https://storage.googleapis.com/interactive-media-ads/media/stock.mp4";
NSString *const kAdTagURLString = @"https://pubads.g.doubleclick.net/gampad/ads?"
    @"iu=/21775744923/external/vmap_ad_samples&sz=640x480&"
    @"cust_params=sample_ar%3Dpremidpostlongpod&"
    @"ciu_szs=300x250&gdfp_req=1&ad_rule=1&output=vmap&unviewed_position_start=1&"
    @"env=vp&impl=s&cmsid=496&vid=short_onecue&correlator=";

@interface ViewController ()
@property(nonatomic) IMAAdsLoader *adsLoader;
@property(nonatomic) IMAAVPlayerContentPlayhead *contentPlayhead;
@property(nonatomic) AVPlayerViewController *contentPlayerViewController;
@end

@implementation ViewController

- (void)viewDidLoad {
  [super viewDidLoad];
  self.view.backgroundColor = UIColor.blackColor;
  [self setupContentPlayer];
  [self setupAdsLoader];
}

- (void)viewDidAppear:(BOOL)animated {
  [super viewDidAppear:animated];
  [self requestAds];
}

- (void)setupAdsLoader {
  self.adsLoader = [[IMAAdsLoader alloc] init];
}

- (void)requestAds {
  // Pass the main view as the container for ad display.
  IMAAdDisplayContainer *adDisplayContainer =
      [[IMAAdDisplayContainer alloc] initWithAdContainer:self.view];
  IMAAdsRequest *request = [[IMAAdsRequest alloc] initWithAdTagUrl:kAdTagURLString
                                                adDisplayContainer:adDisplayContainer
                                                   contentPlayhead:self.contentPlayhead
                                                       userContext:nil];
  [self.adsLoader requestAdsWithRequest:request];
}

...

- (void)contentDidFinishPlaying:(NSNotification *)notification {
  // Notify the SDK that the postrolls should be played.
  [self.adsLoader contentComplete];
}

...

@end

Swift

...

class ViewController: UIViewController {
  static let ContentURLString = "https://storage.googleapis.com/interactive-media-ads/media/stock.mp4"
  static let AdTagURLString = "https://pubads.g.doubleclick.net/gampad/ads?iu=/21775744923/external/single_ad_samples&sz=640x480&cust_params=sample_ct%3Dlinear&ciu_szs=300x250%2C728x90&gdfp_req=1&output=vast&unviewed_position_start=1&env=vp&impl=s&correlator="

  var adsLoader: IMAAdsLoader!
  var contentPlayhead: IMAAVPlayerContentPlayhead?
  var playerViewController: AVPlayerViewController!

...

  override func viewDidLoad() {
    super.viewDidLoad()
    self.view.backgroundColor = UIColor.black;
    setUpContentPlayer()
    setUpAdsLoader()
  }

  override func viewDidAppear(_ animated: Bool) {
    super.viewDidAppear(animated);
    requestAds()
  }

...

  func setUpAdsLoader() {
    adsLoader = IMAAdsLoader(settings: nil)
  }

  func requestAds() {
    // Create ad display container for ad rendering.
    let adDisplayContainer = IMAAdDisplayContainer(adContainer: self.view)
    // Create an ad request with your ad tag, display container, and optional user context.
    let request = IMAAdsRequest(
        adTagUrl: ViewController.AdTagURLString,
        adDisplayContainer: adDisplayContainer,
        contentPlayhead: contentPlayhead,
        userContext: nil)

    adsLoader.requestAds(with: request)
  }

  @objc func contentDidFinishPlaying(_ notification: Notification) {
    adsLoader.contentComplete()
  }
}

7. 広告ローダのデリゲートを設定する

読み込みイベントが正常に終了すると、IMAAdsLoader は adsLoadedWithData を呼び出します。メソッドを呼び出し、IMAAdsManager のインスタンスを渡します。マイページ次に広告マネージャーを初期化します。広告マネージャーは、定義された定義に従って個々の広告を読み込みます広告タグ URL のレスポンスで置き換えられます。

また、読み込み中に発生する可能性のあるエラーに、必ず対処してください。プロセスです広告が読み込まれない場合は、広告なしでメディアの再生が継続されるようにしてください。ユーザーの利便性を損なわないように配慮します

ViewController.m

Objective-C

...

@interface ViewController () <IMAAdsLoaderDelegate>
@property(nonatomic) IMAAdsLoader *adsLoader;
@property(nonatomic) IMAAdsManager *adsManager;
@property(nonatomic) IMAAVPlayerContentPlayhead *contentPlayhead;
@property(nonatomic) AVPlayerViewController *contentPlayerViewController;
@end

@implementation ViewController

...

- (void)setupAdsLoader {
  self.adsLoader = [[IMAAdsLoader alloc] init];
  self.adsLoader.delegate = self;
}

...

#pragma mark - IMAAdsLoaderDelegate

- (void)adsLoader:(IMAAdsLoader *)loader adsLoadedWithData:(IMAAdsLoadedData *)adsLoadedData {
  // Initialize and listen to the ads manager loaded for this request.
  self.adsManager = adsLoadedData.adsManager;
  [self.adsManager initializeWithAdsRenderingSettings:nil];
}

- (void)adsLoader:(IMAAdsLoader *)loader failedWithErrorData:(IMAAdLoadingErrorData *)adErrorData {
  // Fall back to playing content.
  NSLog(@"Error loading ads: %@", adErrorData.adError.message);
  [self.contentPlayerViewController.player play];
}

@end

Swift

...

class ViewController: UIViewController, IMAAdsLoaderDelegate {

...

  var adsLoader: IMAAdsLoader!
  var adsManager: IMAAdsManager!
  var contentPlayhead: IMAAVPlayerContentPlayhead?
  var playerViewController: AVPlayerViewController!

...

  func setUpAdsLoader() {
    adsLoader = IMAAdsLoader(settings: nil)
    adsLoader.delegate = self
  }

...

  // MARK: - IMAAdsLoaderDelegate

  func adsLoader(_ loader: IMAAdsLoader!, adsLoadedWith adsLoadedData: IMAAdsLoadedData!) {
    adsManager = adsLoadedData.adsManager
    adsManager.initialize(with: nil)
  }

  func adsLoader(_ loader: IMAAdsLoader!, failedWith adErrorData: IMAAdLoadingErrorData!) {
    print("Error loading ads: " + adErrorData.adError.message)
    showContentPlayer()
    playerViewController.player?.play()
  }
}

8. 広告マネージャーの委任を設定する

最後に、イベントと状態の変更を管理するには、広告マネージャーがあります。IMAAdManagerDelegate には、広告イベントとエラーを処理するメソッドがあります。動画コンテンツの再生と一時停止をトリガーするメソッドが用意されています

再生を開始しています

didReceiveAdEvent メソッドで処理できるイベントは数多くありますが、この基本的な例では、LOADED イベントをリッスンして、広告にコンテンツや広告の再生を開始できます。

ViewController.m

Objective-C

@interface ViewController () <IMAAdsLoaderDelegate, IMAAdsManagerDelegate>

...

- (void)adsLoader:(IMAAdsLoader *)loader adsLoadedWithData:(IMAAdsLoadedData *)adsLoadedData {
  // Initialize and listen to the ads manager loaded for this request.
  self.adsManager = adsLoadedData.adsManager;
  self.adsManager.delegate = self;
  [self.adsManager initializeWithAdsRenderingSettings:nil];
}

...

#pragma mark - IMAAdsManagerDelegate

- (void)adsManager:(IMAAdsManager *)adsManager didReceiveAdEvent:(IMAAdEvent *)event {
  // Play each ad once it has loaded.
  if (event.type == kIMAAdEvent_LOADED) {
    [adsManager start];
  }
}

...

Swift

...

class ViewController: UIViewController, IMAAdsLoaderDelegate, IMAAdsManagerDelegate {

...

  func adsLoader(_ loader: IMAAdsLoader!, adsLoadedWith adsLoadedData: IMAAdsLoadedData!) {
    // Grab the instance of the IMAAdsManager and set yourself as the delegate.
    adsManager = adsLoadedData.adsManager
    adsManager.delegate = self
    adsManager.initialize(with: nil)
  }

...

  // MARK: - IMAAdsManagerDelegate

  func adsManager(_ adsManager: IMAAdsManager!, didReceive event: IMAAdEvent!) {
    // Play each ad once it has been loaded
    if event.type == IMAAdEventType.LOADED {
      adsManager.start()
    }
  }

...

エラー処理

広告エラー用のハンドラも追加します。前のセクションのようなエラーがコンテンツの再生を再開します。

ViewController.m

Objective-C


...

- (void)adsManager:(IMAAdsManager *)adsManager didReceiveAdError:(IMAAdError *)error {
  // Fall back to playing content.
  NSLog(@"AdsManager error: %@", error.message);
  [self showContentPlayer];
  [self.contentPlayerViewController.player play];
}
@end

Swift

...

  func adsManager(_ adsManager: IMAAdsManager!, didReceive error: IMAAdError!) {
    // Fall back to playing content
    print("AdsManager error: " + error.message)
    showContentPlayer()
    playerViewController.player?.play()
  }

再生イベントと一時停止イベントのトリガー

実装する必要がある最後の 2 つのデリゲートメソッドは、再生とトリガーのトリガーに使用されています。基になる動画コンテンツの一時停止イベント（IMA SDK からリクエストされた場合）リクエストに応じて一時停止や再生をトリガーすることで、ユーザーが途切れるのを防ぐ動画コンテンツの再生タイミングを選択します

ViewController.m

Objective-C

...

- (void)adsManagerDidRequestContentPause:(IMAAdsManager *)adsManager {
  // Pause the content for the SDK to play ads.
  [self.contentPlayerViewController.player pause];
  [self hideContentPlayer];
}

- (void)adsManagerDidRequestContentResume:(IMAAdsManager *)adsManager {
  // Resume the content since the SDK is done playing ads (at least for now).
  [self showContentPlayer];
  [self.contentPlayerViewController.player play];
}

@end

Swift

...

  func adsManagerDidRequestContentPause(_ adsManager: IMAAdsManager!) {
    // Pause the content for the SDK to play ads.
    playerViewController.player?.pause()
    hideContentPlayer()
  }

  func adsManagerDidRequestContentResume(_ adsManager: IMAAdsManager!) {
    // Resume the content since the SDK is done playing ads (at least for now).
    showContentPlayer()
    playerViewController.player?.play()
  }
}

これで、これで、IMA SDK を使用して広告をリクエストし、表示できるようになりました。学習内容機能の詳細については、他のガイドや GitHub のサンプルをご覧ください。

次のステップ

tvOS プラットフォームでの広告収益を最大化するには、IDFA を使用するためにアプリの透明性とトラッキングの許可をリクエストします。

使ってみる

IMA クライアントサイドの概要

前提条件

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

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

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

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

SDK の手動ダウンロードとインストール

手順を表示/非表示

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

Objective-C

Swift

4. IMA SDK をインポートする

Objective-C

Swift

5. コンテンツ プレイヘッド トラッカーとストリーム終了オブザーバーを実装する

Objective-C

Swift

6. 広告ローダを初期化して広告リクエストを行う

Objective-C

Swift

7. 広告ローダのデリゲートを設定する

Objective-C

Swift

8. 広告 マネージャーの委任を設定する

再生を開始しています

Objective-C

Swift

エラー処理

Objective-C

Swift

再生イベントと一時停止イベントのトリガー

Objective-C

Swift

次のステップ

5. コンテンツプレイヘッドトラッカーとストリーム終了オブザーバーを実装する

8. 広告マネージャーの委任を設定する