Mobile: Add section about ad position configuration (#5751)

* Add section about ad position * Add rendering-adunit-config-android.md
prebid · Dec 20, 2024 · 0f74f8b · 0f74f8b
1 parent 8967858
commit 0f74f8b
Show file tree

Hide file tree

Showing 12 changed files with 64 additions and 2 deletions.
diff --git a/_includes/mobile/adunit-config-android.md b/_includes/mobile/adunit-config-android.md
@@ -33,3 +33,13 @@ Using the following method, you can set the impression-level [GPID](https://docs
 ``` kotlin
 adUnit?.gpid = "/36117602/hnp-sfgate.com/Homepage/AP300"
 ```
+
+### Ad Position
+
+The `adPosition` property allows developers to specify the position of the ad within the publisher's content. This property maps to the `pos` field in the OpenRTB specification under the `imp[].banner` or `imp[].video` objects, depending on the ad format. The possible values for this field could be found in the [respective specification](https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/main/AdCOM%20v1.0%20FINAL.md#list--placement-positions-).
+
+You can set `adPosition` by using the following method: 
+
+```kotlin
+adUnit.setAdPosition(AdPosition.FOOTER);
+```
diff --git a/_includes/mobile/adunit-config-ios.md b/_includes/mobile/adunit-config-ios.md
@@ -29,3 +29,13 @@ Using the following method, you can set the impression-level [GPID](https://docs
 ``` swift
 adUnit.setGPID("/36117602/hnp-sfgate.com/Homepage/AP300")
 ```
+
+### Ad Position
+
+The `adPosition` property allows developers to specify the position of the ad within the publisher's content. This property maps to the `pos` field in the OpenRTB specification under the `imp[].banner` or `imp[].video` objects, depending on the ad format. The possible values for this field could be found in the [respective specification](https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/main/AdCOM%20v1.0%20FINAL.md#list--placement-positions-).
+
+You can set `adPosition` by using the following property: 
+
+```swift
+adUnit.adPosition = .footer
+```
diff --git a/_includes/mobile/rendering-adunit-config-android.md b/_includes/mobile/rendering-adunit-config-android.md
@@ -0,0 +1,9 @@
+### Ad Position
+
+The `adPosition` property allows developers to specify the position of the ad within the publisher's content. This property maps to the `pos` field in the OpenRTB specification under the `imp[].banner` or `imp[].video` objects, depending on the ad format. The possible values for this field could be found in the [respective specification](https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/main/AdCOM%20v1.0%20FINAL.md#list--placement-positions-).
+
+You can set `adPosition` by using the following method: 
+
+```kotlin
+adUnit.setAdPosition(AdPosition.FOOTER);
+```
diff --git a/_includes/mobile/rendering-adunit-config-ios.md b/_includes/mobile/rendering-adunit-config-ios.md
@@ -0,0 +1,9 @@
+### Ad Position
+
+The `adPosition` property allows developers to specify the position of the ad within the publisher's content. This property maps to the `pos` field in the OpenRTB specification under the `imp[].banner` or `imp[].video` objects, depending on the ad format. The possible values for this field could be found in the [respective specification](https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/main/AdCOM%20v1.0%20FINAL.md#list--placement-positions-).
+
+You can set `adPosition` by using the following property: 
+
+```swift
+adUnit.adPosition = .footer
+```
diff --git a/prebid-mobile/modules/rendering/android-sdk-integration-admob.md b/prebid-mobile/modules/rendering/android-sdk-integration-admob.md
@@ -389,6 +389,10 @@ The `fetchDemand` method makes a bid request to the prebid server and provides a
 
 Now load an native ad from AdMob according to the [AdMob instructions](https://developers.google.com/admob/android/native/start). Everything else will be handled by GMA SDK and prebid adapters.
 
+## Additional Ad Unit Configuration
+
+{% include mobile/rendering-adunit-config-android.md %}
+
 ## Further Reading
 
 - [Prebid Mobile Overview](/prebid-mobile/prebid-mobile.html)

diff --git a/prebid-mobile/modules/rendering/android-sdk-integration-gam.md b/prebid-mobile/modules/rendering/android-sdk-integration-gam.md
@@ -310,7 +310,7 @@ Integration:
 
 ## Additional Ad Unit Configuration
 
-{% include mobile/adunit-config-android.md %}
+{% include mobile/rendering-adunit-config-android.md %}
 
 ## Further Reading
 

diff --git a/prebid-mobile/modules/rendering/android-sdk-integration-max.md b/prebid-mobile/modules/rendering/android-sdk-integration-max.md
@@ -330,6 +330,10 @@ The `fetchDemand` method makes a bid request to prebid server and provides a res
 
 Now just load a native ad from MAX according to the [MAX instructions](https://dash.applovin.com/documentation/mediation/android/getting-started/native-manual#load-the-native-ad). 
 
+## Additional Ad Unit Configuration
+
+{% include mobile/rendering-adunit-config-android.md %}
+
 ## Further Reading
 
 - [Prebid Mobile Overview](/prebid-mobile/prebid-mobile.html)

diff --git a/prebid-mobile/modules/rendering/android-sdk-integration-pb.md b/prebid-mobile/modules/rendering/android-sdk-integration-pb.md
@@ -238,6 +238,10 @@ override fun onAdLoaded(rewardedAdUnit: RewardedAdUnit) {
 }
 ```
 
+## Additional Ad Unit Configuration
+
+{% include mobile/rendering-adunit-config-android.md %}
+
 ## Further Reading
 
 - [Prebid Mobile Overview](/prebid-mobile/prebid-mobile)

diff --git a/prebid-mobile/modules/rendering/ios-sdk-integration-admob.md b/prebid-mobile/modules/rendering/ios-sdk-integration-admob.md
@@ -350,6 +350,10 @@ The `fetchDemand` method makes a bid request to Prebid server and provides a res
 
 Now just load a native ad from AdMob according to the [AdMob instructions](https://developers.google.com/admob/ios/native/start).
 
+## Additional Ad Unit Configuration
+
+{% include mobile/rendering-adunit-config-ios.md %}
+
 ## Further Reading
 
 - [Prebid Mobile Overview](/prebid-mobile/prebid-mobile)

diff --git a/prebid-mobile/modules/rendering/ios-sdk-integration-gam.md b/prebid-mobile/modules/rendering/ios-sdk-integration-gam.md
@@ -297,7 +297,7 @@ Integration:
 
 ## Additional Ad Unit Configuration
 
-{% include mobile/adunit-config-ios.md %}
+{% include mobile/rendering-adunit-config-ios.md %}
 
 ## Further Reading
 

diff --git a/prebid-mobile/modules/rendering/ios-sdk-integration-max.md b/prebid-mobile/modules/rendering/ios-sdk-integration-max.md
@@ -304,6 +304,10 @@ The `fetchDemand` method makes a bid request to Prebid Server and provides a res
 
 Load a native ad from MAX according to the [MAX instructions](https://dash.applovin.com/documentation/mediation/ios/getting-started/native-manual#load-the-native-ad). 
 
+## Additional Ad Unit Configuration
+
+{% include mobile/rendering-adunit-config-ios.md %}
+
 ## Further Reading
 
 - [Prebid Mobile Overview](/prebid-mobile/prebid-mobile)

diff --git a/prebid-mobile/modules/rendering/ios-sdk-integration-pb.md b/prebid-mobile/modules/rendering/ios-sdk-integration-pb.md
@@ -237,6 +237,10 @@ func rewardedAdDidReceiveAd(_ rewardedAd: RewardedAdUnit) {
 }
 ```
 
+## Additional Ad Unit Configuration
+
+{% include mobile/rendering-adunit-config-ios.md %}
+
 ## Further Reading
 
 - [Prebid Mobile Overview](/prebid-mobile/prebid-mobile)