Release notes for the IMA HTML5 SDK

[Bret McGowen‏]

Hi all,

We'll post in this thread every time a new version of the IMA HTML5 SDK is released. If you wish to receive these updates by e-mail, click the Topic Options arrow at the top of this thread and click E-mail updates to me.

The release notes will also be available at https://developers.google.com/interactive-media-ads/docs/sdks/html5/v3/history

If you have any questions regarding a particular release, please post a new topic in this forum and let us know that you are using the HTML5 version of the IMA SDK. If you're experiencing an error, please also include a link to a test page where we can see the issue.

Thanks,

IMA SDK Team

[Bret McGowen‏]

5/12/2014 - 3.1.51

• Fixed a bug that caused paused ads to resume automatically when the user locked the device.
  
• Updated the documentation for VAST timeout errors and specified the lengths of the timeouts.
  

[Shawn Busolits (IMA SDK Team)‏]

5/29/2014 - 3.1.53

The SDK core will now always be loaded from imasdk.googleapis.com

[Shawn Busolits (IMA SDK Team)‏]

6/9/2014 - 3.1.54

• If a user does not specify the preferred maximum bitrate, the default for cell phones is 500 kbit and the default for other devices, including desktop, is 1,000 kbit.
• Removed ImaSdkSettings.getCompetitiveExclusion().
• Exposed the minSuggestedDuration API on the Ad class.

[Bret McGowen‏]

6/11/2014 - 3.1.55

The GPT Console can now work if it is enabled with all officially recognized flags ('google_console', 'google_force_console', and 'googfc' for use on mobile devices). No need to set the parameter values (such as 'google_console=1').

[Shawn Busolits (IMA SDK Team)‏]

7/16/2014 - 3.1.58

Service release, no new features

[Shawn Busolits (IMA SDK Team)‏]

7/24/2014 - 3.1.59

Service release, no new features

[Shawn Busolits (IMA SDK Team)‏]

7/25/2014 - 3.1.60

Service release, no new features.

[Shawn Busolits (IMA SDK Team)‏]

8/5/2014 - 3.1.61

Service release, no new features.

[Bret McGowen‏]

8/14/2014 - 3.1.62

• We now recommend publishers always pass a custom video player when creating an AdDisplayContainer. Stay tuned for an upcoming guide on modifying your code.
• Publishers will no longer have to save and restore content player state on the CONTENT_PAUSE_REQUESTED and CONTENT_RESUME_REQUESTEDevents.

[Bret McGowen‏]

8/22/2014 - 3.1.63

• Added support for VPAID 2 JavaScript creatives.
  
• Added support for VAST 3 icons.
  
• Added the following new features for companion ads:
  
• Support for the "required" attribute in the VAST CompanionAds element.
• Support for the "adSlotID" attribute in the VAST Companion element.
• If multiple companions are returned in the VAST, the SDK will select the most appropriate companion ad for the given environment.
• Fixed the bug where ImaSdkSettings.setNumRedirects and ImaSdkSettings.getNumRedirects were inaccessible.
  
• Added the isCustomPlaybackUsed and isCustomClickTrackingUsed API methods.
  

[Shawn Busolits (IMA SDK Team)‏]

8/28/2014 - 3.1.64

• Service release, non new fetures

9/4/2014 - 3.1.65

• Makes the skip button more easily discoverable to screen reader users by turning it into a real button.

[Shawn Busolits (IMA SDK Team)‏]

9/11/2014 - 3.1.66

• Adds (1) the uiElements setting to AdsRenderingSettings and (2) the getUiElements API on the Ad.
  

[Shawn Busolits (IMA SDK Team)‏]

9/16/2014 - 3.1.67

• Service release, no new features

9/17/2014 - 3.1.68

• Adds the reportAdAutoPlayed setting to the AdsRequest.

[Bret McGowen‏]

9/18/2014 - 3.1.69

• The Learn more button will be displayed for mobile ads regardless of the length of the ad.
  

