Release notes for the IMA Android SDK

[Bret McGowen]

Hi all,

We'll post in this thread every time a new version of the IMA Android 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/android/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 Android 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

[Shawn Busolits (IMA SDK Team)]

5/27/2014 - Beta v7

Fixes an issue with Google Play Services. The SDK now requires that Google Play Services be built into your app. For more information, see Set Up Google Play Services SDK.

[Bret McGowen]

6/12/2014 - Beta v8

• Fixes an issue with the ad UI not clearing for skippable ads.
  
• Documents the error code for media file load timeouts.
  

[Bret McGowen]

10/17/2014 - Beta 9

• Adds the Ad APIs getTitle, getDescription, and getContentType.
  
• Adds information about ad pod position to the ad UI, for example, "Ad 1 of 4: (0:13)".
  
• You should no longer directly control the pause/play/resume of ads via your video player. Instead, use AdsManager.pause() and AdsManager.resume(). 
• Stay tuned for an upgrade guide for Beta 9 on the blog at http://googleadsdeveloper.blogspot.com. The guide will be also be linked from the IMA Android SDK release notes page.

[Shawn Busolits (IMA SDK Team)]

5/21/2015 - 3.b11.4

• Adds the following to the API:
• AdError.AdErrorCode.VAST_EMPTY_RESPONSE
• AdError.getErrorNumber()
• AdsRequest.setAdWillAutoPlay(Boolean)
• CompanionAdSlot.isFilled()
• ImaSdkSettings.setPlayerType(String)
• ImaSdkSettings.setPlayerVersion(String)

3/24/2015 - 3.b10.3

• Added ImaSdkSettings.getMaxRedirects and ImaSdkSettings.setMaxRedirects.
• IMA API classes are now final.
• SDK version numbers are now in the format 3.bX.Y with b to indicate the SDK's beta status.
• The following AdError.AdErrorCode values have been removed:
  • API_ERROR - instead use UNKNOWN_AD_RESPONSE.
  • PLAYLIST_MALFORMED_RESPONSE - instead use UNKNOWN_AD_RESPONSE.
  • REQUIRED_LISTENERS_NOT_ADDED - was not being raised by the SDK.
  • VAST_INVALID_URL - instead use VAST_LOAD_TIMEOUT.

[Shawn Busolits (IMA SDK Team)]

7/20/2015 - 3.b12.1

• Allows the user to customize ad UI elements via AdsRenderingSettings.setUiElements.
• Adds ability to play ad breaks manually instead of automatically. See Manual Ad Break Playback.
• Adds the restriction that ContentProgressProvider.getContentProgress should never return null.
• Adds AdEvent.TAPPED which will fire when the user taps on any non-clickable region of a video ad.

[Yury Pavlotsky (IMA SDK Team)]

9/10/2015 - 3.b13.3

• Service release, no new features.

[Yury Pavlotsky (IMA SDK Team)]

12/16/2015 - 3.1.3

• Out of beta.
• Adds AdsManager.discardAdBreak to the API.

[Yury Pavlotsky (IMA SDK Team)]

4/7/2016 - 3.2.1

[Shawn Busolits (IMA SDK Team)]

6/7/2016 - 3.3.3

• Adds AdsRenderingSetting.setPlayAdsAfterTime.

[Yury Pavlotsky (IMA SDK Team)]

7/11/2016 - 3.3.2

• Adds AD_BREAK_STARTED and AD_BREAK_ENDED events to AdEventListener.onAdEvent callback.

Correction: the previous release was 3.3.0, not 3.3.2.

[Yury Pavlotsky (IMA SDK Team)]

9/13/2016 - 3.4.0

• Fixes a duplicate files error when using Google Play Services version 9.0.0 and up.
  

[Yury Pavlotsky (IMA SDK Team)]

11/14/2016 - 3.5.2

• Adds an SDK-owned video player that optionally handles ad playback.
• Adds CompanionAdSlot.ClickListener and methods to add and remove a listener.
• Fixes an issue with invalid getViewability() error logs.
• Fixes an issue with icons' clickthrough behavior and not rendering correctly.

