Iniziare a utilizzare l'SDK IMA DAI

Gli SDK IMA semplificano l'integrazione degli annunci multimediali nei tuoi siti web e nelle tue app. Gli SDK IMA possono richiedere annunci da qualsiasi ad server conforme a VAST e gestire la riproduzione degli annunci nelle tue app. Con gli SDK IMA DAI, le app inviano una richiesta di streaming per gli annunci e i video di contenuti, sia VOD che dal vivo. L'SDK restituisce quindi un stream video combinato, in modo da non dover gestire il passaggio tra annunci e video di contenuti all'interno della tua app.

Seleziona la soluzione DAI che ti interessa

Pubblicazione di pod DAI

Questa guida illustra come integrare l'SDK IMA DAI in una semplice app di video player. Se vuoi visualizzare o seguire un'integrazione di esempio completata, scarica PodServingExample da GitHub.

Panoramica di IMA DAI

L'implementazione di IMA DAI prevede quattro componenti principali dell'SDK, come mostrato in questa guida:

  • IMAAdDisplayContainer: un oggetto contenitore che si trova sopra l'elemento di riproduzione video e contiene gli elementi dell'interfaccia utente dell'annuncio.
  • IMAAdsLoader: un oggetto che richiede stream e gestisce gli eventi attivati dagli oggetti di risposta alla richiesta di stream. Devi creare un'istanza di un solo caricatore di annunci, che può essere riutilizzato per tutta la durata dell'applicazione.
  • IMAStreamRequest: un IMAPodVODStreamRequest o un IMAPodStreamRequest.
  • IMAStreamManager – Un oggetto che gestisce gli stream di inserzione di annunci dinamici e le interazioni con il backend DAI. Il gestore dello stream gestisce anche i ping di monitoraggio e inoltra gli eventi relativi allo stream e agli annunci al publisher.

Inoltre, per riprodurre gli stream di pubblicazione di pod, devi implementare un handler VTP personalizzato. Questo gestore VTP personalizzato invia l'ID stream al tuo partner tecnico video (VTP) insieme a tutte le altre informazioni necessarie per restituire un manifest dello stream contenente sia i contenuti sia gli annunci uniti. Il tuo VTP fornirà le istruzioni su come implementare il gestore VTP personalizzato.

Prerequisiti

Prima di iniziare, devi disporre di quanto segue:

Sono necessari anche i parametri utilizzati per richiedere lo stream dall'SDK IMA.

Parametri di live streaming
Codice rete Il codice di rete del tuo account Ad Manager 360.
Esempio: 51636543
Chiave asset personalizzata La chiave dell'asset personalizzato che identifica l'evento di pubblicazione del pod in Ad Manager 360. Può essere creato dal tuo manipolatore del manifest o da un partner di terze parti per la pubblicazione di pod.
Esempio: google-sample
Parametri di streaming VOD
Codice rete Il codice di rete del tuo account Ad Manager 360.
Esempio: 51636543

Creare un nuovo progetto Xcode

In Xcode, crea un nuovo progetto iOS utilizzando Objective-C denominato "PodServingExample".

Aggiungi l'SDK IMA DAI al progetto Xcode

Utilizza uno di questi tre metodi per installare l'SDK IMA DAI.

Installa l'SDK utilizzando CocoaPods (opzione preferita)

CocoaPods è un gestore delle dipendenze per i progetti Xcode ed è il metodo consigliato per installare l'SDK IMA DAI. Per ulteriori informazioni sull'installazione o sull'utilizzo di CocoaPods, consulta la documentazione di CocoaPods. Dopo aver installato CocoaPods, segui le istruzioni riportate di seguito per installare l'SDK IMA DAI:

  1. Nella stessa directory del file PodServingExample.xcodeproj, crea un file di testo chiamato Podfile e aggiungi la seguente configurazione:

    Podfile 
    source 'https://github.com/CocoaPods/Specs.git'

platform :ios, '14'

target 'PodServingExample' do
  pod 'GoogleAds-IMA-iOS-SDK'
end

    Podfile

  2. Dalla directory che contiene il file Podfile, esegui:

    pod install --repo-update

Installa l'SDK utilizzando Swift Package Manager

