[interactive_media_ads] Adds support to define parameters that control the rendering of ads #8057
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
platform-android
platform-ios
p: interactive_media_ads
bparrishMines
changed the title
bparrishMines
commented
Nov 13, 2024
| /// ads manager. | ||
| /// | ||
| /// If null, the platform will decide the default value. | ||
| final bool? enablePreloading; |
There was a problem hiding this comment.
Note: This value defaults to false on Android and true on iOS. To prevent a breaking change, I made the value nullable to indicate the platform will handle the default. Same is true for the other fields.
bparrishMines
requested review from
stuartmorgan
and removed request for
stuartmorgan
stuartmorgan
requested changes
Nov 14, 2024
packages/interactive_media_ads/lib/src/ads_rendering_settings.dart
Outdated
Show resolved
Hide resolved
|
|
||
| /// The SDK will prioritize the media with MIME type on the list. | ||
| /// | ||
| /// If empty, the SDK will pick the media based on player capabilities. This |
There was a problem hiding this comment.
If empty has a special meaning that's the same as null, then we should make it non-nullable.
packages/interactive_media_ads/lib/src/ads_rendering_settings.dart
Outdated
Show resolved
Hide resolved
packages/interactive_media_ads/lib/src/platform_interface/platform_ads_rendering_settings.dart
Outdated
Show resolved
Hide resolved
| /// | ||
| /// If empty, the SDK will pick the media based on player capabilities. This | ||
| /// only refers to the mime types of videos to be selected for linear ads. | ||
| final List<String>? mimeTypes; |
There was a problem hiding this comment.
Only the documentation for iOS actually states what happens if it is empty. Android doesn't actually mention it:
If specified, the SDK will prioritize the media with MIME type on the list. If not specified,
the SDK will pick the media based on player capabilities. This only refers to the mime
types of videos to be selected for linear ads.
This is related to having a "don't set" option for optional native parameters.
There was a problem hiding this comment.
That's an implementation detail though; if we want empty to mean "the SDK decides" as the docs currently say, then we should map an empty list to not setting on platforms that treat null as not setting.
If we actually want to treat [] and null differently, then we need to explain what the difference is in the comments, ideally in a cross-platform way.
packages/interactive_media_ads/lib/src/platform_interface/platform_ads_rendering_settings.dart
Outdated
Show resolved
Hide resolved
| /// | ||
| /// Some modifications to the uiElements list may have no effect for specific | ||
| /// ads. | ||
| final Set<UIElement>? uiElements; |
There was a problem hiding this comment.
Same here. Not sure if there is a difference between setting to empty or not setting it all.
packages/interactive_media_ads/lib/src/platform_interface/ui_element.dart
Outdated
Show resolved
Hide resolved
stuartmorgan
approved these changes
Nov 18, 2024
| /// 15s. | ||
| Duration? get playAdsAfterTime => platform.params.playAdsAfterTime; | ||
|
|
||
| /// Sets the ad UI elements to be rendered by the IMA SDK. |
There was a problem hiding this comment.
"Sets the" -> "The" (since it's a getter)
| /// The SDK will prioritize the media with MIME type on the list. | ||
| /// | ||
| /// This only refers to the mime types of videos to be selected for linear | ||
| /// ads. |
There was a problem hiding this comment.
If we're keeping nullability, this needs a comment explaining that null means platform default.
| /// | ||
| /// Some modifications to the uiElements list may have no effect for specific | ||
| /// ads. | ||
| Set<AdUIElement>? get uiElements => platform.params.uiElements; |
There was a problem hiding this comment.
Same comment about nullability.
bparrishMines
added
the
autosubmit
auto-submit
bot
removed
the
autosubmit
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/flutter
that referenced
this pull request
Nov 20, 2024
…hat control the rendering of ads (flutter/packages#8057)
github-merge-queue bot
pushed a commit
to flutter/flutter
that referenced
this pull request
Nov 20, 2024
flutter/packages@fc4adc7...e95f6d8 2024-11-19 louisehsu@google.com [in_app_purchase_storekit] disallow ios versions lower than supported from enabling storekit (flutter/packages#8110) 2024-11-19 49699333+dependabot[bot]@users.noreply.github.com [interactive_media_ads]: Bump com.google.ads.interactivemedia.v3:interactivemedia from 3.35.1 to 3.36.0 in /packages/interactive_media_ads/android (flutter/packages#8046) 2024-11-19 49699333+dependabot[bot]@users.noreply.github.com [interactive_media_ads]: Bump androidx.annotation:annotation from 1.8.2 to 1.9.1 in /packages/interactive_media_ads/android (flutter/packages#7980) 2024-11-19 10687576+bparrishMines@users.noreply.github.com [webview_flutter_android] Updates plugin to use `ProxyApis`s (flutter/packages#7794) 2024-11-19 10687576+bparrishMines@users.noreply.github.com [interactive_media_ads] Adds support to define parameters that control the rendering of ads (flutter/packages#8057) 2024-11-19 engine-flutter-autoroll@skia.org Roll Flutter from b3818f6 to 8536b96 (22 revisions) (flutter/packages#8124) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages-flutter-autoroll Please CC flutter-ecosystem@google.com on the revert to ensure that a human is aware of the problem. To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
sinyu1012
added a commit
to sinyu1012/packages
that referenced
this pull request
Nov 22, 2024
* main: (64 commits) [quick_actions_plaform_interface] add localizedSubtitle (flutter#8112) [tools] Don't check license of generated Swift package (flutter#8137) Roll Flutter from 8536b96ebb3e to 93d772c5cdd8 (37 revisions) (flutter#8147) [go_router] Fix: Consistent PopScope Handling on Root Routes issue #140869 (flutter#8045) [in_app_purchase_storekit] fix price displayed with wrong precision (flutter#8127) [pigeon] Removes the `@protected` annotation from the InstanceManager field of the `PigeonInternalProxyApiBaseClass` (flutter#8125) [google_maps_flutter] Use structured Pigeon data on iOS (flutter#8142) [vector_graphics] handle errors from bytes loader (flutter#8080) [flutter_svg] Fix SvgNetworkLoader not closing internal http client (flutter#8126) [video_player_avfoundation] send video load failure even when eventsink was initialized late (flutter#7194) [flutter_markdown] enable Wasm support (flutter#8120) Reverts "[url_launcher] Add Swift Package Manager integration to example app (flutter#8128)" (flutter#8136) [url_launcher] Add Swift Package Manager integration to example app (flutter#8128) [pigeon] Enable example app build in CI (flutter#8119) [in_app_purchase_storekit] disallow ios versions lower than supported from enabling storekit (flutter#8110) [interactive_media_ads]: Bump com.google.ads.interactivemedia.v3:interactivemedia from 3.35.1 to 3.36.0 in /packages/interactive_media_ads/android (flutter#8046) [interactive_media_ads]: Bump androidx.annotation:annotation from 1.8.2 to 1.9.1 in /packages/interactive_media_ads/android (flutter#7980) [webview_flutter_android] Updates plugin to use `ProxyApis`s (flutter#7794) [interactive_media_ads] Adds support to define parameters that control the rendering of ads (flutter#8057) Roll Flutter from b3818f6b5979 to 8536b96ebb3e (22 revisions) (flutter#8124) ... # Conflicts: # packages/quick_actions/quick_actions_platform_interface/CHANGELOG.md
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
PlatformAdsManager.init(AdsManagerInitParams)to the correct sharedPlatformAdsManager.init(PlatformAdsRenderingSettings?)feature.Android: https://developers.google.com/interactive-media-ads/docs/sdks/android/client-side/api/reference/com/google/ads/interactivemedia/v3/api/BaseManager.html#init(com.google.ads.interactivemedia.v3.api.AdsRenderingSettings)
iOS: https://developers.google.com/interactive-media-ads/docs/sdks/ios/client-side/reference/Classes/IMAAdsManager#/c:objc(cs)IMAAdsManager(im)initializeWithAdsRenderingSettings:
The platform interface and implementation aren't exposed yet, so this change should not be breaking.
Fixes flutter/flutter#152253
Pre-launch Checklist
dart format.)[shared_preferences]pubspec.yamlwith an appropriate new version according to the pub versioning philosophy, or this PR is exempt from version changes.CHANGELOG.mdto add a description of the change, following repository CHANGELOG style, or this PR is exempt from CHANGELOG changes.///).If you need help, consider asking for advice on the #hackers-new channel on Discord.