Prebid Mobile 3.0 API Changes

This page provides a detailed list of removed APIs in PrebidMobile SDK 3.0, along with their corresponding recommended replacements.

Elimination of Deprecated Functionality

PrebidMobile 3.0 introduces significant changes and removes several deprecated features. Below is a detailed breakdown of these removals, and how publishers should migrate to the new alternatives.

Targeting

Removed Alternative
buyerUID setGlobalORTBConfig(_:)
userCustomData setGlobalORTBConfig(_:)
locationPrecision None, removed
setLocationPrecision(_:) None, removed
getLocationPrecision() None, removed
setCustomParams(_:) setGlobalORTBConfig(_:)
addCustomParam(_:withName:) None, removed
addUserData(key:value:) userExt, setGlobalORTBConfig(_:)
updateUserData(key:value:) None, removed
removeUserData(for:) None, removed
clearUserData() None, removed
getUserData() None, removed
userDataDictionary None, removed
userKeywords getUserKeywords()
addContextData(key:value:) addAppExtData(key:value:)
updateContextData(key:value:) updateAppExtData(key:value:)
removeContextData(for:) removeAppExtData(for:)
clearContextData() clearAppExtData()
getContextData() getAppExtData()
contextDataDictionary getAppExtData()
addContextKeyword(_:) addAppKeyword(_:)
addContextKeywords(_:) addAppKeywords(_:)
removeContextKeyword(_:) removeAppKeyword(_:)
clearContextKeywords() clearAppKeywords()
getContextKeywords() getAppKeywords()
contextKeywords getAppKeywords()
yearOfBirth None, deprecated by ORTB.
setYearOfBirth(yob:) setGlobalORTBConfig(_:)
getYearOfBirth() None, deprecated by ORTB.
clearYearOfBirth() None, deprecated by ORTB.
userGender setGlobalORTBConfig(_:)
userGenderDescription() None, deprecated by ORTB.
userID setGlobalORTBConfig(_:)
eids Targeting.shared.setExternalUserIds(_:)
storeExternalUserId(_:) None, removed
fetchStoredExternalUserIds() None, removed
fetchStoredExternalUserId(_ source:) None, removed
removeStoredExternalUserId(_ source:) None, removed
removeStoredExternalUserIds() None, removed

Prebid

Removed Alternative
bidderNameAppNexus None, removed
bidderNameRubiconProject None, removed
externalUserIdArray Targeting.shared.setExternalUserIds(_:)
prebidServerHost initializeSDK(serverURL:)
useExternalClickthroughBrowser None, removed
impClickbrowserType None, removed
setCustomPrebidServer(url:) initializeSDK(serverURL:)
initializeSDK(::) initializeSDK(serverURL::)
initializeSDK(gadMobileAdsVersion:_:) initializeSDK(serverURL:gadMobileAdsVersion:_:)
initializeSDK(_:) initializeSDK(serverURL:_:)

AdUnit

Removed Alternative
addContextData(key:value:) setImpORTBConfig(_:)
updateContextData(key:value:) None, removed
removeContextData(forKey:) None, removed
clearContextData() None, removed
addContextKeyword(_:) setImpORTBConfig(_:)
addContextKeywords(_:) setImpORTBConfig(_:)
removeContextKeyword(_:) None, removed
clearContextKeywords() None, removed
addExtKeyword(_:) setImpORTBConfig(_:)
addExtKeywords(_:) setImpORTBConfig(_:)
removeExtKeyword(_:) None, removed
clearExtKeywords() None, removed
addExtData(key:value:) setImpORTBConfig(_:)
updateExtData(key:value:) None, removed
removeExtData(forKey:) None, removed
clearExtData() None, removed
setAppContent(_:) Targeting.shared.setGlobalORTBConfig(_:)
getAppContent() None, removed
clearAppContent() None, removed
addAppContentData(_:) Targeting.shared.setGlobalORTBConfig(_:)
removeAppContentData(_:) None, removed
clearAppContentData() None, removed
getUserData() None, removed
addUserData(_:) Targeting.shared.setGlobalORTBConfig(_:)
removeUserData(_:) None, removed
clearUserData() None, removed
setOrtbConfig(_:) setImpORTBConfig(_:)
getOrtbConfig() getImpORTBConfig()
fetchDemand(completion:, _:) fetchDemand(completionBidInfo:)

PrebidRequest

Removed Alternative
addExtData(key:value:) setImpORTBConfig(_:)
updateExtData(key:value:) None, removed
removeExtData(forKey:) None, removed
clearExtData() None, removed
addExtKeyword(_:) setImpORTBConfig(_:)
addExtKeywords(_:) setImpORTBConfig(_:)
removeExtKeyword(_:) None, removed
clearExtKeywords() None, removed
setAppContent(_:) setImpORTBConfig(_:)
clearAppContent() None, removed
addAppContentData(_:) setImpORTBConfig(_:)
removeAppContentDataObject(_:) None, removed
clearAppContentDataObjects() None, removed
addUserData(_:) setImpORTBConfig(_:)
removeUserData(_:) None, removed
clearUserData() None, removed

