Release notes for the IMA iOS SDK

[Bret McGowen]

Hi all,

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

8/11/2014 - 3.0 Beta 7

• Code Changes Required - Introduced the concept of IMAAdDisplayContainer and changed how companion ads are handled. See Changes to the IMA SDK for IOS for information on required code changes in your app.
• Removed references to OCMock headers and sources.

[Shawn Busolits (IMA SDK Team)]

10/13/2014 - 3.0 Beta 8

• Introduces IMAUIElements, which allows showing or hiding SDK UI elements programatically.
  

[Shawn Busolits (IMA SDK Team)]

10/27/2014 - 3.0 Beta 9

• Contains fixes for memory leaks in IMAJavascript classes.
  

[Shawn Busolits (IMA SDK Team)]

12/17/2014 - 3.0 Beta 11

• Fixes a memory leak introduced in Beta v10 with the addition of WKWebView.

[Shawn Busolits (IMA SDK Team)]

2/17/2015 - 3.0 Beta 12

• Now uses native ad playback on iOS 7 and older. This prevents the SDK from interfering with MPMoviePlayerController events and controls.
• Fixed an issue where adPlaybackInfo was not populated at the LOADED and START events.
• Adds IMASettings.maxRedirects to specify the number of redirects after which subsequent redirects will be denied, and the ad load aborted.
• Adds support for manual ad playback.

[Shawn Busolits (IMA SDK Team)]

4/29/2015 - 3.0 Beta 13

• Added support for background ad playback. For more info see Background Ad Playback.
• The SDK can now be imported as a framework. For more info on upgrading, see our blog post on this release.
• Reduced ad loading times on iOS 8.
• Fixed an issue where companion ads disappeared after an ad ended. Companions ads will now display until the slot is refreshed.
• Added a 10 second timeout for SDK loading.
• IMASettings now implements NSCopying.
• Fixed an issue where apps would crash when headphones were unplugged.
• Ads are now silenced when the device is silenced by default. The publisher can change this by setting the AVAudioSession category.
• Fixed bugs with Control Center play and pause not working on iOS versions less than 8.
• Ads are no longer paused when the notifiation drawer is opened.
• Added a VERSION file to the downloadable zip.
• To improve performance, ad rendering is now done natively via AVPlayer on all iOS versions.

[Shawn Busolits (IMA SDK Team)]

5/27/2015 - 3.0 Beta 14

• Fixed an issue where the ad player would occasionally stop to buffer and never resume playback.
• Moved IMASettings to its own header file.

[Yury Pavlotsky (IMA SDK Team)]

7/22/2015 - 3.0 Beta 15

• Introduces ad buffer events via IMAAdsManager delegates. This facilitates adding elements such as activity indicators and buffering bars to the player.
  
• Exposes debugging mode. Publishers can now set the IMASettings enableDebugModesetting to YES to get more verbose logging in the console. This should not be used in production, as it will watermark the ad player.
  
• IMAAdsManager destroy now correctly terminates ads in all cases.
  
• Allows the reuse of display containers.
  
• Allows publishers to destroy IMA objects from within delegate methods.
  
• IMAAdsManager now only has a weak reference to contentPlayhead (fixing potential memory leaks). You will now need to retain any IMAAVPlayerContentPlayhead instance or object that implements IMAContentPlayhead as a property, otherwise the object will be immediately released.
  
• Removes video resizing animation.
  
• Removes unnecessary initial resume ad event.
  

[Yury Pavlotsky (IMA SDK Team)]

9/4/2015 - 3.0 Beta 16

• Updates to be compatible with iOS 9's App Transport Security feature.
  

[Shawn Busolits (IMA SDK Team)]

12/17/2015 - 3.1.0

• Out of beta.
• Adds support for Picture in Picture on iOS 9. For more information, see our Picture in Picture guide or our implementation in the Advanced Sample.
• IMAContentPlayhead should now be passed to the IMAAdsRequest instead of the IMAAdsManager.
• Adds support for HTML5 companions.
• Adds [IMAAdsManager discardAdBreak].

[Shawn Busolits (IMA SDK Team)]

