תחילת העבודה עם IMA DAI SDK

IMA SDK מאפשר לכם לשלב בקלות מודעות מולטימדיה באתרים ובאפליקציות שלכם. IMA SDK יכול לשלוח בקשה להצגת מודעות מכל שרת מודעות שתואם ל-VAST ולנהל את ההפעלה של המודעות באפליקציות שלך. בעזרת ערכות IMA DAI SDK, אפליקציות שולחות בקשות לשידור וידאו של מודעה או תוכן וידאו - VOD או תוכן בשידור חי. לאחר מכן, ה-SDK יחזיר שידור וידאו משולב, כך שלא יהיה צורך לנהל את המעבר בין מודעות וידאו לתוכן בתוך האפליקציה.

בחירת פתרון DAI שמעניין אתכם

הטמעת מודעות דינמיות (DAI) בשירות מלא

מדריך זה מדגים כיצד לשלב את IMA SDK באפליקציה פשוטה של נגן וידאו. אם אתם רוצים להציג שילוב לדוגמה במלואו, או לעקוב אחריו, הורידו את BasicExample מ-GitHub.

סקירה כללית של IMA DAI

כדי להטמיע את IMA DAI יש ארבעה רכיבי SDK עיקריים, כמו שמוסבר במדריך הזה:

  • StreamDisplayContainer: אובייקט מאגר תגים שממוקם מעל לרכיב הפעלת הסרטון, ומכיל את הרכיבים של ממשק המשתמש של המודעה.
  • AdsLoader: אובייקט שמבקש שידורים ומטפל באירועים שהופעלו על ידי אובייקטים של תגובה לבקשת שידור. צריך ליצור רק רכיב אחד של טעינה של מודעות, שאפשר להשתמש בו שוב במהלך כל משך החיים של האפליקציה.
  • StreamRequest: אובייקט שמגדיר בקשה לשידור. בקשות סטרימינג יכולות להיות וידאו על פי דרישה (VOD) או שידורים חיים. הבקשות מציינות את מזהה התוכן, וגם מפתח API, אסימון אימות ופרמטרים נוספים.
  • StreamManager: אובייקט שמטפל בשידורים של הכנסת מודעות דינמיות ובאינטראקציות עם הקצה העורפי של DAI. מנהל הסטרימינג מטפל גם בפינגים במעקב ומעביר אירועי מודעות ושידורים חיים לבעל האתר.

דרישות מוקדמות

  • Android Studio
  • דוגמה לאפליקציה של נגן וידאו לשילוב ה-SDK

הורדה והפעלה של האפליקציה לדוגמה של נגן הווידאו

האפליקציה לדוגמה כוללת נגן וידאו פעיל שמפעיל סרטון בפרוטוקול HLS. השתמשו בנתונים האלה כנקודת התחלה לשילוב יכולות הטמעת המודעות דינמיות (DAI) של IMA Android SDK.

  1. מורידים את האפליקציה של נגן הווידאו לדוגמה ומחלצים אותה.

  2. מפעילים את Android Studio ובוחרים באפשרות פתיחת פרויקט קיים ב-Android Studio. לחלופין, אם Android Studio כבר פועל, בוחרים באפשרות File > New > Import Project. ובוחרים באפשרות SampleVideoPlayer/build.gradle.

  3. כדי להפעיל סנכרון של Gradle, בוחרים באפשרות כלים > Android > סנכרון פרויקט עם קובצי Gradle.

  4. ודאו שאפליקציית הנגן מבצעת הידור ופועלת במכשיר Android פיזי או במכשיר וירטואלי של Android באמצעות Run > Run 'app'. בדרך כלל, לוקח כמה רגעים לטעון את הווידאו בסטרימינג לפני ההפעלה.

בודקים את נגן הווידאו לדוגמה

נגן הווידאו לדוגמה עדיין לא מכיל קוד שילוב של IMA SDK. האפליקציה לדוגמה מורכבת משני חלקים עיקריים:

  1. samplevideoplayer/SampleVideoPlayer.java: נגן HLS שמבוסס על ExoPlayer ומשמש כבסיס לשילוב IMA DAI.

  2. videoplayerapp/MyActivity.java: הפעילות הזו יוצרת את נגן הווידאו ומעבירה לו Context ו-SimpleExoPlayerView.

הוספת IMA Android SDK לאפליקציית הנגן

עליך לכלול גם הפניה ל-IMA 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.33.0'
}

שילוב IMA SDK

  1. יוצרים מחלקה חדשה בשם SampleAdsWrapper בחבילה videoplayerapp (ב-app/java/com.google.ads.interactivemedia.v3.samples/videoplayerapp/), כדי לעטוף את ה-SampleVideoPlayer הקיים ולהוסיף לוגיקה שמטמיעה IMA DAI. לשם כך, קודם צריך ליצור AdsLoader שישמש לבקשת מודעות משרתי מודעות.

    video Playerapp/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. מוסיפים שיטת buildStreamRequest() ל-AdsLoader כדי לבקש שידור עם מודעות. מדובר בשידור חי עם מודעות (מוגדר כברירת מחדל) או בשידור וידאו על פי דרישה(VOD) שמופעל בו תוכן מוקלט מראש עם מודעות. כדי להפעיל את שידור ה-VOD, צריך להגיב לבקשה של השידור החי ולבטל את התגובה לבקשה לשידור VOD.

    כדי לעבוד עם DAI, הנגן חייב להעביר אירועי ID3 לשידורים חיים לערכות ה-SDK של IMA. בקוד לדוגמה הבא, הפעולה הזו מתבצעת באמצעות השיטה callback.onUserTextReceived().

    video Playerapp/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. נדרש גם VideoStreamPlayer כדי להפעיל את השידור, לכן צריך להוסיף שיטה createVideoStreamPlayer() שיוצרת מחלקה אנונימית שמטמיעה את VideoStreamPlayer.

    video Playerapp/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. מומלץ להשתמש ברכיבי ה-listener הנדרשים ולהוסיף תמיכה בטיפול בשגיאות.

    שימו לב להטמעה של AdErrorListener, כי היא מפעילה כתובת URL חלופית במקרה שהמודעות לא פועלות. מכיוון שהתוכן והמודעות נמצאים בשידור אחד, עליכם להיות מוכנים להפעיל שידור חלופי במקרה של שגיאה בשידור ה-DAI.

    video Playerapp/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. הוספת קוד לרישום ביומן.

    video Playerapp/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. יש לשנות את 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);
            }
        });
    }
...
}

  7. צריך לשנות את קובץ הפריסה של הפעילות 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.