Einführung in das IMA DAI SDK

Mit IMA SDKs können Sie Multimedia-Anzeigen ganz einfach in Ihre Websites und Apps einbinden. Mit IMA SDKs können Anzeigen von jedem VAST-kompatiblen Ad-Server angefordert und die Anzeigenwiedergabe in Ihren Apps verwaltet werden. Mit IMA DAI SDKs stellen Apps eine Streamanfrage für Anzeigen- und Contentvideos – entweder VOD oder Livecontent. Das SDK gibt dann einen kombinierten Videostream zurück, sodass Sie in Ihrer App nicht zwischen Anzeigen- und Contentvideo wechseln müssen.

Wählen Sie die gewünschte Lösung für die dynamische Anzeigenbereitstellung aus.

Vollständiger Service Pod-Bereitstellung

Dynamische Anzeigenbereitstellung mit Komplettservice

In diesem Leitfaden wird beschrieben, wie Sie das IMA SDK in eine einfache Videoplayer-App integrieren. Wenn Sie sich ein fertiges Beispiel ansehen oder ein vollständiges Beispiel integrieren möchten, laden Sie das BasicExample von GitHub herunter.

Hinweis:Das IMA DAI SDK für Android unterstützt sowohl HLS- als auch DASH-Streams.

In diesem Leitfaden wird erläutert, wie Sie den Exoplayer und das IMA DAI SDK für die Wiedergabe eines HLS-Streams konfigurieren. Ein Beispiel für einen Videoplayer, der sowohl HLS- als auch DASH-Streams unterstützt, findest du in unserem erweiterten Beispiel.

Wenn Sie die dynamische Anzeigenbereitstellung nutzen möchten, benötigen Sie ein erweitertes Ad Manager 360-Konto. Wenn Sie ein Ad Manager-Konto haben, wenden Sie sich an Ihren Account Manager, um weitere Informationen zu erhalten. Informationen zur Registrierung für Ad Manager finden Sie in der Ad Manager-Hilfe.

Wichtiger Hinweis :Die IMA-Erweiterung von ExoPlayer bietet eine optimierte Möglichkeit, die IMA DAI unter Android zu verwenden. Weitere Informationen finden Sie im Leitfaden zur ExoPlayer-IMA-Erweiterung und im ExoPlayerExample auf GitHub.

Hinweis:Informationen zur Integration in andere Plattformen oder zur Verwendung der clientseitigen IMA SDKs finden Sie unter Interactive Media Ads SDKs.

IMA DAI – Übersicht

Die Implementierung der IMA DAI umfasst vier Hauptkomponenten des SDK, die in diesem Leitfaden beschrieben werden:

• StreamDisplayContainer: Ein Containerobjekt, das sich auf dem Videowiedergabeelement befindet und die UI-Elemente der Anzeige enthält.
• AdsLoader: Ein Objekt, das Streams anfordert und verarbeitet, die von Antwortobjekten für Streamanfragen ausgelöst werden. Sie sollten nur ein Anzeigenladeprogramm instanziieren, das während der Lebensdauer der Anwendung wiederverwendet werden kann.
• StreamRequest: Ein Objekt, das eine Streamanfrage definiert. Streamanfragen können für Video-on-Demand- oder Livestreams erfolgen. In den Anfragen werden eine Content-ID, ein API-Schlüssel oder ein Authentifizierungstoken und weitere Parameter angegeben.
• StreamManager: Ein Objekt, das Streams zur dynamischen Anzeigenbereitstellung und Interaktionen mit dem Back-End für die dynamische Anzeigenbereitstellung verarbeitet. Außerdem verarbeitet er Tracking-Pings und leitet Stream- und Anzeigenereignisse an den Publisher weiter.

Voraussetzungen

• Android Studio
• Beispiel-Videoplayer-App für die SDK-Integration

Beispiel-Videoplayer-App herunterladen und ausführen

Die Beispiel-App stellt einen funktionierenden Videoplayer bereit, der HLS-Video wiedergibt. Verwenden Sie es als Ausgangspunkt für die Integration der Funktionen für die dynamische Anzeigenbereitstellung des IMA Android SDK.

1. Laden Sie die Beispiel-Videoplayer-App herunter und extrahieren Sie sie.

2. Starten Sie Android Studio und wählen Sie Vorhandenes Android Studio-Projekt öffnen aus. Wenn Android Studio bereits ausgeführt wird, wählen Sie File > New > Import Project aus. Wählen Sie dann SampleVideoPlayer/build.gradle aus.

3. Führen Sie eine Gradle-Synchronisierung aus. Wählen Sie dazu Tools > Android > Projekt mit Gradle-Dateien synchronisieren aus.

4. Sorgen Sie dafür, dass die Player-App auf einem physischen Android-Gerät oder einem virtuellen Android-Gerät kompiliert und ausgeführt wird. Klicken Sie dazu auf Run > Run 'app' (Ausführen > App ausführen). Es ist normal, dass der Videostream vor der Wiedergabe eine Weile lädt.

