IMA DAI SDK टूल का इस्तेमाल शुरू करना

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

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

IMA DAI के बारे में खास जानकारी

IMA DAI को लागू करने में चार मुख्य SDK कॉम्पोनेंट शामिल हैं. इनके बारे में इस गाइड में बताया गया है:

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

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

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

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

सैंपल ऐप्लिकेशन, HLS वीडियो चलाने वाला वीडियो प्लेयर उपलब्ध कराता है. इसका इस्तेमाल IMA Android SDK की डीएआई सुविधा को इंटिग्रेट करने के शुरुआती पॉइंट के तौर पर करें.

  1. नमूना वीडियो प्लेयर ऐप्लिकेशन डाउनलोड करें और अनज़िप करें.
  2. Android Studio शुरू करें और कोई मौजूदा Android Studio प्रोजेक्ट खोलें या अगर Android Studio पहले से चल रहा है, तो फ़ाइल > नया > प्रोजेक्ट इंपोर्ट करें चुनें. इसके बाद, SampleVideoPlayer/build.gradle चुनें.
  3. Gradle सिंक करने के लिए, टूल > Android > Gradle फ़ाइल के साथ प्रोजेक्ट सिंक करें को चुनें.
  4. पक्का करें कि प्लेयर ऐप्लिकेशन, Run > 'app' का इस्तेमाल करके, किसी फ़िज़िकल Android डिवाइस या Android वर्चुअल डिवाइस पर कंपाइल और चलता है. वीडियो स्ट्रीम शुरू होने से पहले, वीडियो लोड होने में कुछ समय लग सकता है.

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

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

  • samplevideoplayer/SampleVideoPlayer.java - ExoPlayer आधारित HLS प्लेयर, जो IMA DAI के इंटिग्रेशन की बुनियाद है.
  • videoplayerapp/MyActivity.java - इस गतिविधि से वीडियो प्लेयर बनता है और उसे Context और SimpleExoPlayerView के लिए पास किया जाता है.

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

आपको IMA SDK का रेफ़रंस भी शामिल करना होगा. Android Studio में, app/build.gradle में मौजूद अपनी ऐप्लिकेशन-लेवल फ़ाइल में ये चीज़ें जोड़ें:

repositories {
  google()
  jcenter()
}

dependencies {
    implementation 'androidx.appcompat:appcompat:1.2.0'
    implementation 'androidx.browser:browser:1.3.0'
    implementation 'com.google.android.exoplayer:exoplayer:2.18.1'
    implementation 'com.google.ads.interactivemedia.v3:interactivemedia:3.29.0'
}

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

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

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

    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);
                        }
                    }
                });
    
        // Live stream 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 live stream 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());
            }
        };
        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. MyActivity को तुरंत चालू करने और SampleAdsWrapper को कॉल करने के लिए, 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 लॉग इन के लिए यूज़र इंटरफ़ेस (यूआई) एलिमेंट जोड़ें.

    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 फ़ोरम पर एक लाइन बताएं.