کیتهای توسعه نرمافزار IMA ادغام آگهیهای چندرسانهای در وبسایتها و برنامههایتان را آسان میکنند. کیتهای توسعه نرمافزار IMA میتوانند از هر سرور آگهی سازگار با VAST درخواست آگهی کنند و بازپخش آگهی را در برنامههایتان مدیریت کنند. با کیتهای توسعه نرمافزار سمت کارخواه IMA، کنترل بازپخش ویدیو محتوا را حفظ میکنید، درحالیکه کیت توسعه نرمافزار بازپخش آگهی را مدیریت میکند. آگهیها در یک پخشکننده ویدیو جداگانه که در بالای پخشکننده ویدیو محتوای برنامه قرار دارد پخش میشوند.
این راهنما نشان میدهد که چگونه کیت توسعه نرمافزار IMA را در پروژه خالی «استودیو Android» بااستفاده از Android VideoView برای نمایش محتوا و آگهیها ادغام کنید. برای دنبال کردن نمونه ادغام تکمیلشده، BasicExample را از GitHub بارگیری کنید.
نمای کلی سمت کارخواه IMA
پیادهسازی سمت کارخواه IMA شامل چهار عنصر اصلی کیت توسعه نرمافزار است که در این راهنما نشان داده شده است:
AdDisplayContainer: یک شیء محتوی که مشخص میکند IMA عناصر واسط کاربر آگهی را کجا پرداز میکند و رؤیتپذیری را کجا اندازهگیری میکند، ازجمله Active View و Open Measurement.-
AdsLoader: شیئی که آگهیها را درخواست میکند و رویدادها را از پاسخهای درخواست آگهی مدیریت میکند. فقط باید یک بار تبلیغات بارکننده را نمونهسازی کنید که میتواند در طول عمر برنامه دوباره استفاده شود. AdsRequest: شیئی که درخواست آگهی را تعریف میکند. درخواستهای آگهی نشانی وب را برای برچسب آگهی VAST و همچنین پارامترهای اضافی، مانند ابعاد آگهی، مشخص میکنند.AdsManager: شیئی که حاوی پاسخ به درخواست آگهی است، پخش آگهی را کنترل میکند، و به رویدادهای آگهی که توسط کیت توسعه نرمافزار راهاندازی میشوند گوش میدهد.
پیشنیازها
۱. ایجاد پروژه جدید «استودیو Android»
برای ایجاد پروژه Android Studio، مراحل زیر را تکمیل کنید:
- «استودیو Android» را شروع کنید.
- Start a new Android Studio project (شروع پروژه جدید Android Studio) را انتخاب کنید.
- در صفحه انتخاب پروژه، الگوی فعالیت خالی را انتخاب کنید.
- روی بعدی کلیک کنید.
- در صفحه پیکربندی پروژه، نامی برای پروژه خود انتخاب کنید و زبان Java را انتخاب کنید.
- روی تمام کلیک کنید؛
۲. افزودن IMA SDK به پروژه
ابتدا، در فایل build.gradle در سطح برنامه، واردات برای IMA SDK را به بخش وابستگیها اضافه کنید. همچنین، compileOptions جدیدی اضافه کنید تا اطلاعات سازگاری نسخه Java را مشخص کنید
و desugaring کتابخانه را فعال کنید.
کیت توسعه نرمافزار IMA به فعال بودن شکرزدایی کتابخانه نیاز دارد که باید آن را با تنظیم
coreLibraryDesugaringEnabled true و افزودن
'com.android.tools:desugar_jdk_libs' بهعنوان وابستگی در فایل build.gradle انجام دهید.
برای جزئیات بیشتر،
میاناهای برنامهسازی کاربردی Java 11+ دردسترس ازطریق desugaring با مشخصات nio را ببینید.
apply plugin: 'com.android.application' android { namespace = 'com.google.ads.interactivemedia.v3.samples.videoplayerapp' compileSdk = 36 // Java 17 required by Gradle 8+ compileOptions { // Required by IMA SDK v3.37.0+ coreLibraryDesugaringEnabled = true // Java 17 required by Gradle 8+ sourceCompatibility = JavaVersion.VERSION_17 targetCompatibility = JavaVersion.VERSION_17 } defaultConfig { applicationId = "com.google.ads.interactivemedia.v3.samples.videoplayerapp" minSdkVersion(24) targetSdkVersion(36) versionCode = 1 versionName = "1.0" } buildTypes { release { minifyEnabled = true proguardFiles(getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro') } } } repositories { google() mavenCentral() } dependencies { coreLibraryDesugaring('com.android.tools:desugar_jdk_libs:2.1.5') implementation(platform('org.jetbrains.kotlin:kotlin-bom:2.3.21')) implementation('androidx.appcompat:appcompat:1.8.0') implementation('androidx.browser:browser:1.10.0') implementation('androidx.media:media:1.8.0') implementation('com.google.ads.interactivemedia.v3:interactivemedia:3.40.0') }
۳. بهروزرسانی چیدمان برنامه
چیدمان برنامه را بهروز کنید تا VideoView برای پخش محتوا و آگهی داشته باشد:
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android" xmlns:tools="http://schemas.android.com/tools" android:id="@+id/container" android:layout_width="match_parent" android:layout_height="match_parent" android:orientation="vertical" tools:context=".MyActivity" tools:ignore="MergeRootFrame"> <RelativeLayout android:background="#000000" android:fitsSystemWindows="true" android:layout_width="match_parent" android:layout_height="0dp" android:layout_weight="0.4" android:orientation="vertical" android:id="@+id/videoPlayerContainer" > <VideoView android:id="@+id/videoView" android:layout_width="match_parent" android:layout_height="match_parent" /> <ImageButton android:id="@+id/playButton" android:contentDescription="@string/play_description" android:layout_width="match_parent" android:layout_height="match_parent" android:src="@drawable/ic_action_play_over_video" android:background="@null" /> </RelativeLayout> <FrameLayout android:layout_width="match_parent" android:layout_height="0dp" android:layout_weight="0.6" android:id="@+id/videoDescription" > <TextView android:id="@+id/playerDescription" android:text="@string/app_name" android:textAlignment="center" android:gravity="center_horizontal" android:layout_width="match_parent" android:layout_height="match_parent" android:paddingVertical="@dimen/font_size" android:textSize="@dimen/font_size" /> </FrameLayout> </LinearLayout>
۴. وارد کردن IMA به فعالیت اصلی
بیانیههای وارد کردن را برای «کیت توسعه نرمافزار IMA» اضافه کنید:
import android.content.Context; import android.content.res.Configuration; import android.media.AudioManager; import android.os.Bundle; import android.util.Log; import android.view.View; import android.widget.MediaController; import android.widget.VideoView; import androidx.appcompat.app.AppCompatActivity; import com.google.ads.interactivemedia.v3.api.AdDisplayContainer; 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.AdsManager; import com.google.ads.interactivemedia.v3.api.AdsRenderingSettings; import com.google.ads.interactivemedia.v3.api.AdsRequest; import com.google.ads.interactivemedia.v3.api.ImaSdkFactory; import com.google.ads.interactivemedia.v3.api.ImaSdkSettings; import com.google.ads.interactivemedia.v3.api.player.VideoProgressUpdate; import java.util.Arrays;
کلاس MyActivity را بهروز کنید تا AppCompatActivity را گسترش دهد. کلاس AppCompatActivity امکان پشتیبانی از ویژگیهای جدیدتر پلاتفرم را در دستگاههای Android قدیمیتر فراهم میکند. سپس، مجموعهای از متغیرهای خصوصی را که در برنامه استفاده خواهد شد اضافه کنید:
/** Main activity. */ public class MyActivity extends AppCompatActivity { private static final String LOGTAG = "IMABasicSample"; private static final String SAMPLE_VIDEO_URL = "https://storage.googleapis.com/gvabox/media/samples/stock.mp4"; /** * IMA sample tag for a single skippable inline video ad. See more IMA sample tags at * https://developers.google.com/interactive-media-ads/docs/sdks/html5/client-side/tags */ private static final String SAMPLE_VAST_TAG_URL = "https://pubads.g.doubleclick.net/gampad/ads?iu=/21775744923/external/" + "single_preroll_skippable&sz=640x480&ciu_szs=300x250%2C728x90&gdfp_req=1&output=vast" + "&unviewed_position_start=1&env=vp&correlator="; // Factory class for creating SDK objects. private ImaSdkFactory sdkFactory; // The AdsLoader instance exposes the requestAds method. private AdsLoader adsLoader; // AdsManager exposes methods to control ad playback and listen to ad events. private AdsManager adsManager; // The saved content position, used to resumed content following an ad break. private int savedPosition = 0; // This sample uses a VideoView for content and ad playback. For production // apps, Android's Exoplayer offers a more fully featured player compared to // the VideoView. private VideoView videoPlayer; private MediaController mediaController; private VideoAdPlayerAdapter videoAdPlayerAdapter; private ImaSdkSettings imaSdkSettings;
۵. ایجاد کلاس VideoAdPlayerAdapter
کلاس VideoAdPlayerAdapter را با VideoView ایجاد کنید،
و آن را با میانای
VideoAdPlayer
IMA
تطبیق دهید. این کلاس بازپخش محتوا و آگهی را مدیریت میکند و حاوی مجموعهای از
روشهایی است که پخشکننده ویدیو باید برای استفاده توسط «کیت توسعه نرمافزار آگهیهای رسانهای تعاملی» پیادهسازی کند:
import android.media.AudioManager; import android.media.MediaPlayer; import android.net.Uri; import android.util.Log; import android.widget.VideoView; import com.google.ads.interactivemedia.v3.api.AdPodInfo; import com.google.ads.interactivemedia.v3.api.player.AdMediaInfo; import com.google.ads.interactivemedia.v3.api.player.VideoAdPlayer; import com.google.ads.interactivemedia.v3.api.player.VideoProgressUpdate; import java.util.ArrayList; import java.util.List; import java.util.Timer; import java.util.TimerTask; /** Example implementation of IMA's VideoAdPlayer interface. */ public class VideoAdPlayerAdapter implements VideoAdPlayer { private static final String LOGTAG = "IMABasicSample"; private static final long POLLING_TIME_MS = 250; private static final long INITIAL_DELAY_MS = 250; private final VideoView videoPlayer; private final AudioManager audioManager; private final List<VideoAdPlayerCallback> videoAdPlayerCallbacks = new ArrayList<>(); private Timer timer; private int adDuration; // The saved ad position, used to resumed ad playback following an ad click-through. private int savedAdPosition; private AdMediaInfo loadedAdMediaInfo; public VideoAdPlayerAdapter(VideoView videoPlayer, AudioManager audioManager) { this.videoPlayer = videoPlayer; this.videoPlayer.setOnCompletionListener( (MediaPlayer mediaPlayer) -> notifyImaOnContentCompleted()); this.audioManager = audioManager; }
۶. لغو کردن روشهای VideoAdPlayer
روشهای VideoAdPlayer زیر را ملغی کنید:
روش playAd() نشانی وب محتوا یا آگهی را تنظیم میکند و شنوندهای را برای شروع
پخش پساز بار شدن رسانه تنظیم میکند.
@Override public void addCallback(VideoAdPlayerCallback videoAdPlayerCallback) { videoAdPlayerCallbacks.add(videoAdPlayerCallback); } @Override public void loadAd(AdMediaInfo adMediaInfo, AdPodInfo adPodInfo) { // This simple ad loading logic works because preloading is disabled. To support // preloading ads your app must maintain state for the currently playing ad // while handling upcoming ad downloading and buffering at the same time. // See the IMA Android preloading guide for more info: // https://developers.google.com/interactive-media-ads/docs/sdks/android/client-side/preload loadedAdMediaInfo = adMediaInfo; } @Override public void pauseAd(AdMediaInfo adMediaInfo) { Log.i(LOGTAG, "pauseAd"); savedAdPosition = videoPlayer.getCurrentPosition(); stopAdTracking(); } @Override public void playAd(AdMediaInfo adMediaInfo) { videoPlayer.setVideoURI(Uri.parse(adMediaInfo.getUrl())); videoPlayer.setOnPreparedListener( mediaPlayer -> { adDuration = mediaPlayer.getDuration(); if (savedAdPosition > 0) { mediaPlayer.seekTo(savedAdPosition); } mediaPlayer.start(); startAdTracking(); }); videoPlayer.setOnErrorListener( (mediaPlayer, errorType, extra) -> notifyImaSdkAboutAdError(errorType)); videoPlayer.setOnCompletionListener( mediaPlayer -> { savedAdPosition = 0; notifyImaSdkAboutAdEnded(); }); } @Override public void release() { // any clean up that needs to be done. } @Override public void removeCallback(VideoAdPlayerCallback videoAdPlayerCallback) { videoAdPlayerCallbacks.remove(videoAdPlayerCallback); } @Override public void stopAd(AdMediaInfo adMediaInfo) { Log.i(LOGTAG, "stopAd"); stopAdTracking(); } /** Returns current volume as a percent of max volume. */ @Override public int getVolume() { return audioManager.getStreamVolume(AudioManager.STREAM_MUSIC) / audioManager.getStreamMaxVolume(AudioManager.STREAM_MUSIC); }
۷. راهاندازی پیگیری آگهی
برای اینکه رویدادهای آگهی ثبت شوند،
VideoAdPlayerCallback.onAdProgress باید بهعنوان پیشرفت محتوا و آگهیها فراخوانی شود. برای پشتیبانی از این ویژگی، زمانسنجی تنظیم کنید تا در فواصل زمانی معین با onAdProgress() تماس بگیرد.
private void startAdTracking() { Log.i(LOGTAG, "startAdTracking"); if (timer != null) { return; } timer = new Timer(); TimerTask updateTimerTask = new TimerTask() { @Override public void run() { VideoProgressUpdate progressUpdate = getAdProgress(); notifyImaSdkAboutAdProgress(progressUpdate); } }; timer.schedule(updateTimerTask, POLLING_TIME_MS, INITIAL_DELAY_MS); } private void notifyImaSdkAboutAdEnded() { Log.i(LOGTAG, "notifyImaSdkAboutAdEnded"); savedAdPosition = 0; for (VideoAdPlayer.VideoAdPlayerCallback callback : videoAdPlayerCallbacks) { callback.onEnded(loadedAdMediaInfo); } } private void notifyImaSdkAboutAdProgress(VideoProgressUpdate adProgress) { for (VideoAdPlayer.VideoAdPlayerCallback callback : videoAdPlayerCallbacks) { callback.onAdProgress(loadedAdMediaInfo, adProgress); } } /** * @param errorType Media player's error type as defined at * https://cs.android.com/android/platform/superproject/+/master:frameworks/base/media/java/android/media/MediaPlayer.java;l=4335 * @return True to stop the current ad playback. */ private boolean notifyImaSdkAboutAdError(int errorType) { Log.i(LOGTAG, "notifyImaSdkAboutAdError"); switch (errorType) { case MediaPlayer.MEDIA_ERROR_UNSUPPORTED -> Log.e(LOGTAG, "notifyImaSdkAboutAdError: MEDIA_ERROR_UNSUPPORTED"); case MediaPlayer.MEDIA_ERROR_TIMED_OUT -> Log.e(LOGTAG, "notifyImaSdkAboutAdError: MEDIA_ERROR_TIMED_OUT"); default -> {} } for (VideoAdPlayer.VideoAdPlayerCallback callback : videoAdPlayerCallbacks) { callback.onError(loadedAdMediaInfo); } return true; } public void notifyImaOnContentCompleted() { Log.i(LOGTAG, "notifyImaOnContentCompleted"); for (VideoAdPlayer.VideoAdPlayerCallback callback : videoAdPlayerCallbacks) { callback.onContentComplete(); } } private void stopAdTracking() { Log.i(LOGTAG, "stopAdTracking"); if (timer != null) { timer.cancel(); timer = null; } } @Override public VideoProgressUpdate getAdProgress() { long adPosition = videoPlayer.getCurrentPosition(); return new VideoProgressUpdate(adPosition, adDuration); }
۸. راهاندازی IMA در روش onCreate
روش onCreate را بازنویسی کنید و تخصیصهای متغیر موردنیاز را برای شروع IMA اضافه کنید. در این مرحله، نمونههای موارد زیر را ایجاد کنید:
ImaSdkSettingsAdsLoaderVideoAdPlayerAdapter
@Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_my); // Initialize the IMA SDK as early as possible when the app starts. If your app already // overrides Application.onCreate(), call this method inside the onCreate() method. // https://developer.android.com/topic/performance/vitals/launch-time#app-creation sdkFactory = ImaSdkFactory.getInstance(); sdkFactory.initialize(this, getImaSdkSettings()); // Create the UI for controlling the video view. mediaController = new MediaController(this); videoPlayer = findViewById(R.id.videoView); mediaController.setAnchorView(videoPlayer); videoPlayer.setMediaController(mediaController); // Create an ad display container that uses a ViewGroup to listen to taps. AudioManager audioManager = (AudioManager) getSystemService(Context.AUDIO_SERVICE); videoAdPlayerAdapter = new VideoAdPlayerAdapter(videoPlayer, audioManager); AdDisplayContainer adDisplayContainer = ImaSdkFactory.createAdDisplayContainer( findViewById(R.id.videoPlayerContainer), videoAdPlayerAdapter); // Create an AdsLoader. adsLoader = sdkFactory.createAdsLoader(this, getImaSdkSettings(), adDisplayContainer);
دکمه پخش را برای درخواست آگهیها راهاندازی کنید، سپس وقتی کلیک شد آن را پنهان کنید:
// When the play button is clicked, request ads and hide the button. View playButton = findViewById(R.id.playButton); playButton.setOnClickListener( view -> { videoPlayer.setVideoPath(SAMPLE_VIDEO_URL); requestAds(SAMPLE_VAST_TAG_URL); view.setVisibility(View.GONE); });
ImaSdkSettings اضافه کنید:
private ImaSdkSettings getImaSdkSettings() { if (imaSdkSettings == null) { imaSdkSettings = ImaSdkFactory.getInstance().createImaSdkSettings(); // Set any IMA SDK settings here. } return imaSdkSettings; }
۹. افزودن شنوندگان AdsLoader
شنوندگان را برای addAdErrorListener و
addAdsLoadedListener اضافه کنید. در AdsLoadedListener،
AdsManager را ایجاد کنید و شنونده خطای AdsManager را راهاندازی کنید:
// Add listeners for when ads are loaded and for errors. adsLoader.addAdErrorListener( new AdErrorEvent.AdErrorListener() { /** An event raised when there is an error loading or playing ads. */ @Override public void onAdError(AdErrorEvent adErrorEvent) { Log.i(LOGTAG, "Ad Error: " + adErrorEvent.getError().getMessage()); resumeContent(); } }); adsLoader.addAdsLoadedListener( adsManagerLoadedEvent -> { // Ads were successfully loaded, so get the AdsManager instance. AdsManager has // events for ad playback and errors. adsManager = adsManagerLoadedEvent.getAdsManager(); // Attach event and error event listeners. adsManager.addAdErrorListener( new AdErrorEvent.AdErrorListener() { /** An event raised when there is an error loading or playing ads. */ @Override public void onAdError(AdErrorEvent adErrorEvent) { Log.e(LOGTAG, "Ad Error: " + adErrorEvent.getError().getMessage()); String universalAdIds = Arrays.toString(adsManager.getCurrentAd().getUniversalAdIds()); Log.i( LOGTAG, "Discarding the current ad break with universal " + "ad Ids: " + universalAdIds); adsManager.discardAdBreak(); } });
۱۰. مدیریت رویدادهای آگهی IMA
با AdsManager.addAdEventListener به رویدادهای آگهی IMA گوش دهید. بااستفاده از عبارت switch، کنشهایی را برای رویدادهای IMA زیر راهاندازی کنید:
تکه کد شامل نظراتی با اطلاعات بیشتر درباره نحوه استفاده از رویدادها است. پساز راهاندازی رویدادها،
AdsManager.init() را فراخوانی کنید:
adsManager.addAdEventListener( new AdEvent.AdEventListener() { /** Responds to AdEvents. */ @Override public void onAdEvent(AdEvent adEvent) { if (adEvent.getType() != AdEvent.AdEventType.AD_PROGRESS) { Log.i(LOGTAG, "Event: " + adEvent.getType()); } // These are the suggested event types to handle. For full list of // all ad event types, see AdEvent.AdEventType documentation. switch (adEvent.getType()) { case LOADED -> // AdEventType.LOADED is fired when ads are ready to play. // This sample app uses the sample tag // single_preroll_skippable_ad_tag_url that requires calling // AdsManager.start() to start ad playback. // If you use a different ad tag URL that returns a VMAP or // an ad rules playlist, the adsManager.init() function will // trigger ad playback automatically and the IMA SDK will // ignore the adsManager.start(). // It is safe to always call adsManager.start() in the // LOADED event. adsManager.start(); case CONTENT_PAUSE_REQUESTED -> // AdEventType.CONTENT_PAUSE_REQUESTED is fired when you // should pause your content and start playing an ad. pauseContentForAds(); case CONTENT_RESUME_REQUESTED -> // AdEventType.CONTENT_RESUME_REQUESTED is fired when the ad // you should play your content. resumeContent(); case ALL_ADS_COMPLETED -> { // Calling adsManager.destroy() triggers the function // VideoAdPlayer.release(). adsManager.destroy(); adsManager = null; } case CLICKED -> { // When the user clicks on the Learn More button, the IMA SDK fires // this event, pauses the ad, and opens the ad's click-through URL. // When the user returns to the app, the IMA SDK calls the // VideoAdPlayer.playAd() function automatically. } default -> {} } } }); AdsRenderingSettings adsRenderingSettings = ImaSdkFactory.getInstance().createAdsRenderingSettings(); // Add any ads rendering settings here. // This init() only loads the UI rendering settings locally. adsManager.init(adsRenderingSettings); });
۱۱. جابهجایی بین آگهیها و محتوا را مدیریت کنید
در این بخش، روشهای pauseContentForAds و resumeContent
را که در مراحل قبلی به آنها ارجاع داده شده است ایجاد کنید. این روشها از پخشکننده برای پخش محتوا و آگهیها استفاده مجدد میکنند. باید موقعیت محتوا را پیگیری کنید تا بتوانید
بازپخش را پساز وقفه آگهی ازسر بگیرید.
private void pauseContentForAds() { Log.i(LOGTAG, "pauseContentForAds"); savedPosition = videoPlayer.getCurrentPosition(); videoPlayer.stopPlayback(); // Hide the buttons and seek bar controlling the video view. videoPlayer.setMediaController(null); } private void resumeContent() { Log.i(LOGTAG, "resumeContent"); // Show the buttons and seek bar controlling the video view. videoPlayer.setVideoPath(SAMPLE_VIDEO_URL); videoPlayer.setMediaController(mediaController); videoPlayer.setOnPreparedListener( mediaPlayer -> { if (savedPosition > 0) { mediaPlayer.seekTo(savedPosition); } mediaPlayer.start(); }); videoPlayer.setOnCompletionListener( mediaPlayer -> videoAdPlayerAdapter.notifyImaOnContentCompleted()); }
۱۲. درخواست آگهی
اکنون روش requestAds را برای ساختن
AdsRequest
اضافه کنید و از آن برای فراخوانی AdsLoader.requestAds() استفاده کنید:
private void requestAds(String adTagUrl) { // Create the ads request. AdsRequest request = sdkFactory.createAdsRequest(); request.setAdTagUrl(adTagUrl); request.setContentProgressProvider( () -> { if (videoPlayer.getDuration() <= 0) { return VideoProgressUpdate.VIDEO_TIME_NOT_READY; } return new VideoProgressUpdate( videoPlayer.getCurrentPosition(), videoPlayer.getDuration()); }); // Request the ad. After the ad is loaded, onAdsManagerLoaded() will be called. adsLoader.requestAds(request); }
اکنون با موفقیت درحال درخواست و نمایش آگهیها با «کیت توسعه نرمافزار IMA» هستید. برای آشنایی با ویژگیهای پیشرفته بیشتر، راهنماهای دیگر یا نمونههای GitHub را کاوش کنید.