Skip to content

[interactive_media_ads] Updates readme to clarify currently supported features #7398

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Aug 16, 2024
Merged

[interactive_media_ads] Updates readme to clarify currently supported features #7398

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cbc7098
readme update
bparrishMines Aug 13, 2024
b515395
Merge branch 'main' of github.com:flutter/packages into ima_readme
bparrishMines Aug 13, 2024
e09042e
remove reference to issue tracker
bparrishMines Aug 15, 2024
c841502
Merge branch 'main' of github.com:flutter/packages into ima_readme
bparrishMines Aug 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/interactive_media_ads/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
## 0.1.2+1

* Updates README to clarify supported features and link to issues tracker.

## 0.1.2

* Adds support for all `AdEventType`s and ad data. See `AdEvent.adData`.
Expand Down
6 changes: 5 additions & 1 deletion packages/interactive_media_ads/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,11 @@ a separate video player positioned on top of the app's content video player.
|-------------|---------|-------|
| **Support** | SDK 21+ | 12.0+ |

**This package is still in development.**
**NOTE:**
* The initial release for this package supports linear pre-roll video ads on iOS and Android
* platforms. Please view/report any issues [here](https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+interactive_media_ads%22).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the reason for the issue link? We have the metadata set that causes pub.dev to put an issues link in the sidebar, and that's where we expect clients to be seeing the README.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, that's right. That was my suggestion. I forgot that is already included in the pubspec. I removed it from here.

cc @harold1208 to confirm this is fine as well

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Confirming this is fine, thanks!

* Companion ads, Background Audio ads and Google Dynamic Ad Insertion methods are currently not
* supported.

## IMA client-side overview

Expand Down
2 changes: 1 addition & 1 deletion .../android/src/main/kotlin/dev/flutter/packages/interactive_media_ads/AdsRequestProxyApi.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ class AdsRequestProxyApi(override val pigeonRegistrar: ProxyApiRegistrar) :
*
* This must match the version in pubspec.yaml.
*/
const val pluginVersion = "0.1.2"
const val pluginVersion = "0.1.2+1"
}

override fun setAdTagUrl(pigeon_instance: AdsRequest, adTagUrl: String) {
Expand Down
2 changes: 1 addition & 1 deletion .../ios/interactive_media_ads/Sources/interactive_media_ads/AdsRequestProxyAPIDelegate.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ class AdsRequestProxyAPIDelegate: PigeonApiDelegateIMAAdsRequest {
/// The current version of the `interactive_media_ads` plugin.
///
/// This must match the version in pubspec.yaml.
static let pluginVersion = "0.1.2"
static let pluginVersion = "0.1.2+1"

func pigeonDefaultConstructor(
pigeonApi: PigeonApiIMAAdsRequest, adTagUrl: String, adDisplayContainer: IMAAdDisplayContainer,
Expand Down
2 changes: 1 addition & 1 deletion packages/interactive_media_ads/pubspec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: interactive_media_ads
description: A Flutter plugin for using the Interactive Media Ads SDKs on Android and iOS.
repository: https://github.com/flutter/packages/tree/main/packages/interactive_media_ads
issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+interactive_media_ads%22
version: 0.1.2 # This must match the version in
version: 0.1.2+1 # This must match the version in
# `android/src/main/kotlin/dev/flutter/packages/interactive_media_ads/AdsRequestProxyApi.kt` and
# `ios/interactive_media_ads/Sources/interactive_media_ads/AdsRequestProxyAPIDelegate.swift`

Expand Down