Skip to content

Commit d45b84e

Browse files
Additional mobile SDK video parameters, add auctionSettingsId (#5979)
* docs: new video params * docs: add info about global property 'auctionSettingsId'. * docs: wordsmithing Co-authored-by: bretg <bgorsline@gmail.com> * docs: improvements Co-authored-by: bretg <bgorsline@gmail.com> * docs: improvements Co-authored-by: bretg <bgorsline@gmail.com> * docs: improvements Co-authored-by: bretg <bgorsline@gmail.com> * docs: improvements Co-authored-by: bretg <bgorsline@gmail.com> * docs: fix typo --------- Co-authored-by: bretg <bgorsline@gmail.com>
1 parent d6216fc commit d45b84e

File tree

5 files changed

+70
-2
lines changed

5 files changed

+70
-2
lines changed

_includes/mobile/video-params.md

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@ Notes:
2020
{: .alert.alert-warning :}
2121
Starting from PrebidMobile `3.0.0` the class `VideoInterstitialAdUnit` is removed.
2222

23-
#### plcmnt
23+
#### plcmt
24+
2425
{:.no_toc}
2526

2627
The [OpenRTB v2.6-202303](https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/main/AdCOM%20v1.0%20FINAL.md#list--plcmt-subtypes---video-) Placement Type for the auction can be expressed as an integer or you can use an enum for easier readability.
@@ -31,7 +32,7 @@ The [OpenRTB v2.6-202303](https://github.com/InteractiveAdvertisingBureau/AdCOM/
3132
- `4` or `NoContent` or `Standalone` : Video ads that are played without streaming video content. This can be in placements like slideshows, native feeds, in-content or sticky/floating.
3233

3334
Notes:
34-
- `PrebidAdUnit`, `VideoInterstitialAdUnit` and `RewardedVideoAdUnit` will default to plcmnt=3 if no placement value is supplied.
35+
- `PrebidAdUnit`, `VideoInterstitialAdUnit` and `RewardedVideoAdUnit` will default to plcmt=3 if no placement value is supplied.
3536

3637
{: .alert.alert-warning :}
3738
Starting from PrebidMobile `3.0.0` the class `VideoInterstitialAdUnit` is removed.
@@ -99,3 +100,31 @@ Array of OpenRTB 2.6 playback methods. If none are specified, any method may be
99100
- `6` or `Signals.Protocols.VAST_3_0_Wrapper` : VAST 3.0 Wrapper
100101
- `7` or `Signals.Protocols.VAST_4_0` : VAST 4.0
101102
- `8` or `Signals.Protocols.VAST_4_0_Wrapper` : VAST 4.0 Wrapper
103+
104+
#### battr
105+
{:.no_toc}
106+
107+
Array or enum of OpenRTB 2.6 blocked creative attributes. Values can be one of:
108+
109+
- `1` or `Signals.CreativeAttribute.AudioAd_Autoplay` : Audio Ad (Autoplay)
110+
- `2` or `Signals.CreativeAttribute.AudioAd_UserInitiated` : Audio Ad (User Initiated)
111+
- `3` or `Signals.CreativeAttribute.Expandable_Automatic` : Expandable (Automatic)
112+
- `4` or `Signals.CreativeAttribute.Expandable_Click` : Expandable (User Initiated - Click)
113+
- `5` or `Signals.CreativeAttribute.Expandable_Rollover` : Expandable (User Initiated - Rollover)
114+
- `6` or `Signals.CreativeAttribute.InBanner_Autoplay` : In-Banner Video Ad (Autoplay)
115+
- `7` or `Signals.CreativeAttribute.InBanner_UserInitiated` : In-Banner Video Ad (User Initiated)
116+
- `8` or `Signals.CreativeAttribute.Pop` : Pop (e.g., Over, Under, or Upon Exit)
117+
- `9` or `Signals.CreativeAttribute.Provocative` or `Signals.CreativeAttribute.SuggestiveImagery` : Provocative or Suggestive Imagery
118+
- `10` or `Signals.CreativeAttribute.Shaky`, `Signals.CreativeAttribute.Flashing`, `Signals.CreativeAttribute.Flickering`, `Signals.CreativeAttribute.ExtremeAnimation` or `Signals.CreativeAttribute.Smileys` : Shaky, Flashing, Flickering, Extreme Animation, Smileys
119+
- `11` or `Signals.CreativeAttribute.Surveys` : Surveys
120+
- `12` or `Signals.CreativeAttribute.TextOnly` : Text Only
121+
- `13` or `Signals.CreativeAttribute.UserInteractive` : User Interactive (e.g., Embedded Games)
122+
- `14` or `Signals.CreativeAttribute.WindowsDialog` or `Signals.CreativeAttribute.AlertStyle` : Windows Dialog or Alert Style
123+
- `15` or `Signals.CreativeAttribute.AudioButton` : Has Audio On/Off Button
124+
- `16` or `Signals.CreativeAttribute.SkipButton` : Ad Provides Skip Button (e.g. VPAID-rendered skip button on pre-roll video)
125+
- `17` or `Signals.CreativeAttribute.AdobeFlash` : Adobe Flash
126+
127+
#### isSkippable
128+
{:.no_toc}
129+
130+
Boolean representing the OpenRTB 2.6 video ad skippability.

prebid-mobile/pbm-api/android/code-integration-android.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -323,6 +323,16 @@ To stop sending stored bid response signals use the following method:
323323
void clearStoredBidResponses()
324324
```
325325

326+
### AuctionSettingsId
327+
{:.no_toc}
328+
329+
Allows you to separate account from "auction settings". This is used to set `ext.prebid.storedrequest.id`, otherwise prebidServerAccountId is taken by default. This allows each app to have different global parameters like timeout, price granularity, etc. Please work with your Prebid Server provider to determine what to enter here.
330+
331+
```kotlin
332+
PrebidMobile.setAuctionSettingsId(YOUR_AUCTION_SETTINGS_ID)
333+
var auctionSettingsId = PrebidMobile.getAuctionSettingsId()
334+
```
335+
326336
### Debug
327337
{:.no_toc}
328338

prebid-mobile/pbm-api/android/pbm-targeting-android.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -188,6 +188,29 @@ void clearStoredBidResponses()
188188

189189
Parameters: none.
190190

191+
#### setAuctionSettingsId()
192+
193+
For the SDK to separate out account from "auction settings".
194+
195+
Signature:
196+
197+
```kotlin
198+
func setAuctionSettingsId(settingsId: String)
199+
```
200+
201+
Parameters:
202+
203+
{: .table .table-bordered .table-striped }
204+
| Parameter | Scope | Type | Description | Example |
205+
| --- | --- | --- | --- | --- |
206+
| settingsId | optional | string | Use the settingsId to separate account from "auction settings", allowing each app to have different global parameters defined on the server side. If specified, the settingsId is used to set `ext.prebid.storedrequest.id`, otherwise prebidServerAccountId is taken by default. | "abc321" |
207+
208+
Examples:
209+
210+
```kotlin
211+
PrebidMobile.setAuctionSettingsId("abc321")
212+
```
213+
191214
#### setLogLevel
192215

193216
Controls the level of logging output to the console.

prebid-mobile/pbm-api/ios/code-integration-ios.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -257,6 +257,8 @@ The `Prebid` class is a singleton that enables the user to apply global settings
257257

258258
`prebidServerHost`: String containing configuration your Prebid Server host with which Prebid SDK will communicate. Choose from the system-defined Prebid Server hosts or define your own custom Prebid Server host.
259259

260+
`auctionSettingsId`: Allows you to separate account from "auction settings". This is used to set `ext.prebid.storedrequest.id`, otherwise prebidServerAccountId is taken by default. This allows each app to have different global parameters like timeout, price granularity, etc. Please work with your Prebid Server provider to determine what to enter here.
261+
260262
`shareGeoLocation`: Optional Bool, if this flag is True AND the app collects the user’s geographical location data, Prebid Mobile will send the user’s geographical location data to Prebid Server. If this flag is False OR the app does not collect the user’s geographical location data, Prebid Mobile will not populate any user geographical location information in the call to Prebid Server. The default setting is false.
261263

262264
`logLevel`: Optional level of logging to output in the console. Options are one of the following sorted by a verbosity of the log:
@@ -378,6 +380,9 @@ do {
378380
// Account Id
379381
Prebid.shared.prebidServerAccountId = "1234"
380382

383+
// Auction Settings Id (Optional)
384+
Prebid.shared.auctionSettingsId = "7890"
385+
381386
// Geolocation
382387
Prebid.shared.shareGeoLocation = true
383388

prebid-mobile/pbm-api/ios/pbm-targeting-ios.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ Prebid.shared.customStatusEndpoint="https://pbs.example.com/v2/status"
4848
| prebidServerAccountId | either | string | init | Your Prebid Server team will tell you whether this is required or not and if so, the value. | "abc123" |
4949
| prebidServerHost | optional | enum | init | Starting from PrebidMobile `3.0.0` the property is removed<wbr>This can take the values "Appnexus", "Rubicon", or "Custom". If "Custom", you need to use the setCustomPrebidServerUrl() method to set a URL. This is where the Prebid SDK will send the auction information. Your Prebid Server team will tell you which value to use. The default is "Custom". | "Custom" |
5050
| customStatusEndpoint | optional | string | init | Use this URL to check the status of Prebid Server. The default status endpoint is the PBS URL appended with '/status'. | `https://prebidserver`<wbr>`.example`<wbr>`.com/custom`<wbr>`/status` |
51+
| auctionSettingsId | optional | string | init | For the SDK to separate account from "auction settings", allowing each app to have different global parameters defined on the server side. If specified, the auctionSettingsId is used to set `ext.prebid.storedrequest.id`, otherwise prebidServerAccountId is populated by default. | "abc321" |
5152
| shareGeoLocation | optional | boolean | ORTB | If this flag is true AND the app collects the user’s geographical location data, Prebid Mobile will send the user’s lat/long geographical location data to the Prebid Server. The default is false. | `true` |
5253
| locationUpdatesEnabled | optional | boolean | ORTB | If true, the SDK will periodically try to listen for location updates. Default is `false`. | `true` |
5354
| logLevel | optional | enum | SDK control | This property controls the level of logging output to the console. The value can be .error, .info, .debug, .verbose, .warn, .severe, and .info. The default is `.debug`. | `.error` |

0 commit comments

Comments
 (0)