Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prebid mobile release 2 0 #3732

Merged
merged 15 commits into from
May 3, 2022
Merged
56 changes: 24 additions & 32 deletions _data/sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -612,7 +612,7 @@
subgroup: 0

- sbSecId: 2
title: Rendering API (Open Beta)
title: Rendering API
link:
isHeader: 1
headerId: rendering
Expand Down Expand Up @@ -670,8 +670,8 @@
subgroup: 1

- sbSecId: 2
title: Integration with MoPub
link: /prebid-mobile/modules/rendering/ios-sdk-integration-mopub.html
title: Integration with AppLovin MAX
link: /prebid-mobile/modules/rendering/ios-sdk-integration-max.html
isHeader: 0
isSectionHeader: 0
sectionTitle:
Expand All @@ -684,6 +684,14 @@
isSectionHeader: 0
sectionTitle:
subgroup: 1

- sbSecId: 2
title: Customization Controls
link: /prebid-mobile/modules/rendering/ios-sdk-customization-controls.html
isHeader: 0
isSectionHeader: 0
sectionTitle:
subgroup: 1

- sbSecId: 2
title: "Android"
Expand Down Expand Up @@ -727,8 +735,8 @@
subgroup: 1

- sbSecId: 2
title: Integration with MoPub
link: /prebid-mobile/modules/rendering/android-sdk-integration-mopub.html
title: Integration with MAX
link: /prebid-mobile/modules/rendering/android-sdk-integration-max.html
isHeader: 0
isSectionHeader: 0
sectionTitle:
Expand All @@ -741,6 +749,14 @@
isSectionHeader: 0
sectionTitle:
subgroup: 1

- sbSecId: 2
title: Customization Controls
link: /prebid-mobile/modules/rendering/android-sdk-customization-controls.html
isHeader: 0
isSectionHeader: 0
sectionTitle:
subgroup: 1

- sbSecId: 2
title: "Ad Server"
Expand All @@ -766,10 +782,10 @@
isSectionHeader: 0
sectionTitle:
subgroup: 1

- sbSecId: 2
title: Rendering Order - MoPub
link: /prebid-mobile/modules/rendering/rendering-mopub-line-item-setup.html
title: Custom Network - MAX
link: /prebid-mobile/modules/rendering/rendering-max-line-item-setup.html
isHeader: 0
isSectionHeader: 0
sectionTitle:
Expand Down Expand Up @@ -1265,30 +1281,6 @@
sectionTitle:
subgroup: 0

- sbSecId: 3
title: Setup Line Items For MoPub
link: /prebid-mobile/adops-line-item-setup-mopub.html
isHeader: 0
isSectionHeader: 0
sectionTitle:
subgroup: 0

- sbSecId: 3
title: Setup Rewarded Video Line Items For MoPub
link: /prebid-mobile/adops-setup-rewarded-video-mopub.html
isHeader: 0
isSectionHeader: 0
sectionTitle:
subgroup: 0

- sbSecId: 3
title: Setup Full Screen Video Line Items For MoPub
link: /prebid-mobile/adops-setup-full-screen-video-mopub.html
isHeader: 0
isSectionHeader: 0
sectionTitle:
subgroup: 0

- sbSecId: 3
title: Setup Native Ads
link: /prebid-mobile/adops-native-setup.html
Expand Down
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
70 changes: 0 additions & 70 deletions prebid-mobile/adops-line-item-setup-mopub.md

This file was deleted.

57 changes: 0 additions & 57 deletions prebid-mobile/adops-setup-full-screen-video-mopub.md

This file was deleted.

55 changes: 0 additions & 55 deletions prebid-mobile/adops-setup-rewarded-video-mopub.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
---

layout: page_v2
title: Prebid Mobile Rendering Modules
description: Prebid Mobile Rendering Modules architecture
sidebarType: 2

---

# Customization Controls

Prebid SDK provides an API way to customize its behaviour.

> NOTE: In the nearest future the Server Side Configuration will be supported as well. Follow this [feature request](https://github.com/prebid/prebid-server/issues/2186) for the details.


## Rendering Controls

The following properties allow to customize the rendering of Video Interstitial Ads.

### Max Video Duration

The `maxVideoDuration` indicates the maximum available playback time in seconds.
If the value in the **Duration** tag is bigger than the given value SDK will fail to load ad, providing a respective error message.

### Application Muted

The `isMuted` property indicates whether the ad should run playback with sound or not.
Default value - **false**.

### Close Button Area

The `closeButtonArea` property indicates the percent of device screen which the close button should occupy. The possible values are from **0** to **1**.

### Close Button Possition

The `closeButtonPosition` property indicates the position of the close button on the screen. The possible values are **Position.BOTTOM_LEFT** and **Position.TOP_RIGHT**. The default value is **Position.TOP_RIGHT**.

### Skip Button Areaa

The `skipButtonArea` property indicates the percent of device screen which the skip button should occupy. The possible values are from **0** to **1**.

### Skip Button Possition

The `skipButtonPossition` property indicates the position of the close button on the screen. The possible values are **Position.BOTTOM_LEFT** and **Position.TOP_RIGHT**. The default value is **Position.BOTTOM_LEFT**.

### Skip Delay

The `skipDelay` property indicates the number of seconds which should be passed from the start of playback until the skip or close button should be shown. The default value is **10**.

The code sample:

``` kotlin
adUnit = MediationInterstitialAdUnit(
activity,
configId,
EnumSet.of(AdUnitFormat.DISPLAY),

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we can change DISPLAY to VIDEO here, DISPLAY with the rendering controls here is inapt.

mediationUtils
)

adUnit?.setMaxVideoDuration(30)
adUnit?.setCloseButtonArea(0.1)
adUnit?.setSkipDelay(5)
adUnit?.setSkipButtonArea(0.1)
adUnit?.setSkipButtonPosition(Position.TOP_RIGHT)
adUnit?.setCloseButtonPosition(Position.BOTTOM_LEFT)
```

16 changes: 8 additions & 8 deletions prebid-mobile/modules/rendering/android-sdk-integration-admob.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ They can be integrated using these mediation API categories:
To start running bid requests you should provide the Prebid Server URL and account ID:

```
PrebidRenderingSettings.setBidServerHost(HOST)
PrebidRenderingSettings.setAccountId(YOUR_ACCOUNT_ID)
PrebidMobile.setPrebidServerHost(HOST)
PrebidMobile.setPrebidServerAccountId(YOUR_ACCOUNT_ID)
```

The best place to do it is the `onCreate()` method of your Application class. The `account ID` is an identifier of the **Stored Request** on the prebid server.
Expand Down Expand Up @@ -190,15 +190,15 @@ The `AdMobInterstitialMediationUtils` is a helper class, wich performs certain u

The `MediationInterstitialAdUnit` is part of the prebid mediation API. This class is responsible for making a bid request and providing the winning bid and targeting keywords to mediating SDKs.

If you need to make a bid request for `video` ad - provide the respective ad format `AdUnitFormat.VIDEO` to the constructor of `MediationInterstitialAdUnit`:
In order to make a `multiformat bid request`, set the respective values into the `adUnitFormats` parameter.

```
adUnit = MediationInterstitialAdUnit(
activity,
configId,
AdUnitFormat.VIDEO,
mediationUtils
)
activity,
configId,
EnumSet.of(AdUnitFormat.DISPLAY, AdUnitFormat.VIDEO),
mediationUtils
)
```

#### Step 4: Make a bid request
Expand Down
Loading