4/14/2016 - 3.2.0

• Adds bitcode support.
• Adds support for clickthrough URLs that lead to the app store.

[Yury Pavlotsky (IMA SDK Team)]

5/9/2016 - 3.2.1

Note: Due to an error, bitcode support was non-functional in the 3.2.0 release.

• Adds bitcode support.

[Shawn Busolits (IMA SDK Team)]

1/30/2017 - 3.4.0

• The SDK is now distributed as a dynamic framework. As a result we no longer publish a separate AdMob version of the Framework - you can use the same version whether or not your implementation also uses AdMob.
• Adds support for video icons.
• Adds the following new properties to IMAAd:
  • adSystem
  • creativeID
  • creativeAdID
  • universalAdIdValue
  • universalAdIdRegistry
  • advertiserName
  • surveyURL
  • dealID
  • wrapperCreativeIDs
  • wrapperSystems
• Adds the following new properties to IMAAdsRequest:
  • contentDuration
  • contentKeywords
  • contentTitle
• Adds [IMAAdsManager setVolume:].
• Adds [IMACompanionDelegate companionSlotWasClicked].
• Adds IMASettings.disableNowPlayingInfo.
• SDK version 3.3.1 will be deprecated on 1/30/2018. See the Deprecation Schedule for more details.

[Shawn Busolits (IMA SDK Team)]

1/31/2017 - Rolled back to 3.3.1

• Due to issue with building for specific devices, rolled back to 3.3.1.

[Shawn Busolits (IMA SDK Team)]

2/3/2017 - 3.4.1

• The SDK is now distributed as a dynamic framework. As a result we no longer publish a separate AdMob version of the Framework - you can use the same version whether or not your implementation also uses AdMob.
• Adds support for video icons.
• Adds the following new properties to IMAAd:
  • adSystem
  • creativeID
  • creativeAdID
  • universalAdIdValue
  • universalAdIdRegistry
  • advertiserName
  • surveyURL
  • dealID
  • wrapperCreativeIDs
  • wrapperSystems
• Adds the following new properties to IMAAdsRequest:
  • contentDuration
  • contentKeywords
  • contentTitle
• Adds [IMAAdsManager setVolume:].
• Adds [IMACompanionDelegate companionSlotWasClicked].
• Adds IMASettings.disableNowPlayingInfo.

• SDK version 3.3.1 will be deprecated on 2/3/2018. See the Deprecation Schedule for more details.

[Shawn Busolits (IMA SDK Team)]

3/9/2017 - 3.4.2

• Service release, no new features.

[Shawn Busolits (IMA SDK Team)]

Addendum - 3/9/2017 - 3.4.2

• SDK version 3.4.1 will be deprecated on 3/9/2018. See the Deprecation Schedule for more details.

[Yury Pavlotsky (IMA SDK Team)]

3/24/2017 - 3.5.0 

• Fixes an issue with bitcode support.
  
• Adds adsResponse to the IMAAdsRequest object.
  
• Fixes an issue with Swift builds.
  
• SDK version 3.4.2 will be deprecated on 3/24/2018. See the Deprecation Schedule for more details.

[Shawn Busolits (IMA SDK Team)]

4/6/2017 - 3.5.1

• The SDK will now throw kIMAError_FAILED_TO_REQUEST_ADS if the IMAAdDisplayContainer is not in the view hierarchy when an ad or stream request is made. Previously, these requests failed silently.
• SDK version 3.5.0 will be deprecated on 4/3/2018. See the Deprecation Schedule for more details.

[Yury Pavlotsky (IMA SDK Team)]

5/2/2017 - 3.5.2

• Removes auto-resuming when coming back into app from backgrounding. Call [IMAAdsManager resume] to resume.
• Adds [IMAAdsRenderingSettings playAdsAfterTime].
• SDK version 3.5.1 will be deprecated on 5/2/2018. See the Deprecation Schedule for more details.

[Shawn Busolits (IMA SDK Team)]

7/24/2017 - 3.6.0

