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

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

अपनी पसंद का डीएआई सलूशन चुनें

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  1. samplevideoplayer/SampleVideoPlayer.java: अगर ExoPlayer पर आधारित HLS प्लेयर जो IMA डीएआई इंटिग्रेशन का आधार.

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

प्लेयर ऐप्लिकेशन में IMA डीएआई 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.35.0'
}

IMA डीएआई SDK टूल को इंटिग्रेट करें

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

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

समस्या का हल

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

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