Iniziare a utilizzare l'SDK IMA DAI

Gli SDK IMA semplificano l'integrazione degli annunci multimediali nei siti web e nelle app. Gli SDK IMA possono richiedere annunci da qualsiasi ad server compatibile con VAST e gestire la riproduzione degli annunci nelle tue app. Con gli SDK IMA DAI, le app effettuano una richiesta di streaming per annuncio e video di contenuti, sia VOD che contenuti dal vivo. L'SDK restituisce quindi uno stream video combinato, in modo che tu non debba gestire il passaggio dall'annuncio al video di contenuti all'interno dell'app.

Seleziona la soluzione DAI che ti interessa

Servizio completo Gestione pod

DAI servizio completo

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

Nota: l'SDK IMA DAI per Android supporta gli stream HLS e DASH.

Questa guida spiega come configurare l'exoplayer e l'SDK IMA DAI per riprodurre uno stream HLS. Per un esempio di un video player che supporta gli stream HLS e DASH, consulta il nostro esempio avanzato.

Per utilizzare l'IMA DAI, devi disporre di un account Ad Manager 360 Advanced. Se hai un account Ad Manager, contatta il tuo account manager per ulteriori dettagli. Per informazioni sulla registrazione ad Ad Manager, visita il Centro assistenza Ad Manager.

Punto chiave: l'estensione IMA di ExoPlayer offre un modo semplificato per utilizzare l'IMA DAI su Android. Consulta la guida all'estensione ExoPlayer IMA e l'articolo ExoPlayerExample su GitHub per ulteriori dettagli.

Nota:per informazioni sull'integrazione con altre piattaforme o sull'utilizzo degli SDK lato client IMA, consulta gli SDK Interactive Media Ads.

Panoramica dell'IMA DAI

L'implementazione dell'IMA DAI coinvolge quattro componenti principali dell'SDK, come illustrato in questa guida:

• StreamDisplayContainer: un oggetto contenitore posizionato sopra l'elemento di riproduzione video e che ospita gli elementi dell'interfaccia utente dell'annuncio.
• AdsLoader: un oggetto che richiede flussi di dati e gestisce gli eventi attivati dagli oggetti di risposta alla richiesta di flusso. Devi creare un'istanza solo per un caricatore di annunci, che può essere riutilizzato per tutta la durata dell'applicazione.
• StreamRequest: un oggetto che definisce una richiesta di flusso. Le richieste di streaming possono riguardare video on demand o live streaming. Le richieste specificano un ID contenuto, una chiave API o un token di autenticazione e altri parametri.
• StreamManager: un oggetto che gestisce i flussi di inserimento di annunci dinamici e le interazioni con il backend DAI. Il gestore di streaming gestisce anche i ping di monitoraggio e inoltra gli eventi di streaming e annuncio al publisher.

Prerequisiti

• Android Studio
• Esempio di app di video player per l'integrazione dell'SDK

Scarica ed esegui l'app video player di esempio

L'app di esempio fornisce un video player funzionante che riproduce il video HLS. Utilizzalo come punto di partenza per integrare le funzionalità DAI dell'SDK IMA DAI.

1. Scarica l'app video player di esempio ed estraila.

2. Avvia Android Studio e seleziona Apri un progetto Android Studio esistente oppure, se Android Studio è già in esecuzione, seleziona File > Nuovo > Importa progetto. Poi scegli SampleVideoPlayer/build.gradle.

3. Esegui una sincronizzazione Gradle selezionando Strumenti > Android > Sincronizza il progetto con i file Gradle.

4. Assicurati che l'app del player venga compilata e eseguita su un dispositivo Android fisico o un dispositivo virtuale Android utilizzando Esegui > Esegui "app". È normale che impieghi qualche istante il caricamento dello stream video prima della riproduzione.

Suggerimento: se è la prima volta che sviluppi app Android, dai un'occhiata ai tutorial per il debug USB e l' utilizzo di dispositivi virtuali. Devi eseguire una di queste due operazioni per eseguire la tua nuova app e vedere che aspetto si presenta.

Esamina il video player di esempio

Il video player di esempio non contiene ancora alcun codice di integrazione per l'SDK IMA DAI. L'app di esempio è costituita da due parti principali:

1. samplevideoplayer/SampleVideoPlayer.java: un player HLS basato su ExoPlayer che funge da base per l'integrazione IMA DAI.

2. videoplayerapp/MyActivity.java: questa attività crea il video player e gli passa a Context e SimpleExoPlayerView.

Aggiungere l'SDK IMA DAI all'app del player

Devi anche includere un riferimento all'SDK IMA DAI. In Android Studio, aggiungi quanto segue al file build.gradle a livello di applicazione, che si trova in 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'
}

Punto chiave :la tua app dovrebbe essere compilata ed eseguita a questo punto, anche se devi ancora aggiungere elementi dell'interfaccia utente o codice per richiedere e visualizzare gli annunci.

Integrare l'SDK IMA DAI

1. Crea una nuova classe denominata SampleAdsWrapper nel pacchetto videoplayerapp (in app/java/com.google.ads.interactivemedia.v3.samples/videoplayerapp/) per aggregare l'elemento SampleVideoPlayer esistente e aggiungere la logica che implementa l'IMA DAI. Per farlo, devi prima creare un elemento AdsLoader, che viene utilizzato per richiedere annunci agli ad server.

   Importante: per ridurre la latenza causata dall'IMA, è importante creare AdsLoader non appena viene avviata l'app. Ciò massimizza il tempo necessario all'IMA per caricare le risorse necessarie prima della prima richiesta di vapore. Ti conviene anche riutilizzare una singola istanza AdsLoader per evitare la latenza aggiuntiva causata dalla nuova creazione.

   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. Aggiungi un metodo buildStreamRequest() a AdsLoader in modo che possa richiedere uno stream con annunci. Si tratta di un live streaming con annunci (impostato per impostazione predefinita) o di uno stream video on demand(VOD) che riproduce contenuti preregistrati con annunci. Per abilitare lo streaming VOD, commenta la richiesta di live streaming e rimuovi il commento dalla richiesta di streaming VOD.

   Per utilizzare l'inserimento di annunci dinamici, un player deve passare eventi ID3 per i live streaming agli SDK IMA DAI. Nel codice campione seguente, questa operazione viene eseguita dal metodo 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. È necessario anche un VideoStreamPlayer per riprodurre lo stream, quindi aggiungi un metodo createVideoStreamPlayer() per creare una classe anonima che 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. Implementa i listener richiesti e aggiungi il supporto per la gestione degli errori.

   Nota l'implementazione di AdErrorListener, in quanto chiama un URL di riserva se l'annuncio non viene riprodotto. Poiché i contenuti e gli annunci si trovano in un unico stream, devi essere pronto a richiamare uno stream di riserva se si verifica un errore nello stream DAI.

   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. Aggiungi il codice per il logging.

   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. Modifica MyActivity in videoplayerapp per creare un'istanza e chiamare 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. Modifica il file di layout dell'attività activity_my.xml per aggiungere elementi UI per il logging.

   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>
   ...
   

Congratulazioni! Hai richiesto e visualizzato annunci video nella tua app per Android. Per ottimizzare l'implementazione, consulta Segnalibri, Snapback e la documentazione dell'API.

Risoluzione dei problemi

Se riscontri problemi durante la riproduzione di un annuncio video, prova a scaricare il file BasicExample completato. Se in BasicExample funziona correttamente, è probabile che esista un problema con il codice di integrazione IMA dell'app.

Se continui a riscontrare problemi, visita il forum dell'SDK IMA.