[Yury Pavlotsky (IMA SDK Team)]

3/24/2017 - 3.7.1

• Moves all classes in the jar to the com/google directory. Jar size reduced by around 30KB.
  
• SDK version 3.7.0 will be deprecated on 3/24/2018. See the Deprecation Schedule for more details.
  

[Yury Pavlotsky (IMA SDK Team)]

5/25/2017 - 3.7.2

• Adds setDebugMode to ImaSdkSettings.
• SDK version 3.7.1 will be deprecated on 5/25/2018. See the Deprecation Schedule for more details.

[Yury Pavlotsky (IMA SDK Team)]

6/29/2017 - 3.7.4

• Adds setVastLoadTimeout to AdsRequest.
• Adds getSkipTimeOffset to Ad.
• SDK version 3.7.2 will be deprecated on 6/29/2018. See the Deprecation Schedule for more details.

[Yury Pavlotsky (IMA SDK Team)]

1/24/2017 - 3.8.2

• Adds setLiveStreamPrefetchSeconds to AdsRequest.
• Various documentation fixes.
• SDK version 3.7.4 will be deprecated on 1/24/2019. See the Deprecation Schedule for more details.

[Yury Pavlotsky (IMA SDK Team)]

4/9/2018 - 3.8.5

• Fixes an issue with ImaSdkSettings being ignored.
• Fixes an issue where there were build conflicts with com.android.support version files.
• Adds setAdWillPlayMuted to AdsRequest.
• Adds setLoadVideoTimeout to AdsRenderingSettings.
• SDK version 3.8.2 will be deprecated on 4/9/2019. See the Deprecation Schedule for more details.
  

[Yury Pavlotsky (IMA SDK Team)]

4/23/2018 - 3.8.7

• Allows animation in HTML companion ads.
• SDK version 3.8.5 will be deprecated on 5/23/2019. See the Deprecation ScheduleDeprecation ScheduleDeprecation Schedule for more details.

[Yury Pavlotsky (IMA SDK Team)]

Correction: 3.8.7 was released on 5/23/2018

[Yury Pavlotsky (IMA SDK Team)]

7/9/2018 - 3.9.0

• Adds focusSkipButton() to AdsManager. This will only work on Android TV.
  
• Adds getFocusSkipButtonWhenAvailable() to AdsRenderingSettings, defaulting to true. This will only work on Android TV.
  
• Adds setFocusSkipButtonWhenAvailable() to AdsRenderingSettings. This will only work on Android TV.
  
• VideoAdPlayer now extends the VolumeProvider interface. Implementing this interface is now required for custom playback.
  
• SDK version 3.8.7 will be deprecated on 7/9/2019. See the Deprecation Schedule for more details.
  

[Yury Pavlotsky (IMA SDK Team)]

8/1/2018 - 3.9.4

• Adds getCompanionAds() to Ad. This retuns companion ads while using DAI only.
• Adds new CompanionAd class.
• Adds new SKIPPABLE_STATE_CHANGED event to AdEvent.
• Fixes an issue where the default setting for focusSkipButtonWhenAvailable wasn't being respected in some cases.
• SDK version 3.9.0 will be deprecated on 8/1/2019. See the Deprecation Schedule for more details.
  

[Yury Pavlotsky (IMA SDK Team)]

8/13/2018 - 3.10.2

• Fixes a race condition that causes the second ad in a pod to throw a VAST 402 error.
  
• Adds frequency capping and competitive exclusion to the DAI Android SDK.
  
• Moves getAdProgressInfo() from StreamManager to BaseManager.
  
• Adds getVastMediaHeight(), getVastMediaWidth() and getVastMediaBitrate() to Ad.
  
• SDK version 3.9.4 will be deprecated on 11/13/2019. See the Deprecation Schedule for more details.

[ima-sdk-fo...@google.com]

3.10.9

• Fixed a race condition bug where ad UI sometimes doesn't render on subsequent ads after the first ad is skipped.
• Fixed a crash that occurred when calling the getCompanionAds() API.

