flet-ads 0.1.0.dev2__py3-none-any.whl → 0.2.0.dev37__py3-none-any.whl

flet_ads/__init__.py

@@ -1,10 +1,10 @@
-from flet_ads.banner import BannerAd
-from flet_ads.interstitial import InterstitialAd
+from .banner_ad import BannerAd
+from .base_ad import BaseAd
+from .interstitial_ad import InterstitialAd
+from .types import (  # NativeAdTemplateStyle,; NativeAdTemplateTextStyle,; NativeAdTemplateType,; NativeTemplateFontStyle,
+    AdRequest,
+    PaidAdEvent,
+    PrecisionType,
+)
 
-# from flet_ads.native import (
-#     NativeAd,
-#     NativeAdTemplateStyle,
-#     NativeAdTemplateTextStyle,
-#     NativeAdTemplateType,
-#     NativeTemplateFontStyle,
-# )
+# from .native_ad import NativeAd

flet_ads/banner_ad.py

@@ -0,0 +1,29 @@
+import flet as ft
+
+from .base_ad import BaseAd
+from .types import PaidAdEvent
+
+
+@ft.control("BannerAd")
+class BannerAd(BaseAd):
+    """
+    Displays a banner ad.
+
+    Raises:
+        AssertionError: When using this control on a web and/or non-mobile platform.
+    """
+
+    on_will_dismiss: ft.OptionalControlEventHandler["BannerAd"] = None
+    """
+    Called before dismissing a full screen view.
+
+    Note:
+        Only available on iOS.
+    """
+
+    on_paid: ft.OptionalControlEventHandler[PaidAdEvent["BannerAd"]] = None
+    """
+    Called when this ad is estimated to have earned money.
+
+    Available for allowlisted accounts only.
+    """

flet_ads/base_ad.py

@@ -1,174 +1,67 @@
-from typing import Any, Optional, Union
-
-from flet.core.animation import AnimationValue
-from flet.core.constrained_control import ConstrainedControl
-from flet.core.control import OptionalNumber
-from flet.core.ref import Ref
-from flet.core.types import (
-    OffsetValue,
-    OptionalControlEventCallable,
-    PagePlatform,
-    ResponsiveNumber,
-    RotateValue,
-    ScaleValue,
-)
-
-
-class BaseAd(ConstrainedControl):
-    def __init__(
-        self,
-        unit_id: str,
-        on_load: OptionalControlEventCallable = None,
-        on_error: OptionalControlEventCallable = None,
-        on_open: OptionalControlEventCallable = None,
-        on_close: OptionalControlEventCallable = None,
-        on_impression: OptionalControlEventCallable = None,
-        on_click: OptionalControlEventCallable = None,
-        on_will_dismiss: OptionalControlEventCallable = None,
-        #
-        # ConstrainedControl
-        #
-        ref: Optional[Ref] = None,
-        key: Optional[str] = None,
-        width: OptionalNumber = None,
-        height: OptionalNumber = None,
-        left: OptionalNumber = None,
-        top: OptionalNumber = None,
-        right: OptionalNumber = None,
-        bottom: OptionalNumber = None,
-        expand: Union[None, bool, int] = None,
-        expand_loose: Optional[bool] = None,
-        col: Optional[ResponsiveNumber] = None,
-        opacity: OptionalNumber = None,
-        rotate: RotateValue = None,
-        scale: ScaleValue = None,
-        offset: OffsetValue = None,
-        aspect_ratio: OptionalNumber = None,
-        animate_opacity: AnimationValue = None,
-        animate_size: AnimationValue = None,
-        animate_position: AnimationValue = None,
-        animate_rotation: AnimationValue = None,
-        animate_scale: AnimationValue = None,
-        animate_offset: AnimationValue = None,
-        on_animation_end: OptionalControlEventCallable = None,
-        tooltip: Optional[str] = None,
-        visible: Optional[bool] = None,
-        disabled: Optional[bool] = None,
-        data: Any = None,
-    ):
-        ConstrainedControl.__init__(
-            self,
-            ref=ref,
-            key=key,
-            width=width,
-            height=height,
-            left=left,
-            top=top,
-            right=right,
-            bottom=bottom,
-            expand=expand,
-            expand_loose=expand_loose,
-            col=col,
-            opacity=opacity,
-            rotate=rotate,
-            scale=scale,
-            offset=offset,
-            aspect_ratio=aspect_ratio,
-            animate_opacity=animate_opacity,
-            animate_size=animate_size,
-            animate_position=animate_position,
-            animate_rotation=animate_rotation,
-            animate_scale=animate_scale,
-            animate_offset=animate_offset,
-            on_animation_end=on_animation_end,
-            tooltip=tooltip,
-            visible=visible,
-            disabled=disabled,
-            data=data,
-        )
-
-        self.on_load = on_load
-        self.on_error = on_error
-        self.on_open = on_open
-        self.on_close = on_close
-        self.on_impression = on_impression
-        self.on_click = on_click
-        self.on_will_dismiss = on_will_dismiss
-        self.unit_id = unit_id
+from dataclasses import field
+
+import flet as ft
+
+from flet_ads.types import AdRequest
+
+
+@ft.control
+class BaseAd(ft.Control):
+    """
+    Base class for all ad controls in Flet Ads package.
+
+    Raises:
+        AssertionError: When using this control on a web and/or non-mobile platform.
+    """
+
+    unit_id: str
+    """
+    Ad unit ID for this ad.
+    """
+
+    request: AdRequest = field(default_factory=lambda: AdRequest())
+    """
+    Targeting information used to fetch an Ad.
+    """
+
+    on_load: ft.OptionalControlEventHandler["BaseAd"] = None
+    """
+    Called when this ad is loaded successfully.
+    """
+
+    on_error: ft.OptionalControlEventHandler["BaseAd"] = None
+    """
+    Called when an ad request failed.
+    
+    Event handler argument `data` property contains information about the error.
+    """
+
+    on_open: ft.OptionalControlEventHandler["BaseAd"] = None
+    """
+    Called when this ad opens up.
+    
+    A full screen view/overlay is presented in response to the user clicking
+    on an ad. You may want to pause animations and time sensitive
+    interactions.
+    """
+
+    on_close: ft.OptionalControlEventHandler["BaseAd"] = None
+    """
+    Called when the full screen view has been closed. You should restart
+    anything paused while handling [`on_open`][..].
+    """
+
+    on_impression: ft.OptionalControlEventHandler["BaseAd"] = None
+    """
+    Called when an impression occurs on this ad.
+    """
+
+    on_click: ft.OptionalControlEventHandler["BaseAd"] = None
+    """
+    Called when this ad is clicked.
+    """
 
     def before_update(self):
