PBSDK 1.6: video signals (#1981)

prebid-mobile/pbm-api/android/pbm-video-rewarded-adunit-android.md

@@ -32,6 +32,105 @@ RewardedVideoAdUnit("configId");
 
 `configId`: String; Prebid Server configuration ID.
 
+### Paramaters
+
+Parameters is a sub class of videoAdUnit.Create new Parameters class to define the parameters of the video ad unit. Parameters contain the OpenRTB video attributes.
+
+
+**Parameters**
+
+`placement: [int] or [enum]`: OpenRTB placement
+
+`api: [int] or [enum]`: OpenRTB api frameworks
+
+`maxBitrate: int`: OpenRTB maxBirate
+
+`minBitrate: int`: OpenRTB minBitrate
+
+`maxDuration:int`: OpenRTB maxDuration
+
+`minDuration: int`: OpenRTB minDuration
+
+`mimes: [string]`: OpenRTB mime types
+
+`playbackMethod: [int]`: OpenRTB playbackMethod
+
+`protocols: [int] or [enum]`: OpenRTB Protocols
+
+
+### placement
+
+[OpenRTB 2.5](https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf) Placement Type for the auction can be expressed as an integer array or can use an enum for easier readability. Option 1 (in-stream) is intentionally left out due to lack of in-stream support in Prebid SDK. 
+
+In the context of a VideoInterstitialAdUnit, rewarded video ads are typically labled as interstitial. As such, Prebid SDK will default to value 5 if no placement value is supplied.
+
+* `2` or `InBanner` : In-Banner placement exists within a web banner that leverages the banner space to deliver a video experience as opposed to another static or rich media format. The format relies on the existence of display ad inventory on the page for its delivery.
+* `3` or `InArticle` : In-Article placement loads and plays dynamically between paragraphs of editorial content; existing as a standalone branded message.
+* `4` or `InFeed` : In-Feed placement is found in content, social, or product feeds.
+* `5` or `Slider` or `Floating` or `Interstitial` : Open RTB supports one of three values for option 5 as eitehr Slider, Floating or Interstitial. If an enum value is supplied in placement, bidders will recieve value 5 for placement type and assume to be interstitial with the instl flag set to 1.
+
+
+#### api
+
+Array of integers or enum representing the supported OpenRTB Frameworks:
+
+* `1` or `Signals.Api.VPAID_1` : VPAID 1.0
+* `2` or `Signals.Api.VPAID_2` : VPAID 2.0
+* `3` or `Signals.Api.MRAID_1` : MRAID-1
+* `4` or `Signals.Api.ORMMA` : ORMMA
+* `5` or `Signals.Api.MARAID_2` : MRAID-2
+* `6` or `Signals.Api.MARAID_3` : MRAID-3
+
+
+#### maxBitrate
+
+Integer representing the [OpenRTB 2.5](https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf) maximum bit rate in Kbps. 
+
+
+#### minBitrate
+
+Integer representing the [OpenRTB 2.5](https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf) minimum bit rate in Kbps.
+
+
+#### maxDuration
+
+Integer representing the [OpenRTB 2.5](https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf) maximum video ad duration in seconds.
+
+
+#### minDuration
+
+Integer representing the [OpenRTB 2.5](https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf) minimum video ad duration in seconds.
+
+
+#### mimes
+
+Array of string representing the supported [OpenRTB 2.5](https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf) content MIME types (e.g., “video/x-ms-wmv”, “video/mp4”).
+
+
+#### playbackMethod
+
+Array of [OpenRTB 2.5](https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf) playback methods. If none are specified, any method may be used. Only one method is typically used in practice. It is strongly advised to use only the first element of the array.
+
+* `1` or `Signals.PlaybackMethod.AutoPlaySoundOn` : Initiates on Page Load with Sound On
+* `2` or `Signals.PlaybackMethod.AutoPlaySoundOff` : Initiates on Page Load with Sound Off by Default
+* `3` or `Signals.PlaybackMethod.ClickToPlay` : Initiates on Click with Sound On
+* `4` or `Signals.PlaybackMethod.MouseOver` : Initiates on Mouse-Over with Sound On
+* `5` or `Signals.PlaybackMethod.EnterSoundOn` : Initiates on Entering Viewport with Sound On
+* `6` or `Signals.PlaybackMethod.EnterSoundOff`: Initiates on Entering Viewport with Sound Off by Default
+
+
+#### protocols
+
+Array or enum of [OpenRTB 2.5](https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf) supported Protocols. Values can be one of: 
+
+* `1` or `Signals.Protocols.VAST_1_0` : VAST 1.0
+* `2` or `Signals.Protocols.VAST_2_0` : VAST 2.0
+* `3` or `Signals.Protocols.VAST_3_0` : VAST 3.0
+* `4` or `Signals.Protocols.VAST_1_0_Wrapper` : VAST 1.0 Wrapper
+* `5` or `Signals.Protocols.VAST_2_0_Wrapper` : VAST 2.0 Wrapper
+* `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
 
 
 ## Methods
@@ -47,6 +146,21 @@ RewardedVideoAdUnit("configId");
 ```java
 //setup PB RewardedVideo
 RewardedVideoAdUnit adUnit = new RewardedVideoAdUnit("configId");
+
+VideoAdUnit.Parameters parameters = new VideoAdUnit.Parameters();
+
+parameters.setPlacement(5);  // or alternative enum value Signals.Placement.Interstitial
+parameters.setApi(Arrays.asList(1,2));  // or alternative enum values [Signals.Api.VPAID_1, Signals.Api.VPAID_2]
+parameters.setMaxBitrate(1500);
+parameters.setMinBitrate(300);
+parameters.setMaxDuration(30);
+parameters.setMinDuration(5);
+parameters.setMimes(Arrays.asList("video/x-flv", "video/mp4"));
+parameters.setPlaybackMethod(1); // or alternative enum value (Signals.PlaybackMethod.AutoPlaySoundOn)
+parameters.setProtocols(Arrays.asList(2,3)); // or alternative enum values (Signals.Protocols.VAST_2_0, Signals.Protocols.VAST_3_0)
+
+adUnit.setParameters(parameters);
+
 //setup AM RewardedVideo
 RewardedAd amRewardedAd = new RewardedAd(this, "adUnitId");
 //load AM RewardedVideo
@@ -96,6 +210,22 @@ adUnit.fetchDemand(request, new OnCompleteListener() {
 ```java
 //setup PB RewardedVideo
 RewardedVideoAdUnit adUnit = new RewardedVideoAdUnit("configId");
+
+VideoAdUnit.Parameters parameters = new VideoAdUnit.Parameters();
+
+parameters.setPlacement(5);  // or alternative enum value Signals.Placement.Interstitial
+parameters.setApi(Arrays.asList(1,2));  // or alternative enum values [Signals.Api.VPAID_1, Signals.Api.VPAID_2]
+parameters.setMaxBitrate(1500);
+parameters.setMinBitrate(300);
+parameters.setMaxDuration(30);
+parameters.setMinDuration(5);
+parameters.setMimes(Arrays.asList("video/x-flv", "video/mp4"));
+parameters.setPlaybackMethod(1); // or alternative enum value (Signals.PlaybackMethod.AutoPlaySoundOn)
+parameters.setProtocols(Arrays.asList(2,3)); // or alternative enum values (Signals.Protocols.VAST_2_0, Signals.Protocols.VAST_3_0)
+
+adUnit.setParameters(parameters);
+
+
 //setup MP RewardedVideo
 SdkConfiguration sdkConfiguration = new SdkConfiguration.Builder("adUnitId").build();
 MoPub.initializeSdk(this, sdkConfiguration, null);

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

@@ -35,6 +35,105 @@ VideoInterstitialAdUnit("configId");
 `configId`: String; Prebid Server configuration ID.
 
 
+### Paramaters
+
+Parameters is a sub class of videoAdUnit.Create new Parameters class to define the parameters of the video ad unit. Parameters contain the OpenRTB video attributes.
+
+
+**Parameters**
+
+`placement: [int] or [enum]`: OpenRTB Placement
+
+`api: [int] or [enum]`: OpenRTB api frameworks
+
+`maxBitrate: int`: OpenRTB maxBirate
+
+`minBitrate: int`: OpenRTB minBitrate
+
+`maxDuration:int`: OpenRTB maxDuration
+
+`minDuration: int`: OpenRTB minDuration
+
+`mimes: [string]`: OpenRTB mime types
+
+`playbackMethod: [int]`: OpenRTB playbackMethod
+
+`protocols: [int] or [enum]`: OpenRTB Protocols
+
+
+#### placement
+
+[OpenRTB 2.5](https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf) Placement Type for the auction can be expressed as an integer array or can use an enum for easier readability. Option 1 (in-stream) is intentionally left out due to lack of in-stream support in Prebid SDK. 
+
+In the context of a VideoAdUnit, rewarded video ads are typically labled as interstitial. As such, Prebid SDK will default to value 5 if no placement value is supplied.
+
+* `2` or `InBanner` : In-Banner placement exists within a web banner that leverages the banner space to deliver a video experience as opposed to another static or rich media format. The format relies on the existence of display ad inventory on the page for its delivery.
+* `3` or `InArticle` : In-Article placement loads and plays dynamically between paragraphs of editorial content; existing as a standalone branded message.
+* `4` or `InFeed` : In-Feed placement is found in content, social, or product feeds.
+* `5` or `Slider` or `Floating` or `Interstitial` : Open RTB supports one of three values for option 5 as eitehr Slider, Floating or Interstitial. If an enum value is supplied in placement, bidders will recieve value 5 for placement type and assume to be interstitial with the instl flag set to 1.
+
+#### api
+
+Array of integers or enum representing the supported OpenRTB Frameworks:
+
+* `1` or `Signals.Api.VPAID_1` : VPAID 1.0
+* `2` or `Signals.Api.VPAID_2` : VPAID 2.0
+* `3` or `Signals.Api.MRAID_1` : MRAID-1
+* `4` or `Signals.Api.ORMMA` : ORMMA
+* `5` or `Signals.Api.MARAID_2` : MRAID-2
+* `6` or `Signals.Api.MARAID_3` : MRAID-3
+
+
+#### maxBitrate
+
+Integer representing the [OpenRTB 2.5](https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf) maximum bit rate in Kbps. 
+
+
+#### minBitrate
+
+Integer representing the [OpenRTB 2.5](https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf) minimum bit rate in Kbps.
+
+
+#### maxDuration
+
+Integer representing the [OpenRTB 2.5](https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf) maximum video ad duration in seconds.
+
+
+#### minDuration
+
+Integer representing the [OpenRTB 2.5](https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf) minimum video ad duration in seconds.
+
+
+#### mimes
+
+Array of string representing the supported [OpenRTB 2.5](https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf) content MIME types (e.g., “video/x-ms-wmv”, “video/mp4”).
+
+
+#### playbackMethod
+
+Array of [OpenRTB 2.5](https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf) playback methods. If none are specified, any method may be used. Only one method is typically used in practice. It is strongly advised to use only the first element of the array.
+
+* `1` or `Signals.PlaybackMethod.AutoPlaySoundOn` : Initiates on Page Load with Sound On
+* `2` or `Signals.PlaybackMethod.AutoPlaySoundOff` : Initiates on Page Load with Sound Off by Default
+* `3` or `Signals.PlaybackMethod.ClickToPlay` : Initiates on Click with Sound On
+* `4` or `Signals.PlaybackMethod.MouseOver` : Initiates on Mouse-Over with Sound On
+* `5` or `Signals.PlaybackMethod.EnterSoundOn` : Initiates on Entering Viewport with Sound On
+* `6` or `Signals.PlaybackMethod.EnterSoundOff`: Initiates on Entering Viewport with Sound Off by Default
+
+
+#### protocols
+
+Array or enum of [OpenRTB 2.5](https://www.iab.com/wp-content/uploads/2016/03/OpenRTB-API-Specification-Version-2-5-FINAL.pdf) supported Protocols. Values can be one of: 
+
+* `1` or `Signals.Protocols.VAST_1_0` : VAST 1.0
+* `2` or `Signals.Protocols.VAST_2_0` : VAST 2.0
+* `3` or `Signals.Protocols.VAST_3_0` : VAST 3.0
+* `4` or `Signals.Protocols.VAST_1_0_Wrapper` : VAST 1.0 Wrapper
+* `5` or `Signals.Protocols.VAST_2_0_Wrapper` : VAST 2.0 Wrapper
+* `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
+
 
 ## Methods
 
@@ -61,6 +160,20 @@ private void setupPBInterstitialVAST() {
    PrebidMobile.setPrebidServerAccountId("AccountID");
 
    adUnit = new VideoInterstitialAdUnit("configID");
+
+    VideoAdUnit.Parameters parameters = new VideoAdUnit.Parameters();
+
+    parameters.setPlacement(5);  // or alternative enum value Signals.Placement.Interstitial
+    parameters.setApi(Arrays.asList(1,2));  // or alternative enum values [Signals.Api.VPAID_1, Signals.Api.VPAID_2]
+    parameters.setMaxBitrate(1500);
+    parameters.setMinBitrate(300);
+    parameters.setMaxDuration(30);
+    parameters.setMinDuration(5);
+    parameters.setMimes(Arrays.asList("video/x-flv", "video/mp4"));
+    parameters.setPlaybackMethod(1); // or alternative enum value (Signals.PlaybackMethod.AutoPlaySoundOn)
+    parameters.setProtocols(Arrays.asList(2,3)); // or alternative enum values (Signals.Protocols.VAST_2_0, Signals.Protocols.VAST_3_0)
+
+    adUnit.setParameters(parameters);
 }
 
 private void setupAMInterstitialVAST() {