IMA डीएआई SDK टूल का इस्तेमाल शुरू करना

IMA SDK टूल की मदद से, अपनी वेबसाइटों और ऐप्लिकेशन में आसानी से मल्टीमीडिया विज्ञापन इंटिग्रेट किए जा सकते हैं. IMA SDK टूल, वीएएसटी (वीडियो विज्ञापन देने के लिए टेंप्लेट) का पालन करने वाले किसी भी विज्ञापन सर्वर से विज्ञापनों का अनुरोध कर सकते हैं. साथ ही, आपके ऐप्लिकेशन में विज्ञापन चलाने की सुविधा को मैनेज कर सकते हैं. IMA डीएआई SDK की मदद से, ऐप्लिकेशन विज्ञापन और कॉन्टेंट वीडियो के लिए स्ट्रीम का अनुरोध करते हैं. यह वीओडी या लाइव कॉन्टेंट हो सकता है. इसके बाद, SDK टूल एक ऐसी वीडियो स्ट्रीम दिखाता है जिसमें विज्ञापन और कॉन्टेंट, दोनों शामिल होते हैं. इससे आपको अपने ऐप्लिकेशन में, विज्ञापन और कॉन्टेंट वीडियो के बीच स्विच करने की ज़रूरत नहीं पड़ती.

डीआई (डायनामिक विज्ञापन) का वह समाधान चुनें जिसमें आपकी दिलचस्पी है

पूरी सेवा वाला डीएआई

इस गाइड में, IMA डीएआई SDK टूल को किसी सामान्य वीडियो प्लेयर ऐप्लिकेशन में इंटिग्रेट करने का तरीका बताया गया है. अगर आपको इंटिग्रेशन का पूरा सैंपल देखना है या उसका पालन करना है, तो GitHub से BasicExample डाउनलोड करें.

IMA डीएआई की खास जानकारी

IMA डीएआई लागू करने के लिए, SDK टूल के चार मुख्य कॉम्पोनेंट ज़रूरी होते हैं. इनके बारे में इस गाइड में बताया गया है:

  • StreamDisplayContainer: यह एक कंटेनर ऑब्जेक्ट है, जो वीडियो चलाने वाले एलिमेंट के ऊपर होता है. साथ ही, इसमें विज्ञापन के यूज़र इंटरफ़ेस (यूआई) एलिमेंट होते हैं.
  • AdsLoader: यह एक ऐसा ऑब्जेक्ट है जो स्ट्रीम का अनुरोध करता है और स्ट्रीम के अनुरोध के रिस्पॉन्स ऑब्जेक्ट से ट्रिगर होने वाले इवेंट को मैनेज करता है. आपको सिर्फ़ एक विज्ञापन लोडर का इंस्टेंस बनाना चाहिए. इसका इस्तेमाल, ऐप्लिकेशन के पूरे लाइफ़साइकल के दौरान किया जा सकता है.
  • StreamRequest: यह एक ऐसा ऑब्जेक्ट है जो स्ट्रीम के अनुरोध के बारे में बताता है. स्ट्रीम के अनुरोध, वीडियो ऑन डिमांड या लाइव स्ट्रीम के लिए किए जा सकते हैं. अनुरोधों में कॉन्टेंट आईडी के साथ-साथ, एपीआई पासकोड या पुष्टि करने वाला टोकन और अन्य पैरामीटर भी शामिल होते हैं.
  • StreamManager: यह एक ऐसा ऑब्जेक्ट है जो डाइनैमिक ऐड इंसर्शन स्ट्रीम और डीआई बैकएंड के साथ इंटरैक्शन को मैनेज करता है. स्ट्रीम मैनेजर, ट्रैकिंग पिंग को भी मैनेज करता है. साथ ही, पब्लिशर को स्ट्रीम और विज्ञापन इवेंट भी भेजता है.

ज़रूरी शर्तें

  • Android Studio
  • SDK टूल इंटिग्रेशन के लिए, वीडियो प्लेयर ऐप्लिकेशन का सैंपल

सैंपल वीडियो प्लेयर ऐप्लिकेशन डाउनलोड और चलाना

सैंपल ऐप्लिकेशन में, एचएलएस वीडियो चलाने वाला वीडियो प्लेयर उपलब्ध होता है. IMA DAI SDK टूल की डीआई (डिजिटल इन्वेंट्री) सुविधाओं को इंटिग्रेट करने के लिए, इसका इस्तेमाल शुरुआती बिंदु के तौर पर करें.

  1. सैंपल वीडियो प्लेयर ऐप्लिकेशन डाउनलोड करें और उसे एक्सट्रैक्ट करें.

  2. Android Studio खोलें और कोई मौजूदा Android Studio प्रोजेक्ट खोलें चुनें. अगर Android Studio पहले से चल रहा है, तो फ़ाइल > नया > प्रोजेक्ट इंपोर्ट करें चुनें. इसके बाद, SampleVideoPlayer/build.gradle चुनें.

  3. टूल > Android > Gradle फ़ाइलों के साथ प्रोजेक्ट सिंक करें को चुनकर, Gradle सिंक करें.

  4. पक्का करें कि प्लेयर ऐप्लिकेशन, रन करें > 'ऐप्लिकेशन' चलाएं का इस्तेमाल करके, किसी फ़िज़िकल Android डिवाइस या Android वर्चुअल डिवाइस पर कंपाइल और चलाया जा सकता हो. वीडियो स्ट्रीम को चलने से पहले लोड होने में कुछ समय लगना सामान्य है.