-        assert self.page.platform in [
-            PagePlatform.ANDROID,
-            PagePlatform.IOS,
-        ], f"{self.__class__.__name__} is only supported on Mobile (Android and iOS). "
-
-    @property
-    def unit_id(self) -> str:
-        return self._get_attr("unitId")
-
-    @unit_id.setter
-    def unit_id(self, value: str):
-        self._set_attr("unitId", value)
-
-    # on_load
-    @property
-    def on_load(self):
-        return self._get_event_handler("load")
-
-    @on_load.setter
-    def on_load(self, handler):
-        self._add_event_handler("load", handler)
-
-    # on_error
-    @property
-    def on_error(self):
-        return self._get_event_handler("error")
-
-    @on_error.setter
-    def on_error(self, handler):
-        self._add_event_handler("error", handler)
-
-    # on_open
-    @property
-    def on_open(self):
-        return self._get_event_handler("open")
-
-    @on_open.setter
-    def on_open(self, handler):
-        self._add_event_handler("open", handler)
-
-    # on_close
-    @property
-    def on_close(self):
-        return self._get_event_handler("close")
-
-    @on_close.setter
-    def on_close(self, handler):
-        self._add_event_handler("close", handler)
-
-    # on_click
-    @property
-    def on_click(self):
-        return self._get_event_handler("click")
-
-    @on_click.setter
-    def on_click(self, handler):
-        self._add_event_handler("click", handler)
-
-    # on_impression
-    @property
-    def on_impression(self):
-        return self._get_event_handler("impression")
-
-    @on_impression.setter
-    def on_impression(self, handler):
-        self._add_event_handler("impression", handler)
-
-    # on_will_dismiss
-    @property
-    def on_will_dismiss(self):
-        return self._get_event_handler("willDismiss")
-
-    @on_will_dismiss.setter
-    def on_will_dismiss(self, handler):
-        self._add_event_handler("willDismiss", handler)
+        assert (
+            not self.page.web and self.page.platform.is_mobile()
+        ), f"{self.__class__.__name__} is only supported on Mobile (Android and iOS)"