On 11/13/18 10:57:06 ima-sdk-ad...@google.com wrote:

8/13/2018 - 3.10.2

• Fixes a race condition that causes the second ad in a pod to throw a VAST 402 error.
  
• Adds frequency capping and competitive exclusion to the DAI Android SDK.
  
• Moves getAdProgressInfo() from StreamManager to BaseManager.
  
• Adds getVastMediaHeight(), getVastMediaWidth() and getVastMediaBitrate() to Ad.
  

--
You received this message because you are subscribed to the Google Groups "Interactive Media Ads SDK" group.
To unsubscribe from this group and stop receiving emails from it, send an email to ima-sdk+unsubscribe@googlegroups.com.
To post to this group, send email to ima...@googlegroups.com.
Visit this group at https://groups.google.com/group/ima-sdk.
For more options, visit https://groups.google.com/d/optout.

[ima-sdk-fo...@google.com]

3/22/2019 - 3.11.0

• Introduces support for the Open Measurement SDK for third-party viewability.

On 03/18/19 13:30:42 ima-sdk-fo...@google.com wrote:

3.10.9

• Fixed a race condition bug where ad UI sometimes doesn't render on subsequent ads after the first ad is skipped.
• Fixed a crash that occurred when calling the getCompanionAds() API.

[Greg Schoppe (IMA SDK Team)]

9/6/2019 - 3.13.1

• Adds the ability to set the continuous play context for an ads request. See thesetContinuousPlayback() for more details.
• Adds the getUniversalAdIds() method to the Ad class.
• Adds the setAuthToken, getAuthToken, setFormat, getFormat and the StreamFormat enum.
• Fixes an error in nexus 5 devices that occurs when a container is removed before receiving an ad response.
• Fixes an issue where companion ads would only render once.
• Fixes an issue where unsupported ad types (nonlinears, VPAID) were not failing gracefully.

[Jackson Sui (IMA SDK Team)]

9/12/2019 - 3.14.0

[Jackson Sui (IMA SDK Team)]

10/23/2019 - 3.16.0

• Adds the replaceAdTagParameters API to the StreamManager to update ad tag parameters during a live stream.
• Removes support of the following deprecated methods:
  • AdsRequest.getAdDisplayContainer()
  • AdsRequest.setAdDisplayContainer(AdDisplayContainer adDisplayContainer)
  • ImaSdkFactory.createAdsLoader(Context context)
  • ImaSdkFactory.createAdsLoader(Context context, ImaSdkSettings settings)
  • ImaSdkFactory.createLiveStreamRequest(String assetKey, String apiKey, StreamDisplayContainer streamDisplayContainer)
  • ImaSdkFactory.createVodStreamRequest(String contentSourceId, String videoId, String apiKey, StreamDisplayContainer streamDisplayContainer)
  • StreamRequest.getStreamDisplayContainer()

[Jackson Sui (IMA SDK Team)]

11/11/12019 - 3.16.1

• Adds a new method to the ImaSdkFactory for createAudioAdDisplayContainer.

[Jackson Sui (IMA SDK Team)]

11/5/2019 - 3.16.2

• Adds support for automatic inclusion of consent parameters from IAB TCFv2 and CCPA.
  
• Using Android preferences now requires the androidx package.
  

[Jackson Sui (IMA SDK Team)]

1/22/2020 - 3.16.5

• Reworks support for OMID 1.3 contentUrl with AdsRequest.setContentUrl and StreamRequest.setContentUrl .
  
• Reworks support for OMID 1.3 friendly obstructions with FriendlyObstruction .
  
• Deprecates the methods BaseDisplayContainer.registerVideoControlsOverlay and BaseDisplayContainer.unregisterAllVideoControlsOverlay in favor of FriendlyObstruction .
  
• Fixes an issue with a NullPointerException occurring after calling clear() on CompanionAdSlots.
  
• Fixes an issue that was potentially causing memory leaks when calling destroy() during ad playback.
  
