Premiers pas avec le SDK IMA DAI

Les SDK IMA facilitent l'intégration d'annonces multimédias dans vos sites Web et applications. Les SDK IMA demander des annonces compatible avec la norme VAST et gérer la lecture des annonces dans vos applications. Avec les SDK IMA DAI, les applications demande de flux pour une annonce et du contenu vidéo (VOD ou en direct). Le SDK renvoie ensuite un flux vidéo combiné, pour vous éviter d'avoir à gérer le basculement entre l'annonce et la vidéo de contenu. dans votre application.

Sélectionnez la solution d'insertion dynamique d'annonce qui vous intéresse

Insertion dynamique d'annonces à service complet

Ce guide explique comment intégrer le SDK IMA DAI dans une vidéo simple de votre application. Si vous souhaitez consulter ou suivre un exemple terminé intégration, téléchargez le BasicExample de GitHub

Présentation de l'insertion dynamique d'annonces IMA

Comme le montre cet exemple, quatre composants principaux du SDK guide:

  • IMAAdDisplayContainer: Objet conteneur placé au-dessus de l'élément de lecture vidéo et héberge les éléments d'UI de l'annonce.
  • IMAAdsLoader: Objet qui demande des flux et gère les événements déclenchés par des objets de réponse aux requêtes de flux. Vous ne devez instancier qu'un seul chargeur d'annonces, qui peut être réutilisé tout au long de la durée de vie du application.
  • IMAStreamRequest : soit un IMAVODStreamRequest ou un IMALiveStreamRequest: Objet qui définit une requête de flux. Les demandes de diffusion peuvent concerner des vidéos à la demande ou des diffusions en direct. flux. Les requêtes spécifient un ID de contenu, ainsi qu'une clé API ou un jeton d'authentification paramètres.
  • IMAStreamManager: Objet qui gère les flux d'insertion dynamique d'annonces et les interactions avec le backend d'insertion dynamique d'annonce. La Stream Manager gère également les pings de suivi, et transfère les événements de flux et d'annonces au à un éditeur.

Prérequis

Avant de commencer, vous avez besoin des éléments suivants :

Créer un projet Xcode

Dans Xcode, créez un projet iOS à l'aide d'Objective-C. Utilisez BasicExample comme le nom du projet.

Ajouter le SDK IMA DAI au projet Xcode

Installez le SDK IMA DAI à l'aide de l'une de ces trois méthodes.

Installer le SDK à l'aide de CocoaPods (recommandé)

CocoaPods est un gestionnaire de dépendances pour les projets Xcode. Il s'agit pour installer le SDK IMA DAI. Pour en savoir plus sur l'installation ou à l'aide de CocoaPods, consultez la documentation de CocoaPods. Après vous avez installé CocoaPods, suivez les instructions ci-dessous pour installer le SDK IMA DAI:

  1. Dans le répertoire contenant votre fichier BasicExample.xcodeproj, créez un texte nommé Podfile et ajoutez la configuration suivante:

    source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '14'
target "BasicExample" do
  pod 'GoogleAds-IMA-iOS-SDK', '~> 3.23.0'
end

  2. Dans le répertoire contenant le Podfile, exécutez la commande suivante:

    pod install --repo-update`

  3. Vérifiez que l'installation a réussi en ouvrant le BasicExample.xcworkspace et vérifier qu'il contient deux projets: BasicExample et Pods (les dépendances installées par CocoaPods).

Installer le SDK à l'aide de Swift Package Manager

Le SDK Interactive Media Ads est compatible avec le package Swift Manager à partir de la version 3.18.4. Suivez le les étapes suivantes pour importer le package Swift.

  1. Dans Xcode, installez le package Swift du SDK IMA DAI en accédant à Fichier > Ajouter des packages.

  2. Dans l'invite qui s'affiche, recherchez le package GitHub du package Swift du SDK IMA DAI pour l'insertion dynamique d'annonce. dépôt:

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

  3. Sélectionnez la version du package Swift du SDK IMA DAI que vous souhaitez utiliser. Neuf nous vous recommandons d'utiliser l'option Jusqu'à la prochaine version majeure.

Lorsque vous avez terminé, Xcode résout vos dépendances de package et les télécharge en arrière-plan. Pour en savoir plus sur l'ajout de dépendances de packages, consultez article d'Apple.

Télécharger et installer manuellement le SDK

Si vous ne souhaitez pas utiliser Swift Package Manager ou CocoaPods, vous pouvez télécharger le SDK IMA DAI et de l'ajouter manuellement à votre projet.

Créer un lecteur vidéo simple

Commencez par implémenter un lecteur vidéo de base. Au départ, ce lecteur n'utilise pas le SDK IMA DAI et ne contient aucune méthode pour déclencher la lecture.

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

Importer le SDK et ajouter des bouchons pour l'interaction avec IMA

Après avoir ajouté le SDK IMA DAI à votre projet, importez-le et ajoutez des bouchons. pour les principaux points d'interaction avec l'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

Implémenter le composant IMAAdsLoader

Ensuite, instanciez IMAAdsLoader et associez la vue du conteneur d'annonces à la la hiérarchie des vues.

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;
}

Envoyer une demande de flux

Créez quelques constantes pour stocker les informations de flux, puis implémentez la stream request pour envoyer la requête.

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];
}

Gérer les événements de diffusion

IMAAdsLoader et IMAStreamManager déclenchent des événements permettant de gérer l'initialisation, les erreurs et les changements d'état du flux. Ces événements sont déclenchés les protocoles IMAAdsLoaderDelegate et IMAStreamManagerDelegate. Écouter un événement chargé des annonces et initialiser le flux. Si le chargement d'une annonce échoue, le flux secondaire à la place.

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

Gérer la journalisation et les événements d'erreur

Le délégué du gestionnaire de flux peut gérer plusieurs événements, mais pour les implémentations de base, les utilisations les plus importantes sont la journalisation des événements, pour empêcher les actions de recherche lors de la lecture des annonces et pour gérer les erreurs.

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

Et voilà ! Vous demandez et affichez à présent des annonces à l'aide du SDK IMA DAI. À pour en savoir plus sur les fonctionnalités avancées du SDK, consultez les autres guides exemples sur GitHub.