9/18/2014 - 3.1.70

• Changed reportAdAutoPlayed to setAdWillAutoPlay on the AdsRequest.
  

9/19/2014 - 3.1.71

[Bret McGowen‏]

10/2/2014 - 3.1.72

• We now recommend you always pass in your content video player as the custom playback element, as custom playback will only be used in certain environments.
  
• Custom click tracking elements are now only used in certain environments. Note: if you render your custom click tracking element over your video player, it will break the clickthrough and skip ability of rendered ads.
  
• For more information on these changes, see Upgrading to the New Custom Playback.
  

[Bret McGowen‏]

10/3/2014 - 3.1.73

• Enables custom click tracking for all mobile devices. This reverts a change introduced in the previous release (3.1.72), which enabled custom click tracking only for iPhone and pre-4.0 Android. This more limited custom click tracking will be added back into the SDK at a later date.
  

[Bret McGowen‏]

10/3/2014 - 3.1.74

[Bret McGowen‏]

10/9/2014 - 3.1.75

[Bret McGowen‏]

10/22/2014 - 3.1.77

Service release, no new features.

10/17/2014 - Due to issues with ad playback on mobile web, rolled back to 3.1.75.

10/16/2014 - 3.1.76

[Shawn Busolits (IMA SDK Team)‏]

10/29/2014 - 3.1.78

Service release, no new features.

[Shawn Busolits (IMA SDK Team)‏]

11/6/2014 - 3.1.79

Internet Explorer 11 is now supported in the IMA HTML5 SDK. See the announcement for more information.

[Shawn Busolits (IMA SDK Team)‏]

11/13/2014 - 3.1.80

Added getPlayerType, setPlayerType, getPlayerVersion, and setPlayerVersion to ImaSdkSettings to allow partner players to specify the player type and player version while integrating with the SDK.

[Shawn Busolits (IMA SDK Team)‏]

11/19/2014 - 3/1/81

Fixed a Freewheel tag issue with certain third party ad requests.

[Bret McGowen‏]

12/5/2014 - 3.1.82

[Bret McGowen‏]

1/20/2015 - 3.1.84

[Shawn Busolits (IMA SDK Team)‏]

1/28/2015 - 3.1.85

• Added AdEvent.Type.AD_METADATA.

2/4/2015 - 3.87.0

• Fixes a bug where clients not using the IMA UI were getting incorrect values from getAdSkippableState.
• Release versioning will now change from 3.1.X to 3.X.Y.

[Bret McGowen‏]

2/20/2015 - 3.90.2

[Shawn Busolits (IMA SDK Team)‏]

2/25/2015 - 3.91.0

• Fixes a VPAID related bug where the video player was firing a 'play' event to VPAID ads instead of the expected 'playing' event.
  

[Shawn Busolits (IMA SDK Team)‏]

3/5/2015 - 3.92.0

• Service release, no new features.

[Bret McGowen‏]

3/23/2014 - 3.93.1

• Adds setAdWillAutoPlay method on AdsRequest. This will let publishers specify if the ad will be played in response to a user action or if the ad will be auto played.
  

[Yury Pavlotsky (IMA SDK Team)‏]

4/2/2015 - 3.94.0

• The Skip button will be shown for skippable ads, even when custom click tracking is used.

[Shawn Busolits (IMA SDK Team)‏]

CORRECTION: 3.93.1 was released 3/23/2015, not 3/23/2014.

[Shawn Busolits (IMA SDK Team)‏]

4/9/2015 - 3.95.1

• Service release, no new features

[Shawn Busolits (IMA SDK Team)‏]

4/16/2015 - 3.96.1

• Service release, no new features.

[Yury Pavlotsky (IMA SDK Team)‏]

4/23/2015 - 3.97.0

• Fixes a bug where client.js fails to load due to incorrect protocol usage.
• Fixes a VPAID adapter bug where the adapter fails to load if it is loaded into the <head> section.

