此页面由 Cloud Translation API 翻译。

开始使用 IMA DAI SDK

借助 IMA SDK，您可以轻松地将多媒体广告集成到您的网站和应用中。IMA SDK 可以从任何符合 VAST 标准的广告服务器请求广告，并在您的应用中管理广告播放。借助 IMA DAI SDK，应用可针对广告和内容视频（无论是 VOD 还是直播内容）发出流请求。然后，SDK 会返回一个组合的视频流，这样您就不必在应用内管理广告和内容视频之间的切换了。

选择您感兴趣的 DAI 解决方案

全服务 DAI

本指南演示了如何将 IMA SDK 集成到简单的视频播放器应用中。如果您想查看或遵循已完成的示例集成，请从 GitHub 下载 BasicExample。

IMA DAI 概览

实现 IMA DAI 涉及三个主要 SDK 组件，如本指南所示：

IMAAdDisplayContainer：位于视频播放元素上方并容纳广告界面元素的容器对象。
IMAAdsLoader：用于请求流并处理由流请求响应对象触发的事件的对象。您只能实例化一个广告加载器，该加载器可在应用的整个生命周期内重复使用。
IMAStreamRequest - IMAVODStreamRequest 或 IMALiveStreamRequest：用于定义流请求的对象。流请求可以针对视频点播或直播。请求会指定内容 ID，以及 API 密钥或身份验证令牌和其他参数。
IMAStreamManager：用于处理动态广告插播流以及与 DAI 后端的互动的对象。视频流管理器还会处理跟踪 ping，并将视频流和广告事件转发给发布商。

前提条件

在开始之前，您需要做好以下准备：

Xcode 13 或更高版本
CocoaPods（首选）、Swift Package Manager，或适用于 tvOS 的 IMA SDK 的下载副本

创建新的 Xcode 项目

在 Xcode 中，使用 Objective-C 创建一个新的 tvOS 项目。使用 BasicExample 作为项目名称。

将 IMA SDK 添加到 Xcode 项目

您可以使用以下三种方法之一安装 IMA SDK。

使用 CocoaPods 安装 SDK（首选）

CocoaPods 是 Xcode 项目的依赖项管理器，建议您使用它来安装 IMA SDK。如需详细了解如何安装或使用 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.12.0'
end

从包含 Podfile 的目录中，运行以下命令：
```
pod install --repo-update`
```
验证安装是否成功，方法是打开 BasicExample.xcworkspace 文件并确认其中包含两个项目：BasicExample 和 Pods（通过 CocoaPods 安装的依赖项）。

使用 Swift Package Manager 安装 SDK

从版本 4.8.2 开始，互动式媒体广告 SDK 支持 Swift Package Manager。请按照以下步骤导入 Swift 软件包。

在 Xcode 中，依次点击 File（文件）> Add Packages（添加软件包），安装 IMA SDK Swift Package。

在显示的提示中，搜索 IMA SDK Swift 软件包 GitHub 代码库：

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

选择您要使用的 IMA SDK Swift 软件包版本。对于新项目，我们建议使用 Up to Next Major Version。

完成后，Xcode 会解析您的软件包依赖项，并在后台下载它们。如需详细了解如何添加软件包依赖项，请参阅 Apple 的文章。

手动下载并安装 SDK

如果您不想使用 Swift Package Manager 或 CocoaPods，可以下载 IMA SDK 并手动添加到您的项目中。

显示说明

在 tvOS IMA 下载页面中，下载并解压缩最新版本的 tvOS IMA SDK。
打开 BasicExample.xcodeproj。
在左侧窗格中，点击项目名称。
在中央窗格中，点击 Build Phases。
展开 Link Binary With Libraries 部分。
在库列表底部，点击加号图标 [+]。
点击 Add Other。
在解压缩所下载 SDK 的目录中，选择 GoogleInteractiveMediaAds.framework，然后点击 Open。
在库列表底部，再次点击加号图标 [+]。
在 Status 列中，验证 GoogleInteractiveMediaAds.framework 是否已设置为 Required。
在 build 设置中添加 -ObjC 链接器标志。如需了解详情，请参阅 Apple QA1490。

创建简单的视频播放器

首先，实施一个基本的视频播放器。最初，该播放器不使用 IMA 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 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 SDK 请求和展示广告。如需详细了解高级 SDK 功能，请参阅其他指南或 GitHub 上的示例。