Usar o SDK do IMA DAI no iOS

Reproduzir streams de VOD registrados na API Google Cloud Video Stitcher

Este guia demonstra como usar o SDK do IMA DAI para iOS para solicitar e reproduzir uma sessão de stream de VOD do Google Cloud.

Este guia expande o exemplo básico do guia de introdução do IMA DAI.

Para informações sobre a integração com outras plataformas ou sobre o uso dos SDKs do IMA no lado do cliente, consulte SDKs do Interactive Media Ads.

Se você quiser conferir ou acompanhar uma integração de amostra concluída, baixe o exemplo do Cloud Video Stitcher para Objective-C ou Swift.

Observação: a Apple só oferece frameworks para oferecer suporte ao HTTP Live Streaming (HLS), como AVKit, AVFoundation e WebKit. Esses frameworks não funcionam com o formato de stream DASH.

Configurar um projeto do Google Cloud

Insira as seguintes variáveis para uso no SDK do IMA:

Local

A região do Google Cloud em que a configuração de VOD foi criada: LOCATION

Número do projeto

O número do projeto na nuvem do Google Cloud que usa a API Video Stitcher:PROJECT_NUMBER

Token OAuth

O token OAuth de curta duração de uma conta de serviço com o papel de usuário do Video Stitcher:

OAUTH_TOKEN

Saiba mais sobre como criar tokens OAuth de curta duração. O token OAuth pode ser reutilizado em várias solicitações, desde que não tenha expirado.

Código da rede

O código de rede do Ad Manager para solicitar anúncios: NETWORK_CODE

ID de configuração de VOD

O ID de configuração de VOD para o stream de VOD: VOD_CONFIG_ID

Saiba mais sobre como criar o ID de configuração de VOD no guia Criar uma configuração de VOD do Cloud Stitching.

Contexto do usuário

O contexto do usuário para solicitações de rastreamento. Pode ser nil. O padrão é nil neste guia.

Configurar o exemplo básico

Acesse a página de lançamento do IMA iOS DAI no GitHub e baixe o exemplo básico do Objective-C. Esse exemplo é um projeto do Xcode para iOS que depende do Cocoapods para carregar o SDK do IMA DAI. Se você estiver usando o Swift, o IMA não terá um app de exemplo para iOS, mas confira o snippet de código Swift mais adiante neste guia para saber como implementar um IMAVideoStitcherVODStreamRequest no seu próprio app.

Importante: o SDK do IMA DAI v3.23.0 ou mais recente é obrigatório. Atualize o arquivo de pod conforme necessário.

Para preparar o exemplo para execução, verifique se o CocoaPods está instalado, em seguida, abra a pasta do exemplo básico no terminal e execute o seguinte comando:

pod install --repo-update

Quando esse comando for concluído, um arquivo chamado BasicExample.xcworkspace vai aparecer na pasta do projeto. Abra esse arquivo no Xcode e execute o exemplo para garantir que o vídeo de teste e os anúncios sejam reproduzidos conforme o esperado.

Solicitar um stream de VOD

Para substituir o stream de exemplo pelo stream de VOD com anúncios, use IMAVideoStitcherVODStreamRequest para criar uma sessão de anúncios com o Google Ad Manager. Você pode usar a interface do Google Ad Manager para localizar as sessões de DAI geradas para monitoramento e depuração.

No exemplo atual, há exemplos de como solicitar um stream de VOD ou uma transmissão ao vivo dos servidores de DAI do Google. Para que ele funcione com a API Google Cloud Video Stitcher, é necessário substituir a função requestStream atual por uma que use a classe IMAVideoStitcherVODStreamRequest.

Veja um exemplo:

Objective-C

ViewController.m

...

#import <GoogleInteractiveMediaAds/GoogleInteractiveMediaAds.h>
/// The Stream's VOD config ID.
static NSString *const kVODConfigID = @"VOD_CONFIG_ID";
/// The Network Code used by the Video Stitcher API.
static NSString *const kNetworkCode = @"NETWORK_CODE";
/// The Google Cloud project using the Video Stitcher API.
static NSString *const kProjectNumber = @"PROJECT_NUMBER";
/// The Google Cloud region containing your project.
static NSString *const kLocation = @"LOCATION";
/// An OAuth Token created by a Google Cloud account with Video Stitcher API
/// permissions.
static NSString *const kOAuthToken = @"OAUTH_TOKEN";

/// Fallback URL in case something goes wrong in loading the stream. If all goes well, this will not
/// be used.
static NSString *const kBackupStreamURLString =
    @"http://googleimadev-vh.akamaihd.net/i/big_buck_bunny/bbb-,480p,720p,1080p,.mov.csmil/"
    @"master.m3u8";
@interface ViewController () <IMAAdsLoaderDelegate, IMAStreamManagerDelegate>

...

- (void)requestStream {
    // Create an ad display container for ad rendering.
    IMAAdDisplayContainer *adDisplayContainer =
        [[IMAAdDisplayContainer alloc] initWithAdContainer:self.videoView
                                            viewController:self
                                            companionSlots:nil];
    // Create an IMAAVPlayerVideoDisplay to give the SDK access to your video player.
    IMAAVPlayerVideoDisplay *imaVideoDisplay =
        [[IMAAVPlayerVideoDisplay alloc] initWithAVPlayer:self.contentPlayer];
    IMAVideoStitcherVODStreamRequest *streamRequest =
        [[IMAVideoStitcherVODStreamRequest alloc] initWithVODConfigID:kVODConfigID
                                                             region:kLocation
                                                      projectNumber:kProjectNumber
                                                         OAuthToken:kOAuthToken
                                                        networkCode:kNetworkCode
                                                 adDisplayContainer:adDisplayContainer
                                                       videoDisplay:imaVideoDisplay
                                                        userContext:nil
                                        videoStitcherSessionOptions:nil];
    [self.adsLoader requestStreamWithRequest:streamRequest];
}