[Shawn Busolits (IMA SDK Team)‏]

4/30/2015 - 3.98.0

• Now allows for ima3.js to be loaded in a separate DOM or iframe from the video container as long as it's in the same origin.

[Shawn Busolits (IMA SDK Team)‏]

5/12/2015 - 3.99.4

• Fixed a VPAID adapter bug which caused skip button and ad clickthrough elements to occasionally be unclickable.
• TrueView ads will now properly return skippable state viaAdsManager.getAdSkippableState().

[Yury Pavlotsky (IMA SDK Team)‏]

5/14/2015 - 3.100.0

[Yury Pavlotsky (IMA SDK Team)‏]

5/27/2015 - 3.101.1

[Yury Pavlotsky (IMA SDK Team)‏]

6/4/2015 - 3.102.1

• TrueView ads will now have a "Learn more" button in the upper right. Clicking on the ad outside of this "Learn more" button will no longer take users to the advertiser's site.
• The Skip button for skippable ads will now be shown even when custom click tracking is used.
• Custom playback on Android 4.0+ will be disabled. Ads will still work, but will use an SDK-owned player instead of the user-provided player.

[Shawn Busolits (IMA SDK Team)‏]

6/17/2014 - 3.101.2

• TrueView ads will now have a "Learn more" button in the upper right. Clicking on the ad outside of this "Learn more" button will no longer take users to the advertiser's site.
• The Skip button for skippable ads will now be shown even when custom click tracking is used.

6/4/2015 - Rollback to 3.101.1

• Due to issues with Android playback, rolled back to 3.101.1

[Shawn Busolits (IMA SDK Team)‏]

6/26/2015 - 3.101.3

• Service release, no new features.

[Shawn Busolits (IMA SDK Team)‏]

7/13/2015 - 3.101.4

• Custom playback is disabled on 5% of Android 4.0+ devices. This number will ramp up to 100% over the course of future releases.

[Shawn Busolits (IMA SDK Team)‏]

7/23/2015 - 3.101.6

• Adds insecure iframe support for VPAID ads.

[Shawn Busolits (IMA SDK Team)‏]

7/25/2015 - 3.101.8

• Fixes issue of correlator values not updating for DFP tags of the format pubads.g.doubleclick.net/gampad/live/ads.

[Shawn Busolits (IMA SDK Team)‏]

8/3/2015 - 3.101.9

• Service release, no new features.

[Shawn Busolits (IMA SDK Team)‏]

8/6/2015 - 3.101.10

• Exposes AdsRequest.setAdWillAutoPlay.
  
• Adds AdError.ErrorCode.INVALID_ADX_EXTENSION.
  

[Yury Pavlotsky (IMA SDK Team)‏]

8/16/2015 - 3.101.12

[Yury Pavlotsky (IMA SDK Team)‏]

8/20/2015 - 3.101.14

[Shawn Busolits (IMA SDK Team)‏]

8/27/2015 - 3.101.17

• Makes Ad.getContentType() available after the LOADED event rather than the STARTED event. This provides earlier access to ad data.

[Yury Pavlotsky (IMA SDK Team)‏]

9/4/2015 - 3.101.21

[Shawn Busolits (IMA SDK Team)‏]

9/10/2015 - 3.101.22

• VPAID mode now defaults to ENABLED instead of DISABLED.

[Yury Pavlotsky (IMA SDK Team)‏]

9/18/2015 - 3.107.1

• Custom playback on Android 4.0+ has been disabled. Ads will still work, but will use an SDK-owned player instead of the user-provided player.
  

[Shawn Busolits (IMA SDK Team)‏]

9/23/2015 - 3.108.1

• Adds companion ad support for VPAID ads.

[Shawn Busolits (IMA SDK Team)‏]

10/7/2015 - 3.109.0

• Service release, no new features.

[Shawn Busolits (IMA SDK Team)‏]

10/21/2015 - 3.110.0

