Começar a usar o SDK de DAI do IMA

Os SDKs do IMA facilitam a integração de anúncios multimídia aos seus sites e apps. Os SDKs do IMA podem solicitar anúncios de qualquer servidor de anúncios compatível com VAST e gerenciar a veiculação de anúncios nos seus apps. Com os SDKs do IMA DAI, os apps fazem uma solicitação de transmissão para anúncios e vídeos de conteúdo, seja VOD ou conteúdo ao vivo. O SDK retorna uma transmissão de vídeo combinada para que você não precise alternar entre o anúncio e o vídeo de conteúdo no app.

Selecione a solução de DAI de seu interesse

Veiculação de conjunto DAI

Este guia demonstra como integrar o SDK IMA DAI a um app de reprodução de vídeo simples. Se você quiser conferir ou acompanhar uma integração de exemplo completa, faça o download do PodServingExample do GitHub.

Visão geral da DAI do IMA

A implementação do IMA DAI envolve quatro componentes principais do SDK, conforme demonstrado neste guia:

  • IMAAdDisplayContainer: um objeto de contêiner que fica sobre o elemento de reprodução de vídeo e hospeda os elementos de interface do anúncio.
  • IMAAdsLoader: um objeto que solicita streams e processa eventos acionados por objetos de resposta de solicitação de stream. Você só precisa instanciar um carregador de anúncios, que pode ser reutilizado durante toda a vida útil do aplicativo.
  • IMAStreamRequest: um IMAPodVODStreamRequest ou um IMAPodStreamRequest.
  • IMAStreamManager: um objeto que processa streams de inserção de anúncios dinâmicos e interações com o back-end da DAI. O gerenciador de transmissão também processa pings de rastreamento e encaminha eventos de transmissão e de anúncio para o editor.

Além disso, para reproduzir transmissões de veiculação de pods, você precisa implementar um gerenciador VTP personalizado. Esse manipulador VTP personalizado envia o ID do stream ao parceiro técnico de vídeo (VTP, na sigla em inglês) com todas as outras informações necessárias para retornar um manifesto de stream que contém conteúdo e anúncios unidos. O VTP vai fornecer instruções sobre como implementar o gerenciador personalizado.

Pré-requisitos

Antes de começar, os seguintes itens são necessários:

Você também precisa dos parâmetros usados para solicitar o stream do SDK do IMA.

Parâmetros de transmissão ao vivo
Código da rede O código de rede da sua conta do Ad Manager 360.
Exemplo: 51636543
Chave de recurso personalizada A chave de recurso personalizada que identifica seu evento de veiculação de pod no Ad Manager 360. Ele pode ser criado pelo gerenciador de manifesto ou pelo parceiro de veiculação de pods de terceiros.
Exemplo: google-sample
Parâmetros de stream de VOD
Código da rede O código de rede da sua conta do Ad Manager 360.
Exemplo: 51636543

Criar um novo projeto do Xcode

No Xcode, crie um novo projeto iOS usando o Objective-C chamado "PodServingExample".

Adicionar o SDK do IMA DAI ao projeto do Xcode

Use um destes três métodos para instalar o SDK do IMA DAI.

Instalar o SDK usando o CocoaPods (preferencial)

O CocoaPods é um gerenciador de dependências para projetos do Xcode e é o método recomendado para instalar o SDK da DAI do IMA. Para mais informações sobre como instalar ou usar o CocoaPods, consulte a documentação do CocoaPods. Depois de instalar o CocoaPods, use as instruções abaixo para instalar o SDK do IMA DAI:

  1. No mesmo diretório do arquivo PodServingExample.xcodeproj, crie um arquivo de texto chamado Podfile e adicione a seguinte configuração:

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

platform :ios, '14'

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

    Podfile

  2. No diretório que contém o Podfile, execute:

    pod install --repo-update

Instalar o SDK usando o Gerenciador de pacotes do Swift

O SDK do Interactive Media Ads oferece suporte ao Gerenciador de pacotes do Swift a partir da versão 3.18.4. Siga as etapas abaixo para importar o pacote Swift.

  1. No Xcode, instale o pacote Swift do SDK do IMA DAI acessando File > Add Packages.

  2. No prompt exibido, pesquise o repositório do GitHub do pacote Swift do SDK do IMA DAI:

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

  3. Selecione a versão do pacote Swift do SDK do IMA DAI que você quer usar. Para novos projetos, recomendamos usar a próxima versão principal.