...

Swift

ViewController.swift

...

class ViewController: UIViewController, IMAAdsLoaderDelegate, IMAStreamManagerDelegate {
  /// The Stream's VOD config ID.
  static let vodConfigID = "VOD_CONFIG_ID"
  /// The Network Code used by the Video Stitcher API.
  static let networkCode = "NETWORK_CODE"
  /// The Google Cloud project using the Video Stitcher API.
  static let projectNumber = "PROJECT_NUMBER"
  /// The Google Cloud region containing your project.
  static let location = "LOCATION"
  /// An OAuth Token created by a Google Cloud account with Video Stitcher API
  /// permissions.
  static let oAuthToken = "OAUTH_TOKEN"

  /// Fallback URL in case something goes wrong in loading the stream. If all goes well, this will
  /// not be used.
  static let backupStreamURLString = """
    http://googleimadev-vh.akamaihd.net/i/big_buck_bunny/\
    bbb-,480p,720p,1080p,.mov.csmil/master.m3u8
    """

  ...

  func requestStream() {
    // Create an ad display container for ad rendering.
    adDisplayContainer = IMAAdDisplayContainer(
      adContainer: videoView,
      viewController: self,
      companionSlots: nil)
    // Create an IMAAVPlayerVideoDisplay to give the SDK access to your video player.
    let imaVideoDisplay = IMAAVPlayerVideoDisplay(avPlayer: contentPlayer!)
    // Create a VOD stream request.
    let streamRequest = IMAVideoStitcherVODStreamRequest(
      VODConfigID: ViewController.vodConfigID,
      region: ViewController.location,
      projectNumber: ViewController.projectNumber,
      oAuthToken: ViewController.oAuthToken,
      networkCode: ViewController.networkCode,
      adDisplayContainer: adDisplayContainer!,
      videoDisplay: imaVideoDisplay,
      userContext: nil,
      videoStitcherSessionOptions: nil)
    adsLoader?.requestStream(with: streamRequest)
  }

  ...

Execute o projeto. Em seguida, você poderá solicitar e reproduzir seu stream de VOD personalizado.

Opcional: adicionar opções de sessão de streaming

Personalize a solicitação de stream adicionando opções de sessão para substituir a configuração padrão da API Cloud Video Stitcher. Para isso, preencha o videoStitcherSessionOptions parâmetro no IMAVideoStitcherVODStreamRequest. Se você fornecer uma opção não reconhecida, a API Cloud Video Stitcher vai responder com um erro HTTP 400. Consulte o guia de solução de problemas para receber ajuda.

Por exemplo, é possível substituir as opções de manifesto com o snippet de código a seguir, que solicita dois manifestos de stream com renderizações ordenadas do menor para o maior bitrate.

Objective-C

 // Define session options JSON string.
 // The following session options are examples. Use session options
 // that are compatible with your video stream.
 NSString *sessionOptionsStr =
   @"{"
   "  \"manifestOptions\": {"
   "    \"bitrateOrder\": \"ascending\""
   "  }"
   "}";
 // convert JSON NSString to NSDictionary
 NSData *sessionOptionsData = [sessionOptionsStr dataUsingEncoding:NSUTF8StringEncoding];
 NSError *error = nil;
 NSDictionary *sessionOptions = [NSJSONSerialization
                       JSONObjectWithData:sessionOptionsData
                       options:0
                       error:&error];
 // make stream request
 IMAVideoStitcherVODStreamRequest *streamRequest =
     [[IMAVideoStitcherVODStreamRequest alloc] initWithVODConfigID:kVODConfigID
                                                           region:kLocation
                                                     projectNumber:kProjectNumber
                                                       OAuthToken:kOAuthToken
                                                       networkCode:kNetworkCode
                                               adDisplayContainer:adDisplayContainer
                                                     videoDisplay:imaVideoDisplay
                                                       userContext:nil
                                       videoStitcherSessionOptions:sessionOptions];
 [self.adsLoader requestStreamWithRequest:streamRequest];

Swift

 // Define session options JSON string.
 // The following session options are examples. Use session options
 // that are compatible with your video stream.
 let sessionOptionsStr = """
     {
       "manifestOptions": {
         "bitrateOrder": "ascending"
       }
     }
     """
 // convert JSON string to dictionary
 guard let sessionOptionsData = sessionOptionsStr.data(using: .utf8, allowLossyConversion: false) else { return nil }
 let sessionOptions = try? JSONSerialization.jsonObject(with: sessionOptionsData, options: .mutableContainers)
 // make stream request
 let streamRequest = IMAVideoStitcherVODStreamRequest(
   vodConfigID:ViewController.vodConfigID
   region:ViewController.location
   projectNumber:ViewController.projectNumber
   OAuthToken:ViewController.oAuthToken
   networkCode:ViewController.networkCode
   adDisplayContainer:adDisplayContainer
   videoDisplay:imaVideoDisplay
   userContext:nil
   videoStitcherSessionOptions:sessionOptions)
 adsLoader?.requestStream(with: streamRequest)

Limpar

Agora que você hospedou um stream de VOD usando a API Google Cloud Video Stitcher e o solicitou usando o SDK do IMA DAI para iOS, é importante limpar todos os recursos de veiculação.

Siga o guia de limpeza de VOD para remover recursos e recursos desnecessários.