เริ่มต้นใช้งาน IMA DAI SDK

IMA SDK ช่วยให้ผสานรวมโฆษณามัลติมีเดียลงในเว็บไซต์และแอปได้อย่างง่ายดาย IMA SDK สามารถส่งคําขอโฆษณาจากเซิร์ฟเวอร์โฆษณา ที่เป็นไปตามข้อกําหนดของ VAST ใดก็ได้ และจัดการการเล่นโฆษณาในแอป เมื่อใช้ IMA DAI SDK แอปจะส่งคําขอสตรีมสําหรับโฆษณาและวิดีโอเนื้อหา ไม่ว่าจะเป็น VOD หรือเนื้อหาสด จากนั้น SDK จะแสดงผลสตรีมวิดีโอแบบรวม คุณจึงไม่ต้องจัดการการสลับระหว่างโฆษณากับวิดีโอเนื้อหาภายในแอป

เลือกโซลูชัน DAI ที่คุณสนใจ

DAI แบบครบวงจร

คู่มือนี้แสดงวิธีผสานรวม IMA DAI SDK เข้ากับแอปโปรแกรมเล่นวิดีโอแบบง่าย หากต้องการดูหรือทําตามตัวอย่างการผสานรวมที่เสร็จสมบูรณ์ ให้ดาวน์โหลด BasicExample จาก GitHub

ภาพรวม IMA DAI

การใช้ IMA DAI ประกอบด้วยคอมโพเนนต์ SDK หลัก 4 รายการตามที่แสดงในคู่มือนี้

  • IMAAdDisplayContainer – ออบเจ็กต์คอนเทนเนอร์ที่วางอยู่ด้านบนขององค์ประกอบการเล่นวิดีโอและเป็นที่เก็บองค์ประกอบ UI ของโฆษณา
  • IMAAdsLoader – ออบเจ็กต์ที่ขอสตรีมและจัดการเหตุการณ์ที่ทริกเกอร์โดยออบเจ็กต์การตอบกลับคำขอสตรีม คุณควรสร้างอินสแตนซ์ของโปรแกรมโหลดโฆษณาเพียงรายการเดียว ซึ่งนํามาใช้ซ้ำได้ตลอดอายุการใช้งานของแอปพลิเคชัน
  • IMAStreamRequest – IMAVODStreamRequest หรือ IMALiveStreamRequest ออบเจ็กต์ที่กําหนดคําขอสตรีม คำขอสตรีมอาจเป็นคำขอสำหรับวิดีโอออนดีมานด์หรือสตรีมแบบสดก็ได้ คำขอจะระบุรหัสเนื้อหา รวมถึงคีย์ API หรือโทเค็นการตรวจสอบสิทธิ์ และพารามิเตอร์อื่นๆ
  • IMAStreamManager – ออบเจ็กต์ที่จัดการสตรีมการแทรกโฆษณาแบบไดนามิกและการโต้ตอบกับแบ็กเอนด์ DAI นอกจากนี้ เครื่องมือจัดการสตรีมยังจัดการการติดตามคําสั่ง ping และส่งต่อสตรีมและเหตุการณ์โฆษณาไปยังผู้เผยแพร่โฆษณาด้วย

ข้อกำหนดเบื้องต้น

ก่อนเริ่มต้น คุณต้องมีสิ่งต่อไปนี้

  • Xcode 13 ขึ้นไป
  • CocoaPods (แนะนำ) เครื่องมือจัดการแพ็กเกจ Swift หรือสําเนาที่ดาวน์โหลดไว้ของ IMA DAI SDK สําหรับ iOS

คุณต้องมีพารามิเตอร์ที่ใช้เพื่อขอสตรีมจาก IMA SDK ด้วย ดูตัวอย่างพารามิเตอร์คำขอได้ที่สตรีมตัวอย่าง

