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

Penayangan Pod DAI

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 PodServingExample 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 IMAPodVODStreamRequest atau IMAPodStreamRequest.
  • 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.

Selain itu, untuk memutar streaming penayangan pod, Anda harus menerapkan pengendali VTP kustom. Pengendali VTP kustom ini mengirimkan ID streaming ke partner teknis video (VTP) Anda beserta informasi lain yang diperlukan untuk menampilkan manifes streaming yang berisi konten dan iklan yang digabungkan. VTP akan memberikan petunjuk tentang cara menerapkan pengendali VTP kustom.

Prasyarat

Sebelum memulai, Anda memerlukan hal berikut:

Anda juga memerlukan parameter yang digunakan untuk meminta streaming dari IMA SDK.

Parameter livestream
Kode jaringan Kode jaringan untuk akun Ad Manager 360 Anda.
Contoh: 51636543
Kunci Aset Kustom Kunci aset kustom yang mengidentifikasi peristiwa Penyertaan Pod di Ad Manager 360. Ini dapat dibuat oleh manipulator manifes atau partner Penayangan Pod pihak ketiga.
Contoh: google-sample
Parameter streaming VOD
Kode jaringan Kode jaringan untuk akun Ad Manager 360 Anda.
Contoh: 51636543

Membuat project Xcode baru

Di Xcode, buat project iOS baru menggunakan Objective-C bernama "PodServingExample".

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 PodServingExample.xcodeproj, buat file teks bernama Podfile, lalu tambahkan konfigurasi berikut:

    source 'https://github.com/CocoaPods/Specs.git'
    
    platform :ios, '14'
    
    target 'PodServingExample' do
      pod 'GoogleAds-IMA-iOS-SDK'
    end
    

  2. Dari direktori yang berisi Podfile, jalankan:

    pod install --repo-update

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.

#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

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.

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

Membuat permintaan streaming

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

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

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

- (void)requestStream {
  // Create a stream request.
  IMAStreamRequest *request;
  if (kStreamType == StreamTypeLive) {
    // Live stream request. Replace the network code and custom asset key with your values.
    request = [[IMAPodStreamRequest alloc] initWithNetworkCode:kNetworkCode
                                                customAssetKey:kCustomAssetKey
                                            adDisplayContainer:adDisplayContainer
                                                  videoDisplay:self.videoDisplay
                                         pictureInPictureProxy:nil
                                                   userContext:nil];
  } else {
    // VOD request. Replace the network code with your value.
    request = [[IMAPodVODStreamRequest alloc] initWithNetworkCode:@kNetworkCode
                                               adDisplayContainer:adDisplayContainer
                                                     videoDisplay:self.videoDisplay
                                            pictureInPictureProxy:nil
                                                      userContext:nil];
  }
  [self.adsLoader requestStreamWithRequest:request];
}

Memproses peristiwa pemuatan streaming

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

Dalam metode delegasi adsLoadedWithData, tetapkan IMAStreamManagerDelegate. Teruskan ID streaming ke pengendali VTP kustom Anda, dan ambil URL manifes streaming. Untuk live stream, muat URL manifes ke layar video, lalu mulai pemutaran. Untuk streaming VOD, teruskan URL manifes ke metode loadThirdPartyStream pengelola streaming. Metode ini meminta data peristiwa iklan dari Ad Manager 360, lalu memuat URL manifes dan memulai pemutaran.

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

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

  // Build the Pod serving Stream URL.
  NSString *streamID = adsLoadedData.streamManager.streamId;
  // Your custom VTP handler takes the stream ID and returns the stream manifest URL.
  NSString *urlString = gCustomVTPHandler(streamID);
  NSURL *streamUrl = [NSURL URLWithString:urlString];
  if (kStreamType == StreamTypeLive) {
    // Load live streams directly into the AVPlayer.
    [self.videoDisplay loadStream:streamUrl withSubtitles:@[]];
    [self.videoDisplay play];
  } else {
    // Load VOD streams using the `loadThirdPartyStream` method in IMA SDK's stream manager.
    // The stream manager loads the stream, requests metadata, and starts playback.
    [self.streamManager loadThirdPartyStream:streamUrl streamSubtitles:@[]];
  }
}

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

Menerapkan pengendali VTP kustom

Pengendali VTP kustom mengirimkan ID streaming penonton ke partner teknis video (VTP) Anda beserta informasi lain yang diperlukan VTP untuk menampilkan manifes streaming yang berisi konten dan iklan yang digabungkan. VTP akan memberikan petunjuk khusus tentang cara menerapkan pengendali VTP kustom.

Misalnya, VTP dapat menyertakan URL template manifes yang berisi makro [[STREAMID]]. Dalam contoh ini, pengendali menyisipkan ID Streaming sebagai pengganti makro dan menampilkan URL manifes yang dihasilkan.

/// Custom VTP Handler.
///
/// Returns the stream manifest URL from the video technical partner or manifest manipulator.
static NSString *(^gCustomVTPHandler)(NSString *) = ^(NSString *streamID) {
  // Insert synchronous code here to retrieve a stream manifest URL from your video tech partner
  // or manifest manipulation server.
  // This example uses a hardcoded URL template, containing a placeholder for the stream
  // ID and replaces the placeholder with the stream ID.
  NSString *manifestUrl = @"YOUR_MANIFEST_URL_TEMPLATE";
  return [manifestUrl stringByReplacingOccurrencesOfString:@"[[STREAMID]]"
                                                withString:streamID];
};

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:

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

Membersihkan aset DAI IMA

Untuk menghentikan pemutaran streaming, menghentikan semua pelacakan iklan, dan merilis semua aset streaming yang dimuat, panggil IMAStreamManager.destroy().

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.