• Adds IMAAdsRequest.vastLoadTimeout.
• Adds IMAAd.wrapperAdIDs.
• Adds IMAAd.skipTimeOffset.
• Fixes an error where the SDK could not detect the video view used for ad playback if it was removed from and re-added to the view hierarchy.
• SDK version 3.5.2 will be deprecated on 7/24/2018. See the Deprecation Schedule for more details

[Shawn Busolits (IMA SDK Team)]

10/9/17 - 3.6.1

• Adds IMAAdsRequest.liveStreamPrefetchSeconds/
  

• SDK version 3.6.0 will be deprecated on 10/9/2018. See the Deprecation Schedule for more details.
  

[Shawn Busolits (IMA SDK Team)]

1/30/18 - 3.7.0

• Drops support for iOS 8 and below.

• Service release, no new features.

• SDK version 3.6.1 will be deprecated on 1/30/2019. See the Deprecation Schedule for more details.

[Yury Pavlotsky (IMA SDK Team)]

4/30/2018 - 3.7.1

• Adds IMAAdsRequest.adWillPlayMuted
• Changes VAST media load timeout to 8 seconds
• Fixes an issue with HTML companions
• Removes ad tag parameter documentation from IMAStreamRequest. Ad tag parameters are documented in https://support.google.com/dfp_premium/answer/7320898 and https://support.google.com/dfp_premium/answer/7320899
• SDK version 3.7.0 will be deprecated on 4/30/2019. See the Deprecation Schedule for more details.

[Yury Pavlotsky (IMA SDK Team)]

11/13/2018 - 3.8.1

• Fixes an issue where ad tags with multiple slot size were parsed incorrectly.
  
• Adds [IMAVideoDisplay seekStreamToTime] to support skippable ads in IMA DAI VOD streams.
  
• Adds IMAAdRenderingSettings.loadVideoTimeout.
  
• Adds IMAAd.VASTMediaWidth, IMAAd.VASTMediaHeight, and IMAAd.VASTMediaBitrate.
  
• Reduces binary size by ~15% due to build improvements.
  
• SDK version 3.7.3 will be deprecated on 11/13/2019. See the Deprecation Schedule for more details.
  

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

3/22/2019 - 3.9.0

• Introduces support for the Open Measurement SDK for third-party viewability.
• Added a convenience initializer to IMAAdDisplayContainer to create an ad display container with no companion slots.

[Greg Schoppe (IMA SDK Team)]

9/19/2019 - 3.10.1

• Add support for iOS 13.

[Greg Schoppe (IMA SDK Team)]

02/12/2020 - 3.11.3

• 3.11.3 will be the final version of the IMA SDK that supports iOS 9.x
• Fixes a bug where importing the framework header did not import IMAFriendlyObstruction.h
• Fixes an issue where clickthroughs would crash on iOS 9.x

[Greg Schoppe (IMA SDK Team)]

08/11/2020 - 3.12.1

• Updates the IMA SDK to support iOS 14: Adds support for AppTrackingTransparency. Apps are strongly recommended to request App Tracking Transparency authorization for IDFA access in order to monetize effectively on iOS 14.
• Fixes an issue where opening a click through and then closing the app would cause a memory leak.

[Interactive Media Ads SDK]

2020-10-13 - 3.13.0

• The SDK is now built with Xcode 12.
• Fixed an issue where seeking out of an ad break would not fire the AD_BREAK_ENDED event.
• Removed deprecated fields on IMAAVPlayerVideoDisplay, IMAVideoDisplay,and IMAVideoDisplayDelegate.
• Fixed an issue where PiP would minimize on each ad completion.
• Fixed a bug where live streams would end playback as soon as they were AirPlayed.
• Fixed an issue where pressing skip did nothing for shared playback.
• Fixed an issue where content would briefly flash between ads in a pod for shared playback.
• Added the IMAAVPlayerVideoDisplay.streamAssetOptions API.
• Exposed ad period duration in IMAStreamManagerDelegate.
• Fixed an issue where an "Ads cannot be requested because the ad container is not attached to the view hierarchy." error was fired erroneously.
• SDK version 3.12.1 is scheduled to be deprecated on 2021-10-13. See the Deprecation Schedule for more details.