• SDK version 3.16.5 will be deprecated on 1/22/2021. See the Deprecation Schedule for more details.
  

[Jackson Sui (IMA SDK Team)]

2/7/2020 - 3.17.0

• Adds the following APIs to move the validation of display containers to the time of their creation:
  
• createAdDisplayContainer(ViewGroup container, VideoAdPlayer player)
  
• createStreamDisplayContainer(ViewGroup container, VideoStreamPlayer player)

• createAudioAdDisplayContainer(Context context, VideoAdPlayer player)

• Adds the ImaSdkFactory.createSdkOwnedPlayer which should be used by those using IMAs built-in player (SdkOwnedPlayer). It should be manually constructed and passed into the constructor for AdDisplayContainer.
  
• Adds not null checks to setAdContainer and setPlayer.
  
• Updates cuepoint data to now use floating point precision.
  
• Deprecates the following methods:
• AdDisplayContainer.setPlayer(VideoAdPlayer player)
• BaseDisplayContainer.setAdContainer(ViewGroup container)
  
• BaseManager.isCustomPlaybackUsed()
  
• ImaSdkFactory.createAdDisplayContainer()
  
• ImaSdkFactory.createAudioAdDisplayContainer(Context context)
  
• ImaSdkFactory.createStreamDisplayContainer()
  
• StreamDisplayContainer.setVideoStreamPlayer(VideoStreamPlayer player)
  
• SDK version 3.17.0 will be deprecated on 2/7/2021. See the Deprecation Schedule for more details.
  

[Jackson Sui (IMA SDK Team)]

3/4/2020 - 3.18.0

• Adds pause() and resume() to the VideoStreamPlayer interface. These must be implemented for v3.18.0 and later.
  

[Jackson Sui (IMA SDK Team)]

5/12/2020 - 3.19.0

• Adds the VideoAdPlayerCallback.onLoaded() callback to VideoAdPlayer.
• Deprecates AdsLoader.contentComplete() in favor of VideoAdPlayerCallback.onContentComplete() and VideoStreamPlayerCallback.onContentComplete().

Note: v3.18.1 was released on 3/25/2020 but a post here was not made. Notes for 3.18.1 are as follows:

• Adds scaling for Companion Ads on high-pixel-density devices.
• Adds support for client-side SIMID ads.

[Jackson Sui (IMA SDK Team)]

6/22/2020 - 3.19.2

• Fixes an issue that caused the SDK to ignore VideoAdPlayerCallback.onContentComplete() events outside of ad playback.
• Adds the ability to specify different DAI subtitle sets for the same language by using the subtitle_name parameter for VideoStreamPlayer.loadUrl().

[Jackson Sui (IMA SDK Team)]

6/29/2020 - 3.19.3

• Fixes an issue with the IAB TCF integration for GDPR.

[Jackson Sui (IMA SDK Team)]

7/8/2020 - 3.19.4

• Fixes an issue that was preventing setLoadVideoTimeout from correctly updating the timeout.

[Jackson Sui (IMA SDK Team)]

8/18/2020 - 3.20.0

• Adds the onPause() and onResume() callbacks for the DAI VideoStreamPlayer class.
• Adds the adPeriodDuration() method to the AdProgressInfo class.
• Adds support for icon click fallback images on Android TV devices.
• Adds the ICON_FALLBACK_IMAGE_CLOSED event to handle when the icon fallback image is closed on Android TV devices.
• Removes the deprecated 'focusSkipButton()' method from AdsManager in favor of the focus() method.
• For CTV devices, ads are now auto focused when the 'AdEvent.AdEventType STARTED' event is fired. To disable auto focus for ads, use the adsRenderingSettings.setFocusSkipButtonWhenAvailable(false) method and then use the focus() method based on the custom requirements.
• Adds the getCurrentTimeMillis() and getDurationMillis methods to the 'VideoProgressUpdate()' class.
• Deprecates the 'getCurrentTime' and 'getDuration' methods in favor of the new 'getCurrentTimeMillis' and 'getDurationMillis' methods.

