doc: add comments to new examples #688

prebid · Sep 26, 2023 · 6b5e4a9 · 6b5e4a9
1 parent 23b4a19
commit 6b5e4a9
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 3 deletions.
diff --git a/...javademo/activities/ads/gam/original/GamOriginalApiMultiformatBannerVideoNativeInApp.java b/...javademo/activities/ads/gam/original/GamOriginalApiMultiformatBannerVideoNativeInApp.java
@@ -66,23 +66,28 @@ public void onCreate(@Nullable Bundle savedInstanceState) {
     }
 
     private void createAd() {
+        // Random only for test cases. For production use one config id.
         ArrayList<String> configIds = Lists.newArrayList(CONFIG_ID_BANNER, CONFIG_ID_VIDEO, CONFIG_ID_NATIVE);
         String configId = configIds.get((new Random().nextInt(3)));
 
+        // 1. Create PrebidAdUnit with configId
         prebidAdUnit = new PrebidAdUnit(configId);
 
+        // 2. Create PrebidRequest with needed multiformat parameters
         PrebidRequest prebidRequest = new PrebidRequest();
         prebidRequest.setBannerParameters(new BannerParameters());
         prebidRequest.setVideoParameters(new VideoParameters(Lists.newArrayList("video/mp4")));
         prebidRequest.setNativeParameters(creativeNativeParameters());
 
+        // 3. Make a bid request to Prebid Server
         AdManagerAdRequest gamRequest = new AdManagerAdRequest.Builder().build();
         prebidAdUnit.fetchDemand(gamRequest, prebidRequest, bidInfo -> {
             loadGam(gamRequest);
         });
     }
 
     private void loadGam(AdManagerAdRequest gamRequest) {
+        // 4. Load GAM ad
         OnAdManagerAdViewLoadedListener onBannerLoaded = adManagerAdView -> showBannerAd(adManagerAdView);
 
         NativeAd.OnNativeAdLoadedListener onNativeLoaded = nativeAd -> showNativeAd(nativeAd, getAdWrapperView());
@@ -101,8 +106,8 @@ private void loadGam(AdManagerAdRequest gamRequest) {
     }
 
     private void showBannerAd(AdManagerAdView adView) {
+        // 5.1. Show banner
         getAdWrapperView().addView(adView);
-
         AdViewUtils.findPrebidCreativeSize(adView, new AdViewUtils.PbFindSizeListener() {
 
             @Override
@@ -118,6 +123,7 @@ public void failure(@NonNull PbFindSizeError error) {
     }
 
     private void showNativeAd(NativeAd ad, ViewGroup adWrapperView) {
+        // 5.2. Show GAM native
         View nativeContainer = View.inflate(adWrapperView.getContext(), R.layout.layout_native, null);
 
         TextView title = nativeContainer.findViewById(R.id.tvTitle);
@@ -141,6 +147,7 @@ private void showNativeAd(NativeAd ad, ViewGroup adWrapperView) {
     }
 
     private void showPrebidNativeAd(NativeCustomFormatAd customNativeAd) {
+        // 5.3. Show Prebid native
         AdViewUtils.findNative(customNativeAd, new PrebidNativeAdListener() {
             @Override
             public void onPrebidNativeLoaded(PrebidNativeAd ad) {

diff --git a/...mo/activities/ads/gam/original/GamOriginalApiMultiformatBannerVideoNativeInAppActivity.kt b/...mo/activities/ads/gam/original/GamOriginalApiMultiformatBannerVideoNativeInAppActivity.kt
@@ -50,23 +50,27 @@ class GamOriginalApiMultiformatBannerVideoNativeInAppActivity : BaseAdActivity()
     }
 
     private fun createAd() {
-        // random() only for test cases, in production use only one config id
+        // Random only for test cases. For production use one config id.
         val configId = listOf(CONFIG_ID_BANNER, CONFIG_ID_VIDEO, CONFIG_ID_NATIVE).random()
 
+        // 1. Create PrebidAdUnit with configId
         prebidAdUnit = PrebidAdUnit(configId)
-        val prebidRequest = PrebidRequest()
 
+        // 2. Create PrebidRequest with needed multiformat parameters
+        val prebidRequest = PrebidRequest()
         prebidRequest.setBannerParameters(createBannerParameters())
         prebidRequest.setVideoParameters(createVideoParameters())
         prebidRequest.setNativeParameters(createNativeParameters())
 
+        // 3. Make a bid request to Prebid Server
         val gamRequest = AdManagerAdRequest.Builder().build()
         prebidAdUnit?.fetchDemand(gamRequest, prebidRequest) {
             loadGam(gamRequest)
         }
     }
 
     private fun loadGam(gamRequest: AdManagerAdRequest) {
+        // 4. Load GAM ad
         val onBannerLoaded = OnAdManagerAdViewLoadedListener { adView ->
             showBannerAd(adView)
         }
@@ -148,6 +152,7 @@ class GamOriginalApiMultiformatBannerVideoNativeInAppActivity : BaseAdActivity()
     }
 
     private fun showBannerAd(adView: AdManagerAdView) {
+        // 5.1. Show banner
         adWrapperView.addView(adView)
         AdViewUtils.findPrebidCreativeSize(adView, object : AdViewUtils.PbFindSizeListener {
             override fun success(width: Int, height: Int) {
@@ -159,6 +164,7 @@ class GamOriginalApiMultiformatBannerVideoNativeInAppActivity : BaseAdActivity()
     }
 
     private fun showNativeAd(ad: NativeAd, wrapper: ViewGroup) {
+        // 5.2. Show GAM native
         val nativeContainer = View.inflate(wrapper.context, R.layout.layout_native, null)
 
         val icon = nativeContainer.findViewById<ImageView>(R.id.imgIcon)
@@ -186,6 +192,7 @@ class GamOriginalApiMultiformatBannerVideoNativeInAppActivity : BaseAdActivity()
     }
 
     private fun showPrebidNativeAd(customNativeAd: NativeCustomFormatAd) {
+        // 5.3. Show Prebid native
         AdViewUtils.findNative(customNativeAd, object : PrebidNativeAdListener {
             override fun onPrebidNativeLoaded(ad: PrebidNativeAd) {
                 inflatePrebidNativeAd(ad)