IMA SDK'ları, multimedya reklamları web sitelerinize ve uygulamalarınıza entegre etmenizi kolaylaştırır. IMA SDK'ları, VAST uyumlu herhangi bir reklam sunucusundan reklam isteyebilir ve uygulamalarınızda reklam oynatmayı yönetebilir. IMA DAI SDK'ları sayesinde uygulamalar, reklam ve içerik videosu (VOD veya canlı içerik) için akış isteğinde bulunur. SDK, daha sonra birleştirilmiş bir video akışı döndürür. Böylece, uygulamanız içinde reklam ve içerik videosu arasında geçişi yönetmeniz gerekmez.
İlgilendiğiniz DAI çözümünü seçme
Tam hizmet DAI
Bu kılavuzda, IMA SDK'nın basit bir video oynatıcı uygulamasına nasıl entegre edileceği gösterilmektedir. Tamamlanmış bir örnek entegrasyonu görüntülemek veya takip etmek isterseniz GitHub'dan BasicExample'i indirin.
IMA DAI'ya genel bakış
IMA DAI'yı uygulamak, bu kılavuzda gösterildiği gibi dört ana SDK bileşeni içerir:
StreamDisplayContainer
: Video oynatma öğesinin en üstünde bulunan ve reklam kullanıcı arayüzü öğelerini barındıran bir kapsayıcı nesne.AdsLoader
: Akış isteği yanıt nesneleri tarafından tetiklenen etkinlikleri akış isteğinde bulunan ve işleyen bir nesnedir. Uygulamanın kullanım süresi boyunca yeniden kullanılabilecek tek bir reklam yükleyicisi örneklendirmelisiniz.StreamRequest
: Akış isteğini tanımlayan bir nesne. Akış istekleri seç-izle video veya canlı yayınlar için olabilir. İstekler bir içerik kimliğinin yanı sıra API anahtarı veya kimlik doğrulama jetonu ve diğer parametreleri belirtir.StreamManager
: Dinamik reklam ekleme akışlarını ve DAI arka ucuyla etkileşimlerini işleyen bir nesne. Akış yöneticisi ayrıca izleme ping'lerini yönetir ve akış ile reklam etkinliklerini yayıncıya yönlendirir.
Ön koşullar
- Android Studio
- SDK entegrasyonu için örnek video oynatıcı uygulaması
Örnek video oynatıcı uygulamasını indirip çalıştırın
Örnek uygulama, HLS video oynatan çalışan bir video oynatıcı sağlar. Bunu, IMA Android SDK'sının DAI özelliklerini entegre etmek için başlangıç noktası olarak kullanın.
Örnek video oynatıcı uygulamasını indirip çıkarın.
Android Studio'yu başlatın ve Mevcut bir Android Studio projesini aç'ı veya Android Studio zaten çalışıyorsa Dosya > Yeni > Projeyi İçe Aktar'ı seçin. Ardından
SampleVideoPlayer/build.gradle
uygulamasını seçin.Araçlar > Android > Projeyi Gradle Dosyalarıyla Senkronize Et'i seçerek bir Gradle senkronizasyonu çalıştırın.
Oynatıcı uygulamasının Çalıştır > "Uygulamayı çalıştır" seçeneğini kullanarak fiziksel bir Android cihazda veya bir Android Sanal Cihazda derleme yaptığından ve çalıştırıldığından emin olun. Video akışının oynatılmadan önce yüklenmesi birkaç dakika sürebilir.
Örnek video oynatıcıyı inceleme
Örnek video oynatıcı henüz herhangi bir IMA SDK entegrasyon kodu içermiyor. Örnek uygulama iki ana bölümden oluşur:
samplevideoplayer/SampleVideoPlayer.java
: IMA DAI entegrasyonunun temelini oluşturan ExoPlayer tabanlı bir HLS oynatıcısı.videoplayerapp/MyActivity.java
: Bu etkinlik, video oynatıcıyı oluşturur ve onaContext
veSimpleExoPlayerView
iletir.
IMA Android SDK'sını oynatıcı uygulamasına ekleme
Ayrıca, bir IMA SDK referansı da eklemeniz gerekir. Android Studio'da app/build.gradle
adresindeki uygulama düzeyindeki build.gradle
dosyanıza aşağıdakileri ekleyin:
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'
}
IMA SDK'yı entegre etme
Mevcut
SampleVideoPlayer
öğesini sarmalamak ve IMA DAI uygulayarak mantık eklemek içinvideoplayerapp
paketinde (app/java/com.google.ads.interactivemedia.v3.samples/videoplayerapp/
içinde)SampleAdsWrapper
adlı yeni bir sınıf oluşturun. Bunun için önce reklam sunucularından reklam istemek amacıyla birAdsLoader
oluşturmanız gerekir.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()); } }
Reklamlı akış isteğinde bulunabilmesi için
AdsLoader
öğesine birbuildStreamRequest()
yöntemi ekleyin. Bu, reklamlı bir canlı yayın (varsayılan olarak ayarlanır) veya önceden kaydedilmiş içeriğin reklamlarla birlikte oynatıldığı seç-izle video(VOD) akışıdır. VOD akışını etkinleştirmek için canlı yayın isteğine yorum ekleyin ve VOD akış isteğindeki yorumu kaldırın.Oyuncunun DAI ile çalışabilmesi için IMA SDK'lara canlı yayınlarda ID3 etkinliklerini iletmesi gerekir. Bu işlem, aşağıdaki örnek kodda
callback.onUserTextReceived()
yöntemiyle gerçekleştirilir.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; }
Akışı oynatmak için bir
VideoStreamPlayer
öğesine de ihtiyacınız vardır. Bu yüzden,VideoStreamPlayer
yöntemini uygulayan anonim bir sınıf oluşturancreateVideoStreamPlayer()
yöntemi ekleyin.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; }
Gerekli işleyicileri uygulayın ve hata işleme için destek ekleyin.
Reklamlar oynatılamadığı takdirde yedek URL çağırdığından
AdErrorListener
uygulamasına dikkat edin. İçerik ve reklamlar tek bir akışta yer aldığından, DAI akışı hatayla karşılaşırsa yedek akış çağırmaya hazır olmanız gerekir.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; }
Günlük kaydı için kod ekleyin.
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); } }
SampleAdsWrapper
örneğini oluşturmak ve çağırmak içinvideoplayerapp
öğesindekiMyActivity
değerini değiştirin.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); } }); } ... }
Günlük kaydı için kullanıcı arayüzü öğeleri eklemek üzere Etkinliğin düzen dosyasını
activity_my.xml
değiştirin.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> ...
Tebrikler! Şu anda Android uygulamanızda video reklamlar istiyor ve gösteriyorsunuz. Uygulama uygulamanızda ince ayar yapmak için Yer İşaretleri, Snapback ve API belgeleri'ne bakın.
Sorun giderme
Video reklamı oynatmayla ilgili sorun yaşıyorsanız tamamlanan BasicExample dosyasını indirmeyi deneyin. BasicExample'de düzgün çalışıyorsa muhtemelen uygulamanızın IMA entegrasyon koduyla ilgili bir sorun vardır.
Hâlâ sorun yaşıyorsanız IMA SDK forumunu ziyaret edin.