[Jackson Sui (IMA SDK Team)]

10/12/2020 - 3.20.1

• Fixes an issue with HTMLResource companions on API Level 29+ of Android. The change in Android API behavior is documented here.

[Jackson Sui (IMA SDK Team)]

11/17/2020 - 3.21.1

• Fixes an issue that occasionally led to app crashes when events were fired.

[Jackson Sui (IMA SDK Team)]

12/9/2020 - 3.21.4

• Removes a harmless warning message related to calling adsLoader.release() after the webview has been destroyed.

Late post for the 11/20 update:
11/20/2020 - 3.21.2

• Fixes unexpected thread-safe issues caused by sending message updates from an empty queue.
• Updates the documentation for AdsLoader.release().

[Jackson Sui (IMA SDK Team)]

1/11/2021 - 3.22.0

• Adds pod serving for DAI streams. In the pod serving workflow, Ads Manager is only responsible for serving ads. Publishers are responsible for content and creating the manifest that will then point to Ads Manager. Use ImaSdkFactory.createPodStreamRequest() to create a stream request for pod serving. If using this, you will be responsible for loading the stream on streamInit().
• Fixes a memory leak caused by the app lifecycle monitor not being properly cleaned up.

[Jackson Sui (IMA SDK Team)]

2/26/2021 - 3.22.2

• The IMA SDK now depends on the following libraries:
  • com.google.android.gms:play-services-base
  • com.google.android.gms:play-services-basement
  • androidx.preference:preference
• Fixes the error message when AdsLoader would receive an error without a valid session ID.

[Jackson Sui (IMA SDK Team)]

3/16/2021 - 3.22.3

• Fixes a NullPointerException error related to releasing the AdsLoader while an ad is being loaded.

[Jackson Sui (IMA SDK Team)]

4/7/2021 - 3.23.0

• Adds the ImaSdkSettings.setSessionId() and the ImaSdkSettings.getSessionId() methods to get and set the Session ID. This is a temporary random ID used exclusively for frequency capping.
• Fixes a NullPointerException error related to companion ads.
• Disables javascript within companion ads below API level 21 to fix an issue with security vulnerabilities.

[Jackson Sui (IMA SDK Team)]

6/3/2021 - 3.24.0

• Adds fixed-point precision APIs for the CuePoint and StreamManager classes used in DAI. This adds the following APIs:
  • CuePoint.getEndTimeMs()
  • CuePoint.getStartTimeMs()
  • StreamManager.getContentTimeMsForStreamTimeMs()
  • StreamManager.getPreviousCuePointForStreamTimeMs()
  • StreamManager.getStreamTimeMsForContentTimeMs()
  And deprecates the following APIs:
  • CuePoint.getEndTime()
  • CuePoint.getStartTime()
  • StreamManager.getContentTimeMsForStreamTime()
  • StreamManager.getPreviousCuePointForStreamTime()
  • StreamManager.getStreamTimeMsForContentTime()
• Prevents a NullPointerException error related to internal calls to StreamRequest.getContentUrl().

[Interactive Media Ads SDK]

11/08/2021 - 3.25.1

• Adds AdsRenderingSettings.setEnableCustomTabs() and AdsRenderingSettings.getEnableCustomTabs() for in-app click-through of ads using custom tabs.
• Starting from version 3.25.1, IMA SDK includes the com.google.android.gms.AD_ID permission in the SDK's manifest that is automatically merged into the app manifest by Android build tools. To learn more about the AD_ID permission declaration, including how to disable it, refer to this Play Console Help article.
• Adds performance improvements when using multiple AdsLoader instances by supporting thread caching and reuse.

[Jackson Sui (IMA SDK Team)]

1/12/2022 - 3.26.0

• Adds Encrypted Signals for Publishers (ESP) APIs to allow publishers to enable Network Bidders and IDPs.

[Interactive Media Ads SDK]

3/1/2022 - 3.27.0

• Adds support for fluid sized companion slots by setting companion width and height to the IMA constant FLUID_SIZE.