ExternalUserId

Removed Alternative
identifier uids[].id
atype uids[].atype
init(source:identifier:atype:ext:) init(source:uids:ext:)

BannerAdUnit, InterstitialAdUnit

Removed Alternative
parameters BannerAdUnit.bannerParamters, InterstitialAdUnit.bannerParamters

RewardedVideoAdUnit

Removed Alternative
parameters videoParameters

BannerView, InterstitialRenderingAdUnit, RewardedAdUnit, MediationBannerAdUnit, MediationBaseInterstitialAdUnit, MediationNativeAdUnit

Removed Alternative
ortbConfig BannerView.setImpORTBConfig(_:), InterstitialRenderingAdUnit.setImpORTBConfig(_:), RewardedAdUnit.setImpORTBConfig(_:), MediationBannerAdUnit.setImpORTBConfig(_:), MediationBaseInterstitialAdUnit.setImpORTBConfig(_:), MediationNativeAdUnit.setImpORTBConfig(_:)
addExtKeyword(_:) BannerView.setImpORTBConfig(_:), InterstitialRenderingAdUnit.setImpORTBConfig(_:), RewardedAdUnit.setImpORTBConfig(_:), MediationBannerAdUnit.setImpORTBConfig(_:), MediationBaseInterstitialAdUnit.setImpORTBConfig(_:), MediationNativeAdUnit.setImpORTBConfig(_:)
addExtKeywords(_:) BannerView.setImpORTBConfig(_:), InterstitialRenderingAdUnit.setImpORTBConfig(_:), RewardedAdUnit.setImpORTBConfig(_:), MediationBannerAdUnit.setImpORTBConfig(_:), MediationBaseInterstitialAdUnit.setImpORTBConfig(_:), MediationNativeAdUnit.setImpORTBConfig(_:)
removeExtKeyword(_:) None, removed
clearExtKeywords() None, removed
addContextData(_:forKey:) BannerView.setImpORTBConfig(_:), InterstitialRenderingAdUnit.setImpORTBConfig(_:), RewardedAdUnit.setImpORTBConfig(_:), MediationBannerAdUnit.setImpORTBConfig(_:), MediationBaseInterstitialAdUnit.setImpORTBConfig(_:), MediationNativeAdUnit.setImpORTBConfig(_:)
updateContextData(_:forKey:) None, removed
removeContextDate(forKey:) None, removed
clearContextData() None, removed
addContextKeyword(_:) BannerView.setImpORTBConfig(_:), InterstitialRenderingAdUnit.setImpORTBConfig(_:), RewardedAdUnit.setImpORTBConfig(_:), MediationBannerAdUnit.setImpORTBConfig(_:), MediationBaseInterstitialAdUnit.setImpORTBConfig(_:), MediationNativeAdUnit.setImpORTBConfig(_:)
addContextKeywords(_:) BannerView.setImpORTBConfig(_:), InterstitialRenderingAdUnit.setImpORTBConfig(_:), RewardedAdUnit.setImpORTBConfig(_:), MediationBannerAdUnit.setImpORTBConfig(_:), MediationBaseInterstitialAdUnit.setImpORTBConfig(_:), MediationNativeAdUnit.setImpORTBConfig(_:)
removeContextKeyword(_:) None, removed
clearContextKeywords() None, removed
addExtData(key:value:) BannerView.setImpORTBConfig(_:), InterstitialRenderingAdUnit.setImpORTBConfig(_:), RewardedAdUnit.setImpORTBConfig(_:), MediationBannerAdUnit.setImpORTBConfig(_:), MediationBaseInterstitialAdUnit.setImpORTBConfig(_:), MediationNativeAdUnit.setImpORTBConfig(_:),
updateExtData(key:value:) None, removed
removeExtData(forKey:) None, removed
clearExtData() None, removed
setAppContent(_:) Targeting.shared.setGlobalORTBConfig(_:)
clearAppContent() None, removed
addAppContentData(_:) Targeting.shared.setGlobalORTBConfig(_:)
removeAppContentDataObject(_:) None, removed
clearAppContentDataObjects() None, removed
addUserData(_:) Targeting.shared.setGlobalORTBConfig(_:)
removeUserData(_:) None, removed
clearUserData() None, removed

AdFormat

Removed Alternative
display banner

Utils

Removed Alternative
convertDictToMoPubKeywords(dict:) None, removed

Host

Removed Alternative
setCustomHostURL(_:) setHostURL(_:nonTrackingURLString:)
getHostURL(host:) getHostURL()

Other SDK Changes

  • imp[].ext.data.adslot is no longer sent in the request;
  • Removed VideoAdUnit, alternative - BannerAdUnit with video ad format;
  • Removed VideoInterstitialAdUnit, alternative - InterstitialAdUnit with video ad format;
  • Removed PrebidHost without replacement;
  • Removed PrebidAdMobRewardedVideoAdapter, alternative - PrebidAdMobRewardedAdapter.