From 1db84bc7db6ce655bef21d637de8f0ecb7e1efa0 Mon Sep 17 00:00:00 2001 From: Maksym Danylov Date: Thu, 3 Apr 2025 12:11:09 +0300 Subject: [PATCH 1/8] docs: new video params --- _includes/mobile/video-params.md | 32 ++++++++++++++++++++++++++++++-- 1 file changed, 30 insertions(+), 2 deletions(-) diff --git a/_includes/mobile/video-params.md b/_includes/mobile/video-params.md index d5f20a67aa..c9144ae5bd 100644 --- a/_includes/mobile/video-params.md +++ b/_includes/mobile/video-params.md @@ -15,7 +15,7 @@ The [OpenRTB 2.6](https://iabtechlab.com/wp-content/uploads/2022/04/OpenRTB-2-6_ - `5` or `Slider`, `Floating` or `Interstitial` : Open RTB supports one of three values for option 5 as either Slider, Floating or Interstitial. If an enum value is supplied in placement, bidders will receive value 5 for placement type and assume to be interstitial with the instl flag set to 1. Notes: -- `PrebidAdUnit`, `VideoInterstitialAdUnit` and `RewardedVideoAdUnit` will default to placement=5 if no placement value is supplied. +- `PrebidAdUnit` and `RewardedVideoAdUnit` will default to placement=5 if no placement value is supplied. {: .alert.alert-warning :} Starting from PrebidMobile `3.0.0` the class `VideoInterstitialAdUnit` is removed. @@ -31,7 +31,7 @@ The [OpenRTB v2.6-202303](https://github.com/InteractiveAdvertisingBureau/AdCOM/ - `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. Notes: -- `PrebidAdUnit`, `VideoInterstitialAdUnit` and `RewardedVideoAdUnit` will default to plcmnt=3 if no placement value is supplied. +- `PrebidAdUnit` and `RewardedVideoAdUnit` will default to plcmnt=3 if no placement value is supplied. {: .alert.alert-warning :} Starting from PrebidMobile `3.0.0` the class `VideoInterstitialAdUnit` is removed. @@ -99,3 +99,31 @@ Array of OpenRTB 2.6 playback methods. If none are specified, any method may be - `6` or `Signals.Protocols.VAST_3_0_Wrapper` : VAST 3.0 Wrapper - `7` or `Signals.Protocols.VAST_4_0` : VAST 4.0 - `8` or `Signals.Protocols.VAST_4_0_Wrapper` : VAST 4.0 Wrapper + +#### battr +{:.no_toc} + + Array or enum of OpenRTB 2.6 blocked creative attributes. Values can be one of: + +- `1` or `Signals.CreativeAttribute.AudioAd_Autoplay` : Audio Ad (Autoplay) +- `2` or `Signals.CreativeAttribute.AudioAd_UserInitiated` : Audio Ad (User Initiated) +- `3` or `Signals.CreativeAttribute.Expandable_Automatic` : Expandable (Automatic) +- `4` or `Signals.CreativeAttribute.Expandable_Click` : Expandable (User Initiated - Click) +- `5` or `Signals.CreativeAttribute.Expandable_Rollover` : Expandable (User Initiated - Rollover) +- `6` or `Signals.CreativeAttribute.InBanner_Autoplay` : In-Banner Video Ad (Autoplay) +- `7` or `Signals.CreativeAttribute.InBanner_UserInitiated` : In-Banner Video Ad (User Initiated) +- `8` or `Signals.CreativeAttribute.Pop` : Pop (e.g., Over, Under, or Upon Exit) +- `9` or `Signals.CreativeAttribute.Provocative` or `Signals.CreativeAttribute.SuggestiveImagery` : Provocative or Suggestive Imagery +- `10` or `Signals.CreativeAttribute.Shaky`, `Signals.CreativeAttribute.Flashing`, `Signals.CreativeAttribute.Flickering`, `Signals.CreativeAttribute.ExtremeAnimation` or `Signals.CreativeAttribute.Smileys` : Shaky, Flashing, Flickering, Extreme Animation, Smileys +- `11` or `Signals.CreativeAttribute.Surveys` : Surveys +- `12` or `Signals.CreativeAttribute.TextOnly` : Text Only +- `13` or `Signals.CreativeAttribute.UserInteractive` : User Interactive (e.g., Embedded Games) +- `14` or `Signals.CreativeAttribute.WindowsDialog` or `Signals.CreativeAttribute.AlertStyle` : Windows Dialog or Alert Style +- `15` or `Signals.CreativeAttribute.AudioButton` : Has Audio On/Off Button +- `16` or `Signals.CreativeAttribute.SkipButton` : Ad Provides Skip Button (e.g. VPAID-rendered skip button on pre-roll video) +- `17` or `Signals.CreativeAttribute.AdobeFlash` : Adobe Flash + +#### isSkippable +{:.no_toc} + +Boolean representing the OpenRTB 2.6 video ad skippability. \ No newline at end of file From 1dbd2359db4e6f112c5082ef15938fdcad2791a9 Mon Sep 17 00:00:00 2001 From: Maksym Danylov Date: Thu, 3 Apr 2025 12:11:45 +0300 Subject: [PATCH 2/8] docs: add info about global property 'auctionSettingsId'. --- .../android/code-integration-android.md | 10 ++++++++ .../pbm-api/android/pbm-targeting-android.md | 23 +++++++++++++++++++ .../pbm-api/ios/code-integration-ios.md | 5 ++++ .../pbm-api/ios/pbm-targeting-ios.md | 1 + 4 files changed, 39 insertions(+) diff --git a/prebid-mobile/pbm-api/android/code-integration-android.md b/prebid-mobile/pbm-api/android/code-integration-android.md index d186b90dab..55004dc8bb 100644 --- a/prebid-mobile/pbm-api/android/code-integration-android.md +++ b/prebid-mobile/pbm-api/android/code-integration-android.md @@ -323,6 +323,16 @@ To stop sending stored bid response signals use the following method: void clearStoredBidResponses() ``` +### AuctionSettingsId +{:.no_toc} + +String to separate out account from "auction settings". There is used to set `ext.prebid.storedrequest.id`, otherwise prebidServerAccountId is taken by default. + +```kotlin +PrebidMobile.setAuctionSettingsId(YOUR_AUCTION_SETTINGS_ID) +var auctionSettingsId = PrebidMobile.getAuctionSettingsId() +``` + ### Debug {:.no_toc} diff --git a/prebid-mobile/pbm-api/android/pbm-targeting-android.md b/prebid-mobile/pbm-api/android/pbm-targeting-android.md index 0a07eb9c02..5ff1c3105d 100755 --- a/prebid-mobile/pbm-api/android/pbm-targeting-android.md +++ b/prebid-mobile/pbm-api/android/pbm-targeting-android.md @@ -188,6 +188,29 @@ void clearStoredBidResponses() Parameters: none. +#### setAuctionSettingsId() + +For the SDK to separate out account from "auction settings". + +Signature: + +```kotlin +func setAuctionSettingsId(settingsId: String) +``` + +Parameters: + +{: .table .table-bordered .table-striped } +| Parameter | Scope | Type | Description | Example | +| --- | --- | --- | --- | --- | +| settingsId | optional | string | Use the settingsId to separate out account from "auction settings". If specified, the settingsId is used to set `ext.prebid.storedrequest.id`, otherwise prebidServerAccountId is taken by default. | "abc321" | + +Examples: + +```kotlin +PrebidMobile.setAuctionSettingsId("abc321") +``` + #### setLogLevel Controls the level of logging output to the console. diff --git a/prebid-mobile/pbm-api/ios/code-integration-ios.md b/prebid-mobile/pbm-api/ios/code-integration-ios.md index f73597f3e4..489a33386d 100644 --- a/prebid-mobile/pbm-api/ios/code-integration-ios.md +++ b/prebid-mobile/pbm-api/ios/code-integration-ios.md @@ -257,6 +257,8 @@ The `Prebid` class is a singleton that enables the user to apply global settings `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. +`auctionSettingsId`: String to separate out account from "auction settings". There is used to set `ext.prebid.storedrequest.id`, otherwise prebidServerAccountId is taken by default. + `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. `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 { // Account Id Prebid.shared.prebidServerAccountId = "1234" +// Auction Settings Id (Optional) +Prebid.shared.auctionSettingsId = "7890" + // Geolocation Prebid.shared.shareGeoLocation = true diff --git a/prebid-mobile/pbm-api/ios/pbm-targeting-ios.md b/prebid-mobile/pbm-api/ios/pbm-targeting-ios.md index 147ec5fabb..84ca4a1816 100644 --- a/prebid-mobile/pbm-api/ios/pbm-targeting-ios.md +++ b/prebid-mobile/pbm-api/ios/pbm-targeting-ios.md @@ -48,6 +48,7 @@ Prebid.shared.customStatusEndpoint="https://pbs.example.com/v2/status" | prebidServerAccountId | either | string | init | Your Prebid Server team will tell you whether this is required or not and if so, the value. | "abc123" | | prebidServerHost | optional | enum | init | Starting from PrebidMobile `3.0.0` the property is removedThis 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" | | 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``.example``.com/custom``/status` | +| auctionSettingsId | optional | string | init | For the SDK to separate out account from "auction settings". If specified, the auctionSettingsId is used to set `ext.prebid.storedrequest.id`, otherwise prebidServerAccountId is populated by default. | "abc321" | | 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` | | locationUpdatesEnabled | optional | boolean | ORTB | If true, the SDK will periodically try to listen for location updates. Default is `false`. | `true` | | 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` | From 520bdcaf8f06da16ac15be8897525bebaaa6d440 Mon Sep 17 00:00:00 2001 From: Maksym Danylov <146753616+mdanylov-sigma@users.noreply.github.com> Date: Thu, 10 Apr 2025 19:31:49 +0300 Subject: [PATCH 3/8] docs: wordsmithing Co-authored-by: bretg --- prebid-mobile/pbm-api/android/code-integration-android.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/prebid-mobile/pbm-api/android/code-integration-android.md b/prebid-mobile/pbm-api/android/code-integration-android.md index 55004dc8bb..fde3731100 100644 --- a/prebid-mobile/pbm-api/android/code-integration-android.md +++ b/prebid-mobile/pbm-api/android/code-integration-android.md @@ -326,7 +326,7 @@ void clearStoredBidResponses() ### AuctionSettingsId {:.no_toc} -String to separate out account from "auction settings". There is used to set `ext.prebid.storedrequest.id`, otherwise prebidServerAccountId is taken by default. +String to separate out account from "auction settings". This is used to set `ext.prebid.storedrequest.id`, otherwise prebidServerAccountId is taken by default. ```kotlin PrebidMobile.setAuctionSettingsId(YOUR_AUCTION_SETTINGS_ID) From 64a54b70487582cb787ccf0b4191054febfd6a05 Mon Sep 17 00:00:00 2001 From: Maksym Danylov <146753616+mdanylov-sigma@users.noreply.github.com> Date: Thu, 10 Apr 2025 21:18:17 +0300 Subject: [PATCH 4/8] docs: improvements Co-authored-by: bretg --- prebid-mobile/pbm-api/android/code-integration-android.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/prebid-mobile/pbm-api/android/code-integration-android.md b/prebid-mobile/pbm-api/android/code-integration-android.md index fde3731100..911fc9e71b 100644 --- a/prebid-mobile/pbm-api/android/code-integration-android.md +++ b/prebid-mobile/pbm-api/android/code-integration-android.md @@ -326,7 +326,7 @@ void clearStoredBidResponses() ### AuctionSettingsId {:.no_toc} -String to separate out account from "auction settings". This is used to set `ext.prebid.storedrequest.id`, otherwise prebidServerAccountId is taken by default. +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. ```kotlin PrebidMobile.setAuctionSettingsId(YOUR_AUCTION_SETTINGS_ID) From ca8c287af2e16f0a831acea7b46605e77a3acc2d Mon Sep 17 00:00:00 2001 From: Maksym Danylov <146753616+mdanylov-sigma@users.noreply.github.com> Date: Thu, 10 Apr 2025 21:18:25 +0300 Subject: [PATCH 5/8] docs: improvements Co-authored-by: bretg --- prebid-mobile/pbm-api/android/pbm-targeting-android.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/prebid-mobile/pbm-api/android/pbm-targeting-android.md b/prebid-mobile/pbm-api/android/pbm-targeting-android.md index 5ff1c3105d..9ecf41c3d4 100755 --- a/prebid-mobile/pbm-api/android/pbm-targeting-android.md +++ b/prebid-mobile/pbm-api/android/pbm-targeting-android.md @@ -203,7 +203,7 @@ Parameters: {: .table .table-bordered .table-striped } | Parameter | Scope | Type | Description | Example | | --- | --- | --- | --- | --- | -| settingsId | optional | string | Use the settingsId to separate out account from "auction settings". If specified, the settingsId is used to set `ext.prebid.storedrequest.id`, otherwise prebidServerAccountId is taken by default. | "abc321" | +| 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" | Examples: From 4b612a40a649e598ce7c2141565ecb2adbeeec2d Mon Sep 17 00:00:00 2001 From: Maksym Danylov <146753616+mdanylov-sigma@users.noreply.github.com> Date: Thu, 10 Apr 2025 21:18:32 +0300 Subject: [PATCH 6/8] docs: improvements Co-authored-by: bretg --- prebid-mobile/pbm-api/ios/pbm-targeting-ios.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/prebid-mobile/pbm-api/ios/pbm-targeting-ios.md b/prebid-mobile/pbm-api/ios/pbm-targeting-ios.md index 84ca4a1816..09133e285b 100644 --- a/prebid-mobile/pbm-api/ios/pbm-targeting-ios.md +++ b/prebid-mobile/pbm-api/ios/pbm-targeting-ios.md @@ -48,7 +48,7 @@ Prebid.shared.customStatusEndpoint="https://pbs.example.com/v2/status" | prebidServerAccountId | either | string | init | Your Prebid Server team will tell you whether this is required or not and if so, the value. | "abc123" | | prebidServerHost | optional | enum | init | Starting from PrebidMobile `3.0.0` the property is removedThis 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" | | 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``.example``.com/custom``/status` | -| auctionSettingsId | optional | string | init | For the SDK to separate out account from "auction settings". If specified, the auctionSettingsId is used to set `ext.prebid.storedrequest.id`, otherwise prebidServerAccountId is populated by default. | "abc321" | +| 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" | | 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` | | locationUpdatesEnabled | optional | boolean | ORTB | If true, the SDK will periodically try to listen for location updates. Default is `false`. | `true` | | 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` | From 3c0b5c23fc31de716c253ae6eb2d19ca0d36bc06 Mon Sep 17 00:00:00 2001 From: Maksym Danylov <146753616+mdanylov-sigma@users.noreply.github.com> Date: Thu, 10 Apr 2025 21:18:38 +0300 Subject: [PATCH 7/8] docs: improvements Co-authored-by: bretg --- prebid-mobile/pbm-api/ios/code-integration-ios.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/prebid-mobile/pbm-api/ios/code-integration-ios.md b/prebid-mobile/pbm-api/ios/code-integration-ios.md index 489a33386d..77bfb60169 100644 --- a/prebid-mobile/pbm-api/ios/code-integration-ios.md +++ b/prebid-mobile/pbm-api/ios/code-integration-ios.md @@ -257,7 +257,7 @@ The `Prebid` class is a singleton that enables the user to apply global settings `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. -`auctionSettingsId`: String to separate out account from "auction settings". There is used to set `ext.prebid.storedrequest.id`, otherwise prebidServerAccountId is taken by default. +`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. `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. From 2638ed0bcb021cf33f2bafe17250cac38e796f60 Mon Sep 17 00:00:00 2001 From: Maksym Danylov Date: Thu, 10 Apr 2025 21:20:11 +0300 Subject: [PATCH 8/8] docs: fix typo --- _includes/mobile/video-params.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/_includes/mobile/video-params.md b/_includes/mobile/video-params.md index c9144ae5bd..80bd0e7cbb 100644 --- a/_includes/mobile/video-params.md +++ b/_includes/mobile/video-params.md @@ -15,12 +15,13 @@ The [OpenRTB 2.6](https://iabtechlab.com/wp-content/uploads/2022/04/OpenRTB-2-6_ - `5` or `Slider`, `Floating` or `Interstitial` : Open RTB supports one of three values for option 5 as either Slider, Floating or Interstitial. If an enum value is supplied in placement, bidders will receive value 5 for placement type and assume to be interstitial with the instl flag set to 1. Notes: -- `PrebidAdUnit` and `RewardedVideoAdUnit` will default to placement=5 if no placement value is supplied. +- `PrebidAdUnit`, `VideoInterstitialAdUnit` and `RewardedVideoAdUnit` will default to placement=5 if no placement value is supplied. {: .alert.alert-warning :} Starting from PrebidMobile `3.0.0` the class `VideoInterstitialAdUnit` is removed. -#### plcmnt +#### plcmt + {:.no_toc} 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/ - `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. Notes: -- `PrebidAdUnit` and `RewardedVideoAdUnit` will default to plcmnt=3 if no placement value is supplied. +- `PrebidAdUnit`, `VideoInterstitialAdUnit` and `RewardedVideoAdUnit` will default to plcmt=3 if no placement value is supplied. {: .alert.alert-warning :} Starting from PrebidMobile `3.0.0` the class `VideoInterstitialAdUnit` is removed.