תחילת העבודה עם 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 עיקריים, כפי שמוסבר במדריך הזה:

  • IMAAdDisplayContainer: אובייקט מאגר תגים שממוקם מעל לרכיב הפעלת הסרטון, ומכיל את הרכיבים של ממשק המשתמש של המודעה.
  • IMAAdsLoader: אובייקט שמבקש שידורים ומטפל באירועים שהופעלו על ידי אובייקטים של תגובה לבקשת שידור. צריך ליצור רק רכיב אחד של טעינה של מודעות, שאפשר להשתמש בו שוב במהלך כל משך החיים של האפליקציה.
  • IMAStreamRequest – IMAVODStreamRequest או IMALiveStreamRequest: אובייקט שמגדיר בקשה לשידור. בקשות סטרימינג יכולות להיות וידאו על פי דרישה (VOD) או שידורים חיים. הבקשות מציינות את מזהה התוכן, וגם מפתח API, אסימון אימות ופרמטרים נוספים.
  • IMAStreamManager: אובייקט שמטפל בשידורים של הכנסת מודעות דינמיות ובאינטראקציות עם הקצה העורפי של DAI. מנהל הסטרימינג מטפל גם בפינגים במעקב ומעביר אירועי מודעות ושידורים חיים לבעל האתר.

דרישות מוקדמות

לפני שמתחילים:

יצירת פרויקט Xcode חדש

ב-Xcode, יוצרים פרויקט tvOS חדש באמצעות Objective-C. משתמשים ב-BasicExample בתור שם הפרויקט.

הוספת IMA DAI SDK לפרויקט Xcode

יש להשתמש באחת משלוש השיטות הבאות כדי להתקין את IMA DAI SDK.

התקנת ה-SDK באמצעות CocoaPods (מועדף)

CocoaPods הוא מנהל תלות בפרויקטים של Xcode, והוא השיטה המומלצת להתקנת IMA DAI SDK. למידע נוסף על התקנה של CocoaPods ועל השימוש בו, עיינו במשאבי העזרה של CocoaPods. אחרי ההתקנה של CocoaPods, תוכלו לבצע את ההוראות הבאות כדי להתקין את IMA DAI SDK:

  1. באותה ספרייה שבה נמצא הקובץ 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

  2. מהספרייה שמכילה את קובץ ה-Podfile, מריצים את:

    pod install --repo-update`

  3. כדי לוודא שההתקנה בוצעה בהצלחה, פותחים את הקובץ BasicExample.xcworkspace ומוודאים שהוא מכיל שני פרויקטים: BasicExample ו-Pods (יחסי התלות שהותקנו על ידי CocoaPods).

התקנת ה-SDK באמצעות מנהל החבילות של Swift

Interactive Media Ads SDK תומך במנהל החבילות של Swift החל מגרסה 4.8.2. כדי לייבא את חבילת Swift, צריך לבצע את השלבים הבאים.

  1. ב-Xcode, מתקינים את חבילת Swift של GoogleInteractiveMediaAds על ידי מעבר אל File > Add Packages (קובץ > הוספת חבילות).

  2. בהודעה שמופיעה, מחפשים את המאגר GoogleInteractiveMediaAds Swift Package GitHub:

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

  3. בחר בגרסה של חבילת GoogleInteractiveMediaAds Swift שבה ברצונך להשתמש. לפרויקטים חדשים, מומלץ להשתמש ב-Up to Next Major Version.

בסיום, Xcode פותר את יחסי התלות של החבילות ומוריד אותן ברקע. למידע נוסף על הוספת יחסי תלות של חבילות, קראו את המאמר של Apple.

הורדה והתקנה של ה-SDK באופן ידני

אם אתם לא רוצים להשתמש ב-Swift Package Manager או ב-CocoaPods, תוכלו להוריד את IMA DAI SDK ולהוסיף אותו לפרויקט באופן ידני.

יצירת נגן וידאו פשוט

קודם כול, מטמיעים נגן וידאו בסיסי. בהתחלה, הנגן הזה לא משתמש ב-IMA DAI 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 DAI SDK לפרויקט, יש לייבא את ה-SDK ולהוסיף קטעי stub לנקודות העיקריות של האינטראקציה עם 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 DAI SDK. למידע נוסף על תכונות SDK מתקדמות יותר, קראו את המדריכים האחרים או דוגמאות ב-GitHub.