flet_ads/interstitial_ad.py

@@ -0,0 +1,21 @@
+import asyncio
+
+import flet as ft
+
+from .base_ad import BaseAd
+
+
+@ft.control("InterstitialAd")
+class InterstitialAd(BaseAd):
+    """
+    Displays a full-screen interstitial ad.
+
+    Raises:
+        AssertionError: When using this control on a web and/or non-mobile platform.
+    """
+
+    def show(self):
+        asyncio.create_task(self.show_async())
+
+    async def show_async(self):
+        await self._invoke_method_async("show")

flet_ads/native_ad.py

@@ -0,0 +1,32 @@
+import flet as ft
+
+from .banner_ad import BannerAd
+from .types import NativeAdTemplateStyle
+
+__all__ = ["NativeAd"]
+
+
+@ft.control("NativeAd")
+class NativeAd(BannerAd):
+    """
+    Renders a native ad.
+
+    Raises:
+        AssertionError: When neither [`factory_id`][..] nor [`template_style`][..] is set.
+    """
+
+    factory_id: str = None
+    """
+    An identifier for the factory that creates the Platform view.
+    """
+
+    template_style: NativeAdTemplateStyle = None
+    """
+    A style for the native ad template.
+    """
+
+    def before_update(self):
+        super().before_update()
+        assert (
+            self.factory_id is not None or self.template_style is not None
+        ), "factory_id or template_style must be set"

flet_ads/types.py

@@ -0,0 +1,129 @@
+from dataclasses import dataclass
+from enum import Enum
+from typing import Optional
+
+import flet as ft
+
+__all__ = [
+    "PrecisionType",
+    "PaidAdEvent",
+    "AdRequest",
+    "NativeAdTemplateType",
+    "NativeTemplateFontStyle",
+    "NativeAdTemplateTextStyle",
+    "NativeAdTemplateStyle",
+]
+
+
+class PrecisionType(Enum):
+    UNKNOWN = "unknown"
+    """An ad value with unknown precision."""
+
+    ESTIMATED = "estimated"
+    """An ad value estimated from aggregated data."""
+
+    PUBLISHER_PROVIDED = "publisherProvided"
+    """A publisher-provided ad value, such as manual CPMs in a mediation group."""
+
+    PRECISE = "precise"
+    """The precise value paid for this ad."""
+
+
+@dataclass
+class PaidAdEvent(ft.Event[ft.EventControlType]):
+    """
+    Event data for paid ad events.
+    """
+
+    value: float
+    """
+    The monetary value of the ad.
+    """
+
+    precision: PrecisionType
+    """
+    The precision of the ad value.
+    """
+
+    currency_code: str
+    """
+    The currency code of the ad value.
+    """
+
+
+@dataclass
+class AdRequest:
+    """
+    Targeting info per the AdMob API.
+
+    This class's properties mirror the native AdRequest API. See for example:
+    [AdRequest.Builder for Android](https://developers.google.com/android/reference/com/google/android/gms/ads/AdRequest.Builder).
+    """
+
+    keywords: Optional[list[str]] = None
+    """
+    Words or phrases describing the current user activity.
+    """
+
+    content_url: Optional[str] = None
+    """
+    URL string for a webpage whose content matches the app’s primary content.
+
+    This webpage content is used for targeting and brand safety purposes.
+    """
+
+    neighboring_content_urls: Optional[list[str]] = None
+    """
+    URLs representing web content near an ad.
+    """
+
+    non_personalized_ads: Optional[bool] = None
+    """
+    Non-personalized ads are ads that are not based on a user’s past behavior.
+
+    For more information: https://support.google.com/admob/answer/7676680?hl=en
+    """
+
+    http_timeout: Optional[int] = None
+    """
+    A custom timeout (in milliseconds) for HTTPS calls during an ad request.
+
+    Note:
+        This is only supported in Android. (ignored on iOS)
+    """
+
+    extras: Optional[dict[str, str]] = None
+    """
+    Extras to pass to the AdMob adapter.
+    """
+
+
+class NativeAdTemplateType(Enum):
+    SMALL = "small"
+    MEDIUM = "medium"
+
+
+class NativeTemplateFontStyle(Enum):
+    NORMAL = "normal"
+    BOLD = "bold"
+    ITALIC = "italic"
+    MONOSPACE = "monospace"
+
+
+@dataclass
+class NativeAdTemplateTextStyle:
+    size: Optional[ft.Number] = None
+    text_color: Optional[ft.ColorValue] = None
+    bgcolor: Optional[ft.ColorValue] = None
+    style: Optional[NativeTemplateFontStyle] = None
+
+
+@dataclass
+class NativeAdTemplateStyle:
+    template_type: NativeAdTemplateType = NativeAdTemplateType.MEDIUM
+    main_bgcolor: Optional[ft.ColorValue] = None
+    corner_radius: Optional[ft.Number] = None
+    call_to_action_text_style: Optional[NativeAdTemplateTextStyle] = None
+    primary_text_style: Optional[NativeAdTemplateTextStyle] = None
+    secondary_text_style: Optional[NativeAdTemplateTextStyle] = None
+    tertiary_text_style: Optional[NativeAdTemplateTextStyle] = None

