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

Serviço completo Serviço de pods

DAI de serviço completo

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

Observação:o SDK da DAI do IMA para Android é compatível com streams HLS e DASH.

Este guia explica como configurar o Exoplayer e o SDK do IMA DAI para reproduzir um stream HLS. Para conferir um exemplo de player de vídeo com suporte a streams HLS e DASH, consulte nosso Exemplo avançado.

Para usar o IMA DAI, você precisa ter uma conta do Ad Manager 360 Advanced. Se você tiver uma conta do Ad Manager, entre em contato com seu gerente de contas para saber mais detalhes. Para saber como se inscrever no Ad Manager, acesse a Central de Ajuda do Ad Manager.

Importante: a extensão IMA do ExoPlayer oferece uma maneira simplificada de usar o DAI do IMA no Android. Consulte o guia de extensão do ExoPlayer IMA e o ExoPlayerExample no GitHub para mais detalhes.

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

Visão geral da DAI do IMA

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

• StreamDisplayContainer: um objeto de contêiner que fica acima do elemento de reprodução de vídeo e hospeda os elementos da interface do anúncio.
• AdsLoader: um objeto que solicita fluxos e processa eventos acionados por objetos de resposta de solicitação de fluxo. Você só precisa instanciar um carregador de anúncios, que pode ser reutilizado durante toda a vida útil do aplicativo.
• StreamRequest: um objeto que define uma solicitação de transmissão. As solicitações de transmissão podem ser para transmissões ao vivo ou de vídeo on demand. As solicitações especificam um ID de conteúdo, uma chave de API ou token de autenticação e outros parâmetros.
• StreamManager: 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 stream também processa pings de rastreamento e encaminha eventos de stream e de anúncio para o editor.

Pré-requisitos

• Android Studio
• Exemplo de app de player de vídeo para a integração do SDK

Fazer o download e executar o app de exemplo do player de vídeo

O app de exemplo oferece um player de vídeo funcional que reproduz vídeos HLS. Use isso como um ponto de partida para integrar os recursos de DAI do SDK do IMA.

1. Faça o download e extraia o app de amostra do player de vídeo.

2. Inicie o Android Studio e selecione Open an existing Android Studio project. Se o Android Studio já estiver em execução, selecione File > New > Import Project. Em seguida, escolha SampleVideoPlayer/build.gradle.

3. Execute uma sincronização do Gradle selecionando Tools > Android > Sync Project with Gradle Files.

4. Confira se o app do player é compilado e executado em um dispositivo Android físico ou em um dispositivo virtual Android usando Run > Run 'app'. É normal que a transmissão de vídeo demore alguns instantes para carregar antes da reprodução.

Dica: se você está começando a desenvolver aplicativos Android, confira os tutoriais sobre Depuração USB e Uso de dispositivos virtuais. Você precisa fazer uma dessas duas coisas para executar o novo app e conferir como ele está.

Examinar o player de vídeo de exemplo

O player de vídeo de exemplo ainda não contém nenhum código de integração do SDK do IMA DAI. O app de exemplo consiste em duas partes principais:

1. samplevideoplayer/SampleVideoPlayer.java: um player HLS baseado no ExoPlayer que serve como base para a integração do DAI do IMA.

2. videoplayerapp/MyActivity.java: essa atividade cria o player de vídeo e o transmite a um Context e SimpleExoPlayerView.

Adicionar o SDK do IMA DAI ao app do player

Também é necessário incluir uma referência ao SDK do DAI do IMA. No Android Studio, adicione o seguinte ao arquivo build.gradle no nível do aplicativo, localizado em app/build.gradle:

repositories {
  google()
  mavenCentral()
}

dependencies {
    implementation 'androidx.appcompat:appcompat:1.6.1'
    implementation 'androidx.media3:media3-exoplayer:1.3.1'
    implementation 'com.google.ads.interactivemedia.v3:interactivemedia:3.35.1'
}

Importante: o app deve ser compilado e executado nesse ponto, mas você ainda precisa adicionar elementos da interface ou código para solicitar e mostrar anúncios.

Integrar o SDK do IMA DAI

