Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kmcgill88/admob_flutter

Admob Flutter plugin that shows banner ads using native platform views.
https://github.com/kmcgill88/admob_flutter

admob admob-plugin android dart flutter ios monetization plugin

Last synced: 23 days ago
JSON representation

Admob Flutter plugin that shows banner ads using native platform views.

Host: GitHub
URL: https://github.com/kmcgill88/admob_flutter
Owner: kmcgill88
License: isc
Created: 2018-12-10T00:33:18.000Z (almost 6 years ago)
Default Branch: master
Last Pushed: 2024-08-12T05:04:32.000Z (3 months ago)
Last Synced: 2024-08-22T23:35:43.352Z (3 months ago)
Topics: admob, admob-plugin, android, dart, flutter, ios, monetization, plugin
Language: Dart
Homepage: https://pub.dartlang.org/packages/admob_flutter
Size: 329 KB
Stars: 435
Watchers: 16
Forks: 151
Open Issues: 113
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

        # Looking for Maintainers.

Unfortunately I haven't been able to keep up with demand for features and improvments. If you are interested in helping maintain this repo please create an issue requesting maintainer status. Or consider using the new [google_mobile_ads](https://pub.dev/packages/google_mobile_ads) by Google.

# admob_flutter

[![Build Status](https://app.bitrise.io/app/aab4844dfe687df4/status.svg?token=0rKyF3lAc5Q73hC9f3H0EQ)](https://app.bitrise.io/app/aab4844dfe687df4)

[![version](https://img.shields.io/badge/Awesome-Flutter-blue.svg?longCache=true&style=flat-square)](https://github.com/Solido/awesome-flutter/)

[![version](https://img.shields.io/pub/v/admob_flutter.svg?style=flat-square)](https://pub.dartlang.org/packages/admob_flutter)

[![GitHub stars](https://img.shields.io/github/stars/kmcgill88/admob_flutter.svg?style=social&label=Star)](https://github/kmcgill88/admob_flutter)

[![GitHub forks](	https://img.shields.io/github/forks/kmcgill88/admob_flutter.svg?style=social&label=Forks)](https://github/kmcgill88/admob_flutter)

[![GitHub issues](	https://img.shields.io/github/issues/kmcgill88/admob_flutter.svg?style=social&label=Issues)](https://github/kmcgill88/admob_flutter)

![Demo](https://i.imgur.com/zJC41es.gif)

A Flutter plugin that uses native platform views to show Admob banner ads!

This plugin also has support for Interstitial and Reward ads.

# Installation

- Add this to your package's pubspec.yaml file:

```yaml

dependencies:

  admob_flutter: ""

```

- Install it - You can install packages from the command line:

```sh

flutter pub get

```

## Android Specific Setup

### Update your AndroidManifest.xml

Add your AdMob App ID to your app's AndroidManifest.xml file by adding the `` tag shown below. You can find your App ID in the AdMob UI. For android:value insert your own AdMob App ID in quotes, as shown below.

You can use these test App ID's from Admob for development:

```

Android: ca-app-pub-3940256099942544~3347511713

iOS: ca-app-pub-3940256099942544~1458002511

```

```xml

  

    

  

```

## iOS Specific Setup

Update your `Info.plist` per [Firebase instructions](https://developers.google.com/admob/ios/quick-start#update_your_infoplist).

```xml

GADApplicationIdentifier

ca-app-pub-3940256099942544~1458002511

```

and add

```xml

io.flutter.embedded_views_preview

```

Starting from Beta 6, you also need to display the App Tracking Transparency authorization request for accessing the IDFA,

so you have to update your `Info.plist` to add the `NSUserTrackingUsageDescription` key with a custom message describing your usage.

Below is an example description text:

```xml

NSUserTrackingUsageDescription

This identifier will be used to deliver personalized ads to you.

```

See [Prepare for iOS 14+](https://developers.google.com/admob/ios/ios14) for more information.

You also need to update your `ios/Podfile` by adding `platform :ios, '9.0'` at the very top of your file.

### Initialize the plugin

First thing to do before attempting to show any ads is to initialize the plugin. You can do this in the earliest starting point of your app, your `main` function:

```dart

import 'package:admob_flutter/admob_flutter.dart';

void main() {

  WidgetsFlutterBinding.ensureInitialized();

  // Initialize without device test ids.

  Admob.initialize();

  // Or add a list of test ids.

  // Admob.initialize(testDeviceIds: ['YOUR DEVICE ID']);

}

```

If you're using iOS, you may also need to request the tracking authorization in order to display personalized ads:

```dart

// Run this before displaying any ad.

await Admob.requestTrackingAuthorization();

```

### Supported Platforms

- `0.3.0` >= iOS

- `0.2.0` >= AndroidX

### Supported Admob features

- Banner Ads

- Interstitial Ads

- Reward Ads

- Native Ads (Coming soon)

### Check out the [repository Wiki](https://github.com/kmcgill88/admob_flutter/wiki) for more info!

# FAQ

- Why doesn't the Admob Banner class have a dispose method?

    - TL;DR - It's called automatically for you. Longer reason see [94](https://github.com/kmcgill88/admob_flutter/issues/94)

- failed to load ad : 3

    - TL;DR - Things are working correctly, Admob didn't give you an ad. If the app id + ad unit is new, give it 24/48 hours. See:[161](https://github.com/kmcgill88/admob_flutter/issues/161) [stackoverflow](https://stackoverflow.com/questions/33566485/failed-to-load-ad-3)

    - See all [Admob codes](https://support.google.com/admob/thread/3494603?hl=en)

- Ads are not loading

    - TL;DR - Make sure you have the correct combination of id's per platform. See:[161](https://github.com/kmcgill88/admob_flutter/issues/161)

- Objective-C based project cannot build

    - TL;DR - You have to enable swift support for your flutter project. See: [stackoverflow](https://stackoverflow.com/questions/52244346/how-to-enable-swift-support-for-existing-project-in-flutter) and [123](https://github.com/kmcgill88/admob_flutter/issues/123)

- How do I manage consentement for users in the European Economic Area?

    - Pass `nonPersonalizedAds: true` to the classes constructor (`AdmobBanner`, `AdmobInterstitial` and `AdmobReward`) in order to not display personalized ads for users who don't give their consent. A way to ask users for their consent is to use the plugin [admob_consent](https://pub.dev/packages/admob_consent). Please note that the new recommended is to use the brand new UMP SDK ([Android](https://developers.google.com/admob/ump/android/quick-start), [iOS](https://developers.google.com/admob/ump/ios/quick-start)).

# Recipes

- [AppBar Banner](https://mcgilldevtech.com/2020/08/admob-flutter-appbar-banner-recipe/)

# Pull Requests

I welcome and encourage all pull requests. Here are some basic rules to follow to ensure timely addition of your request:

1.  Match the document style as closely as possible.

1.  Please keep PR titles easy to read and descriptive of changes, this will make them easier to review/merge.

1.  Pull requests _must_ be made against `master` branch for this repository.

1.  Check for existing [issues](https://github.com/kmcgill88/admob_flutter/issues) first, before filing an issue.

1.  Check the [project board](https://github.com/kmcgill88/admob_flutter/projects/1), before filing an issue.

1.  Read the [FAQ](https://github.com/kmcgill88/admob_flutter#faq), before filing an issue.

1.  Have fun!