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

  • 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.13.0'
end

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

    pod install --repo-update`

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

התקנת ה-SDK באמצעות Swift Package Manager

ב-Interactive Media Ads SDK יש תמיכה ב-Swift Package חשבון ניהול החל מגרסה 4.8.2. מעקב השלבים לייבוא חבילת Swift.

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

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

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

  3. בוחרים את הגרסה של GoogleInteractiveMediaAds SWIFT Package שבה רוצים להשתמש. חדשים לגבי פרויקטים, מומלץ להשתמש ב-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 ומוסיפים קטעי טקסט עבור הנקודות העיקריות של האינטראקציה של 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.