Quando terminar, o Xcode vai resolver as dependências do pacote e fazer o download delas em segundo plano. Para mais detalhes sobre como adicionar dependências de pacote, consulte o artigo da Apple.

Fazer o download e instalar o SDK manualmente

Se você não quiser usar o Gerenciador de pacotes do Swift ou o CocoaPods, faça o download do SDK IMA DAI e adicione-o manualmente ao seu projeto.

Criar um player de vídeo simples

Implemente um player de vídeo no seu controlador de visualização principal usando um player AV encapsulado em uma visualização de interface. O SDK do IMA usa a visualização da interface para mostrar elementos da interface do anúncio.

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

Inicializar o carregador de anúncios

Importe o SDK do IMA no seu controlador de visualização e adote os protocolos IMAAdsLoaderDelegate e IMAStreamManagerDelegate para processar eventos do gerenciador de fluxo e do carregador de anúncios.

Adicione estas propriedades privadas para armazenar os principais componentes do SDK do IMA:

  • IMAAdsLoader: gerencia as solicitações de stream durante a vida útil do app.
  • IMAAdDisplayContainer: processa a inserção e o gerenciamento de elementos da interface do usuário do anúncio.
  • IMAAVPlayerVideoDisplay: se comunica entre o SDK do IMA e o player de mídia e processa metadados temporizados.
  • IMAStreamManager: gerencia a reprodução do stream e dispara eventos relacionados a anúncios.

Inicialize o carregador de anúncios, o contêiner de exibição de anúncios e a exibição de vídeo após o carregamento da visualização.

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

Fazer uma solicitação de stream

Quando um usuário pressiona o botão de reprodução, faça uma nova solicitação de transmissão. Use a classe IMAPodStreamRequest para transmissões ao vivo. Para transmissões VOD, use a classe IMAPodVODStreamRequest.

A solicitação de stream exige seus parâmetros de stream, além de uma referência ao invólucro de exibição de anúncios e à exibição de vídeo.

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

Ouvir eventos de carregamento de stream

A classe IMAAdsLoader chama os métodos IMAAdsLoaderDelegate na inicialização bem-sucedida ou na falha da solicitação de transmissão.

No método de delegação adsLoadedWithData, defina o IMAStreamManagerDelegate. Transmita o ID do stream para seu gerenciador VTP personalizado e extraia o URL do manifesto do stream. Para transmissões ao vivo, carregue o URL do manifesto na tela de vídeo e inicie a reprodução. Para transmissões VOD, transmita o URL do manifesto para o método loadThirdPartyStream do gerenciador de transmissões. Esse método solicita dados de eventos de anúncios do Ad Manager 360, carrega o URL do manifesto e inicia a reprodução.

No método do delegante failedWithErrorData, registre o erro. Opcionalmente, reproduza o stream de backup. Consulte as práticas recomendadas para DAI.

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

Implementar o gerenciador de VTP personalizado

O gerenciador VTP personalizado envia o ID do stream do espectador para seu parceiro técnico de vídeo (VTP, na sigla em inglês) com todas as outras informações necessárias para retornar um manifesto de stream contendo conteúdo e anúncios unidos. O VTP vai fornecer instruções específicas sobre como implementar o gerenciador VTP personalizado.

Por exemplo, um VTP pode incluir um URL de modelo de manifesto que contém a macro [[STREAMID]]. Neste exemplo, o gerenciador insere o ID do stream no lugar da macro e retorna o URL do manifesto resultante.

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

Ouvir eventos de anúncios

O IMAStreamManager chama os métodos IMAStreamManagerDelegate para transmitir eventos e erros de streaming para o aplicativo.

Neste exemplo, registre os eventos de anúncios principais no 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

Limpar recursos da DAI do IMA

Para interromper a reprodução do stream, interromper todo o rastreamento de anúncios e liberar todos os recursos de stream carregados, chame IMAStreamManager.destroy().

Execute o app e, se for bem-sucedido, solicite e reproduza fluxos de DAI do Google com o SDK do IMA. Para saber mais sobre recursos avançados do SDK, consulte outros guias listados na barra lateral esquerda ou exemplos no GitHub.