Mulai menggunakan IMA DAI SDK

IMA SDK memudahkan integrasi iklan multimedia ke dalam situs dan aplikasi Anda. IMA SDK dapat meminta iklan dari server iklan yang sesuai dengan VAST dan mengelola pemutaran iklan di aplikasi Anda. Dengan IMA DAI SDK, aplikasi membuat permintaan streaming untuk iklan dan video konten—baik VOD maupun konten live. SDK kemudian menampilkan streaming video gabungan, sehingga Anda tidak perlu mengelola peralihan antara iklan dan video konten dalam aplikasi.

Memilih solusi DAI yang Anda minati

DAI layanan lengkap

Panduan ini menunjukkan cara mengintegrasikan IMA DAI SDK ke dalam aplikasi pemutar video sederhana. Jika Anda ingin melihat atau mengikuti integrasi contoh yang telah selesai, download BasicExample dari GitHub.

Ringkasan DAI IMA

Mengimplementasikan IMA DAI melibatkan empat komponen SDK utama seperti yang ditunjukkan dalam panduan ini:

  • IMAAdDisplayContainer – Objek penampung yang berada di atas elemen pemutaran video dan menyimpan elemen UI iklan.
  • IMAAdsLoader – Objek yang meminta streaming dan menangani peristiwa yang dipicu oleh objek respons permintaan streaming. Anda hanya boleh membuat instance satu loader iklan, yang dapat digunakan kembali selama masa aktif aplikasi.
  • IMAStreamRequest – IMAVODStreamRequest atau IMALiveStreamRequest. Objek yang menentukan permintaan streaming. Permintaan streaming dapat berupa video on demand atau live stream. Permintaan menentukan ID konten, serta kunci API atau token autentikasi dan parameter lainnya.
  • IMAStreamManager – Objek yang menangani aliran penyisipan iklan dinamis dan interaksi dengan backend DAI. Pengelola streaming juga menangani ping pelacakan dan meneruskan peristiwa streaming dan iklan ke penayang.

Prasyarat

Sebelum memulai, Anda memerlukan hal berikut:

Anda juga memerlukan parameter yang digunakan untuk meminta streaming dari IMA SDK. Untuk contoh parameter permintaan, lihat Contoh Streaming.

Parameter livestream
Kunci aset Kunci aset yang mengidentifikasi live stream Anda di Google Ad Manager.
Contoh: c-rArva4ShKVIAkNfy6HUQ
Parameter streaming VOD
ID sumber konten ID sumber konten dari Google Ad Manager.
Contoh: 2548831
ID Video ID video dari Google Ad Manager.
Contoh: tears-of-steel

Membuat project Xcode baru

Di Xcode, buat project iOS baru menggunakan Objective-C. Gunakan BasicExample sebagai nama project.

Menambahkan IMA DAI SDK ke project Xcode

Gunakan salah satu dari tiga metode ini untuk menginstal IMA DAI SDK.

Menginstal SDK menggunakan CocoaPods (lebih disarankan)

CocoaPods adalah pengelola dependensi untuk project Xcode dan merupakan metode yang direkomendasikan untuk menginstal IMA DAI SDK. Untuk informasi selengkapnya tentang cara menginstal atau menggunakan CocoaPods, lihat dokumentasi CocoaPods. Setelah menginstal CocoaPods, gunakan petunjuk berikut untuk menginstal IMA DAI SDK:

  1. Di direktori yang sama dengan file BasicExample.xcodeproj, buat file teks bernama Podfile, lalu tambahkan konfigurasi berikut:

    Podfile 
    source 'https://github.com/CocoaPods/Specs.git'

platform :ios, '14'

target 'BasicExample' do
  pod 'GoogleAds-IMA-iOS-SDK', '~> 3.23.0'
