Android Native Ad Unit - freestarcapital/SDK_documentation_Android GitHub Wiki
Freestar supports the Native Ad unit. Native ads are well suited for content-based or feed-based apps because developers can actually customize the ad layout to better match their user experience.
import com.freestar.android.ads.NativeAd;
...
NativeAd nativeAd = new NativeAd(this); //this Activity
nativeAd.setTemplate( com.freestar.android.ads.NativeAd.TEMPLATE_SMALL ); //or NativeAd.TEMPLATE_MEDIUM
nativeAd.setNativeAdListener(...);
nativeAd.loadAd( adRequest, placement);
//Note: you may pass in a "placement" parameter in loadAd but it requires prior remote staff setup
When the native ad is ready, the onNativeAdLoaded callback will occur.
@Override
public void onNativeAdLoaded(View nativeAd, String placement) {
//Note: Placement will be null if not specified in the original loadAd request.
((ViewGroup) findViewById(R.id.ad_container)).removeAllViews();
((ViewGroup) findViewById(R.id.ad_container)).addView(nativeAd); //Add the native ad to your container!
}
Another way to display native ads is to put NativeAd directly into your XML layout as follows. NOTE: If you choose this route, then you do not need any code in java or kotlin since the ad will automatically be fetched and displayed. Also, if you need to set targeting parameters in the AdRequest, then please use the programmatic approach (above) and do not put the native ad in the layout.
<com.freestar.android.ads.NativeAd xmlns:ads="http://schemas.android.com/apk/res-auto"
ads:FreestarNativeAdPlacement="test_placement"
ads:FreestarNativeAdTemplate="SMALL_TEMPLATE"
android:layout_width="match_parent"
android:layout_height="wrap_content" />
<com.freestar.android.ads.NativeAd xmlns:ads="http://schemas.android.com/apk/res-auto"
ads:FreestarNativeAdPlacement="test_placement_2"
ads:FreestarNativeAdTemplate="MEDIUM_TEMPLATE"
android:layout_width="match_parent"
android:layout_height="wrap_content" />
Freestar supports two native ad templates: small and medium
By default, you are not required to modify the native ad templates. However, if you want to modify, keep reading...
If you wish to modify the templates, get a copy here.
Copy res/layout/* to your app/src/main/res/layout folder
Copy res/values/* to your app/src/main/res/values folder
Copy res/drawable/* to your app/src/main/res/drawable folder
You may modify ANY of the above files to better meet your needs. However, when you modify freestar_medium_native_template.xml or freestar_small_native_template.xml please do not remove any elements or rename any id's.
You can also have multiple Native Ads templates in your app. Simply copy freestar_medium_native_template.xml or freestar_small_native_template.xml and rename them to something different in your res/layout folder.
For example, let's say you want your app to display 2 different medium sized Native Ads. Copy freestar_medium_native_template.xml to your layout folder and rename it to my_other_medium_native_template.xml (example)
Modify my_other_medium_native_template.xml however you desire without removing any of the original tags/ids. You can modify the height or width, colors, margins/paddings, re-arrange things, change fonts, etc.
To utilize the original native ad:
NativeAd originalNativeAd = new NativeAd(context); originalNativeAd.setTemplate( NativeAd.TEMPLATE_MEDIUM );
To display the new native ad:
NativeAd newNativeAd = new NativeAd(context); newNativeAd.setTemplate( NativeAd.TEMPLATE_MEDIUM ); newNativeAd.setCustomTemplateResourceId( R.layout.my_other_medium_native_template );
If your game or app is officially under the Google Play Families program, Freestar provides such support:
FreeStarAds.setGoogleFamilyPolicyMode( GoogleFamilyPolicyMode.app, true); //If your app is designed only for children //FreeStarAds.setGoogleFamilyPolicyMode( GoogleFamilyPolicyMode.mixed, false); //If your app is designed for families with children FreeStarAds.init(...);
If your app is not officially under the Google Play Families program, then you do not need to set the Google Family Policy mode.
/**
* Only set Google Families Policy Mode if your app is required to comply with Google Play’s
* Families Policy program.
*
* @param googleFamilyPolicyMode app: the app is child-directed and will not receive
* personalize or contextual ads.
* mixed: the app is directed at mixed audiences.
* none: (default) the app is not required to comply with Google
* Play's Family Policy
*
* @param onlyNonPersonalizedAds true: if 'mixed' mode, then only personalized or contextual ads
* may be served.
* false: if 'mixed' mode, then personalized or contextual ads
* may be served.
* note: if 'app' mode, then personalized or contextual ads
* may not be served regardless of this parameter.
*/
public static void setGoogleFamilyPolicyMode(GoogleFamilyPolicyMode googleFamilyPolicyMode,
boolean onlyNonPersonalizedAds)
If you use the above code, then our SDK will automatically and internally utilize Google methods:
setTagForChildDirectedTreatment( true )
setMaxAdContentRating( Rated_G )
Freestar SDK is GDPR compliant. In order for your users to be able to receive any ad fills in GDPR-affected countries, you, as a publisher, will need to implement a 3rd party Consent Management Platform (CMP). Freestar SDK will automatically detect user interactions with the CMP and act accordingly. Please see our Freestar GDPR Frequently Asked Questions for complete details and our recommended list of CMP service providers.
For Android, please use our test key XqjhRR for all your testing runs and enable test mode true. You will usually get 100% fill on all ad units. It is not recommended to use your production key for testing runs as that is strictly prohibited by our partners and bad things may happen to us on the business side of things.
Do not forget to uninstall and re-install your app when changing keys on your device.
When you are satisfied with your testing, please make a release build with your production key, and turn test mode off. Publish to store.
Are your automated tests failing after integrating Freestar Mediation Ads into your mobile application or game? Are you not sure it could be due to Freestar or something else? We have a feature called Automated Test Mode where you can run your automated tests to bypass Freestar or run Freestar in 'Limited Mediation' mode without making drastic changes to your code:
In your automated test suite code, before FreeStarAds.init is called:
FreeStarAds.setAutomatedTestMode( FreeStarAds.AutomatedTestMode.BYPASS_ALL_ADS )
//OR
FreeStarAds.setAutomatedTestMode( FreeStarAds.AutomatedTestMode.LIMITED_MEDIATION ) //only runs AdMob & GAM
Again, this is only for your automated tests and not for production use.
Final note when creating your release build: if you use proguard or minify, please add our proguard rules to your app proguard file.