• Adds Ad.getTraffickingParameters andAd.getTraffickingParametersString.

[Yury Pavlotsky (IMA SDK Team)‏]

10/28/2015 - 3.111.0

• Adds AdEvent.LINEAR_CHANGED.
  
• Adds AdEvent.DURATION_CHANGE.
  
• Uses new UI on 1% of ad requests.
  

[Shawn Busolits (IMA SDK Team)‏]

11/5/2015 - 3.112.0

• Service release, no new features.

[Shawn Busolits (IMA SDK Team)‏]

11/12/2015 - 3.113.1

• Introduces AdsManager.discardAdBreak().

[Yury Pavlotsky (IMA SDK Team)‏]

12/3/2015 - 3.115.0

• Any non-linear AdSense or Ad Exchange ad greater than 90 pixels in height will now be rendered as a fullslot ad.
• The new fullslot ad takes up the entire content and contains a countdown timer and skip button. The playing of the content resumes after the ad closes, either from the timer or when the user skips the ad.
• Non-linear AdSense or Ad Exchange ads with heights less than 90px can also be forced to render fullslot by settingadsRequest.forceNonLinearFullSlot=true.

[Shawn Busolits (IMA SDK Team)‏]

12/10/2015 - 3.116.4

• Mobile ads that don't use custom click tracking will now feature a new UI with a "Learn More" button. Clicking on the ad will now pause or resume it instead of directing the user to the ad's landing page.

[Shawn Busolits (IMA SDK Team)‏]

1/11/2016 - 3.117.1

• Service release, no new features.

[Shawn Busolits (IMA SDK Team)‏]

1/13/2016 - 3.118.0

• Service release, no new features.

[Yury Pavlotsky (IMA SDK Team)‏]

Correction:

1/13/2016 - 3.118.0

• VPAID Flash creatives are now supported in IMA HTML5.

[Yury Pavlotsky (IMA SDK Team)‏]

1/14/2016 - 3.118.1

• Service release, no new features.

[Shawn Busolits (IMA SDK Team)‏]

1/29/2015 - 3.120.0

• Adds the videoElement parameter to AdsManager.init. This can be used to specify the custom video element to be used if it's not ready when theAdDisplayContainer constructor is called. The AdDisplayContainerconstructor is still the preferred way of providing a custom video element.
• Adds AdsRenderingSettings.useStyledLinearAds.

[Yury Pavlotsky (IMA SDK Team)‏]

2/16/2016 - 3.121.1

[Yury Pavlotsky (IMA SDK Team)‏]

2/19/2016 - 3.122.0

[Shawn Busolits (IMA SDK Team)‏]

4/19/2016 - 3.127.2

• Service release, no new features.

[Shawn Busolits (IMA SDK Team)‏]

5/3/2016 - 3.128.2

• Adds AdsRenderingSettings.playAdsAfterTime.

[Yury Pavlotsky (IMA SDK Team)‏]

5/172016 - 3.130.0

• Service release, no new features.

[Shawn Busolits (IMA SDK Team)‏]

6/7/2016 - 3.133.0

• Fixes a visual glitch with skip buttons on Android 4.4.4. Skip buttons on other platforms were not affected by this glitch and are not affected by this change.

[Yury Pavlotsky (IMA SDK Team)‏]

6/16/2016 - 3.134.0

• Fixes an issue where the skip ad button would sometimes dissapear if the countdown timer was clicked.
  

[Shawn Busolits (IMA SDK Team)‏]

6/28/2016 - 3.135.1

• Adds support for media asset preloading via AdsRenderingSettings.enablePreloading.

[Shawn Busolits (IMA SDK Team)‏]

7/18/2016 - 3.136.0

• Service release, no new features.

[Shawn Busolits (IMA SDK Team)‏]

7/26/2016 - 3.137.0

• Adds Ad.getVastMediaWidth() and Ad.getVastMediaHeight().
  
