IMA SDK memudahkan pengintegrasian iklan multimedia ke dalam situs dan aplikasi Anda. IMA SDK dapat minta iklan dari semua 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 gabungan streaming video, sehingga Anda tidak perlu mengelola peralihan antara iklan dan video konten dalam aplikasi Anda.
Pilih solusi DAI yang Anda minati
DAI layanan penuh
Panduan ini menunjukkan cara mengintegrasikan IMA DAI SDK ke dalam video sederhana aplikasi pemutar audio. Jika Anda ingin melihat atau mengikuti contoh yang telah selesai integrasi, download BasicExample dari GitHub.
Ringkasan IMA DAI
Penerapan IMA DAI melibatkan empat komponen SDK utama seperti yang ditunjukkan dalam panduan:
IMAAdDisplayContainer
: Objek penampung yang berada di atas elemen pemutaran video dan menampung elemen UI iklan.IMAAdsLoader
: Objek yang meminta stream dan menangani peristiwa yang dipicu oleh objek respons permintaan streaming. Sebaiknya Anda hanya membuat instance satu loader iklan, yang dapat digunakan kembali selama masa pakai aplikasi.IMAStreamRequest
– dapat berupaIMAVODStreamRequest
atauIMALiveStreamRequest
: Objek yang menentukan permintaan streaming. Permintaan streaming dapat berupa video on demand atau live feed. Permintaan menentukan ID konten, serta kunci API atau token autentikasi, dan parameter.IMAStreamManager
: Objek yang menangani interaksi dan streaming penyisipan iklan dinamis dengan backend DAI. Tujuan stream manager juga menangani ping pelacakan serta meneruskan streaming dan peristiwa iklan ke penayang.
Prasyarat
Sebelum memulai, Anda memerlukan hal berikut:
- Xcode 13 atau yang lebih baru
- CocoaPods (lebih disukai), Swift Package Manager, atau salinan IMA DAI SDK untuk iOS
Membuat project Xcode baru
Di Xcode, buat proyek 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.
Instal SDK menggunakan CocoaPods (lebih disukai)
CocoaPods adalah pengelola dependensi untuk proyek Xcode dan direkomendasikan penginstalan IMA DAI SDK. Untuk informasi selengkapnya tentang cara menginstal atau menggunakan CocoaPods, lihat dokumentasi CocoaPods. Sesudah telah menginstal CocoaPods, gunakan petunjuk berikut untuk menginstal IMA DAI SDK:
Dalam direktori yang sama dengan file BasicExample.xcodeproj, buat teks bernama Podfile, dan tambahkan konfigurasi berikut:
source 'https://github.com/CocoaPods/Specs.git' platform :ios, '14' target "BasicExample" do pod 'GoogleAds-IMA-iOS-SDK', '~> 3.23.0' end
Dari direktori yang berisi Podfile, jalankan:
pod install --repo-update`
Verifikasi bahwa instalasi berhasil dengan membuka 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.
Di Xcode, instal Swift Package IMA DAI SDK dengan membuka File > Tambahkan Paket.
Pada perintah yang muncul, telusuri GitHub Paket Swift IMA DAI SDK repositori:
https://github.com/googleads/swift-package-manager-google-interactive-media-ads-ios
Pilih versi Paket Swift IMA DAI SDK yang ingin Anda gunakan. Untuk baru sebaiknya gunakan Up to Next Major Version.
Setelah selesai, Xcode menyelesaikan dependensi paket Anda dan mengunduhnya di latar belakang. Untuk 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 mengunduh IMA DAI SDK dan menambahkannya secara manual ke project Anda.
Membuat pemutar video sederhana
Pertama, terapkan pemutar video dasar. Awalnya, pemutar ini tidak menggunakan IMA DAI SDK juga tidak berisi metode apa pun untuk memicu pemutaran.
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
Impor SDK dan tambahkan stub untuk interaksi IMA
Setelah menambahkan IMA DAI SDK ke project Anda, impor SDK dan tambahkan stub sebagai poin utama interaksi 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
Menerapkan IMAAdsLoader
Selanjutnya, buat instance IMAAdsLoader
dan lampirkan tampilan penampung iklan ke
hierarki tampilan.
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;
}
Membuat permintaan streaming
Buat beberapa konstanta untuk menyimpan informasi streaming, lalu implementasikan metode {i>stream request<i} untuk membuat permintaan.
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];
}
Menangani peristiwa streaming
Peristiwa kebakaran IMAAdsLoader
dan IMAStreamManager
yang digunakan untuk menangani
inisialisasi, error, dan perubahan status streaming. Peristiwa ini terpicu melalui
protokol IMAAdsLoaderDelegate
dan IMAStreamManagerDelegate
. Dengarkan
peristiwa pemuatan iklan dan melakukan inisialisasi streaming. Jika iklan gagal dimuat, putar
streaming cadangan.
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
Menangani peristiwa logging dan error
Ada beberapa kejadian yang bisa ditangani oleh delegasi pengelola {i>stream<i}, tetapi untuk implementasi dasar, penggunaan yang paling penting adalah melakukan pencatatan peristiwa, untuk mencegah tindakan pencarian saat iklan diputar, dan untuk menangani error.
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
Selesai. Sekarang Anda meminta dan menampilkan iklan dengan IMA DAI SDK. Kepada mempelajari fitur SDK lanjutan lainnya, lihat panduan lainnya atau sampel di GitHub.