พารามิเตอร์ของไลฟ์สด
คีย์เนื้อหา คีย์ของชิ้นงาน การระบุสตรีมแบบสดใน Google Ad Manager
ตัวอย่าง: c-rArva4ShKVIAkNfy6HUQ
พารามิเตอร์สตรีม VOD
รหัสแหล่งที่มาของเนื้อหา รหัสแหล่งที่มาของเนื้อหาจาก Google Ad Manager
ตัวอย่าง: 2548831
รหัสวิดีโอ รหัสวิดีโอจาก Google Ad Manager
ตัวอย่าง: tears-of-steel

สร้างโปรเจ็กต์ Xcode ใหม่

ใน Xcode ให้สร้างโปรเจ็กต์ iOS ใหม่โดยใช้ Objective-C ใช้ BasicExample เป็นชื่อโปรเจ็กต์

เพิ่ม IMA DAI SDK ลงในโปรเจ็กต์ Xcode

ใช้วิธีใดวิธีหนึ่งต่อไปนี้เพื่อติดตั้ง IMA DAI SDK

ติดตั้ง SDK โดยใช้ CocoaPods (แนะนำ)

CocoaPods เป็นเครื่องมือจัดการทรัพยากร Dependency สําหรับโปรเจ็กต์ Xcode และเป็นวิธีที่เราแนะนําสําหรับการติดตั้ง IMA DAI SDK ดูข้อมูลเพิ่มเติมเกี่ยวกับการติดตั้งหรือการใช้ CocoaPods ได้ที่เอกสารประกอบของ CocoaPods หลังจากติดตั้ง CocoaPods แล้ว ให้ใช้วิธีการต่อไปนี้เพื่อติดตั้ง IMA DAI SDK

  1. ในไดเรกทอรีเดียวกับไฟล์ BasicExample.xcodeproj ให้สร้างไฟล์ข้อความชื่อ Podfile และเพิ่มการกําหนดค่าต่อไปนี้

    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. จากไดเรกทอรีที่มี Podfile ให้เรียกใช้คำสั่งต่อไปนี้

    pod install --repo-update`

  3. ยืนยันว่าการติดตั้งสําเร็จโดยเปิดไฟล์ BasicExample.xcworkspace และตรวจสอบว่ามีโปรเจ็กต์ 2 รายการ ได้แก่ BasicExample และ Pods (Dependency ที่ CocoaPods ติดตั้ง)

ติดตั้ง SDK โดยใช้ Swift Package Manager

Interactive Media Ads SDK รองรับ Swift Package Manager ตั้งแต่เวอร์ชัน 3.18.4 เป็นต้นไป ทำตามขั้นตอนต่อไปนี้เพื่อนำเข้าแพ็กเกจ Swift

  1. ใน Xcode ให้ติดตั้งแพ็กเกจ Swift ของ IMA DAI SDK โดยไปที่ไฟล์ > เพิ่มแพ็กเกจ

  2. ในพรอมต์ที่ปรากฏขึ้น ให้ค้นหาที่เก็บ GitHub ของ IMA DAI SDK Swift Package

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

  3. เลือกเวอร์ชันของแพ็กเกจ Swift ของ IMA DAI SDK ที่ต้องการใช้ สําหรับโปรเจ็กต์ใหม่ เราขอแนะนําให้ใช้อัปเดตเป็นเวอร์ชันหลักถัดไป

เมื่อดำเนินการเสร็จแล้ว Xcode จะจับคู่ข้อมูลและดาวน์โหลดทรัพยากร Dependency ของแพ็กเกจในเบื้องหลัง ดูรายละเอียดเพิ่มเติมเกี่ยวกับวิธีเพิ่มแพ็กเกจที่ต้องพึ่งพาได้ที่บทความของ Apple

ดาวน์โหลดและติดตั้ง SDK ด้วยตนเอง

หากไม่ต้องการใช้ Swift Package Manager หรือ CocoaPods คุณสามารถดาวน์โหลด IMA DAI SDK และเพิ่มลงในโปรเจ็กต์ด้วยตนเอง

สร้างวิดีโอเพลเยอร์แบบง่าย

ใช้โปรแกรมเล่นวิดีโอใน ViewController หลักโดยใช้โปรแกรมเล่น AV ที่รวมอยู่ในมุมมอง UI IMA SDK ใช้มุมมอง UI เพื่อแสดงองค์ประกอบ ad UI

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

เริ่มต้นโหลดโฆษณา

นําเข้า IMA SDK ไปยังตัวควบคุมมุมมองและใช้โปรโตคอล IMAAdsLoaderDelegate และ IMAStreamManagerDelegate เพื่อจัดการเหตุการณ์ของโปรแกรมโหลดโฆษณาและตัวจัดการสตรีม

เพิ่มพร็อพเพอร์ตี้ส่วนตัวเหล่านี้เพื่อจัดเก็บคอมโพเนนต์ IMA SDK หลัก

  • IMAAdsLoader - จัดการคําขอสตรีมตลอดอายุของแอป
  • IMAAdDisplayContainer - จัดการการแทรกและจัดการองค์ประกอบอินเทอร์เฟซผู้ใช้ของโฆษณา
  • IMAAVPlayerVideoDisplay - สื่อสารระหว่าง IMA SDK กับโปรแกรมเล่นสื่อ รวมถึงจัดการข้อมูลเมตาแบบกำหนดเวลา
  • IMAStreamManager - จัดการการเล่นสตรีมและเรียกเหตุการณ์ที่เกี่ยวข้องกับโฆษณา

เริ่มต้นโหลดโฆษณา คอนเทนเนอร์การแสดงโฆษณา และการแสดงวิดีโอหลังจากโหลดวิว

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

ส่งคำขอสตรีม

เมื่อผู้ใช้กดปุ่มเล่น ให้ส่งคำขอสตรีมใหม่ ใช้คลาส IMALiveStreamRequest สำหรับสตรีมแบบสด สำหรับสตรีม VOD ให้ใช้คลาส IMAVODStreamRequest

คําขอสตรีมต้องใช้พารามิเตอร์สตรีม รวมถึงการอ้างอิงถึงคอนเทนเนอร์โฆษณาและการแสดงวิดีโอ

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

รอรับเหตุการณ์การโหลดสตรีม

คลาส IMAAdsLoader จะเรียกใช้เมธอด IMAAdsLoaderDelegate เมื่อเริ่มต้นใช้งานสําเร็จหรือไม่สําเร็จของคําขอสตรีม

ในเมธอด adsLoadedWithData delegate ให้ตั้งค่า IMAStreamManagerDelegate และเริ่มต้นผู้จัดการสตรีม เมื่อเริ่มต้น ตัวจัดการสตรีมจะเริ่มเล่น

ในเมธอดตัวแทน failedWithErrorData ให้บันทึกข้อผิดพลาด เล่นสตรีมสำรอง (ไม่บังคับ) ดูแนวทางปฏิบัติแนะนำสำหรับ 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

ฟังเหตุการณ์โฆษณา

IMAStreamManager เรียกใช้วิธีของ IMAStreamManagerDelegate เพื่อส่งเหตุการณ์และข้อผิดพลาดของสตรีมไปยังแอปพลิเคชัน

ในตัวอย่างนี้ ให้บันทึกเหตุการณ์โฆษณาหลักลงในคอนโซล

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

เรียกใช้แอป หากสำเร็จ คุณจะขอและสตรีม DAI ของ Google ได้โดยใช้ IMA SDK หากต้องการดูข้อมูลเกี่ยวกับฟีเจอร์ขั้นสูงอื่นๆ ของ SDK โปรดดูคู่มืออื่นๆ ที่แสดงในแถบด้านข้างทางซ้ายหรือตัวอย่างใน GitHub