Update to newest version and translate to English.

Transcription

1 1. Import Project 1.1 Preparation 1.2 Project Configuration 1.3 Configure Display Resources 1.4 Configure Test Environment 1.5 Enable Video Buffer 2. Ad formats 2.1 Banner 2.1.1Banner FullScreen Ads Interstitial 2.2 Native Ads Card Image Conbinatorial Video Post-Video Ads 2.3 Video Ads FullScreen Video Interstitial Video 2.4 Supplementary Ads Types Video Wall 3.Get the status of Ads 4.API Data Packaging 4.1 Image Data Packaging 4.2 Video data Packaging 5. Compatible Platform 5.1Unity Summary Environment Setup Project Configuration 5.2.Mediation Adapter 6. Video buffering Mode Update log Version Data Author Description Xiaoquan Vicky Sean Release document. Update to newest version and translate to English. 1.Remove token. Token is not necessary now.2.add a help center link about how to use mopub adapter. 1 of 29

2 1 1. Import Project Preparation 1.Apply for the developer Account from Appcoach and Appcoach will provide unique SiteID. 2. Download the Appcoach SDK.zip. The website: Project Configuration 1. Configure AndroidManifest.xml Please use <metadata> label to configure Siteid under <application> label in Androidmanifest.xml. Set Siteid metadata as APPCOACH_SITEID. <application> <meta-data android:name="appcoach_siteid" android:value="siteid"/> </application> siteid: Unique ID Provided by Appcoach 2. Add Permission (Mandatory) <uses-permission android:name="android.permission.internet"/> <uses-permission android:name="android.permission.access_network_state"/> <uses-permission android:name="android.permission.mount_unmount_filesystems"/> <uses-permission android:name="android.permission.write_external_storage"/> <uses-permission android:name="android.permission.read_phone_state"/> <uses-permission android:name="android.permission.access_coarse_location"/> <uses-permission android:name="android.permission.access_fine_location"/> <uses-permission android:name= android.permission.access_wifi_state"/> <uses-permission android:name="android.permission.read_external_storage"/> <uses-permission android:name="android.permission.use_credentials" /> Permission Adaptation (Mandatory) for Android 6.0 (Risk Permission/permission application in operation) Apply for Risk Permission before call the SDK API Dynamic Application Permission Manifest.permission.WRITE_EXTERNAL_STORAGE, Manifest.permission.READ_EXTERNAL_STORAGE, Manifest.permission.ACCESS_COARSE_LOCATION, Manifest.permission.ACCESS_FINE_LOCATION, Manifest.permission.READ_PHONE_STATE 2 of 29

3 3. Configure the SDK minimum Version The minimum Android SDK that Appcoach SDK required is 3.0 and up For example <uses-sdk android:minsdkversion= 11 > 4. Import AppcoachSDK.jar into the project Configure Display Resources a. string.xml document appcoach_offerwall_loading_txt offerwall Loading appcoach_offerwall_empty_txt offerwall No Data appcoach_offerwall_list_title offerwall List Title appcoach_offerwall_grid_title offerwall Grid Title appcoach_open_faulire Ad open failure b. drawable appcoach_default_app_icon Default Icon Configure Test Environment By Default, the server is the formal environment, when do the test, test environment is need, please follw the instruction below to switch to test environment address. 1. Open test environment AppcoachConfig.changeToTestEnvrinoment(true); 2.Close test environment AppcoachConfig.changeToTestEnvrinoment(false); Enable Video Buffer Enable Video buffer in the beginning of Application (Call API enable buffer in the beginning of Application or MainActivity) 3 of 29

4 AppcoachSDK.getInstance(Context).setCacheVideoMode(int[] slotid) Note: for Android6.0 permission adaptation Need to do the following two steps before call AppcoachSDK.getInstance(Context).setCacheVideoMode(int [] slotid) 1. Code dynamic application permissionactivitycompat.requestpermissions 2. User allow or prohibit permission request callback public void onrequestpermissionsresult( int requestcode, String[] permissions, int[] grantresult) Need dynamic application permission, refer to Android project configuration/ permission adaption 4 of 29