1. Crie uma nova classe chamada SampleAdsWrapper no pacote videoplayerapp (em app/java/com.google.ads.interactivemedia.v3.samples/videoplayerapp/) para agrupar o SampleVideoPlayer e adicionar a lógica que implementa o DAI do IMA. Para fazer isso, primeiro crie uma AdsLoader, que é usada para solicitar anúncios dos servidores de anúncios.

   Importante: para reduzir a latência causada pelo IMA, é importante criar o AdsLoader assim que o app for iniciado. Isso maximiza o tempo para que o IMA carregue os recursos necessários antes da primeira solicitação de acesso. Também é necessário reutilizar uma única instância de AdsLoader para evitar a latência adicional causada pela recriação dela.

   videoplayerapp/SampleAdsWrapper.java

   package com.google.ads.interactivemedia.v3.samples.videoplayerapp;
   
   import android.annotation.TargetApi;
   import android.content.Context;
   import android.os.Build;
   import android.view.ViewGroup;
   import android.webkit.WebView;
   
   import com.google.ads.interactivemedia.v3.api.AdErrorEvent;
   import com.google.ads.interactivemedia.v3.api.AdEvent;
   import com.google.ads.interactivemedia.v3.api.AdsLoader;
   import com.google.ads.interactivemedia.v3.api.AdsManagerLoadedEvent;
   import com.google.ads.interactivemedia.v3.api.CuePoint;
   import com.google.ads.interactivemedia.v3.api.ImaSdkFactory;
   import com.google.ads.interactivemedia.v3.api.ImaSdkSettings;
   import com.google.ads.interactivemedia.v3.api.StreamDisplayContainer;
   import com.google.ads.interactivemedia.v3.api.StreamManager;
   import com.google.ads.interactivemedia.v3.api.StreamRequest;
   import com.google.ads.interactivemedia.v3.api.player.VideoProgressUpdate;
   import com.google.ads.interactivemedia.v3.api.player.VideoStreamPlayer;
   import com.google.ads.interactivemedia.v3.samples.samplevideoplayer.SampleVideoPlayer;
   
   import java.util.ArrayList;
   import java.util.HashMap;
   import java.util.List;
   
   public class SampleAdsWrapper implements AdEvent.AdEventListener,
           AdErrorEvent.AdErrorListener, AdsLoader.AdsLoadedListener {
   
       // Livestream asset key.
       private static final String TEST_ASSET_KEY = "sN_IYUG8STe1ZzhIIE_ksA";
   
       // VOD content source and video IDs.
       private static final String TEST_CONTENT_SOURCE_ID = "2548831";
       private static final String TEST_VIDEO_ID = "tears-of-steel";
   
       private static final String PLAYER_TYPE = "DAISamplePlayer";
   
       /**
        * Log interface, so you can output the log commands to the UI or similar.
        */
       public interface Logger {
           void log(String logMessage);
       }
   
       private ImaSdkFactory sdkFactory;
       private AdsLoader adsLoader;
       private StreamDisplayContainer displayContainer;
       private StreamManager streamManager;
       private List<VideoStreamPlayer.VideoStreamPlayerCallback> playerCallbacks;
   
       private SampleVideoPlayer videoPlayer;
       private Context context;
       private ViewGroup adUiContainer;
   
       private String fallbackUrl;
       private Logger logger;
   
       public SampleAdsWrapper(Context context, SampleVideoPlayer videoPlayer,
                               ViewGroup adUiContainer) {
           this.videoPlayer = videoPlayer;
           this.context = context;
           this.adUiContainer = adUiContainer;
           sdkFactory = ImaSdkFactory.getInstance();
           playerCallbacks = new ArrayList<>();
           createAdsLoader();
           displayContainer = sdkFactory.createStreamDisplayContainer(
               this.adUiContainer,
               videoStreamPlayer
           );
       }
   
       private void createAdsLoader() {
           ImaSdkSettings settings = new ImaSdkSettings();
           adsLoader = sdkFactory.createAdsLoader(context);
       }
   
       public void requestAndPlayAds() {
           adsLoader.addAdErrorListener(this);
           adsLoader.addAdsLoadedListener(this);
           adsLoader.requestStream(buildStreamRequest());
       }
   }
   

