Começar a usar o SDK de DAI do IMA

Com os SDKs do IMA, é fácil integrar anúncios multimídia aos seus sites e apps. Os SDKs do IMA podem solicitar anúncios de qualquer de anúncios compatíveis com VAST e gerencie a reprodução de anúncios nos seus apps. Com os SDKs de DAI do IMA, os apps criam uma solicitação de streaming para anúncio e conteúdo de vídeo, seja VOD ou conteúdo ao vivo. Em seguida, o SDK retorna uma stream de vídeo combinado, para que você não precise alternar entre anúncios e conteúdo em vídeo no seu app.

Selecione a solução de DAI do seu interesse

Serviço completo Veiculação de pods

DAI de serviço completo

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

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

Este guia explica como configurar o exoplayer e o SDK de DAI do IMA para reproduzir um stream HLS. Para um exemplo de um player de vídeo compatível com streams HLS e DASH, confira nosso Exemplo avançado.

Para usar a DAI do IMA, é preciso ter um conta do Ad Manager 360 Advanced. Se tem uma conta do Ad Manager, entre em contato com o gerente de contas para saber mais detalhes. Para informações sobre a inscrição no Ad Manager, acesse Central de Ajuda do Ad Manager.

Importante: o recurso de IMA do ExoPlayer extensão oferece uma maneira simplificada de usar a DAI do IMA no Android. Consulte a Extensão de IMA do ExoPlayer guia e o ExoPlayerExample no GitHub (link em inglês) para mais detalhes.

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

Visão geral da DAI do IMA

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

• StreamDisplayContainer: Um objeto contêiner que fica em cima do elemento de reprodução de vídeo e hospeda os elementos da interface do anúncio.
• AdsLoader: Um objeto que solicita streams e processa eventos acionados por objetos de resposta de solicitação de stream. Você deve criar apenas uma instância do carregador de anúncios, que pode ser reutilizado durante a vida útil do para o aplicativo.
• StreamRequest: Um objeto que define uma solicitação de stream. As solicitações de transmissão podem ser para vídeo on demand ou ao vivo córregos. As solicitações especificam um ID de conteúdo, bem como uma chave de API ou um token de autenticação e outros parâmetros.
• StreamManager: Um objeto que processa fluxos de Inserção de anúncios dinâmicos e interações com o back-end da DAI. A O gerenciador de streams também lida com pings de rastreamento e encaminha eventos de anúncios e streams para 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 de player de vídeo

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

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

2. Inicie o Android Studio e selecione Open an existing Android Studio project. ou, se o Android Studio já estiver em execução, selecione File > Novo > Importar Projeto. Em seguida, selecione SampleVideoPlayer/build.gradle.

3. Execute uma sincronização do Gradle selecionando Tools > Android > Sincronizar o projeto com arquivos do Gradle (link em inglês).

4. Garantir que o app do jogador seja compilado e executado em um dispositivo Android físico ou um Dispositivo virtual Android usando Run > Execute 'app'. É normal que o vídeo antes de iniciar a transmissão.

.

Dica :se você é iniciante no desenvolvimento de aplicativos Android, confira a tutoriais para depuração USB e Usar dispositivos virtuais É preciso fazer uma dessas duas coisas para executar seu novo aplicativo e ver o que como funciona.

Analise o player de vídeo de exemplo

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

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

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

Adicionar o SDK de DAI do IMA ao app do player

Também é preciso incluir uma referência ao SDK de DAI do IMA. No Android Studio, adicione o após o 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.34.0'
}

Importante :seu app vai ser compilado e executado nesse momento, embora você ainda não adicionar elementos da interface ou código para solicitar e mostrar anúncios.

Integrar o SDK de DAI do IMA

1. Crie uma nova classe com o nome SampleAdsWrapper no pacote videoplayerapp (em app/java/com.google.ads.interactivemedia.v3.samples/videoplayerapp/) para unir o SampleVideoPlayer existente e adicionar lógica para implementar a DAI do IMA. Para faça isso, primeiro crie um AdsLoader usado 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 necessário para o IMA carregar os recursos necessários antes da primeira solicitação de transmissão. Você também deve reutilizar uma única instância de AdsLoader para evitar latência adicional causada pela recriação com ele.

   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. Adicione um método buildStreamRequest() à AdsLoader para que ela possa solicitar uma transmissão com anúncios. É uma transmissão ao vivo com anúncios (definido por padrão) ou transmissão de vídeo on demand(VOD) que mostra conteúdo pré-gravado com anúncios. Para ative a transmissão de VOD, comente a solicitação de transmissão ao vivo e remova a marca de comentário solicitação de stream de VOD.

   Para trabalhar com a DAI, o player precisa transmitir os eventos ID3 de transmissões ao vivo para a DAI do IMA do Google Cloud. No exemplo de código a seguir, isso é feito pelo 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 a transmissão, então adicione um 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 para tratamento de erros.

   Observe a implementação de AdErrorListener, já que ela chama um URL substituto se o de anúncios não forem reproduzidos. Como o conteúdo e os anúncios estão em um stream, você precisa estar pronto para chamar um stream substituto 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. Modificar o arquivo de layout da atividade activity_my.xml para adicionar elementos de interface. geração de registros.

   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 dispositivo app. Para ajustar sua implementação, consulte Favoritos, Ajustes, e a API na documentação.

Solução de problemas

Se você estiver com problemas para reproduzir um anúncio em vídeo, tente fazer o download BasicExample (em inglês). Se funcionar corretamente no BasicExample, significa que há um problema no seu código de integração de IMA do app.

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