• Fixes cursor stylng in built-in ad UI.
  

[Shawn Busolits (IMA SDK Team)‏]

8/2/16 - 3.138.3

• Service release, no new features

[Yury Pavlotsky (IMA SDK Team)‏]

8/4/2016 - 3.138.5

• Service release, no new features.

[Yury Pavlotsky (IMA SDK Team)‏]

8/10/2016 - 3.139.0

• Removes AdsRenderingSettings.AUTO_SCALE.

[Yury Pavlotsky (IMA SDK Team)‏]

8/18/2016 - 3.140.1

• Fixes a click-through issue for insecure Flash VPAID ads.
  

[Shawn Busolits (IMA SDK Team)‏]

8/26/2016 - 3.141.2

• Service release, no new features.
  

[Shawn Busolits (IMA SDK Team)‏]

9/1/2016 - 3.142.0

• Service release, no new features.

[Yury Pavlotsky (IMA SDK Team)‏]

9/13/2016 - 3.144.0

• Adds AdError.ErrorCode.VAST_PROBLEM_DISPLAYING_MEDIA_FILE.
  

9/7/2016 - 3.143.1

• Service release, no new features.

[Shawn Busolits (IMA SDK Team)‏]

9/22/2016 - 3.145.0

• Adds Ad.getApiFramework().
  

[Shawn Busolits (IMA SDK Team)‏]

10/10/2016 - 3.146.2

• Fixes a bug where specific Flash VPAID ads were being terminated prematurely.
  
• Fixes an issue where Flash VPAID ads were cropped in fullscreen mode.
  

[Yury Pavlotsky (IMA SDK Team)‏]

10/14/2016 - 3.147.1

• Adds Ad.getCreativeId().

[Yury Pavlotsky (IMA SDK Team)‏]

10/20/2016 - 3.148.1

• Service release, no new features.

[Yury Pavlotsky (IMA SDK Team)‏]

10/25/2016 - 3.149.0

• Service release, no new features.

[Shawn Busolits (IMA SDK Team)‏]

11/7/2016 - 3.150.1

• Service release, no new features.

[Yury Pavlotsky (IMA SDK Team)‏]

11/10/2016 - 3.151.1

• Adds Ad.getAdvertiserName.
• Fixes an issue with Flash VPAIDs in HTML5.

[Shawn Busolits (IMA SDK Team)‏]

12/6/2016 - 3.153.1

• Adds Ad.getDealId().
• Adds Ad.getSurveyUrl().
• Adds Ad.getWrapperCreativeIds().
• Adds icon support to Flash and HTML5 VPAID ads in ENABLED mode. Icons will not work in INSECURE mode.

[Yury Pavlotsky (IMA SDK Team)‏]

12/8/2016 - 3.153.3

• Service release, no new features.

[Shawn Busolits (IMA SDK Team)‏]

1/10/16 - 3.154.1

• Ad.getWrapperCreativeIds() is now more robust in matching creatives through wrappers.
  

[Yury Pavlotsky (IMA SDK Team)‏]

1/19/2017

• Service release, no new features.

[Shawn Busolits (IMA SDK Team)‏]

1/26/17 - 3.156.0

• Fixes incorrect ad position reporting with mixed VPAID pods.
• Adds ImaSdkSettings.(set|get)DisableFlashAds().
• Adds 'application/dash+xml' as a valid mime type.
• Adds the following methods to Ad:
  • getUniversalAdIdValue()
  • getUniversalAdIdRegistry()
• Adds the following properties to AdsRequest:
  • contentDuration
  • contentKeywords
  • contentTitle

[Yury Pavlotsky (IMA SDK Team)‏]

2/2/2017 - 3.157.2

• Service release, no new features.

[Shawn Busolits (IMA SDK Team)‏]

2/6/2017 - 3.157.4

• Service release, no new features.

[Shawn Busolits (IMA SDK Team)‏]

2/9/2017 - 3.158.0

• Service release, no new features.