end

    Podfile

  2. Dari direktori yang berisi Podfile, jalankan:

    pod install --repo-update`

  3. Verifikasi bahwa penginstalan berhasil dengan membuka file BasicExample.xcworkspace dan mengonfirmasi bahwa file tersebut berisi dua project: BasicExample dan Pods (dependensi yang diinstal oleh CocoaPods).

Menginstal SDK menggunakan Swift Package Manager

Interactive Media Ads SDK mendukung Swift Package Manager mulai versi 3.18.4. Ikuti langkah-langkah berikut untuk mengimpor paket Swift.

  1. Di Xcode, instal Paket Swift IMA DAI SDK dengan membuka File > Add Packages.

  2. Pada perintah yang muncul, telusuri repositori GitHub Paket Swift IMA DAI SDK:

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

  3. Pilih versi Paket Swift IMA DAI SDK yang ingin Anda gunakan. Untuk project baru, sebaiknya gunakan Sampai Versi Utama Berikutnya.

Setelah selesai, Xcode akan me-resolve dependensi paket Anda dan mendownloadnya di latar belakang. Untuk mengetahui detail selengkapnya tentang cara menambahkan dependensi paket, lihat artikel Apple.

Mendownload dan menginstal SDK secara manual

Jika tidak ingin menggunakan Swift Package Manager atau CocoaPods, Anda dapat mendownload IMA DAI SDK dan menambahkannya secara manual ke project Anda.

Membuat pemutar video sederhana

Terapkan pemutar video di pengontrol tampilan utama Anda, menggunakan pemutar AV yang digabungkan dalam tampilan UI. IMA SDK menggunakan tampilan UI untuk menampilkan elemen UI iklan.

ViewController.m 
#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

ViewController.m

Menginisialisasi loader iklan

Impor IMA SDK ke pengontrol tampilan Anda dan terapkan protokol IMAAdsLoaderDelegate dan IMAStreamManagerDelegate untuk menangani peristiwa loader iklan dan pengelola streaming.

Tambahkan properti pribadi ini untuk menyimpan komponen IMA SDK utama:

  • IMAAdsLoader - Mengelola permintaan streaming selama siklus proses aplikasi Anda.
  • IMAAdDisplayContainer - Menangani penyisipan dan pengelolaan elemen antarmuka pengguna iklan.
  • IMAAVPlayerVideoDisplay - Berkomunikasi antara IMA SDK dan pemutar media Anda serta menangani metadata berjangka waktu.
  • IMAStreamManager - Mengelola pemutaran streaming dan memicu peristiwa terkait iklan.

Lakukan inisialisasi pemuat iklan, penampung tampilan iklan, dan tampilan video setelah tampilan dimuat.

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

Membuat permintaan streaming

Saat pengguna menekan tombol putar, buat permintaan streaming baru. Gunakan class IMALiveStreamRequest untuk Live stream. Untuk streaming VOD, gunakan class IMAVODStreamRequest.

Permintaan streaming memerlukan parameter streaming, serta referensi ke penampung tampilan iklan dan tampilan video Anda.

ViewController.m 
- (IBAction)onPlayButtonTouch:(id)sender {
  [self requestStream];
  self.playButton.hidden = YES;
}

- (void)requestStream {
  // Create a stream request. Use one of "Live stream request" or "VOD request", depending on your
  // type of stream.
  IMAStreamRequest *request;
  // Switch this variable to NO to make a VOD request.
  BOOL useLiveStream = YES;
  if (useLiveStream) {
    // Live stream request. Replace the asset key with your value.
    request = [[IMALiveStreamRequest alloc] initWithAssetKey:@"c-rArva4ShKVIAkNfy6HUQ"
                                          adDisplayContainer:self.adDisplayContainer
                                                videoDisplay:self.imaVideoDisplay
                                                 userContext:nil];
  } else {
    // VOD request. Replace the content source ID and video ID with your values.
    request = [[IMAVODStreamRequest alloc] initWithContentSourceID:@"2548831"
                                                           videoID:@"tears-of-steel"
                                                adDisplayContainer:self.adDisplayContainer
                                                      videoDisplay:self.imaVideoDisplay
                                                       userContext:nil];
  }
  [self.adsLoader requestStreamWithRequest:request];
}
ViewController.m

Memproses peristiwa pemuatan streaming

Class IMAAdsLoader akan memanggil metode IMAAdsLoaderDelegate saat inisialisasi berhasil atau permintaan streaming gagal.

Dalam metode delegasi adsLoadedWithData, tetapkan IMAStreamManagerDelegate dan lakukan inisialisasi pengelola streaming. Saat inisialisasi, pengelola streaming akan memulai pemutaran.

Di metode delegasi failedWithErrorData, catat error ke dalam log. Atau, putar streaming cadangan. Lihat praktik terbaik DAI.

ViewController.m 
- (void)adsLoader:(IMAAdsLoader *)loader adsLoadedWithData:(IMAAdsLoadedData *)adsLoadedData {
  NSLog(@"Stream created with: %@.", adsLoadedData.streamManager.streamId);
  self.streamManager = adsLoadedData.streamManager;
  self.streamManager.delegate = self;
  [self.streamManager initializeWithAdsRenderingSettings:nil];
}

- (void)adsLoader:(IMAAdsLoader *)loader failedWithErrorData:(IMAAdLoadingErrorData *)adErrorData {
  // Log the error and play the content.
  NSLog(@"AdsLoader error, code:%ld, message: %@", adErrorData.adError.code,
        adErrorData.adError.message);
  [self.videoPlayer play];
}
ViewController.m

Memproses peristiwa iklan

IMAStreamManager memanggil metode IMAStreamManagerDelegate untuk meneruskan peristiwa dan error streaming ke aplikasi Anda.

Untuk contoh ini, catat peristiwa iklan utama ke konsol:

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

Jalankan aplikasi Anda, dan jika berhasil, Anda dapat meminta dan memutar streaming Google DAI dengan IMA SDK. Untuk mempelajari fitur SDK lanjutan lainnya, lihat panduan lain yang tercantum di sidebar kiri atau contoh di GitHub.