Cheetah Orion Ad Platform SDK Guide (for Android) V1.0

Transcription

1 Cheetah Orion Ad Platform SDK Guide (for Android) V1.0 Cheetah Mobile Date Version 1.0

2 1 Introduction Integration Workflow Integration Workflow Load Cheetah Orion Ad Platform SDK Add Permissions Initialize SDK Create Native Ads Layout Request and Show Ads Obfuscate Code FAQ Error Codes... 6

3 1 Introduction This document describes how to get Cheetah Orion Ad Platform SDK integrated into Android apps. 2 Integration Workflow 2.1 Integration Workflow Load Cheetah Orion Ad Platform SDK Add Permissions Initialize SDK Create Native Ads Layout Request and Show Ads 2.2 Load Cheetah Orion Ad Platform SDK Unzip the package, and copy the files under the folder libs-native to the folder of libs of your android project. Note that: If you are using Eclipse, right click Build Path -> Add to Build Path; If you are using Android Studio, add the code below to your Gradle scripts under node dependencies. compile(name: 'cmadsdk', ext: 'aar') 2.2 Add Permissions Add permissions for SDK, by modifying AndroidManifest.xml in your Android project. <uses-permission android:name="android.permission.write_external_storage" /> <uses-permission android:name="android.permission.access_network_state" /> <uses-permission android:name="android.permission.internet" /> 2.3 Initialize SDK Add the following codes into the OnCreate() Method:

4 public void oncreate() { super.oncreate(); //Initialize SDK //Param1:Context //Param2:Your AppId //Param3:Your Channel Id, fill in "" if your channel id is missing. CMAdManager.applicationInit(this, "Your AppId", "You channel ID"); //Set Debug Mode with logs. Default not set, and no logs printed. CMAdManager.setDebug(); The following table shows main Methods of CMAdManager: Method Name applicationinit(context context,string posid, String channeid) setdebug() stopwork() startwork() Descriptions Initialize SDK Set Debug Model Set No-Working Model (Stop requesting ads and configuration) Set Working Model (Default model) 2.4 Create Native Ads Layout Ads layout must use CMAdRelativeLayout as the root node for Ads View, and you can refer to the layout in Demo for detailed information. Code Sample: <?xml version="1.0" encoding="utf-8"?> <com.cmcm.adsdk.cmadrelativelayout xmlns:android=" android:layout_width="match_parent" android:layout_height="match_parent" android:background="#ffffff" android:orientation="vertical" > <!-- custom your layout --> </com.cmcm.adsdk.cmadrelativelayout> 2.5 Request and Show Ads Create thread NativeAdManager and call the requestad() method to request ads. Code Sample: //Param1:Context //Param2:Your Posid NativeAdManager nativeadmanager = new NativeAdManager(this, "Your posid"); nativeadmanager.setnativeadlistener(new NativeAdListener() { public void adloaded() { CMNativeAd ad = nativeadmanager.getad(); View madview = View.inflate(MainActivity.this, "Your Ad layout", null); //To get ad data via ad object String iconurl = ad.getadiconurl(); //To get data, and fill ad view into the boundary //Note that if ads view is reused, unbond the view before new ads is bonded if (mnativead!= null) { mnativead.unregisterview(); //save the ad object

5 mnativead = ad; //To bond the ad object and ad view. Once bonded, Click Event would be added automatically to listen to Clicks for the Ad //Warning that Ad Bonding is a must, or the Ad would neither disappear nor add click events ad.registerviewforinteraction(bignativeadview); public void adfailedtoload(int errorcode) { //Request failed public void adclicked(cmnativead ad) { //Ad clicked ); nativeadmanager.requestad(); The following table shows main Methods of NativeAdManager: (com.cmcm.adsdk.nativeadmanager) Method Name requestad() setnativeadlistener(nativeadlistener listener) getad() getadlist(int num) Descriptions Request Ads Set ad listener Get Ad Get multiple Ads The following table shows main Methods of CMNativeAd: (com.cmcm.adsdk.nativead.cmnativead) Method Name Descriptions getadtitle() Get Ad title getadbody() Get Ad body getadiconurl() Get Ad icon URL getadcoverimageurl() Get Ad cover image URL getadstarrating() Get Ad star rating getadsocialcontext() Get Ad download numbers or Websites registerviewforinteraction(view view) (Must)Bond Ad with Ad view unregisterview() setimpressionlistener(impressionlistener listener) Unbond Ad with Ad view Set Impression listener 3 Obfuscate Code If you need to obfuscate code, follow the rules below: -dontwarn com.cmcm.adsdk.** -dontwarn com.cleanmaster.** -keep class com.cmcm.adsdk.** { *; -keep class com.cleanmaster.** { *; 4 FAQ 1. Why are there still no ads returned after initialization?

6 The SDK would simultaneously request configuration file when initializing, and the ads would not be shown before the configuration file was successfully loaded. So no ads would be shown when initializing. You can judge the condition via logs (TAG=CMCMADSDK), the message loadad,mconfigbeans...isempty means configuration file need to be loaded. 2. When to call the registerviewforinteraction() method? If registerviewforinteraction() is called, the SDK would judge the Ad as being viewed. So please only call the method before the ad was shown. Warning: we suggest you call the method only once for one show time. 3. Does the SDK support Multi-Process? The SDK supports only Single-Process. 5 Error Codes Method Name Descriptions No configuration for the posid or the posid is closed No Ad data Internal error