5 2 2. Ad formats Three types of universalbanner AdsNative AdsVideo Ads. In additionour own App wallvideo wall can provide more chance to display Ads Banner Banner AdsBannerFull ScreenInterstitial Ads Banner Layout <com.appcoachs.sdk.view.imageadbannerview android:layout_width="match_parent" android: layout_height="210dp" Request Data mbannerview = (ImageAdBannerView)findViewById(R.id.banner); mbannerview.setdefaultdrawable(r.drawable.bg); // Set default banner mbannerview.loadad(slotid, number, orientation); mbannerview.setonappcoachadlistener(callback)// Set callback 5 of 29

6 Set up the scroll time, 15s by default mbannerview.setautoscrolltime(long mills); in the Request slotid Ads slot id appointed with Appcoach number Ad number in the reqeust ( Maximum is 5) orientation callback Ads Display method: 0:portrait; 1: landscape OnAppcoachAdListener interface instant object FullScreen Ads Mobile Device,support portrait and landscape effect. Build default Object mfullscreen = new ImageFullScreenActivity(this).setRequestParams(slotId, orientation).show(); Customized-countdown time mfullscreen = new ImageFullScreenActivity(this).setRequestParams(slotId, orientation displaytime).show(); Add callback mfullscreen.setonappcoachadlistener(callback); Request slotid orientation callback displaytime Ads slot id appointed with Appcoach Ads display method 0:portrait; 1: landscape OnAppcoachAdListener interface instant object Ads countdown durationms Interstitial Create Object, Set up request parameters. After that, SDK will ask for Ads. 6 of 29

7 mpopad = new ImageFullScreenActivity(this, smallstyle).setrequestparams(slotid, oritation); Create Function smallstyle Definition true Small mode, false fullscreen mode Request s slotid oritation Definition Ads slot id appointed with Appcoach Ads display method 0:portrait; 1: landscape Display Ads mpopad.show(); NoteCall Show() repeatedly can display interstitial Ads repeatedly, SDK will get new Ads Source when the Ads showed last time. Customized display Size mpopimage.setcustomesize(width, height); width height Definition Width of the ads height of the ads Native Ads Native AdsCard Ads, Combinatorial Video, Pre, Post-Scroll Video 7 of 29

8 Card Image Layout <com.appcoachs.sdk.view.imageadcardview android:layout_width="match_parent" android: layout_height="210dp" Image Ads size can be set up depends on the Display requestthat is customized sizebut wrap_parent attribution can t be used to set display Size Ads Request mcardview = (ImageAdCardView)findViewById(R.id.card); mcardview setdefaultdrawable(r.drawable.bg); //setup Default ads mcardview.loadad (slotid, orientation); mcardview.setonappcoachadlistener(callback) slotid Description Slot id decided by Appcoach and the Developer. Usually, 1 slot represent a ad format with specific dimension 8 of 29

9 orientation callback Description 0:portrait; 1: landscape OnAppcoachAdListener interface instant object Conbinatorial Video Layout <com.appcoachs.sdk.view.videocombinationview android:layout_width="match_parent" android: layout_height="280dp" Ads Request VideoCombinationView combination = (VideoCombinationView)findViewById(R.id.video_combination); combination.loadad(slotid); Add Callback combination.setonappcoachadlistener(callback); s 9 of 29

10 Description slotid Slot id decided by Appcoach and the Developer Set up the location of information bar combination.setdescriptionorientation(orientation); : orientation Description locality VideoCombinationView.TOP or VideoCombinationView.BOTTOM Post-Video Ads 1. Add layout and cover the content <FrameLayout xmlns:android=" android:layout_width="ma tch_parent" android:layout_height="240dp" android:id="@+id/frame"> <SurfaceView android:layout_width="match_parent" android:layout_height="match_parent" android: id="@+id/surface"/> <com.appcoachs.sdk.view.videopasterview android:layout_width="match_parent" android: layout_height="match_parent" android:id="@+id/paster_video"/> </FrameLayout> 2. Get the ads and setting ads parameters mpasterview = (VideoPasterView)findViewById(R.id.paster_video); mpasterview.loadad(slotid); slotid Description Slot ID 3. Add callback and manage the ads display mpasterview.setonpastervideoadlistener(new OnPasterVideoAdListener() { public void onadloaded(absadview arg0) { 10 of 29