[Interactive Media Ads SDK]

2021-02-17 - 3.14.1

• Fixed an issue where duplicate ad events were sometimes fired when preloading was enabled.
• Implemented PodServing Support.
• Fixed an issue with double deeplink opening on iOS 13+.
• SDK version 3.13.0 is scheduled to be deprecated on 2022-02-17. See the Deprecation Schedule for more details.

[Interactive Media Ads SDK]

2021-05-03 - 3.14.3

• Fixed an issue that caused warning messages on iOS < 12.
• Added IMASettings:sessionid to let publishers customize session ID.
• Fixed an issue where ad pause and resume events would fire during content.
• Ensured ad UI content insets aren't adjusted automatically
• Last version of the IMA SDK for iOS to support iOS 10.
• SDK version 3.14.1 is scheduled to be deprecated on 2022-05-03. See the Deprecation Schedule for more details.

[Interactive Media Ads SDK]

2021-07-06 - 3.14.4

• Fixed an issue that caused missing events when apps are backgrounded.
• Fixed an issue that allowed publishers to manually set islat on iOS <14.
• Increased minimum iOS version to iOS 11
• SDK version 3.14.3 is scheduled to be deprecated on 2022-07-06. See the Deprecation Schedule for more details.

[Interactive Media Ads SDK]

2021-10-05 - 3.14.5

• Added IMASettings:sameAppKeyEnabled API which helps you deliver more relevant and personalized ads by using data collected from your apps. The API is currently enabled by default with no changes needed from publishers.
• Added nullability contracts to all APIs.
• SDK version 3.14.4 is scheduled to be deprecated on 2022-10-05. See the Deprecation Schedule for more details.

[Interactive Media Ads SDK]

2022-02-23 - 3.15.1

• Increased minimum iOS version to 12
• SDK version 3.14.5 is scheduled to be deprecated on 2023-02-23. See the Deprecation Schedule for more details.

[Interactive Media Ads SDK]

2022-04-19 - 3.16.3

• Added IMACompanionAdSlot.initWithView(view: UIView) to support fluid sized companion ads.
• The IMA iOS SDK is now packaged as an xcframework.
• Adds M1 simulator support.
• Fixed an issue where it was possible to overwrite the IMA SDK version information.
• Fixed an issue where the iOS SDK created duplicate symbol warnings.
• SDK version 3.15.1 is scheduled to be deprecated on 2023-04-19. See the Deprecation Schedule for more details.

[Interactive Media Ads SDK]

2022-08-03 - 3.17.0

• Increases the maximum default bitrate for non-mobile devices if the maximum bitrate is not set by the publisher.
  
• SDK version 3.16.3 is scheduled to be deprecated on 2023-08-03. See the Deprecation Schedule for more details.

[Interactive Media Ads SDK]

2022-10-02 - 3.18.1

• Fixes an issue that caused the SDK to crash with UIViewControllerHierarchyInconsistency
• SDK version 3.17.0 is scheduled to be deprecated on 2023-10-02. See the Deprecation Schedule for more details.

[Interactive Media Ads SDK]

2022-11-07 -  3.18.2

• Adds user_context to stream request.
• Fixes erroneous "Invalid internal message" warnings.
• SDK version 3.18.1 is scheduled to be deprecated on 2023-11-07. See the Deprecation Schedule for more details.

[Interactive Media Ads SDK]

2022-12-08 - 3.18.4

• Service release. No new features.
• SDK version 3.18.2 is scheduled to be deprecated on 2023-12-08. See the Deprecation Schedule for more details.

[Interactive Media Ads SDK]

2023-03-10 - 3.18.5

• Increases minimum version for the IMA SDK for iOS to iOS 14.
• Fixes a bug where user context wasn't passed with stream error.
• Enables Publisher first-party ID (formerly known as same app key) for apps that also bundle GMA version 9.14.0 and above.
• Adds the IMAVideoStitcherLiveStreamRequest class, which provides support for the Google Video Stitcher Live API.
• Public beta release of Google Video Stitcher API
• Public beta release of Secure Signals API.
• SDK version 3.18.4 is scheduled to be deprecated on 2024-03-10. See the Deprecation Schedule for more details.

