Unity Ads Plugin
Unity Ads plugin for Flutter Applications. This plugin is able to display Unity Banner Ads and Unity Video Ads.
Table of Contents
Getting Started
1. Initialization
UnityAds.init(
gameId: 'PROJECT_GAME_ID',
onComplete: () => print('Initialization Complete'),
onFailed: (error, message) => print('Initialization Failed: $error $message'),
);
Set your Game ID.
For testing purposes, set testMode to true.
UnityAds.isInitialized() can be used to check if the SDK is initialized successfully.
Android only: To change ads behavior in Firebase Test Lab, use firebaseTestLabMode parameter. Possible values:
| Mode | Description |
|---|---|
| disableAds | Ads are not displayed in the Firebase Test Lab (default) |
| showAdsInTestMode | Ads are displayed in test mode. |
| showAds | Real ads are displayed if testMode is false. |
2. Show Rewarded/Interstitial Video Ad
Load a video ad before showing it.
UnityAds.load(
placementId: 'PLACEMENT_ID',
onComplete: (placementId) => print('Load Complete $placementId'),
onFailed: (placementId, error, message) => print('Load Failed $placementId: $error $message'),
);
Show a loaded ad.
UnityAds.showVideoAd(
placementId: 'PLACEMENT_ID',
onStart: (placementId) => print('Video Ad $placementId started'),
onClick: (placementId) => print('Video Ad $placementId click'),
onSkipped: (placementId) => print('Video Ad $placementId skipped'),
onComplete: (placementId) => print('Video Ad $placementId completed'),
onFailed: (placementId, error, message) => print('Video Ad $placementId failed: $error $message'),
);
Server-to-server Redeem Callbacks
UnityAds.showVideoAd has a serverId parameter. To use server-to-server callbacks, set this parameter. Read more on docs.unity.com.
3. Show Banner Ad
Place UnityBannerAd widget in your app.
UnityBannerAd(
placementId: 'PLACEMENT_ID',
onLoad: (placementId) => print('Banner loaded: $placementId'),
onClick: (placementId) => print('Banner clicked: $placementId'),
onShown: (placementId) => print('Banner shown: $placementId'),
onFailed: (placementId, error, message) => print('Banner Ad $placementId failed: $error $message'),
)
Privacy Consent
Read more about privacy consent in the Unity Ads documentation.
Use the following code to pass the appropriate consent flags to the Unity Ads SDK:
UnityAds.setPrivacyConsent(<Privacy Consent type>, true)
Donate
If you find this package helpful and would like to support its continued development, please consider making a donation. Your contributions are greatly appreciated and motivate the further enhancement of this and other plugins.
Your support helps in maintaining and improving this package, ensuring it remains up-to-date and useful for the community.
Thank you for your generosity!