11 public void onadfailure(absadview arg0, int arg1) { public void onadcompleted(absadview view) { madfinish = true; ((ViewGroup)mPasterView.getParent()).removeView(mPasterView); if (mplayer!= null && mplayerprepared) { startplaye(); public void onadclose(absadview arg0) { public void onadclick(absadview arg0) { public void onskipadbuttonclicked(absadview arg0) { //TODO click the remove Ads button public void onfullbuttonclicked(absadview arg0, boolean full) { //TODO Click the fullscreen button ); public void onaddetailbuttonclicked(absadview arg0) { //TODO Click the ads details button 4. Get the corresponding Button and manage the display Get remove Ads button mpasterview.getskipbutto(); Get countdown button mpasterview.gettimetextview(); Get Full Screen management Button mpasterview.getfullbutton(); 11 of 29

12 Get Ads Details Button mpasterview.getaddetailtextview(); Video Ads FullScreen Video AndroidManifest.xml <activity android:name="com.appcoachs.sdk.view.videoplayeractivity" android:configchanges="orien tation screensize keyboardhidden" android:screenorientation="landscape"/> Call fullscreen Video Intent videoallintent = new Intent(this, VideoPlayerActivity.class); videoallintent.putextra(appcoachconstants.extra_auto_jump, true); videoallintent.putextra(appcoachconstants.extra_slot_id, slotid); videoallintent.putextra(appcoachconstants.extra_video_show_type, VideoPlayerLayout.SHOW_VIDEO_MOST); startactivity(videoallintent); Description Mandatory AppcoachConstants. EXTRA_AUTO_JUMP AppcoachConstants. EXTRA_SLOT_ID AppcoachConstants. EXTRA_VIDEO_SHOW_TYPE After the video showedif the Maket download link will be opened. True: Auto-Openfalse: no open Slot id decided by Appcoach and developer. Usually, 1 slot represent a ad format with specific dimension Video Display Mode AppcoachConstants.SHOW_VIDEO_FULL FullScreen optional Mandatory optional AppcoachConstants.SHOW_VIDEO_MOST 100% Display AppcoachConstants.SHOW_VIDEO_ITSELF_SIZE Video content Size Interstitial Video Layout 12 of 29

13 <com.appcoachs.sdk.view.videotableplaqueview android: layout_width="match_parent" android:layout_height="240dp"></com.appcoachs.sdk.view. VideoTablePlaqueView> Ad request mvideoplayerlayout = (VideoTablePlaqueView)findViewById(R.id.video_layout); mvideoplayerlayout.loadad(slotid, showtype); Add callback mvideoplayerlayout.setonappcoachadlistener(callback); slotid showtype Description Ads Slot Id Video Display Mode AppcoachConstants.SHOW_VIDEO_FULL Full Screen AppcoachConstants.SHOW_VIDEO_MOST 100% Display AppcoachConstants.SHOW_VIDEO_ITSELF_SIZE The Size of the Video Supplementary Ads Types App Wall Grid and List 13 of 29

14 AndroidManifest.xml Configuration List <activity android:name= com.appcoachs.sdk.view.listofferwallactivity" android:configchanges= orientation screensize keyboardhidden" android:screenorientation= portrait > </activity> Nine-Box <activity android:name= com.appcoachs.sdk.view.gridofferwallactivity" android:configchanges= orientation screensize keyboardhidden" android:screenorientation= portrait > </activity> Display App wall List Intent intent = new Intent(context, ListOfferWallActivity.class); intent.putextra(appcoachconstants.extra_slot_id, slotid); intent.putextra(appcoachconstants.extra_title_text, xxxx); //Setup Title textcharacter String types intent.putextra(appcoachconstants.extra_background_color, xxxx); // Setup background color of text, int type context.startactivity(intent); Grid 14 of 29

15 Intent intent = new Intent(context, GridOfferWallActivity.class); intent.putextra(appcoachconstants.extra_slot_id, slotid); intent.putextra(appcoachconstants.extra_title_text, xxxx); // Setup Title textcharacter String types intent.putextra(appcoachconstants.extra_background_color, xxxx); //Setup background color of text, int type context.startactivity(intent); Description Mandatory AppcoachConstants.EXTRA_SLOT_ID Slot id Mandatory AppcoachConstants.EXTRA_TITLE_TEXT Title Text optional AppcoachConstants.EXTRA_BACKGROUND_COLOR Title background color optional Video Wall 1>.AndroidManifest.xml Configuration List <activity android:name= com.appcoachs.sdk.view.videoofferwallactivity" android:configchanges= orientation screensize keyboardhidden" android:screenorientation= portrait > </activity> 15 of 29

16 Call Video Wall Intent videoofferwall = new Intent(this, VideoOfferWallActivity.class); videoofferwall.putextra(appcoachconstants.extra_slot_id, slotid); videoofferwall.putextra(appcoachconstants.extra_title_text, xxxx); // Setup the Subject and character string Type videoofferwall.putextra(appcoachconstants.extra_endcard_direction, AppcoachConstants.ENDCARD_LAYOUT_HALF_CENTER); videoofferwall.putextra(appcoachconstants.extra_install_button_text, xxxx); videoofferwall.putextra(appcoachconstants.extra_background_color, xxxx); //Setup the Subject background colorint type videoofferwall.putextra(appcoachconstants.extra_endcard_install_text, xxxx); startactivity(videoofferwall); Description Mandatory AppcoachConstants. EXTRA_SLOT_ID AppcoachConstants. EXTRA_TITLE_TEXT AppcoachConstants. EXTRA_ENDCARD_DIRECTION Slot id decided by Appcoach and the developer. Usually, 1 slot represent a ad format with specific dimension Content of the title Display mode when the the end of the video AppcoachConstants. ENDCARD_LAYOUT_HALF_CENTER Mandatory optional optional AppcoachConstants. ENDCARD_LAYOUT_BOTTOM By Default: AppcoachConstants. EXTRA_INSTALL_BUTTON_TEXT AppcoachConstants. EXTRA_BACKGROUND_COLOR AppcoachConstants. EXTRA_ENDCARD_INSTALL_TEXT AppcoachConstants. ENDCARD_LAYOUT_BOTTOM The txt of button for download Background of the title The download button when the end of the video optional optional optional 16 of 29

17 3 3.Get the status of Ads Two ways of getting the status of ads according to different types: 1. Get ads status of entry level a. Integrate entry level Ads type SDK b. Modify the configuration from mainfest.xml c. Add the callback interface of monitoring state of Ads d. Modify the starting class For example a. Integrate full screen video ads type provided by SDK and register Ads status callback interface public class ActivityVideoFullScreen extends VideoPlayerActivity implements OnAppcoachAdListener { protected void oncreate(bundle savedinstancestate) { super.oncreate(savedinstancestate); registeronappcoachadlistener(this); // // protected Bundle getcustomeparams() { // return super.getcustomeparams(); // public void onadloaded(absadview ad) { // TODO Auto-generated method stub Log.d("Tag", "onadloaded"); public void onadfailure(absadview ad, int errorcode) { // TODO Auto-generated method stub Log.d("Tag", "onadfailure"); public void onadclick(absadview ad) { // TODO Auto-generated method stub Log.d("Tag", "onadclick"); public void onadcompleted(absadview ad) { // TODO Auto-generated method stub Log.d("Tag", "onadcompleted"); public void onadclose(absadview ad) { 17 of 29

18 // TODO Auto-generated method stub Log.d("Tag", "onadclose"); b. Modify Mainfest.xml Registration <activity android:name="com.appcoachs.ad.sdk.activityvideofullscreen" android:configchanges="ori entation screensize keyboardhidden" android:screenorientation= landscape"/> c. Register Callback registeronappcoachadlistener(this); d. Start fullscreen video Ads Intent videoallintent = new Intent(this, ActivityVideoFullScreen.class); videoallintent.putextra(appcoachconstants.extra_auto_jump, true); videoallintent.putextra(appcoachconstants.extra_slot_id, Constants.VIDEO_SLOT); videoallintent.putextra(appcoachconstants.extra_video_show_type,videoplayerlayout. SHOW_VIDEO_FULL); startactivity(videoallintent); 2. Get status of embeded Ads a. Getting Ads type object mbannerview = (ImageAdBannerView)findViewById(R.id.banner); b. Add Minitor Ads status callback interface mbannerview.setonappcoachadlistener(new OnAppcoachAdListener() { public void onadloaded(absadview ad) { // TODO Auto-generated method stub public void onadfailure(absadview ad, int errorcode) { // TODO Auto-generated method stub public void onadclick(absadview ad) { // TODO Auto-generated method stub public void onadcompleted(absadview ad) { // TODO Auto-generated method stub 18 of 29

19 public void onadclose(absadview ad) { // TODO Auto-generated method stub ); 3.Get Video playing progress mvideoadview.setonappcoachvideoadlistener(new OnAppcoachVideoAdListener() { public void onvideoplaycallback(long duration, long currentposition) { //TODO doing something. ); 19 of 29

20 4 4.API Data Packaging Image Data Packaging Support Ads Image data Provided by Appcoachs a. Request Use ImageSDKAbandoned ImageSdk.getIntance(context).loadAd(slotId, number, orientation, new IAdResponseCallBack() public void onsuccess(request req, Response resp) { // Request Image Ads success if (resp!= null && resp.model!= null && resp.model instanceof ImageAds) { public void onfailure(request res, int errorcode, String responsedata) { // Failed to request Ads data ); Use APPcoachSdkRecommend AppcoachSDK.getInstance(this).loadImageAd(slotId, number, orientation, new IAdResponseCallBack() public void onsuccess(request req, Response resp) { // Request Image Ads success if (resp!= null && resp.model!= null && resp.model instanceof ImageAds) { public void onfailure(request res, int errorcode, String responsedata) { // Failed to request Ads data ); Request s slotid number Discription Slot id decided by Appcoach and the Developer. Usually, 1 slot represent an ad format with specific dimension Number of ad 20 of 29

21 orientation callback Discription 0:portrait; 1: landscape Achieved OnAppcoachAdListener interface Object Response s req resp Discription Request Object, including request information Response Object, including Ads information postback by ads server. Error req errorcode responsedata Discription Request Object, including request information Request Error Code. Errorcode including http error code and error code of Constants. HttpConstants Error response Code returned by Server Object Definition ImageAds Packaging image Ads data Objects in the response of sever, including multiple ads data information ImageAd Single image Ad information Please check the API doc for How to use variables and method of Object b. Report Ads Impression event ImageSdk.getInstance(context).reportImpressionEvent(url); url Discription Impressiong url report event URL. Postback by Appcoach Server. TrackingUrl of Image Ad Object Video data Packaging Data Request Use VideoSdkAbandoned 21 of 29

22 VideoSdk.getInstance(context).loadAd(slotId, new IAdResponseCallback() public void onsuccess(request req, Response resp) { // Video ads request success if (res!= null && resp.model!= null && resp.model instanceof VideoAds) { public void onfailure(request res, int errorcode, String responsedata) { // Failed to Request Ads ); Use APPcoachSdkRecommend AppcoachSDK.getInstance(this).loadVideoAd(slotId, number, new IAdResponseCallBack() public void onsuccess(request req, Response resp) { //request success if (resp!= null && resp.model!= null && resp.model instanceof ImageAds) { public void onfailure(request res, int errorcode, String responsedata) { // Request failed ); slotid callback number Ads slot id appointed with Appcoach Request responds monitor Ads Number in the request 22 of 29

23 5 5. Compatible Platform Unity Summary This document is used for Unity3d game API, The following Demo was developed basing on Unity5.3. If there are some questions about SDK configuration, pls refer the importing projects.currently Unity Demo shows four types of video ads, e.g. Banner, Full-screen video, Video walls, Combination video. For the other forms of ads, please refer the method call of SDK interface of Demo. Note: If need to release both Android version and ios version at the same time, you need to add all the files which are under the File Directory Assets/Plugins/iOS of ios s resource package AppcoachUnitySampleForSDK.unitypackage and under the File Directory Assets/Plugins/Android of Android s resource package AppcoachUnitySampleForSDK.unitypackage into the File Directory Assets /Plugins Environment Setup 1. Import Project, download Unity3D SDK and add AppcoachUnitySampleForSDK.unitypackage into Unity projectplease don t put unitypackage doc under Chinese File Path. 23 of 29

24 After imported the project, please check if bonding with script; if not, please bond it. 24 of 29

25 Project Configuration 1 Developer Unique ID configuration Attribution Method SITE_ID Definition Unique ID provided by Appcoach The configuration method is in Assets/Plugins/Android/AndroidManifest.xml, for example Assets/Plugins/Android/AndroidManifest.xml <meta-data android:name="appcoach_siteid" android:value="ykqpuuiu" /> Attribution Method xxxxx_sot XXXXXX_TYPE Definition Ads slot discussed between Publisher and Product Android Only XXXX_TYPE of android version one-to-one correspondence With each ad type.the constant configuration of ad type in MainActivity should be consistent with the constants of ad type in AppcoachConstants.cs 3.In SDK package, enclosing with the UnitySDKAndroidProj of Android project.it is the demo project which call by sdk of Android condition. If no need to append the banner, composite video, video wall, interstitial video etc., it can be used directly, if not, please call the interface by referring the UnitySDKAndroidProj project. 4. When UnitySDKAndroidProj project jar package needs to be export, export src and res package is enough. Click the Project using right mouse button to export, as below 25 of 29

26 5Options that need to be exported are: 6.The jar package should be exported into directory of Unity Project s file path Assets / Plugins / Android / bin 26 of 29

27 7.The Appcoachs s android sdk package should be put into Unity Project s file path Assets / Plugins / Android / libs, If the appcoachs SDK already exists there, Pls replace it by the latest version of the SDK Ads Formats for instance Introduce the API integration methods in AppcoachSDK.cs and the usage of all interface in Externs.cs. 1. Banner /*** Load Banner Ads**/ public void loadbanneradview(); Call method: AppcoachSDK.Instance.loadBannerAdView(); /*** Remove Banner Ads**/ public void destroybannerviewclient(); Call method: AppcoachSDK.Instance.destroyBannerViewClient(); 2. Full Screen Video There are two ways to show full-screen ads, Landscape mode and portrait mode(controlled by the developer) Create a full-screen video, sdk provides four methods,( Developers usually use the first two methods) /*** FullScreen Video **/ public void loadvideofullscreenadclient() AppcoachSDK.Instance.loadVideoFullScreenAdClient(); 3. Video Ads Walls /*** Create Video wall controller ***/ /*** Video Wall**/ public void loadvideowallclient() Call method AppcoachSDK.Instance.loadVideoWallClient (); Attribution method explanation: Attribution (nonatomic, strong) UIColor (nonatomic, assign) ACVideo- AdWallShowRate videoadwallshowrate; Definition Set navigationbar s color,default color is black Set the video size rate a.full screen b.100% c.75% 27 of 29

28 4. Combination Video Create combined Video View /*** Create combined video* frame Combined video frame parameters request parameters failure failure code * return combined video View */ public void loadcombinedvideoclient(); Call Method AppcoachSDK.Instance.loadCombinedVideoClient() /// Destory views of Combined Video public void destroycombinedviewclient() Call Method AppcoachSDK.Instance.destroyCombinedViewClient (); Please release the source when exit the View controller with calling this method to avoid the memory leakage Mediation Adapter If you integrate with Appcoach via mediation, please read the following document about adapter. Mopub: 28 of 29

29 6 6. Video buffering Mode 1>. Enable Video buffering Mode AppcoachSdk.getInstance(context).setCacheVideoModel(int [] slotids); slotids context Ads slot id appointed with Appcoach Context Object 2>. Check if SDK video buffer is ready. AppcoachSdk.getInstance(context).hasCacheVideo(slotId) Once set buffer mode, SDK will fetch video data from buffer firstly. If no video data can be fetched in buffers, SDK will switch into online play mode. Under Buffer mode, all the video resources will be fetched from Appcoach Server by SDK. To improve the video play fluency, we recommend to check if there is any video resources can be fetched before display the video ad by calling hascachevideo(slotid); if there is no video resources, the video ads window can be hide. For example: if (mappcoachssdk.iscachevideomodel() &&!mappcoachssdk.hascachevideo(slotid)) { Toast.makeText(this, "", Toast.LENGTH_LONG).show(); else { Intent pasterintent = new Intent(this, ActivityPasterVideo.class); startactivity(pasterintent); 29 of 29