[Interactive Media Ads SDK]

2023-04-20 - 3.19.1

• Increased minimum iOS version for compilation to iOS14.
• Removed support for the ARMv7 platform.
• Fixes an error where a click Ad Event wasn't fired on SIMID clickthrough.
• Stops incorrectly signalling OMID support in VPAID Secure mode.
• Fixes an issue with SIMID resize event support.
• Adds the IMAVideoStitcherVODStreamRequest class, which provides support for the Google Video Stitcher VOD API.
• SDK version 3.18.5 is scheduled to be deprecated on 2024-04-20. See the Deprecation Schedule for more details.

[Interactive Media Ads SDK]

2023-04-28 - 3.19.2

• Reduced minimum iOS version for compilation to iOS14.

[Interactive Media Ads SDK]

2024-01-28 - 3.20.0

• Enables companion ad support for pod serving
• Enable Pod Serving VOD stream requests.
• Adds a getter for cue points to the stream manager.

[Interactive Media Ads SDK]

2024-04-03 - 3.22.0

• Adds a privacy manifest PrivacyInfo.xcprivacy file and a signature for the SDK.
• Adds IMAVideoStitcherLiveStreamRequest.videoStitcherSessionOptions and IMAVideoStitcherVODStreamRequest.videoStitcherSessionOptions properties to set Cloud Video Stitcher's options for manifest generation.

[Interactive Media Ads SDK]

2024-04-12 - 3.22.1

• Fixes an issue with the most recent Cocoapods release which prevented apps from building on iOS Simulators.

[Interactive Media Ads SDK]

2024-06-12 - 3.23.0

• Adds VODConfigID to IMAVideoStitcherVODStreamRequest.
• Makes the background transparent for companion ads.
• Rejects null value for adTagURL in IMAAdsRequest.
• Changes asset-level fallback logic to iterate through all ads in the original VAST until the SDK identifies a playable creative. If no playable creative is found, the ad isn't played.

On Tuesday, June 18, 2024 at 11:14:58 AM UTC-4 Greg Schoppe (IMA SDK Team) wrote:

2024-06-12 - 3.23.0

• Adds VODConfigID to IMAVideoStitcherVODStreamRequest.
• Adds videoStitcherSessionOptions to IMAVideoStitcherLiveStreamRequest and IMAVideoStitcherVODStreamRequest to manage video stitching sessions.
• Makes the background transparent for companion ads.
• Rejects null value for adTagURL in IMAAdsRequest.
• Changes asset-level fallback logic to iterate through all ads in the original VAST until the SDK identifies a playable creative. If no playable creative is found, the ad isn't played.

[Jackson Sui (IMA SDK Team)]

2025-04-02 - 3.26.1

• Adds the ad period info to the AD_PERIOD_STARTED event, which you can access from IMAAdEvent.adData property.
• Adds support for handling HLS interstitials metadata with the IMA SDK.

2024-12-03 - 3.24.0

• Adds network code to the list of stream request parameters for all stream types.
• Fires a LOG event when an invalid click-through URL is clicked, rather than failing silently.
• Fixes a memory leak when OMID sessions were improperly destroyed.
• Adds support for skippable ads in VOD Pod Serving streams.
• Fixes a bug with scrolling support when the video is embedded in a scrollable container.
• Adds support for minSuggestedDuration to non-linear ads
• Fixes a bug that caused incorrect encoding for Campaign Manager tracking URLs, in some cases.

[Jackson Sui (IMA SDK Team)]

2025-08-28 - 3.27.4

• Fixes IMARemoteControl class creation to only happen when the player starts playback.

[Interactive Media Ads SDK]

2025-10-22 - 3.28.10

• Enables interstitial support for Server-Directed Ad Insertion (SDAI) live and VOD streams by introducing a useHLSInterstitial field to the stream request.
• Improves memory management for companion ads to prevent memory leaks when your application destroys the adsManager object.
• Increased minimum iOS version to 15.