ערכות IMA SDK מאפשרות לכם לשלב בקלות מודעות מולטימדיה באתרים ובאפליקציות שלכם. ערכות IMA SDK יכולות לבקש מודעות מכל שרת מודעות שתואם ל-VAST ולנהל את הפעלת המודעות באפליקציות שלכם. בעזרת ערכות IMA DAI SDK, אפליקציות בקשה לשידור וידאו של מודעה ותוכן – VOD או תוכן בשידור חי. לאחר מכן ה-SDK מחזיר סטרימינג משולב של מודעות וידאו, כך שלא יהיה צורך לנהל את המעבר בין מודעות וידאו בתוכן בתוך האפליקציה.
איך בוחרים את פתרון DAI שמעניין אתכם
DAI בשירות מלא
המדריך הזה מדגים איך לשלב את IMA DAI SDK בנגן וידאו פשוט אפליקציה. אם אתם רוצים להציג טעימה מלאה או לעקוב אחריו צריך להוריד את BasicExample מ- GitHub.
סקירה כללית של IMA DAI
כדי להטמיע IMA DAI יש ארבעה רכיבים עיקריים של ה-SDK, כמו שאפשר לראות guide:
StreamDisplayContainer: אובייקט קונטיינר שנמצא מעל הרכיב של הפעלת הסרטון ומכיל את הרכיבים של ממשק המשתמש של המודעה.AdsLoader: אובייקט ששולח בקשה בסטרימינג ומטפל באירועים שהופעלו על ידי אובייקטים של תגובה לבקשה בסטרימינג. עליך ליצור רק טוען מודעות אחד, שניתן לעשות בו שימוש חוזר לאורך כל חיי תרגום מכונה.StreamRequest: אובייקט שמגדיר בקשה של מקור נתונים. בקשות סטרימינג יכולות להיות עבור וידאו על פי דרישה (VOD) או שידור חי בסטרימינג. הבקשות כוללות מזהה תוכן, מפתח API או אסימון אימות ועוד .StreamManager: אובייקט שמטפל בשידורים של הוספת מודעות דינמיות ובאינטראקציות עם הקצה העורפי של הטמעת מודעות דינמיות (DAI). מנהל סטרימינג מטפל גם במעקב אחר פינגים ואירועי העברה של מודעות ושידורים חיים מו"ל.
דרישות מוקדמות
- ב-Android Studio
- אפליקציה לדוגמה של נגן וידאו לשילוב ה-SDK
הורדה והפעלה של אפליקציית נגן הווידאו לדוגמה
האפליקציה לדוגמה מספקת נגן וידאו פעיל שמפעיל וידאו ב-HLS. שימוש בתור נקודת התחלה לשילוב יכולות DAI של IMA DAI SDK.
הורדת נגן הווידאו לדוגמה אפליקציה וגם לחלץ אותו.
מפעילים את Android Studio ובוחרים באפשרות פתיחת פרויקט Android Studio קיים. לחלופין, אם Android Studio כבר פועל, בוחרים באפשרות קובץ > חדש > יבא פרויקט. אחר כך צריך לבחור
SampleVideoPlayer/build.gradle.כדי להפעיל סנכרון של Gradle, בוחרים באפשרות כלים > Android > סנכרון הפרויקט עם קובצי Gradle
לוודא שאפליקציית הנגן עוברת הידור ופועל במכשיר Android פיזי או מכשיר וירטואלי של Android באמצעות הפעלה > מריצים את 'app'. זו תופעה רגילה בסרטון להפעיל סטרימינג כך שייקח כמה דקות להיטען לפני ההפעלה.
בדיקת נגן הווידאו לדוגמה
נגן הווידאו לדוגמה לא מכיל עדיין קוד שילוב של IMA DAI SDK. האפליקציה לדוגמה מורכבת משני חלקים עיקריים:
samplevideoplayer/SampleVideoPlayer.java: נגן HLS מבוסס ExoPlayer שמשמש בתור הבסיס לשילוב של IMA DAI.videoplayerapp/MyActivity.java: פעילות זו יוצרת את נגן הווידאו וגם מעביר אותוContextו-SimpleExoPlayerView.
הוספת IMA DAI SDK לאפליקציית הנגן
עליך לכלול גם הפניה ל-IMA DAI SDK. ב-Android Studio, מוסיפים את
בהמשך לקובץ build.gradle ברמת האפליקציה, שנמצא בכתובת
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.0'
}
שילוב של IMA DAI SDK
יצירת כיתה חדשה בשם
SampleAdsWrapperבחבילהvideoplayerapp(בapp/java/com.google.ads.interactivemedia.v3.samples/videoplayerapp/) אל כוללים אתSampleVideoPlayerהקיים ומוסיפים לוגיקה להטמעת IMA DAI. שפת תרגום לעשות זאת, קודם צריך ליצורAdsLoaderשישמש לבקשת מודעות משרתי המודעות.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()); } }צריך להוסיף method
buildStreamRequest()ל-AdsLoaderכדי שתהיה אפשרות לבקש תשודר עם מודעות. זהו שידור חי עם מודעות (מוגדר כברירת מחדל) או שידור וידאו על פי דרישה(VOD) שבו מופעל תוכן שהוקלט מראש עם מודעות. שפת תרגום להפעיל את זרם ה-VOD, להוסיף תגובה לבקשה בשידור החי ולבטל תגובה בקשה לשידור VOD.כדי לעבוד עם DAI, שחקן צריך להעביר את אירועי ID3 של השידורים החיים אל IMA DAI ערכות SDK. בקוד לדוגמה הבא, הפעולה הזו מתבצעת על ידי אמצעי תשלום אחד (
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; }צריך גם
VideoStreamPlayerכדי להפעיל את השידור, לכן מומלץ להוסיףcreateVideoStreamPlayer(), שיוצרת מחלקה אנונימית באמצעות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; }להטמיע את המאזינים הנדרשים ולהוסיף תמיכה בטיפול בשגיאות.
שימו לב להטמעה של
AdErrorListener, כי היא קוראת לכתובת URL חלופית אם מודעות לא מוצגות. מאחר שהתוכן והמודעות הם בזרם אחד, עליך מוכן להפעיל שידור חלופי אם מתרחשת שגיאה בשידור של 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; }הוספת קוד לרישום ביומן.
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); } }שינוי
MyActivityב-videoplayerappכדי ליצור ולהתקשר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); } }); } ... }יש לשנות את קובץ הפריסה של הפעילות
activity_my.xmlכדי להוסיף רכיבי ממשק משתמש עבור רישום ביומן.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> ...
מזל טוב! זו בקשה להצגת מודעות וידאו במכשיר Android שלך אפליקציה. כדי לשפר את ההטמעה, סימניות, Snapback וה-API בתיעוד.
פתרון בעיות
אם נתקלת בבעיות בהפעלת מודעת וידאו, כדאי לנסות להוריד את BasicExample (דוגמה בסיסית). אם הוא פועל בצורה תקינה בקובץ BasicExample, סביר להניח שיש בעיה את קוד השילוב של ה-IMA של האפליקציה.
אם הבעיה נמשכת, יש להיכנס אל IMA SDK בפורום.