2. Foi adicionado um método buildStreamRequest() ao AdsLoader para que ele possa solicitar um stream com anúncios. É uma transmissão ao vivo com anúncios (configurada por padrão) ou um stream de vídeo sob demanda(VOD) que exibe conteúdo pré-gravado com anúncios. Para ativar a transmissão VOD, comente a solicitação de transmissão ao vivo e descomente a solicitação de transmissão VOD.

   Para trabalhar com o DAI, um player precisa transmitir eventos ID3 de transmissões ao vivo para os SDKs do DAI do IMA. No exemplo de código abaixo, isso é feito pelo método callback.onUserTextReceived().

   videoplayerapp/SampleAdsWrapper.java

   private StreamRequest buildStreamRequest() {
       VideoStreamPlayer videoStreamPlayer = createVideoStreamPlayer();
       videoPlayer.setSampleVideoPlayerCallback(
               new SampleVideoPlayer.SampleVideoPlayerCallback() {
                   @Override
                   public void onUserTextReceived(String userText) {
                       for (VideoStreamPlayer.VideoStreamPlayerCallback callback :
                               playerCallbacks) {
                           callback.onUserTextReceived(userText);
                       }
                   }
   
                   @Override
                   public void onSeek(int windowIndex, long positionMs) {
                       // See if you would seek past an ad, and if so, jump back to it.
                       long newSeekPositionMs = positionMs;
                       if (streamManager != null) {
                           CuePoint prevCuePoint  =
                                   streamManager.getPreviousCuePointForStreamTime(positionMs / 1000);
                           if (prevCuePoint != null && !prevCuePoint.isPlayed()) {
                               newSeekPositionMs = (long) (prevCuePoint.getStartTime() * 1000);
                           }
                       }
                       videoPlayer.seekTo(windowIndex, newSeekPositionMs);
                   }
   
                   @Override
                   public void onContentComplete() {
                       for (VideoStreamPlayer.VideoStreamPlayerCallback callback : playerCallbacks) {
                           callback.onContentComplete();
                       }
                   }
   
                   @Override
                   public void onPause() {
                       for (VideoStreamPlayer.VideoStreamPlayerCallback callback : playerCallbacks) {
                           callback.onPause();
                       }
                   }
   
                   @Override
                   public void onResume() {
                       for (VideoStreamPlayer.VideoStreamPlayerCallback callback : playerCallbacks) {
                           callback.onResume();
                       }
                   }
   
                   @Override
                   public void onVolumeChanged(int percentage) {
                       for (VideoStreamPlayer.VideoStreamPlayerCallback callback : playerCallbacks) {
                           callback.onVolumeChanged(percentage);
                       }
                   }
               });
   
       // Livestream request.
       StreamRequest request = sdkFactory.createLiveStreamRequest(
               TEST_ASSET_KEY, null, displayContainer);
   
       // VOD request. Comment the createLiveStreamRequest() line above and uncomment this
       // createVodStreamRequest() below to switch from a livestream to a VOD stream.
       // StreamRequest request = sdkFactory.createVodStreamRequest(TEST_CONTENT_SOURCE_ID,
       //        TEST_VIDEO_ID, null, displayContainer);
       return request;
   }
   

3. Você também precisa de um VideoStreamPlayer para reproduzir o stream. Adicione um método createVideoStreamPlayer(), que cria uma classe anônima que implementa VideoStreamPlayer.

   videoplayerapp/SampleAdsWrapper.java

   private VideoStreamPlayer createVideoStreamPlayer() {
       VideoStreamPlayer player = new VideoStreamPlayer() {
           @Override
           public void loadUrl(String url, List<HashMap<String, String>> subtitles) {
               videoPlayer.setStreamUrl(url);
               videoPlayer.play();
           }
   
           @Override
           public void addCallback(
               VideoStreamPlayerCallback videoStreamPlayerCallback) {
                   playerCallbacks.add(videoStreamPlayerCallback);
           }
   
           @Override
           public void removeCallback(
               VideoStreamPlayerCallback videoStreamPlayerCallback) {
                   playerCallbacks.remove(videoStreamPlayerCallback);
           }
   
           @Override
           public void onAdBreakStarted() {
               // Disable player controls.
               videoPlayer.enableControls(false);
               log("Ad Break Started\n");
           }
   
           @Override
           public void onAdBreakEnded() {
               // Re-enable player controls.
               videoPlayer.enableControls(true);
               log("Ad Break Ended\n");
           }
   
           @Override
           public VideoProgressUpdate getContentProgress() {
               return new VideoProgressUpdate(videoPlayer.getCurrentPosition(),
                       videoPlayer.getDuration());
           }
   
           @Override
           public int getVolume() {
               return videoPlayer.getVolume();
           }
       };
       return player;
   }
   

