דף זה תורגם על ידי Cloud Translation API.

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

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

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

DAI בשירות מלא

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

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

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

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

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

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

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

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

מורידים את האפליקציה לדוגמה של נגן הווידאו ומחלצים אותה.
מפעילים את Android Studio ובוחרים באפשרות Open an existing Android Studio project. אם אתם כבר משתמשים ב-Android Studio, בוחרים באפשרות File > New >Import Project. אחר כך צריך לבחור SampleVideoPlayer/build.gradle.
כדי להפעיל סנכרון של Gradle, בוחרים באפשרות כלים > Android > סנכרון הפרויקט עם קובצי Gradle.
מוודאים שאפליקציית הנגן מורכבת ופועלת במכשיר Android פיזי או במכשיר וירטואלי של Android באמצעות לחיצה על Run > Run '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.34.0'
}

שילוב של IMA DAI SDK

יוצרים מחלקה חדשה בשם 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());
    }
}

מוסיפים method buildStreamRequest() ל-AdsLoader כדי שהוא יוכל לבקש סטרימינג עם מודעות. זהו שידור חי עם מודעות (מוגדר כברירת מחדל) או וידאו על פי דרישה(VOD) שבו מוצג תוכן שהוקלט מראש עם מודעות. כדי להפעיל שידור VOD, צריך להגיב על הבקשה לשידור החי ולבטל את התגובה לבקשה לשידור ה-VOD.

כדי לעבוד עם DAI, השחקן צריך להעביר אירועי ID3 עבור שידורים חיים לערכות ה-SDK של IMA DAI. בקוד לדוגמה הבא, הפעולה הזו מתבצעת באמצעות ה-method 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;
}

צריך גם 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());
        }

        @Override
        public int getVolume() {
            return videoPlayer.getVolume();
        }
    };
    return player;
}

להטמיע את המאזינים הנדרשים ולהוסיף תמיכה בטיפול בשגיאות.

שימו לב להטמעה של 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;
}

הוספת קוד לרישום ביומן.

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);
    }
}

משנים את MyActivity ב-videoplayerapp כדי ליצור אובייקט (instantiation) ולקרוא ל-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.