Changelog
- Core
- GAM
- AdMob
- AppLovin MAX
Release notes of prebid_mobile_sdk, the core package: Prebid rendering, the Original API and the SDK settings. Each package is versioned and released on its own; the native SDK versions of every release are on the Compatibility page.
v1.1.0
Added
PrebidBannerAdUnit(bannerApi: ...): the banner's API frameworks (imp.banner.api), e.g. MRAID.PrebidVideoAdBidResponseis aPrebidBidResponse: in-stream video bids carryreceivedAt,expiresAt,isExpired,topBidFilteredandeventslike the other Original API responses.- Value equality (
==,hashCode) and a readabletoString()for the bid responses,PrebidWinningBid,PrebidReward,ExternalUserId,UserUniqueId,VideoParametersandPrebidFullscreenControls. AdViewState.reportsVisibleFraction(companion library): a native view can get the fraction of it that Flutter paints on screen, which its own viewability check can't see.package:prebid_mobile_sdk/companion.dartexportsimpOrtbWithGpidandimpOrtbWithPbAdSlot, which the companion packages use to send a GPID and an ad slot in theimpJSON.- Value equality and a readable
toString()forNativeParameters,NativeAsset,NativeEventTracker,PrebidNativeAdResponse,PrebidNativeImageandPrebidNativeData. flatSizes(companion library): theadditionalSizescreation param of the native banner views.- iOS:
PrebidTargeting.setBundleNameoverridesapp.bundle(through the global OpenRTB config, likesetAppName), andgetBundleNamereturns it; both were Android only. - iOS:
winningBidonPrebidInterstitialAdandPrebidRewardedAd; it was Android only.
Changed
- Android: Prebid Mobile SDK 3.4.1 (was 3.4.0).
Fixed
- Android: a native request without a bid reports
prebidDemandNoBids.PrebidNativeAdreported "Failed to parse native ad" (and the Original API a success with a native cache id), because Prebid Android caches the response of a native unit, with itshb_cache_id_localkeyword, even when no bid won. PrebidNativeAdUnit.fetchDemand()responses carryreceivedAt, soexpiresAtandisExpiredwork for native bids as for the other units (they were alwaysnull/false).PrebidInterstitialAdwithoutadFormatsrequests a banner on iOS too, as documented; Prebid iOS used to add video on its own.- After a hot restart, a preloaded banner or an Original API / multiformat
unit without
onDemandRefreshedthat is the first ad releases the previous isolate's native ads first, as every other ad does (the old banner could be shown again and old auto-refresh timers kept running). - A preloaded banner whose native creation failed is created again by the
next
load(), andstopRefresh()no longer throws for it. This also applies to the GAM, AdMob and MAX preloaded banners. - The Android library's Gradle
versionis the package version (it was the plugin template's1.0-SNAPSHOT). - iOS: with several Flutter engines, an engine that detaches no longer resets Prebid's logger while another engine's log listener uses it.
- iOS: fullscreen ads present from the Flutter engine's own window, and banners from their own, instead of the first key window: on an iPad with several windows, or with Flutter in a secondary scene (add-to-app), they appeared in the wrong one. The key window remains the fallback.
- Android:
setLogLevelandsetLogListenerafterinitializeSdktake effect (Prebid applied them only when it initialized), and removing the log listener logs to logcat again. - Android:
initializeSdkcompletes when the app had started initializing Prebid natively; it waited forever. - Native ads keep Flutter's visible fraction across a reload, on both platforms: a reloaded ad half hidden under an app bar could count an impression.
- A native ad Flutter doesn't paint (under
Offstage,Opacity0, anotherIndexedStackchild, or on a route covered by an opaque one) counts as invisible for its impression. - Android: a native ad's late impression callback after it was reloaded or destroyed is ignored instead of reaching the new ad's listener.
PrebidBannerAdController.winningBidandPrebidPreloadedBannerAd.winningBidare null after a load or refresh without a bid, as documented; they kept the previous bid.- After a hot restart, a new banner no longer shares its channel with a
previous isolate's preloaded banner, which could leave its controller
throwing
MissingPluginException. This also applies to the GAM, AdMob and MAX ads. PrebidInterstitialAd(adFormats: {})requests a banner on iOS too, as on Android.- An interstitial, rewarded, native or Original API ad that is never loaded no longer keeps its listener alive.
- Android: Original API interstitial and rewarded units send
adPosition. - Android: after a hot restart, an Original API unit no longer refreshes on an interval set by the previous isolate.
- Android: a result code added by a newer Prebid SDK is reported as
prebidUnknownErrorinstead of crashing the app. - Original API and in-stream video sizes are rounded to whole points like the other ads' (they were truncated).
- iOS:
activateBannerImpressionTracker,findPrebidCreativeSizeandactivateBannerSKAdNetworklook for the banner in the Flutter engine's window. - iOS:
show()during a view controller transition that UIKit can't queue reportsonAdDisplayedoronAdFailed; it could report neither. - iOS: with several Flutter engines, an engine whose log listener was reset by another engine detaching gets its logs back when it sets it again.
- iOS: a failed
initializeSdkreports Prebid's failure reason, not only its generic description.
v1.0.0
First stable release, built on Prebid Mobile SDK 3.4 (Android 3.4.0, iOS 3.4.1 or later). Requires Android 7.0 (API 24) and iOS 15.
Added
- Prebid-rendered ads: banner (display, multisize, outstream video, auto-refresh), interstitial, rewarded, and native with built-in rendering and impression and click tracking.
- Original API auctions for banner, interstitial, rewarded video, native, multiformat and in-stream video, returning targeting keywords for Google Ad Manager, with auto-refresh and Prebid impression tracking.
- OpenRTB 2.6 video signals: placement, start delay, linearity, skippability, blocked creative attributes, bitrates and durations.
- Fullscreen rendering controls: close and skip buttons, skip delay, sound, minimum size, and SKOverlay on iOS.
- Bid expiration events for every ad format.
- Privacy signals: GDPR (TCF v2), US Privacy (CCPA) and COPPA, plus GPP read from the consent management platform.
- First-party data: user and app keywords and data, bidder access control, global and per-impression OpenRTB configuration, app information and location.
- Identity: external user IDs (OpenRTB 2.6 EIDs, several IDs per source,
with entry- and ID-level
ext) and Prebid SharedID. - SDK configuration: timeouts, custom headers, Prebid Server targeting flags, stored responses, status check, log level, and a bid request and response listener for debugging.
- Runtime switching of the Prebid Server account and auction endpoint without re-initializing, with getters.
- Creative factory timeout getters, caching of Rendering API bids for
reporting, the bundled OM SDK version, and an
app.nameoverride. - iOS privacy and attribution: a separate Prebid Server URL for users who haven't allowed tracking (App Tracking Transparency), and SKAdNetwork source app and iTunes ID.
- Native ads in your own Flutter layout (
PrebidNativeAdView.custom) with impression and click tracking, and Original API native wins shown from their cache id (PrebidNativeAd.loadFromCacheId). NativeParameters, the native request every native ad takes (assets, event trackers, context, placement count, sequence, asset and DCO URL support, privacy,ext), with image MIME types andextfields on assets and event trackers.- Per-ad-unit global OpenRTB configuration for banner, interstitial, rewarded, native and in-stream video.
- Rewarded ad formats, video parameters and minimum size (iOS), and
isLoadedon interstitial and rewarded ads. - Video player size in video parameters (
video.w/video.h). - The winning bid of a Prebid-rendered banner
(
PrebidBannerAdController.winningBid), and of interstitial and rewarded ads on Android (winningBid). - GPID on the Prebid-rendered banner, interstitial and rewarded ads, and the ad position of interstitial and rewarded ads (iOS).
- The whole
user.extobject (PrebidTargeting.setUserExt), Prebid's log file (PrebidMobile.setDebugLogFileEnabled, iOS) and the timeout adopted from Prebid Server (PrebidMobile.getTimeoutMillisDynamic, iOS). - Prebid's Google Mobile Ads version check, run at initialization when the app links Google Mobile Ads.
- Original API: the Prebid creative size in a GAM banner
(
findPrebidCreativeSize), bid event URLs, banner API frameworks, the interstitial minimum size, GPID on every ad unit, and SKAdNetwork StoreKit flows and SKOverlay on iOS. - Original API:
NativeParameterson native and multiformat units, a display interstitial requested by minimum size alone, andpbAdSlotplus per-unit OpenRTB configuration (on Android for single-format units). - Prebid ad slot (
pbAdSlot) on interstitial and rewarded ads. - Prebid's log messages delivered to the app (
PrebidMobile.setLogListener) and anonelog level. - The Google Ad Manager VAST tag URL for IMA players
(
PrebidInstreamVideoAd.generateInstreamUriForGam). - The plugin's name and version in every bid request
(
app.ext.prebid.wrapper), so Prebid Server hosts and bidders can tell Flutter traffic from native app traffic. The native SDK'sapp.ext.prebid.sourceandversionare unchanged. - Bid expiry on Original API and multiformat results:
receivedAt,expiresAtandisExpired. - Preloaded banners (
PrebidPreloadedBannerAd, shown byPrebidPreloadedBannerAdView): loaded before their slot is on screen and kept across the views showing them, so a banner in a scrolling list isn't re-auctioned each time it scrolls back. PreloadedBannerandPreloadedBannerViewin the companion library, for the companion packages' preloaded banners.- Native response image sizes (iOS), the device-data consent check, an
app.bundleoverride (Android), Prebid's own location updates switch (iOS), and clearing the user location. - Getters for the SDK settings and targeting values.
- The same events and result codes on Android and iOS.