सैंपल वीडियो प्लेयर की जांच करना

सैंपल वीडियो प्लेयर में अब तक कोई IMA DAI SDK टूल इंटिग्रेशन कोड नहीं है. सैंपल ऐप्लिकेशन में दो मुख्य हिस्से होते हैं:

  1. samplevideoplayer/SampleVideoPlayer.java: ExoPlayer पर आधारित एचएलएस प्लेयर, जो IMA डीएआई इंटिग्रेशन के लिए आधार के तौर पर काम करता है.

  2. videoplayerapp/MyActivity.java: यह गतिविधि वीडियो प्लेयर बनाती है और उसे Context और SimpleExoPlayerView पास करती है.

प्लेयर ऐप्लिकेशन में IMA DAI SDK टूल जोड़ना

आपको IMA DAI SDK टूल का रेफ़रंस भी शामिल करना होगा. Android Studio में, app/build.gradle में मौजूद अपने ऐप्लिकेशन-लेवल की 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.1'
}

IMA DAI SDK टूल को इंटिग्रेट करना

  1. मौजूदा SampleVideoPlayer को रैप करने और IMA DAI लागू करने वाला लॉजिक जोड़ने के लिए, videoplayerapp पैकेज (app/java/com.google.ads.interactivemedia.v3.samples/videoplayerapp/ में) में SampleAdsWrapper नाम की एक नई क्लास बनाएं. ऐसा करने के लिए, आपको सबसे पहले एक 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());
        }
    }
    
  2. AdsLoader में buildStreamRequest() का तरीका जोड़ें, ताकि वह विज्ञापनों के साथ स्ट्रीम का अनुरोध कर सके. यह विज्ञापनों के साथ लाइव स्ट्रीम (डिफ़ॉल्ट रूप से सेट) या वीडियो-ऑन-डिमांड(वीओडी) स्ट्रीम होती है. इसमें, विज्ञापनों के साथ पहले से रिकॉर्ड किया गया कॉन्टेंट चलता है. वीओडी स्ट्रीम की सुविधा चालू करने के लिए, लाइव स्ट्रीम के अनुरोध पर की गई टिप्पणी हटाएं और वीओडी स्ट्रीम के अनुरोध पर की गई टिप्पणी पर से सही का निशान हटाएं.

    डीआई के साथ काम करने के लिए, प्लेयर को IMA डीआई के SDK टूल में लाइव स्ट्रीम के लिए आईडी3 इवेंट पास करने होंगे. नीचे दिए गए सैंपल कोड में, यह 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;
    }
    
  3. स्ट्रीम चलाने के लिए, आपको 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;
    }
    
  4. ज़रूरी लिसनर लागू करें और गड़बड़ी को मैनेज करने के लिए सहायता जोड़ें.

    AdErrorListener को लागू करने का तरीका ध्यान से देखें, क्योंकि अगर विज्ञापन नहीं चल पाते हैं, तो यह फ़ॉलबैक यूआरएल को कॉल करता है. कॉन्टेंट और विज्ञापन एक ही स्ट्रीम में होते हैं. इसलिए, अगर डीएआई स्ट्रीम में कोई गड़बड़ी आती है, तो आपको फ़ॉलबैक स्ट्रीम को कॉल करने के लिए तैयार रहना होगा.

    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. लॉग करने के लिए कोड जोड़ें.

    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. SampleAdsWrapper को इंस्टैंशिएट करने और कॉल करने के लिए, videoplayerapp में MyActivity में बदलाव करें.

    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 में बदलाव करके, Logging के लिए यूज़र इंटरफ़ेस (यूआई) एलिमेंट जोड़ें.

    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 ऐप्लिकेशन में वीडियो विज्ञापनों का अनुरोध करने और उन्हें दिखाने का विकल्प है. इसे बेहतर तरीके से लागू करने के लिए, बुकमार्क, स्नैपबैक, और एपीआई दस्तावेज़ देखें.

समस्या का हल

अगर आपको वीडियो विज्ञापन चलाने में समस्या आ रही है, तो पूरा BasicExample डाउनलोड करके देखें. अगर यह BasicExample में सही तरीके से काम करता है, तो हो सकता है कि आपके ऐप्लिकेशन के IMA इंटिग्रेशन कोड में कोई समस्या हो.

अगर आपको अब भी समस्याएं आ रही हैं, तो IMA SDK के फ़ोरम पर जाएं.