JarCastingSHAREit Audience Network Android Document
Get Started with San Open SDK
Welcome to San Ad! This navigation will provide the comprehensive guidelines including the SDK integration document, Midas platform's configuration guides, advanced features and classic monetization cases, which will navigate you to use San Open Mediation quickly and maximize your monetization.
Aggregate twelve mainstream online advertising platforms including AdColony, Admob, AppLovin, Facebook, Fyber, InMobi, Ironsource, Mintegral, Mopub, TopOn, UnityAds, Vungle with native, banner , interstitial and rewarded video Ad available.
Integrate the San SDK for Android
Prerequisites
- Use Android Studio 3.2 or higher
- Support androidX
- minSdkVersion 16 or higher
- compileSdkVersion 28 or higher
Step 1. Download the San Ad Android SDK
The San Open SDK is available as an AAR via Bintray.To add the san-sdk dependency, open your project and update the app module’s build.gradle to have the following repositories and dependencies:
The LATEST_VERSION
repositories {
// ... other project repositories
maven {url "https://dl.bintray.com/sunitsdk/SUnit"}// San open sdk
}
//...
dependencies {
// ... other project dependencies
api "com.sunit:san-sdk:LATEST_VERSION"// San open sdk
}
To support Java 8, add the language feature support:
android {
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
}
Step 2.Update Your Android Manifest
Update your AndroidManifest.xml in order to complete the SDK integration. Add the following permissions and activity declarations according to the bundle you are integrating.
- Declare the following permissions:
<!-- Required permissions -->
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<!-- Optional permissions. Will pass Lat/Lon values when available. Choose either Coarse or Fine -->
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"/>
Step 3：Add network_security_config.xml
Oct 01, 2020 - Android 9.0 (API 28) blocks cleartext (non-HTTPS) traffic by default, which can prevent ads from serving correctly. To mitigate that, publishers whose apps run on Android 9.0 or above should ensure to add a network security config file. Doing so allowlists cleartext traffic and allows non-HTTPS ads to serve.
-
In your AndroidManifest.xml file, add the following:
<manifest> <application ... android:networkSecurityConfig="@xml/network_security_config" ...> </application> </manifest> -
In your
network_security_config.xmlfile, add abase-configthat setscleartextTrafficPermittedtotrue:<?xml version="1.0" encoding="utf-8"?> <network-security-config> ... <base-config cleartextTrafficPermitted="true"> <trust-anchors> <certificates src="system"/> </trust-anchors> </base-config> ... </network-security-config>
Step 4. Configure Ad Placement in Your App
Once you’ve completed the above steps, you can start displaying ads in your application by configuring the PlacementIds as shown in the link below for your ad format:
Initialize
After you have integrated the San open SDK and created an ad placement, you must call SanAd.init() before you send any ad requests. Initialization is required for a number of new functionalities:
It is recommended to initialize in Application onCreate()
public class MyApplication extends MultiDexApplication {
@Override
public void onCreate() {
super.onCreate();
SanAd.init(this);
}
}
Banner Ads
Banner ads usually appear at the top or bottom of your app’s screen. Adding one to your app takes just a few lines of code.
Prerequisites
Before integrating banner ads in your app:
- create an account, create an App, and create an PlacementId using the format ‘Banner’.
- Follow our steps to Integrate the San SDK for Android into your project.
- Integrated the San Ad open SDK
Loading Banner Ads in Your App
Step 1.Define a Slot for Your Banner Ad in Your XML Layout
Start by including this XML block to your Activity’s or Fragment’s layout. We will fill in the details later:
<com.san.ads.SanBannerView
android:layout_width=""
android:layout_height=""/>
Step 2. Load an Ad Into the Banner Slot
Next, in your Activity or Fragment code, declare an instance variable for your SanBannerView：
private SanBannerView banner;
You should already have created an ad placement on Midas’s site and received an Ad Placement ID. You’ll use it now to identify that ad placementId in your app and request ads from Midas that are relevant for your users.
In your Activity’s onCreate() or your Fragment’s onCreateView() method, set your SanBannerView placementId, then simply call loadAd() to fetch and display the ad:
banner = (SanBannerView)findViewById(R.id.adview);
banner.setAdUnitId(placementId);
banner.setAdSize(adSize);
banner.loadAd();
When the hosting Activity or Fragment is destroyed, be sure to also destroy the SanBannerView by calling:
banner.destory();
Using the Delegate
banner.setBannerAdListener(new SanBannerView.BannerAdListener() {
@Override
public void onBannerLoaded(@NonNull SanBannerView sanBannerView) {
//the banner has successfully retrieved an ad.
Log.d(TAG,"onBannerLoaded");
}
@Override
public void onBannerFailed(SanBannerView sanBannerView, AdException e) {
//the banner has failed to retrieve an ad.
Log.d(TAG,"onBannerFailed exception = " + e.getMessage());
}
@Override
public void onBannerClicked(SanBannerView sanBannerView) {
//the user has tapped on the banner.
Log.d(TAG,"onBannerClicked");
}
@Override
public void onBannerImpression(SanBannerView sanBannerView) {
//the banner has showed
Log.d(TAG,"onBannerImpression");
}
});
Ad Preload
Using the preload() to preload in advance reduces the load time at presentation time
banner.preload();
Native Ads
Native ads let you monetize your app in a way that’s consistent with its existing design. You can design the ad layout to be consistent with the look and feel of your app. The SDK automatically handles image caching and metrics tracking so you can focus on how, when, and where to display ads.
Prerequisites
Before integrating native ads into your app:
- create an account, create an App, and create an placementId using the format ‘Native’.
- Follow our steps to Integrate the San SDK for Android into your project.
- Integrated the San Ad open SDK
Step 1. Request the Native Ad
SanNative sanNative = new SanNative(getContext(), placementId, new SanNative.NativeNetworkListener() {
@Override
public void onNativeLoaded(BaseNativeAd nativeAd) {
// Called when the ad for the given placementId has loaded.
Log.d(TAG, "onNativeLoaded");
}
@Override
public void onNativeFailed(AdException e) {
// Called when a ad fails to load for the given placementId.
Log.d(TAG, "onNativeFailed e = " + e.getMessage() + " code = " + e.getCode());
}
@Override
public void onImpression(BaseNativeAd baseNativeAd) {
// Called when a ad shown
Log.d(TAG, "onImpression");
}
@Override
public void onClick(BaseNativeAd baseNativeAd) {
// Called when a ad is clicked
Log.d(TAG, "onClick");
}
});
sanNative.loadAd();//Request ad
Step 2：Create an XML layout
The Sample:
<?xml version="1.0" encoding="utf-8"?>
<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
android:id="@+id/native_outer_view"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:background="@android:color/white">
<ImageView
android:id="@+id/native_icon_image"
android:layout_width="64dp"
android:layout_height="64dp"
android:layout_alignParentStart="true"
android:layout_alignParentLeft="true"
android:layout_alignParentTop="true"
android:layout_marginStart="10dp"
android:layout_marginLeft="10dp"
android:layout_marginTop="10dp"
android:background="@null"
android:contentDescription="@null" />
<TextView
android:id="@+id/native_title"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_toEndOf="@+id/native_icon_image"
android:layout_toRightOf="@+id/native_icon_image"
android:layout_alignParentTop="true"
android:layout_marginTop="32dp"
android:layout_marginStart="8dp"
android:layout_marginLeft="8dp"
android:textColor="@android:color/darker_gray"
android:textStyle="bold" />
<TextView
android:id="@+id/native_text"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_below="@+id/native_icon_image"
android:layout_alignParentStart="true"
android:layout_alignParentLeft="true"
android:layout_marginStart="10dp"
android:layout_marginLeft="10dp"
android:layout_marginTop="10dp"
android:textColor="@android:color/darker_gray" />
<com.san.ads.MediaView
android:id="@+id/native_main_image"
android:layout_width="match_parent"
android:layout_height="200dp"
android:layout_below="@+id/native_text"
android:layout_alignParentStart="true"
android:layout_alignParentLeft="true"
android:layout_marginLeft="10dp"
android:layout_marginTop="10dp"
android:layout_marginRight="10dp"
android:background="@null"
android:scaleType="centerCrop" />
<Button
android:id="@+id/native_cta"
android:layout_width="70dp"
android:layout_height="wrap_content"
android:layout_alignParentEnd="true"
android:layout_alignParentRight="true"
android:layout_marginTop="10dp"
android:layout_marginEnd="10dp"
android:layout_marginRight="10dp"
android:background="@drawable/ads_button_bg"
android:clickable="true"
android:focusable="true"
android:singleLine="true"
android:textColor="@color/white"
android:textStyle="bold" />
<FrameLayout
android:id="@+id/ad_choices"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_alignParentEnd="true"
android:layout_alignParentTop="true"
android:layout_alignParentRight="true" />
</RelativeLayout>
Step 3：Show Native Ads
- Get BaseNativeAd to show
BaseNativeAd nativeAd;//The BaseNativeAd is obtained from onNativeLoaded()
TextView titleText = contentView.findViewById(R.id.native_title);
TextView contentText = contentView.findViewById(R.id.native_text);
TextView buttonView = contentView.findViewById(R.id.native_button);
ImageView iconImage = contentView.findViewById(R.id.native_icon_image);
MediaView mediaLayout = contentView.findViewById(R.id.native_main_image);
//text
titleText.setText(nativeAd.getTitle());
contentText.setText(nativeAd.getContent());
buttonView.setText(nativeAd.getCallToAction());
//icon
AdViewRenderHelper.loadImage(iconImage.getContext(), nativeAd.getIconUrl(), iconImage);
//media view
mediaLayout.loadMediaView(nativeAd);
//click list
List<View> clickViews = new ArrayList<>();
clickViews.add(titleText);
clickViews.add(contentText);
clickViews.add(buttonView);
clickViews.add(iconImage);
clickViews.add(mediaLayout);
//prepare
nativeAd.prepare(contentView, clickViews, null);
Ad Preload
Using the preload() to preload in advance reduces the load time at presentation time
nativeAd.preload();
Interstitial Ads
Interstitial ads provide full-screen experiences, commonly incorporating rich media to offer a higher level of interactivity compared to banner ads. Interstitials are typically shown during natural transitions in your app; for example, after completing a game level, or while waiting for a new view to load. Use the SanInterstitial object and its associated listeners to fetch and display interstitial ads in your app.
Prerequisites
- create an account, create an App, and create an Ad placement using the format ‘Interstitial’.
- Follow our steps to Integrate the San SDK for Android into your project.
- Integrated the San Ad open SDK
Load Interstitial Ads in Your App
Step 1. Create an Interstitial Ad
SanInterstitial interstitial = new SanInterstitial(getContext(), INTERSTITIAL_PLACEMENT_ID);
interstitial.setInterstitialAdListener(new SanInterstitial.InterstitialAdListener() {
@Override
public void onInterstitialLoaded(final SanInterstitial SanInterstitial) {
// The interstitial has been cached and is ready to be shown.
Log.d(TAG, "onInterstitialLoaded");
}
@Override
public void onInterstitialFailed(SanInterstitial SanInterstitial, AdException e) {
// The interstitial has failed to load.
Log.d(TAG,"onInterstitialFailed e = " + e.getMessage());
}
@Override
public void onInterstitialShown(SanInterstitial SanInterstitial) {
// The interstitial has been shown.
Log.d(TAG,"onInterstitialShown");
}
@Override
public void onInterstitialClicked(SanInterstitial SanInterstitial) {
Log.d(TAG,"onInterstitialClicked");
}
@Override
public void onInterstitialDismissed(SanInterstitial SanInterstitial) {
// The interstitial has being dismissed.
Log.d(TAG,"onInterstitialDismissed");
}
});
interstitial.load();//Request Ad
Step 2. Display an Interstitial Ad
If isReady() returns true, display the interstitial by calling the show() method
if(interstitial.isReady()){
interstitial.show();
}
Step 3：Destory
When the interstitial Ad dismissed use the destroy()
interstitial.destory();
Ad Preload
Using the preload() to preload in advance reduces the load time at presentation time
interstitial.preload();
Rewarded Video Ads
Rewarded video ads are a great way to keep users engaged in your app while earning ad revenue. The reward generally comes in the form of in-game currency (gold, coins, power-ups, etc.) and is distributed to the user after a successful video completion.
Prerequisites
- create an account, create an App, and create an Ad placement using the format ‘Rewarded Video’.
- Follow our steps to Integrate the San SDK for Android into your project.
- Integrated the San Ad open SDK
Basic Integration
Step 1： Request and Cache the Rewarded Video
SanRewardedAd rewardedAd = new SanRewardedAd(getContext(), REWARDED_PLACEMENT_ID);
rewardedAd.setRewardedAdListener(new SanRewardedAd.RewardedVideoAdListener() {
@Override
public void onRewardedAdLoaded(final SanRewardedAd SanRewardedAd) {
// Called when the video for the given placementId has loaded.
Log.d(TAG, "onRewardedAdLoaded");
}
@Override
public void onRewardedAdFailed(SanRewardedAd SanRewardedAd, AdException e) {
// Called when a video fails to load for the given placementId.
Log.d(TAG, "onRewardedAdFailed e = " + e.getMessage());
}
@Override
public void onRewardedAdShown(SanRewardedAd SanRewardedAd) {
// Called when a rewarded video starts playing.
Log.d(TAG, "onRewardedAdShown");
}
@Override
public void onRewardedAdClicked(SanRewardedAd SanRewardedAd) {
// Called when a rewarded video is clicked.
Log.d(TAG, "onRewardedAdClicked");
}
@Override
public void onRewardedVideoClosed(SanRewardedAd SanRewardedAd) {
// Called when a rewarded video is closed.
Log.d(TAG, "onRewardedVideoClosed");
}
@Override
public void onRewardedVideoCompleted(SanRewardedAd SanRewardedAd) {
// Called when a rewarded video is completed and the user should be rewarded.
Log.d(TAG, "onRewardedVideoCompleted");
}
});
rewardedAd.load();//Request ad
Step 2：Display an Rewarded Ad
If isReady() returns true, display the interstitial by calling the show() method
if (rewardedAd.isReady()) {
rewardedAd.show();
}
Step 3：Destory
When the Rewarded Ad dismissed use the destroy()
rewardedAd.destory();
Ad Preload
Using the preload() to preload in advance reduces the load time at presentation time
rewardedAd.preload();
Mediation
AdNetworks
- AdColony
- Admob
- AppLovin
- FacebookAudienceNetwork
- Fyber
- IronSource
- InMobi
- Mopub
- Mintegral
- TopOn
- UnityAds
- Vungle