flet_ads-0.2.0.dev37.dist-info/METADATA

@@ -0,0 +1,66 @@
+Metadata-Version: 2.4
+Name: flet-ads
+Version: 0.2.0.dev37
+Summary: Display Google Ads in Flet apps.
+Author-email: Flet contributors <hello@flet.dev>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://flet.dev
+Project-URL: Documentation, https://flet-dev.github.io/flet-ads
+Project-URL: Repository, https://github.com/flet-dev/flet-ads
+Project-URL: Issues, https://github.com/flet-dev/flet-ads/issues
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: flet>=0.70.0.dev0
+Dynamic: license-file
+
+# flet-ads
+
+[![pypi](https://img.shields.io/pypi/v/flet-ads.svg)](https://pypi.python.org/pypi/flet-ads)
+[![downloads](https://static.pepy.tech/badge/flet-ads/month)](https://pepy.tech/project/flet-ads)
+[![license](https://img.shields.io/github/license/flet-dev/flet-ads.svg)](https://github.com/flet-dev/flet-ads/blob/main/LICENSE)
+
+Display Google Ads in [Flet](https://flet.dev) apps.
+
+It is based on the [google_mobile_ads](https://pub.dev/packages/google_mobile_ads) Flutter package.
+
+## Documentation
+
+Detailed documentation to this package can be found [here](https://flet-dev.github.io/flet-ads/).
+
+## Platform Support
+
+This package supports the following platforms:
+
+| Platform | Supported |
+|----------|:---------:|
+| Windows  |     ❌     |
+| macOS    |     ❌     |
+| Linux    |     ❌     |
+| iOS      |     ✅     |
+| Android  |     ✅     |
+| Web      |     ❌     |
+
+## Installation
+
+To install the `flet-ads` package and add it to your project dependencies:
+
+- Using `uv`:
+    ```bash
+    uv add flet-ads
+    ```
+
+- Using `pip`:
+    ```bash
+    pip install flet-ads
+    ```
+    After this, you will have to manually add this package to your `requirements.txt` or `pyproject.toml`.
+
+- Using `poetry`:
+    ```bash
+    poetry add flet-ads
+    ```
+
+## Examples
+
+For examples, see [this](./examples)

flet_ads-0.2.0.dev37.dist-info/RECORD

@@ -0,0 +1,11 @@
+flet_ads/__init__.py,sha256=IJRqRlozCGkISTdcXX7xn7-jzUtp1yMp6y2msgpPR6g,316
+flet_ads/banner_ad.py,sha256=esnqiKAmeaLEpBSJfO1_z847FyKvTrtk3YypjRh8d0U,645
+flet_ads/base_ad.py,sha256=lYuEWwYVVd1qTmVFt02igcAS-g6tOcFzwbO4Li18mY0,1748
+flet_ads/interstitial_ad.py,sha256=KXGcf0bXIDDw4gPeo4O0vR3LK9wgRSa6gAzxPl40qNg,432
+flet_ads/native_ad.py,sha256=-4xOvEjaIWCWSQbgPX1JBpqOTBARN-cwaPPTPuQxCrQ,737
+flet_ads/types.py,sha256=q1Hpmu_w6afkG6ovLUgToWSRVb1Euf-OVlf52si00VM,3212
+flet_ads-0.2.0.dev37.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+flet_ads-0.2.0.dev37.dist-info/METADATA,sha256=dgXnm-O3WNEdG48xDiOURgwH5HiYmR7-uEo07l-ldhs,1870
+flet_ads-0.2.0.dev37.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+flet_ads-0.2.0.dev37.dist-info/top_level.txt,sha256=gv6ICx8xIfzUQalF99v9x0gh0g0R8EPksQFAknB3baM,9
+flet_ads-0.2.0.dev37.dist-info/RECORD,,

{flet_ads-0.1.0.dev2.dist-info → flet_ads-0.2.0.dev37.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.8.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

{flutter/flet_ads → flet_ads-0.2.0.dev37.dist-info/licenses}/LICENSE

@@ -198,4 +198,4 @@
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
-   limitations under the License.
+   limitations under the License.

{flet_ads-0.1.0.dev2.dist-info → flet_ads-0.2.0.dev37.dist-info}/top_level.txt

@@ -1,2 +1 @@
 flet_ads
-flutter

flet_ads/banner.py

@@ -1,110 +0,0 @@
-from typing import Any, Optional, Union
-
-from flet.core.animation import AnimationValue
-from flet.core.control import OptionalNumber
-from flet.core.ref import Ref
-from flet.core.types import (
-    OffsetValue,
-    OptionalControlEventCallable,
-    ResponsiveNumber,
-    RotateValue,
-    ScaleValue,
-)
-
-from flet_ads.base_ad import BaseAd
-
-
-class BannerAd(BaseAd):
-    """
-    Displays a banner ad.
-
-    -----
-
-    Online docs: https://flet.dev/docs/controls/bannerad
-    """
-
-    def __init__(
-        self,
-        unit_id: str,
-        on_load: OptionalControlEventCallable = None,
-        on_error: OptionalControlEventCallable = None,
-        on_open: OptionalControlEventCallable = None,
-        on_close: OptionalControlEventCallable = None,
-        on_impression: OptionalControlEventCallable = None,
-        on_click: OptionalControlEventCallable = None,
-        on_will_dismiss: OptionalControlEventCallable = None,
-        #
-        # ConstrainedControl
-        #
-        ref: Optional[Ref] = None,
-        key: Optional[str] = None,
-        width: OptionalNumber = None,
-        height: OptionalNumber = None,
-        left: OptionalNumber = None,
-        top: OptionalNumber = None,
-        right: OptionalNumber = None,
-        bottom: OptionalNumber = None,
-        expand: Union[None, bool, int] = None,
-        expand_loose: Optional[bool] = None,
-        col: Optional[ResponsiveNumber] = None,
-        opacity: OptionalNumber = None,
-        rotate: RotateValue = None,
-        scale: ScaleValue = None,
-        offset: OffsetValue = None,
-        aspect_ratio: OptionalNumber = None,
-        animate_opacity: AnimationValue = None,
-        animate_size: AnimationValue = None,
-        animate_position: AnimationValue = None,
-        animate_rotation: AnimationValue = None,
-        animate_scale: AnimationValue = None,
-        animate_offset: AnimationValue = None,
-        on_animation_end: OptionalControlEventCallable = None,
-        tooltip: Optional[str] = None,
-        visible: Optional[bool] = None,
-        disabled: Optional[bool] = None,
-        data: Any = None,
-    ):
-        BaseAd.__init__(
-            self,
-            unit_id=unit_id,
-            on_load=on_load,
-            on_error=on_error,
-            on_open=on_open,
-            on_close=on_close,
-            on_impression=on_impression,
-            on_click=on_click,
-            on_will_dismiss=on_will_dismiss,
-            #
-            # ConstrainedControl
-            #
-            ref=ref,
-            key=key,
-            width=width,
-            height=height,
-            left=left,
-            top=top,
-            right=right,
-            bottom=bottom,
-            expand=expand,
-            expand_loose=expand_loose,
-            col=col,
-            opacity=opacity,
-            rotate=rotate,
-            scale=scale,
-            offset=offset,
-            aspect_ratio=aspect_ratio,
-            animate_opacity=animate_opacity,
-            animate_size=animate_size,
-            animate_position=animate_position,
-            animate_rotation=animate_rotation,
-            animate_scale=animate_scale,
-            animate_offset=animate_offset,
-            on_animation_end=on_animation_end,
-            tooltip=tooltip,
-            visible=visible,
-            disabled=disabled,
-            data=data,
-        )
-
-    def _get_control_name(self):
-        return "banner_ad"