L'SDK Interactive Media Ads supporta Swift Package Manager a partire dalla versione 3.18.4. Segui i seguenti passaggi per importare il pacchetto Swift.

  1. In Xcode, installa il pacchetto Swift dell'SDK IMA DAI andando a File > Aggiungi pacchetti.

  2. Nella richiesta visualizzata, cerca il repository GitHub del pacchetto Swift dell'SDK IMA DAI:

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

  3. Seleziona la versione del pacchetto Swift dell'SDK IMA DAI che vuoi utilizzare. Per i nuovi progetti, consigliamo di utilizzare l'opzione Fino alla versione principale successiva.

Al termine, Xcode risolve le dipendenze del pacchetto e le scarica in background. Per maggiori dettagli su come aggiungere le dipendenze dei pacchetti, consulta l'articolo di Apple.

Scaricare e installare manualmente l'SDK

Se non vuoi utilizzare Swift Package Manager o CocoaPods, puoi scaricare l'SDK IMA DAI e aggiungerlo manualmente al tuo progetto.

Creare un video player semplice

Implementa un video player nel tuo view controller principale utilizzando un player AV inserito in una vista UI. L'SDK IMA utilizza la visualizzazione dell'interfaccia utente per visualizzare gli elementi dell'interfaccia utente dell'annuncio.

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

Inizializzare il caricatore degli annunci

Importa l'SDK IMA nel tuo view controller e adotta i protocolli IMAAdsLoaderDelegate e IMAStreamManagerDelegate per gestire gli eventi di caricamento degli annunci e di gestione dello stream.

Aggiungi queste proprietà private per memorizzare i componenti chiave dell'SDK IMA:

  • IMAAdsLoader: gestisce le richieste di stream per tutta la durata dell'app.
  • IMAAdDisplayContainer: gestisce l'inserimento e la gestione degli elementi dell'interfaccia utente dell'annuncio.
  • IMAAVPlayerVideoDisplay: comunica tra l'SDK IMA e il media player e gestisce i metadati con temporizzazione.
  • IMAStreamManager: gestisce la riproduzione dello stream e attiva gli eventi correlati agli annunci.

Inizializza il caricamento degli annunci, il contenitore di visualizzazione degli annunci e la visualizzazione del video dopo il caricamento della visualizzazione.

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

Inviare una richiesta di streaming

Quando un utente preme il pulsante di riproduzione, effettua una nuova richiesta di stream. Utilizza la classe IMAPodStreamRequest per i live streaming. Per gli stream VOD, utilizza la classe IMAPodVODStreamRequest.

La richiesta di stream richiede i parametri dello stream, nonché un riferimento al contenitore di visualizzazione dell'annuncio e alla visualizzazione video.

ViewController.m 
- (IBAction)onPlayButtonTouch:(id)sender {
  [self requestStream];
  self.playButton.hidden = YES;
}

- (void)requestStream {
  // Create a stream request.
  IMAStreamRequest *request;
  if (kStreamType == StreamTypeLive) {
    // Live stream request. Replace the network code and custom asset key with your values.
    request = [[IMAPodStreamRequest alloc] initWithNetworkCode:kNetworkCode
                                                customAssetKey:kCustomAssetKey
                                            adDisplayContainer:adDisplayContainer
                                                  videoDisplay:self.videoDisplay
                                         pictureInPictureProxy:nil
                                                   userContext:nil];
  } else {
    // VOD request. Replace the network code with your value.
    request = [[IMAPodVODStreamRequest alloc] initWithNetworkCode:@kNetworkCode
                                               adDisplayContainer:adDisplayContainer
                                                     videoDisplay:self.videoDisplay
                                            pictureInPictureProxy:nil
                                                      userContext:nil];
  }
  [self.adsLoader requestStreamWithRequest:request];
}
ViewController.m

Ascolta gli eventi di caricamento dello stream

La classe IMAAdsLoader invoca i metodi IMAAdsLoaderDelegate in caso di inizializzazione riuscita o di errore della richiesta di stream.