4. Implemente os listeners necessários e adicione suporte ao tratamento de erros.

   Observe a implementação de AdErrorListener, porque ela chama um URL alternativo se os anúncios não forem veiculados. Como o conteúdo e os anúncios estão em um stream, você precisa estar pronto para chamar um stream alternativo se o stream da DAI encontrar um erro.

   videoplayerapp/SampleAdsWrapper.java

   /** AdErrorListener implementation **/
   @Override
   public void onAdError(AdErrorEvent event) {
       // play fallback URL.
       videoPlayer.setStreamUrl(fallbackUrl);
       videoPlayer.enableControls(true);
       videoPlayer.play();
   }
   
   /** AdEventListener implementation **/
   @Override
   public void onAdEvent(AdEvent event) {
       switch (event.getType()) {
           case AD_PROGRESS:
               // Do nothing or else log are filled by these messages.
               break;
           default:
               log(String.format("Event: %s\n", event.getType()));
               break;
       }
   }
   
   /** AdsLoadedListener implementation **/
   @Override
   public void onAdsManagerLoaded(AdsManagerLoadedEvent event) {
       streamManager = event.getStreamManager();
       streamManager.addAdErrorListener(this);
       streamManager.addAdEventListener(this);
       streamManager.init();
   }
   
   /** Sets fallback URL in case ads stream fails. **/
   void setFallbackUrl(String url) {
       fallbackUrl = url;
   }
   

5. Adicione o código para geração de registros.

   videoplayerapp/SampleAdsWrapper.java

   /** Sets logger for displaying events to screen. Optional. **/
   void setLogger(Logger logger) {
       this.logger = logger;
   }
   
   private void log(String message) {
       if (logger != null) {
           logger.log(message);
       }
   }
   

6. Modifique MyActivity em videoplayerapp para instanciar e chamar SampleAdsWrapper.

   videoplayerapp/MyActivity.java

   import android.view.ViewGroup;
   import android.widget.ScrollView;
   ...
   public class MyActivity extends AppCompatActivity {
   ...
       @Override
       protected void onCreate(Bundle savedInstanceState) {
           super.onCreate(savedInstanceState);
           setContentView(R.layout.activity_my);
           View rootView = findViewById(R.id.videoLayout);
           videoPlayer = new SampleVideoPlayer(rootView.getContext(),
                   (SimpleExoPlayerView) rootView.findViewById(R.id.playerView));
           videoPlayer.enableControls(false);
   
           final SampleAdsWrapper sampleAdsWrapper = new SampleAdsWrapper(this, videoPlayer,
               (ViewGroup) rootView.findViewById(R.id.adUiContainer));
           sampleAdsWrapper.setFallbackUrl(DEFAULT_STREAM_URL);
   
           final ScrollView scrollView = (ScrollView) findViewById(R.id.logScroll);
           final TextView textView = (TextView) findViewById(R.id.logText);
   
           sampleAdsWrapper.setLogger(new SampleAdsWrapper.Logger() {
               @Override
               public void log(String logMessage) {
                   Log.i(APP_LOG_TAG, logMessage);
                   if (textView != null) {
                       textView.append(logMessage);
                   }
                   if (scrollView != null) {
                       scrollView.post(new Runnable() {
                           @Override
                           public void run() {
                               scrollView.fullScroll(View.FOCUS_DOWN);
                           }
                       });
                   }
               }
           });
   
           playButton = (ImageButton) rootView.findViewById(R.id.playButton);
           // Set up play button listener to play video then hide play button.
           playButton.setOnClickListener(new View.OnClickListener() {
               @Override
               public void onClick(View view) {
                   sampleAdsWrapper.requestAndPlayAds();
                   playButton.setVisibility(View.GONE);
               }
           });
       }
   ...
   }
   

7. Modifique o arquivo de layout activity_my.xml da atividade para adicionar elementos de interface para registro.

   res/layout/activity_my.xml

   ...
       <TextView
           android:id="@+id/playerDescription"
           android:text="@string/video_description"
           android:textAlignment="center"
           android:gravity="center_horizontal"
           android:layout_width="match_parent"
           android:layout_height="0dp"
           android:layout_weight="0.1"
           android:textSize="@dimen/font_size" />
       <!-- UI element for viewing SDK event log -->
       <ScrollView
           android:id="@+id/logScroll"
           android:layout_width="match_parent"
           android:layout_height="0dp"
           android:layout_weight="0.5"
           android:padding="5dp"
           android:background="#DDDDDD">
   
           <TextView
               android:id="@+id/logText"
               android:layout_width="match_parent"
               android:layout_height="wrap_content">
           </TextView>
       </ScrollView>
   ...
   

Parabéns! Agora você está solicitando e exibindo anúncios em vídeo no seu app Android. Para ajustar sua implementação, consulte Marcadores, Snapback e a documentação da API.

Solução de problemas

Se você tiver problemas para reproduzir um anúncio em vídeo, tente fazer o download do BasicExample completo. Se ele funcionar corretamente no BasicExample, provavelmente há um problema com o código de integração do IMA do app.

Se você ainda tiver problemas, acesse o fórum do SDK do IMA.