Скилл
Yandex Mobile Ads SDK 8
Миграция Android приложения с Yandex Mobile Ads SDK 7 на SDK 8. Исходник: yandexmobile/yandex ads sdk android.
- Скачивания
- 0
- В избранном
- 0
- Комментарии
- 0
- Просмотры
Миграция Android приложения с Yandex Mobile Ads SDK 7 на SDK 8. Исходник: yandexmobile/yandex ads sdk android.
Добавьте инструмент одной командой или скачайте проверенный архив версии.
npx skills add yandexmobile/yandex-ads-sdk-android --skill migrate-yandex-ads-sdk-from-7-to-8To avoid tool errors when modifying files:
// FIXME_SDK8: Auto-generated during migration, please review. (or <!-- FIXME_SDK8: Auto-generated during migration, please review. --> in XML) to indicate that this code was auto-generated and requires manual review.Use latest available versions in repositories :
Read the app module's Gradle build script and find the namespace value (e.g., "com.yandex.ads.sample").
The build script may use either Gradle DSL — do NOT assume .kts:
app/build.gradle.kts — namespace = "com.yandex.ads.sample"app/build.gradle — namespace "com.yandex.ads.sample" or namespace = "com.yandex.ads.sample"Many projects (including Capacitor / hybrid wrappers) use the Groovy build.gradle. Check which file actually exists in the app module before reading it.
If namespace is absent (older AGP), fall back to the applicationId in the same file or the package attribute in app/src/main/AndroidManifest.xml.
CRITICAL: Any import starting with this namespace is application code, NOT SDK code. NEVER replace imports that start with the application namespace.
Replace SDK imports ONE BY ONE using bulk find-and-replace (e.g., one command per import). Only process lines that do NOT start with application namespace.
How to replace imports:
Use IDE's "Replace in Path" feature or command-line tools (sed, PowerShell, etc.)
Replace simple class/method names ONE BY ONE using bulk find-and-replace (e.g., one command per API):
How to replace APIs/Classes:
Replace patterns:
MobileAds.initialize → YandexAds.initializeAdRequestConfiguration.Builder → AdRequest.BuilderClosableBannerAdEventListener → BannerAdEventListenerMobileInstream → YandexInstreamAdsBannerAdSize.stickySize → BannerAdSize.stickyBannerAdSize.inlineSize → BannerAdSize.inlineUse IDE's "Replace in Path" feature or command-line tools (sed, PowerShell, etc.)
Optional: If possible, perform STEP 2 and STEP 3 in parallel in one response (both commands are independent). If not, perform sequentially.
Do not start the build.
NativeBannerView (with NativeTemplateAppearance) was a ready-made template removed in SDK 8. The SDK now requires a custom native ad view: NativeAdView as the root container + NativeAdViewBinder to bind assets to child views.
Ready-to-use replacement: The Yandex Mobile Ads public sample (YandexMobileAdsExample) provides a complete drop-in implementation. Read the following files from the sample and create them in the partner's project, replacing the sample package com.yandex.ads.sample with the app namespace from STEP 1:
app/src/main/java/com/yandex/ads/sample/nativeads/NativeAdBannerView.kt — a custom FrameLayout that wires up all native ad asset views via NativeAdViewBinderapp/src/main/java/com/yandex/ads/sample/common/RatingView.kt — a RatingBar that implements the SDK's Rating interface; place it alongside NativeAdBannerView.kt and update its packageapp/src/main/res/layout/native_banner_ad_view.xml — the full XML layout; update the RatingView class reference to match the new packageAdd //FIXME(SDK8): Auto-generated during migration, please review. to the top of each copied Kotlin file.
Migration Actions:
NativeTemplateAppearance, ButtonAppearance, TextAppearance, ImageAppearance, RatingAppearance, SizeConstraint usages and app:appearance in XML. Note the values — you will apply them to the new layout in step 3.native_banner_ad_view.xml: For each value extracted in step 1, set the equivalent XML attribute on the corresponding view. If app:appearance="@style/..." was used, open that style to extract values first.| Old customization | View @id |
XML attribute |
|---|---|---|
withTitleAppearance → withTextColor / withTextSize |
title |
android:textColor / android:textSize |
withBodyAppearance → withTextColor / withTextSize |
body |
android:textColor / android:textSize |
withCallToActionAppearance → withTextColor / withNormalColor / withTextSize |
call_to_action |
android:textColor / android:backgroundTint / android:textSize |
withIconAppearance → withWidth / withHeight |
icon |
android:layout_width / android:layout_height |
withRatingAppearance → withStarColor |
rating |
android:progressTint |
withDomainAppearance → withTextColor / withTextSize |
domain |
android:textColor / android:textSize |
withSponsoredAppearance → withTextColor |
sponsored |
android:textColor |
withWarningAppearance → withTextColor |
warning |
android:textColor |
SizeConstraint on root |
native_ad_container |
android:layout_width / android:minHeight |
NativeBannerView in XML with NativeAdBannerView (using the partner's app package). Remove the app:appearance attribute. Keep android:id and all layout parameters.nativeBannerView.setAd(nativeAd) → nativeBannerView.bindNativeAd(nativeAd)nativeBannerView.release() before each new load and in onDestroy()Do not start the build.
Explain to user: build needed to identify complex migration cases.
Only after completing STEP 1-4, start the fast compilation check:
./gradlew compileDebugSources 2>&1 | tee build.log
Important: This is the first build run before iterative fixes.
For each compilation error:
apply_diff to fix it.Optional: If fixes are in different files and don't depend on each other, you can perform multiple apply_diff operations in parallel in one response.
Important: Do not rebuild after every 5-10 fixes. Fix all SDK-related errors from the current build log, then rebuild once.
Complex cases (require apply_diff):
setAdLoadListener() call (with context).loadAd() to include listener parameter (with context).AdRequestConfiguration.Builder().setParameters(...).build()AdRequest.Builder(adUnitId).setParameters(...).build()adUnitId from setAdUnitId() call or banner setup. Remove setAdUnitId() call after migration.AdRequest.Builder().setAge(25).setGender(Gender.MALE)AdRequest.Builder(id).setTargeting(AdTargeting.Builder().setAge(25).setGender(Gender.MALE).build()).setAge(), .setGender(), .setLocation() to AdTargeting.Builder().Iterate assemble application until success build, fix found issues between builds.
(Optional) Check if the user's project uses this specific mediation adapters (mobileads-google, mobileads-mytarget, mobileads-extras):
mobileads-google, mobileads-mytarget, mobileads-extras). If they use these adapters and minSdk is lower than 23, warn them that a manifest merger failure will occur and suggest raising it to 23. Do not force this if they don't use these adapters.plugin.compose compiler plugin instead of the old composeOptions { kotlinCompilerExtensionVersion = ... }.Do not automatically edit these Gradle settings unless the user explicitly agrees or encounters a build error related to them.
| Task | Tool | Rationale |
|---|---|---|
| Import replacement | execute_command (sed) |
Processes all files in 1 sec |
| Simple API replacement | execute_command (sed) |
Safe for simple patterns |
| Complex refactoring | apply_diff |
Requires context and precision |
| Project build | execute_command (gradlew compileDebugSources) |
Only after bulk replacements |
sed for bulk replacements (imports, simple APIs), but apply them ONE BY ONE (one pattern per command).apply_diff only for complex casesbuild.gradle.kts or Groovy build.gradle) are already set by the user. Do not change Yandex / mediation dependency coordinates unless the user asks.Some SDK classes were moved to different packages. Ensure all imports match the SDK 8 package layout.
Action:
com.yourcompany.yourapp.* - this is application code, not SDK)media3.YandexAdsLoader:
Custom Player Implementations:
InstreamAdPlayer, add new required methods:supportedMimeTypes: List<String>bindPlayerView(container: FrameLayout)All SDK imports must use com.yandex.mobile.ads.* prefix:
| Feature Area | Package | Key Classes |
|---|---|---|
| Core/Common | com.yandex.mobile.ads.common.* |
YandexAds, AdRequest, AdRequestError, AdError, ImpressionData, AdBindingResult, Result, Result.Success, Result.Failure |
| Banner | com.yandex.mobile.ads.banner.* |
BannerAdView, BannerAdSize, BannerAdEventListener |
| Interstitial | com.yandex.mobile.ads.interstitial.* |
InterstitialAd, InterstitialAdLoader, InterstitialAdLoadListener, InterstitialAdEventListener |
| Rewarded | com.yandex.mobile.ads.rewarded.* |
RewardedAd, RewardedAdLoader, RewardedAdLoadListener, RewardedAdEventListener, Reward |
| App Open | com.yandex.mobile.ads.appopenad.* |
AppOpenAd, AppOpenAdLoader, AppOpenAdLoadListener, AppOpenAdEventListener |
| Native Ads | com.yandex.mobile.ads.nativeads.* |
NativeAd, NativeAdLoader, NativeAdLoadListener, NativeAdEventListener, NativeAdViewBinder, NativeAdAssets, NativeAdWarning, NativeAdOptions, SliderAd, SliderAdLoader, SliderAdLoadListener, FeedAd, FeedAdAdapter, FeedAdAppearance, FeedAdLoadListener, FeedAdEventListener |
| Instream | com.yandex.mobile.ads.instream.* |
InstreamAd, InstreamAdLoader, InstreamAdLoadListener, InstreamAdListener, InstreamAdRequest, InstreamAdRequestError, YandexInstreamAds, InstreamAdBreakType, InstreamAdBreakEventListener |
| Instream Binder | com.yandex.mobile.ads.instream.binder.* |
InstreamAdBinder |
| Instream Ad Break | com.yandex.mobile.ads.instream.adbreak.* |
InstreamAdBreak, AdBreakData |
| Instream Player | com.yandex.mobile.ads.instream.player.* |
InstreamAdPlayer, InstreamAdPlayerListener |
| Instream Player Content | com.yandex.mobile.ads.instream.player.content.* |
VideoPlayer, VideoPlayerListener |
| Instream Player Ad | com.yandex.mobile.ads.instream.player.ad.* |
InstreamAdPlayer, InstreamAdPlayerListener, InstreamAdMimeTypes |
| Instream Media3 (ExoPlayer) | com.yandex.mobile.ads.instream.media3.* |
YandexAdsLoader — local ad insertion with Media3; import was instream.exoplayer.YandexAdsLoader on older 7.x |
| Feature | Old SDK 7.x | New SDK 8 | Full Package Path |
|---|---|---|---|
| Instream SDK Class | MobileInstream |
YandexInstreamAds |
com.yandex.mobile.ads.instream.YandexInstreamAds |
| Main SDK Class | MobileAds |
YandexAds |
com.yandex.mobile.ads.common.YandexAds |
| Ad Request | AdRequestConfiguration |
AdRequest |
com.yandex.mobile.ads.common.AdRequest |
| Ad Request Builder | AdRequestConfiguration.Builder |
AdRequest.Builder |
com.yandex.mobile.ads.common.AdRequest.Builder |
| Native Ad Request | NativeAdRequestConfiguration |
AdRequest |
com.yandex.mobile.ads.common.AdRequest |
| Instream Ad Request | InstreamAdRequestConfiguration |
InstreamAdRequest |
com.yandex.mobile.ads.instream.InstreamAdRequest |
| Instream ExoPlayer/Media3 ads insertion | YandexAdsLoader |
YandexAdsLoader (same class name) |
Import/package change: com.yandex.mobile.ads.instream.exoplayer.YandexAdsLoader → com.yandex.mobile.ads.instream.media3.YandexAdsLoader (use with AndroidX Media3 / DefaultMediaSourceFactory local ad insertion; not a replacement for InstreamAdLoader) |
| Ad Targeting | N/A (was in AdRequest.Builder) | AdTargeting |
com.yandex.mobile.ads.common.AdTargeting |
| Ad Targeting Builder | N/A | AdTargeting.Builder |
com.yandex.mobile.ads.common.AdTargeting.Builder |
| Native Template View | NativeBannerView |
NativeAdView |
com.yandex.mobile.ads.nativeads.NativeAdView |
| Native Template Appearance | NativeTemplateAppearance |
(removed - use custom layouts) | N/A |
| Size Constraint | SizeConstraint |
(removed) | N/A |
| Banner Event Listener | ClosableBannerAdEventListener |
BannerAdEventListener |
com.yandex.mobile.ads.banner.BannerAdEventListener |
| Feature | Old SDK 7.x | New SDK 8 |
|---|---|---|
| Initialization | MobileAds.initialize(...) |
YandexAds.initialize(...) |
| Instream Initialization | MobileInstream.setAdGroupPreloading(...) |
YandexInstreamAds.setAdGroupPreloading(...) |
| Banner Setup | banner.setAdUnitId(id)banner.setAdSize(size)banner.setBannerAdEventListener(listener)banner.loadAd(AdRequest.Builder().build()) |
banner.setAdSize(size)banner.setBannerAdEventListener(listener)banner.loadAd(AdRequest.Builder(id).build()) |
| Interstitial Load | loader.setAdLoadListener(listener)loader.loadAd(config) |
loader.loadAd(request, listener) |
| Native Load | loader.setNativeAdLoadListener(listener)loader.loadAd(config) |
loader.loadAd(request, listener) |
| Rewarded Load | loader.setAdLoadListener(listener)loader.loadAd(config) |
loader.loadAd(request, listener) |
| App Open Load | loader.setAdLoadListener(listener)loader.loadAd(config) |
loader.loadAd(request, listener) |
| Instream Load | loader.setInstreamAdLoadListener(listener)loader.loadInstreamAd(context, request) |
loader.loadAd(request, listener) (method renamed: loadInstreamAd → loadAd; context arg dropped — loader holds it internally) |
| Slider Load | loader.setSliderAdLoadListener(listener)loader.loadSlider(config) |
loader.loadAd(request, listener) orloader.loadAd(request, options, listener) |
| Bulk Native Load | loader.setNativeBulkAdLoadListener(listener)loader.loadAds(config, count) |
loader.loadAds(request, count, listener) |
| Banner Size (Sticky) | BannerAdSize.stickySize(context, width) |
BannerAdSize.sticky(context, width) |
| Banner Size (Inline) | BannerAdSize.inlineSize(context, width, maxHeight) |
BannerAdSize.inline(context, width, maxHeight) |
| Ad Show (Interstitial/Rewarded/AppOpen) | ad.setAdEventListener(listener)ad.show(activity) |
ad.setAdEventListener(listener)ad.show(activity) |
| Cancel / detach loading | loader.setAdLoadListener(null) (also used to detach and avoid stale callbacks) |
loader.cancelLoading() |
| Native Binding | try { ad.bindNativeAd(binder) } catch (e: NativeAdException) |
when (ad.bindNativeAd(binder)) { is AdBindingResult.Failure -> ..., is AdBindingResult.Success -> ... } |
| Feature | Old SDK 7.x | New SDK 8 | Full Type Path |
|---|---|---|---|
| Native Warning | ad.adAssets.warning: String? |
ad.adAssets.warning: NativeAdWarning?Use .value for text, .minimumRequiredArea for size |
com.yandex.mobile.ads.nativeads.NativeAdWarning |
| AdInfo Data | ad.infoad.adInfo.data |
ad.adInfo.extraData |
N/A |
| Creative ID | nativeAd.creativeId |
ad.adInfo.creatives.first().creativeId |
N/A |
| Campaign ID | nativeAd.campaignId |
ad.adInfo.creatives.first().campaignId |
N/A |
| Banner Ad Size | ad.adInfo.adSize |
banner.adSize (only for banner, removed for others) |
N/A |
| Feature | Old SDK 7.x | New SDK 8 |
|---|---|---|
| Age Restriction | MobileAds.setAgeRestrictedUser(value) |
YandexAds.setAgeRestricted(value) (renamed) |
| Location Consent | MobileAds.setLocationConsent(value) |
YandexAds.setLocationTracking(value) |
| User Consent | MobileAds.setUserConsent(value) |
YandexAds.setUserConsent(value) (unchanged) |
| Removed API | Alternative | Migration Action |
|---|---|---|
NativeBannerView |
NativeAdBannerView (from public sample) |
Copy NativeAdBannerView.kt + native_banner_ad_view.xml from the Yandex Mobile Ads public sample. Replace XML tag and update call sites: setAd() → bindNativeAd(), add release(). |
NativeTemplateAppearance |
Custom XML layout attributes | Delete all appearance builder code. Visual customization is now done directly via XML attributes on the child views inside NativeAdView. |
ButtonAppearance |
Button XML attributes |
Delete builder. Use android:textColor, android:background, android:textSize on your CTA Button. |
ImageAppearance |
ImageView XML attributes |
Delete builder. Use android:scaleType, android:layout_width, android:layout_height on your ImageView. |
LabelAppearance / TextAppearance |
TextView XML attributes |
Delete builder. Use android:textColor, android:textSize, android:fontFamily on your TextView. |
RatingAppearance |
Custom rating view attributes | Delete builder. Configure your custom rating view directly in XML. |
SizeConstraint |
Standard Android layout constraints | Delete builder. Use android:layout_width, android:layout_height, or ConstraintLayout constraints. |
ClosableBannerAdEventListener.onAdClosed() |
No direct replacement | Extract business logic to a separate method (e.g., fun onAdClosed()). Find where onAdClosed() was previously called in the app code and insert the new method call there. Add // FIXME_SDK8: verify invocation point comment. |
onLeftApplication() / onReturnedToApplication() |
Removed from listeners - extract business logic and remove @Override / override |
Delete method overrides completely |
AdRequest.Builder().setAge/Gender/Location() |
Move to AdTargeting.Builder(), pass via AdRequest.Builder().setTargeting() |
Extract targeting calls, wrap in AdTargeting.Builder(), pass to setTargeting() |
AdRequest.Builder().setShouldLoadImagesAutomatically() |
Move to NativeAdOptions for native ads |
Remove from AdRequest.Builder, pass to NativeAdLoader.loadAd(request, options, listener) where options = NativeAdOptions.Builder().setShouldLoadImagesAutomatically(value).build() |
BannerAdView.setAdUnitId() |
Pass adUnitId to AdRequest.Builder() constructor |
Remove setAdUnitId() call, extract value, pass to AdRequest.Builder(adUnitId) |
loader.setAdLoadListener(null) / setNativeAdLoadListener(null) / setInstreamAdLoadListener(null) (detach listener to cancel loading / avoid stale callbacks) |
loader.cancelLoading() |
setAdLoadListener is removed entirely, so any setAdLoadListener(listener) becomes the loadAd(request, listener) argument. But a setAdLoadListener(null) call has no loadAd equivalent — replace it with loader.cancelLoading(). Applies to InterstitialAdLoader, RewardedAdLoader, AppOpenAdLoader, NativeAdLoader, NativeBulkAdLoader, SliderAdLoader, InstreamAdLoader. |
NativeAdType.PROMO (enum constant) |
Removed — only CONTENT, APP_INSTALL, MEDIA remain in NativeAdType |
Remove NativeAdType.PROMO from when/switch branches; merge its behaviour with another branch (typically APP_INSTALL) or delete the case |
InrollQueueProvider |
Use instreamAd.instreamAdBreaks.filter { it.adBreakData.type == InstreamAdBreakType.INROLL } |
Remove provider instantiation, replace queue access with filter expression |
PauserollQueueProvider |
Use instreamAd.instreamAdBreaks.filter { it.adBreakData.type == InstreamAdBreakType.PAUSEROLL } |
Remove provider instantiation, replace queue access with filter expression |
InstreamAdBreak.invalidate() |
Removed - just remove from memory | Delete method calls completely |
Migration Steps:
setAdLoadListener(this) or setAdLoadListener(listener) callloadAd(request, listener)setAdLoadListener is removed, so a setAdLoadListener(null) call (typically used to detach the listener and cancel loading / avoid stale callbacks, e.g. in onDestroy) has NO loadAd argument to move into. Replace it with loader.cancelLoading(). Do not silently drop it — dropping it changes cleanup behavior and leaves the removed method as a compile error.Migration Steps:
setNativeAdLoadListener(listener) callloadAd() to accept two parameters: loadAd(request, listener)setNativeAdLoadListener is removed, so a setNativeAdLoadListener(null) call (typically used to detach the listener and cancel loading / avoid stale callbacks, e.g. in onDestroy) has NO loadAd argument to move into. Replace it with loader.cancelLoading(). Do not silently drop it — dropping it changes cleanup behavior and leaves the removed method as a compile error. (Same applies to NativeBulkAdLoader/SliderAdLoader with setNativeBulkAdLoadListener(null)/setSliderAdLoadListener(null).)Migration Steps:
setInstreamAdLoadListener(listener) callloadAd(request, listener) (method renamed: loadInstreamAd → loadAd; context is no longer passed, loader holds it internally)String to InstreamAdRequestErrorerror.description to get error messagesetInstreamAdLoadListener is removed, so a setInstreamAdLoadListener(null) call (typically used to detach the listener and cancel loading / avoid stale callbacks, e.g. in onDestroy) has NO loadAd argument to move into. Replace it with loader.cancelLoading(). Do not silently drop it — dropping it changes cleanup behavior and leaves the removed method as a compile error.Migration Steps:
ClosableBannerAdEventListener to BannerAdEventListeneronAdClosed() method override completelyoverride fun onAdClosed() to a separate method (e.g., fun onAdClosed())onAdClosed() was previously being called and insert the call to your new method there.// FIXME_SDK8: onAdClosed logic migrated from SDK 7.x - verify invocation point comment at the new call site.| Old SDK 7.x | New SDK 8 | Full Package Path |
|---|---|---|
com.yandex.mobile.ads.instream.InstreamAdBinder |
com.yandex.mobile.ads.instream.binder.InstreamAdBinder |
com.yandex.mobile.ads.instream.binder.InstreamAdBinder |
InstreamAdRequestConfiguration |
InstreamAdRequest |
com.yandex.mobile.ads.instream.InstreamAdRequest |
InstreamAdBreak |
adbreak.InstreamAdBreak |
com.yandex.mobile.ads.instream.adbreak.InstreamAdBreak |
inroll.Inroll |
adbreak.InstreamAdBreak |
com.yandex.mobile.ads.instream.adbreak.InstreamAdBreak |
pauseroll.Pauseroll |
adbreak.InstreamAdBreak |
com.yandex.mobile.ads.instream.adbreak.InstreamAdBreak |
InrollQueueProvider |
(removed - use instreamAd.instreamAdBreaks.filter) |
N/A |
PauserollQueueProvider |
(removed - use instreamAd.instreamAdBreaks.filter) |
N/A |
| Feature | Old SDK 7.x | New SDK 8 |
|---|---|---|
| Instream Load | loader.setInstreamAdLoadListener(listener)loader.loadInstreamAd(context, request) |
loader.loadAd(request, listener) (method renamed: loadInstreamAd → loadAd; context arg dropped — loader holds it internally) |
| Error Callback | onInstreamAdFailedToLoad(reason: String) |
onInstreamAdFailedToLoad(error: InstreamAdRequestError) - use error.description |
| Binder Player | InstreamAdBinder(context, ad, player, videoPlayer) |
Player is now optional: InstreamAdBinder(context, ad, null, videoPlayer) |
| Ad Break Prepare | adBreak.prepare(player) |
Player is optional: adBreak.prepare() or adBreak.prepare(player) |
| Queue Access | InrollQueueProvider(context, ad).queue.poll() |
instreamAd.instreamAdBreaks.filter { it.adBreakData.type == InstreamAdBreakType.INROLL }.getOrNull(index) |
InstreamAdPlayer interface has new required methods:
override val supportedMimeTypes: List<String> - return list of supported MIME typesInstreamAdMimeTypes: MP4, WEBM, DASH, HLS, etc.override fun bindPlayerView(container: FrameLayout) - add your player view to the provided container with MATCH_PARENT layout paramsonAdClosed() methodloadAd() instead of setAdLoadListener()loadAd() instead of setNativeAdLoadListener()onInstreamAdFailedToLoad(reason: String) → onInstreamAdFailedToLoad(error: InstreamAdRequestError)InrollEventListener → InstreamAdBreakEventListeneronInrollPrepared() → onInstreamAdBreakPrepared(), etc.onInrollError(reason: String) → onInstreamAdBreakError(reason: String)adUnitId) and reuse themnew ClassName() { ... } for anonymous classes in .java files, not Kotlin's object :null for Instream player parameters when SDK default is acceptablecom.yandex.mobile.ads.* importsnpx skills add yandexmobile/yandex-ads-sdk-android --skill migrate-yandex-ads-sdk-from-7-to-8 или скачайте ZIP-архив.Войдите, чтобы оставить комментарий.
Комментариев пока нет.