Tipp :Wenn Sie zum ersten Mal Android-Apps entwickeln, sehen Sie sich die Anleitungen für USB-Debugging und Verwendung virtueller Geräte an. Sie müssen einen dieser beiden Schritte ausführen, um die neue Anwendung auszuführen und zu sehen, wie sie aussieht.

Beispielvideoplayer ansehen

Der Beispielvideoplayer enthält noch keinen Integrationscode für das IMA SDK. Die Beispielanwendung besteht aus zwei Hauptteilen:

1. samplevideoplayer/SampleVideoPlayer.java: Ein ExoPlayer-basierter HLS-Player, der als Grundlage für die Integration der IMA-Anzeigenbereitstellung dient.

2. videoplayerapp/MyActivity.java: Durch diese Aktivität wird der Videoplayer erstellt und ein Context- und ein SimpleExoPlayerView-Element übergeben.

IMA Android SDK zur Player-App hinzufügen

Außerdem muss ein Verweis auf das IMA SDK angegeben werden. Fügen Sie in Android Studio der Datei build.gradle auf Anwendungsebene unter app/build.gradle Folgendes hinzu:

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.33.0'
}

Wichtiger Hinweis :Ihre App sollte zu diesem Zeitpunkt kompiliert und ausgeführt werden, auch wenn Sie noch UI-Elemente oder Code hinzugefügt haben, um Anzeigen anzufordern und anzuzeigen.

IMA SDK integrieren

1. Erstellen Sie eine neue Klasse mit dem Namen SampleAdsWrapper im Paket videoplayerapp (in app/java/com.google.ads.interactivemedia.v3.samples/videoplayerapp/), um den vorhandenen SampleVideoPlayer zu umschließen und eine Logik hinzuzufügen, die die IMA DAI implementiert. Dazu müssen Sie zuerst ein AdsLoader erstellen, das zum Anfordern von Anzeigen von Ad-Servern verwendet wird.

   Wichtig :Um die durch IMA verursachte Latenz zu verringern, muss AdsLoader beim Start der App erstellt werden. Dadurch wird die Zeit maximiert, die IMA vor der ersten Dampfanfrage benötigt, um die erforderlichen Ressourcen zu laden. Sie sollten außerdem eine einzelne AdsLoader-Instanz wiederverwenden, um zusätzliche Latenz zu vermeiden, die durch die Neuerstellung verursacht wird.

   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. Fügen Sie dem AdsLoader eine buildStreamRequest()-Methode hinzu, damit ein Stream mit Anzeigen angefordert werden kann. Das ist entweder ein Livestream mit Anzeigen (standardmäßig festgelegt) oder ein VOD-Stream(Video-on-Demand), bei dem vorab aufgezeichnete Inhalte mit Anzeigen wiedergegeben werden. Wenn Sie den VOD-Stream aktivieren möchten, kommentieren Sie die Livestreamanfrage aus und entfernen Sie die Kommentarzeichen bei der Anfrage.

   Damit die dynamische Anzeigenbereitstellung genutzt werden kann, muss ein Player ID3-Ereignisse für Livestreams an die IMA SDKs übergeben. Im folgenden Beispielcode wird dies über die Methode callback.onUserTextReceived() ausgeführt.

   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. Zum Abspielen des Streams benötigen Sie außerdem eine VideoStreamPlayer. Fügen Sie also die Methode createVideoStreamPlayer() hinzu, die eine anonyme Klasse erstellt, die VideoStreamPlayer implementiert.

   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());
           }
       };
       return player;
   }
   

4. Implementieren Sie die erforderlichen Listener und fügen Sie Unterstützung für die Fehlerbehandlung hinzu.

   Beachten Sie die AdErrorListener-Implementierung. Sie ruft eine Fallback-URL auf, wenn die Anzeigen nicht wiedergegeben werden. Da sich der Inhalt und die Anzeigen in einem Stream befinden, müssen Sie einen Fallback-Stream aufrufen können, falls beim Stream für die dynamische Anzeigenbereitstellung ein Fehler auftritt.

   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. Fügen Sie Code für die Protokollierung hinzu.

   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. Ändern Sie MyActivity in videoplayerapp, um SampleAdsWrapper zu instanziieren und aufzurufen.

   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. Ändern Sie die Layoutdatei activity_my.xml der Aktivität, um UI-Elemente für das Logging hinzuzufügen.

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

Glückwunsch! Sie fordern jetzt Videoanzeigen in Ihrer Android-App an und präsentieren sie. Informationen zur Optimierung Ihrer Implementierung finden Sie unter Lesezeichen, Snapback und der API-Dokumentation.

Fehlerbehebung

Falls bei der Wiedergabe einer Videoanzeige Probleme auftreten, laden Sie das fertige BasicExample bitte herunter. Wenn die Funktion in BasicExample korrekt funktioniert, liegt wahrscheinlich ein Problem mit dem IMA-Integrationscode Ihrer App vor.

Sollten weiterhin Probleme auftreten, besuchen Sie das IMA SDK-Forum.