[Jackson Sui (IMA SDK Team)]

5/27/2022 - 3.27.1

• Service release, no new features.

[Jackson Sui (IMA SDK Team)]

8/3/2022 - 3.28.1

• Service release, no new features.

[Jackson Sui (IMA SDK Team)]

9/14/2022 - 3.28.2

• Updates SDK dependencies to use AndroidX.

Note: version 3.28.1 has an issues with crashes on Android v27 and lower. Use IMA SDK Android v3.28.2 instead.

[IMA SDK]

10/14/2022 - 3.29.0

• Renames the EspVersion class to the VersionInfo class.
• Renames the Encrypted Signals for Publishers (ESP) APIs to the Secure Signals APIs.
• Adds the feature flags APIs. You can use the feature flag APIs to enable or disable specific features in IMA. Use ImaSdkSettings.getFeatureFlags() and ImaSdkSettings.setFeatureFlags() to get and set feature flags.
• Fixes an issue where some IMA events weren't sent.
• Adds androidx.webkit:webkit as an IMA SDK dependency

 

ref:_00D1U1174p._5004Q2eObIl:ref

[Jackson Sui (IMA SDK Team)]

3/29/2022 - 3.30.0

• Adds the ImaSdkFactory.createVideoStitcherVodStreamRequest() API.
• Adds compatibility for Google TVs Hybrid inventory.
• Removes support for the deprecated ImaSdkFactory.createSdkOwnedPlayer() API.
• Adds the ADS_PLAYER_NOT_PROVIDED error code.
• Creates the BaseRequest class that both AdsRequest and StreamRequest now implement.
• Adds the SecureSignals class.
• Adds the BaseRequest.setSecureSignals() method.

[Jackson Sui (IMA SDK Team)]

4/18/2022 - 3.30.1

• Fixes an issue where apps using v3.30.0 crash on non-Android TV devices.

[Jackson Sui (IMA SDK Team)]

7/28/2023 - 3.30.2

• Fixes an issue with proguarding which caused some events to not be emitted from the SDK. This bugfix affects the ExoPlayer extension for the IMA DAI SDK.

[Jackson Sui (IMA SDK Team)]

8/03/2023 - 3.30.3

• Updates internal library dependencies to improve startup latency.

Note for v3.30.2:

• Adds support for Gradle v8+. Past versions of the Android IMA SDK need to set android.enableR8.fullMode=false in the gradle.properties file. See the R8 full mode article for more info.

[Jackson Sui (IMA SDK Team)]

8/31/2023 - 3.31.0

• Deprecates the following AdsRequest APIs:
  • getExtraParameter()
  • getExtraParameters()
  • setExtraParameter()

[Jackson Sui (IMA SDK Team)]

1/30/2024 - 3.32.0

• Adds third-party stitcher VOD stream support for pod serving. See the Android pod serving guide for more info. This change includes adding the following APIs:
  • ImaSdkFactory.createPodVodStreamRequest()
  • StreamManager.loadThirdPartyStream()
• Increase the minSdkVersion that IMA supports to 19.
• Fixes the issue where ad clickthroughs using the Learn more button wouldn't open a new page in Android API version 30 and higher. The issue still exists on IMA SDK versions 3.31.0 through 3.29.0 where a workaround is needed for ad clickthroughs to work.
• Fixes a bug where using AdsLoader.addAdsLoadedListener() could cause an ArrayIndexOutOfBoundsException exception.
• Adds the ad error VAST_NO_ADS_AFTER_WRAPPER.

[Jackson Sui (IMA SDK Team)]

3/28/2024 - 3.33.0

• Adds ImaSdkFactory.createVideoStitcherVodStreamRequest(String networkCode, String region, String projectNumber, String oAuthToken, String vodConfigId). This new API includes the vodConfigId parameter which replaces the use of contentSourceUrl and adTagUrl in the previous API.
• Adds StreamRequest.getVodConfigId().
• Fixes the unexpected crash on Android API levels 25 and lower, introduced in v3.32.0.