Nel metodo delegato adsLoadedWithData, imposta IMAStreamManagerDelegate. Passa l'ID stream al gestore VTP personalizzato e recupera l'URL del manifest dello stream. Per i live streaming, carica l'URL manifest nella visualizzazione video e avvia la riproduzione. Per gli stream VOD, passa l'URL manifest al metodo loadThirdPartyStream del gestore dello stream. Questo metodo richiede i dati sugli eventi correlati agli annunci da Ad Manager 360, quindi carica l'URL manifest e avvia la riproduzione.

Nel metodo delegato failedWithErrorData registra l'errore. Se vuoi, riproduci lo stream di backup. Consulta le best practice per l'inserimento di annunci dinamici.

ViewController.m 
- (void)adsLoader:(IMAAdsLoader *)loader adsLoadedWithData:(IMAAdsLoadedData *)adsLoadedData {
  NSLog(@"Stream created with: %@.", adsLoadedData.streamManager.streamId);
  self.streamManager = adsLoadedData.streamManager;
  self.streamManager.delegate = self;

  // Build the Pod serving Stream URL.
  NSString *streamID = adsLoadedData.streamManager.streamId;
  // Your custom VTP handler takes the stream ID and returns the stream manifest URL.
  NSString *urlString = gCustomVTPHandler(streamID);
  NSURL *streamUrl = [NSURL URLWithString:urlString];
  if (kStreamType == StreamTypeLive) {
    // Load live streams directly into the AVPlayer.
    [self.videoDisplay loadStream:streamUrl withSubtitles:@[]];
    [self.videoDisplay play];
  } else {
    // Load VOD streams using the `loadThirdPartyStream` method in IMA SDK's stream manager.
    // The stream manager loads the stream, requests metadata, and starts playback.
    [self.streamManager loadThirdPartyStream:streamUrl streamSubtitles:@[]];
  }
}

- (void)adsLoader:(IMAAdsLoader *)loader failedWithErrorData:(IMAAdLoadingErrorData *)adErrorData {
  // Log the error and play the backup content.
  NSLog(@"AdsLoader error, code:%ld, message: %@", adErrorData.adError.code,
        adErrorData.adError.message);
  [self.videoPlayer play];
}
ViewController.m

Implementa il gestore VTP personalizzato

Il gestore VTP personalizzato invia l'ID stream dello spettatore al tuo partner tecnico video (VTP) insieme a tutte le altre informazioni necessarie al VTP per restituire un manifest dello stream contenente sia i contenuti sia gli annunci uniti. Il tuo VTP fornirà istruzioni specifiche su come implementare il gestore VTP personalizzato.

Ad esempio, un VTP può includere un URL del modello manifest contenente la macro [[STREAMID]]. In questo esempio, l'handler inserisce l'ID stream al posto della macro e restituisce l'URL manifest risultante.

ViewController.m 
/// Custom VTP Handler.
///
/// Returns the stream manifest URL from the video technical partner or manifest manipulator.
static NSString *(^gCustomVTPHandler)(NSString *) = ^(NSString *streamID) {
  // Insert synchronous code here to retrieve a stream manifest URL from your video tech partner
  // or manifest manipulation server.
  // This example uses a hardcoded URL template, containing a placeholder for the stream
  // ID and replaces the placeholder with the stream ID.
  NSString *manifestUrl = @"YOUR_MANIFEST_URL_TEMPLATE";
  return [manifestUrl stringByReplacingOccurrencesOfString:@"[[STREAMID]]"
                                                withString:streamID];
};
ViewController.m

Ascoltare gli eventi correlati agli annunci

IMAStreamManager invoca i metodi IMAStreamManagerDelegate per trasmettere eventi e errori dello stream alla tua applicazione.

Per questo esempio, registra gli eventi relativi agli annunci principali nella console:

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

Organizzare gli asset DAI IMA

Per interrompere la riproduzione dello stream, interrompere tutto il monitoraggio degli annunci e rilasciare tutti gli asset stream caricati, chiama IMAStreamManager.destroy().

Esegui l'app e, se la richiesta va a buon fine, puoi richiedere e riprodurre gli stream DAI di Google con l'SDK IMA. Per scoprire di più sulle funzionalità SDK più avanzate, consulta le altre guide elencate nella barra laterale a sinistra o i sample su GitHub.