תחילת העבודה עם 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, יוצרים פרויקט חדש ל-iOS באמצעות 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 :ios, '14'
target "BasicExample" do
  pod 'GoogleAds-IMA-iOS-SDK', '~> 3.22.1'
end

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

    pod install --repo-update`

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

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

ב-Interactive Media Ads SDK יש תמיכה ב-Swift Package Manager, החל מגרסה 3.18.4. מבצעים את השלבים הבאים כדי לייבא את חבילת Swift.

  1. ב-Xcode, מתקינים את IMA DAI SDK SWIFT Package על ידי מעבר אל File > Add Package.

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

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

  3. בוחרים את הגרסה של IMA DAI SDK 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;
}

שליחת בקשה לשידור

יוצרים מספר קבועים כדי להחזיק את פרטי השידור ואז מטמיעים את פונקציית הבקשה ל-stream כדי לשלוח את הבקשה.

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.