Skip to content

Latest commit

 

History

History
229 lines (184 loc) · 7.37 KB

README-CN.md

File metadata and controls

229 lines (184 loc) · 7.37 KB

Appluck Android SDK集成说明

English

Github地址

使用要求

MinSDK 21 (Android 5.0)以上

1.下载AppluckSDK

AppLuckSDK.aar

2. 引入SDK

  1. 在 Android Studio 里的 Project Navigator， 选择 Project，你将在 Android Studio project 里的 app 模块下看到 libs 文件夹 。
  2. 你需要将 AppLuckSDK.aar 文件添加到 libs 文件夹中。
  3. 在你的 Android Studio 项目的 app 模块，选择 build.gradle 文件，确保将以下添加到 dependencies block 中：
dependencies {
  implementation fileTree(dir: 'libs', include: ['*.jar', '*.aar'])
}
  1. 在你的 Android Studio 项目的 app 模块，选择 AndroidManifest.xml 文件，确保以下添加到 manifest block 中：
 <uses-permission android:name="android.permission.INTERNET" />
 <uses-permission android:name="com.google.android.gms.permission.AD_ID" />

3. 配置依赖

可通过以下两种方式引入，任选其一

  • 通过gradle引入

    implementation 'androidx.appcompat:appcompat:1.3.0'
implementation 'com.google.android.material:material:1.4.0'
//常用工具
implementation 'org.apache.commons:commons-lang3:3.3.2'
//http请求
implementation 'org.jsoup:jsoup:1.11.2'
//json处理
implementation 'com.alibaba:fastjson:1.1.72.android'
//图片加载缓存
implementation 'com.github.bumptech.glide:glide:4.14.2'
//gaid
implementation 'com.google.android.gms:play-services-ads-identifier:18.0.1'

  • 手动引入

    • 将libs.zip解压，内容全部放入 Assets/Plugins/Android

4. 开始集成

4.1 初始化SDK

4.1.1 填充初始化成功回调.

AppLuckSDK.setListener(new AppLuckSDK.AppLuckSDKListener() {
          @Override
          public void onInitSuccess() {
              Toast.makeText(MyApplication.this, "AppLuck SDK Init Success.", Toast.LENGTH_SHORT).show();
          }

          @Override
          public void onInitFailed(Error error) {
              Log.e("AppLuckSDK", "Init Failed.", error);
              Toast.makeText(MyApplication.this, "AppLuck SDK Init Failed.", Toast.LENGTH_SHORT).show();
          }

          @Override
          public void onPlacementLoadSuccess(String placementId) {
              Toast.makeText(MyApplication.this, placementId + " Load Success.", Toast.LENGTH_SHORT).show();
          }

          @Override
          public void onInteractiveAdsHidden(String s, int i) {
              
          }
      
      @Override
          public void onInteractiveAdsDisplayed(String s) {

          }

          /**
           *
           * @param placementId
           * @param interaction INTERACTIVE_PLAY 活动参与; INTERACTIVE_CLICK 广告点击
           */
          @Override
          public void onUserInteraction(String placementId, String interaction) {
              Toast.makeText(MyApplication.this, placementId + " " + interaction, Toast.LENGTH_SHORT).show();
          }
      });

4.1.2 初始化

//请在主线程中进行
//placementId - 广告位ID 插件会自动对该位置做预加载，如产品中有多个广告位建议传入最重要即预期曝光最多的广告位ID。生产环境的placementId请与运营人员联系获取。
AppLuckSDK.init(placementId);

4.2 设置广告位入口

Appluck支持两种方式的广告位入口

  • 使用封装好的方法加载入口(建议使用)
    • 只需传入入口的宽高及位置即可展示，Appluck将会对素材做系统推荐并根据点击率实时优化
  • 自行设置入口(适合对入口有特殊要求，或在某些场景希望直接打开互动广告的需求)
    • 希望打开互动广告时，调用我们提供的方法打开Appluck的活动页面。

4.2.1 使用Appluck封装的入口

  1. 填充placement加载成功回调
AppLuckSDK.setListener(new AppLuckSDK.AppLuckSDKListener() {
      //loadedPlacementId - 加载成功的placementId
          @Override
          public void onPlacementLoadSuccess(String placementId) {
              Toast.makeText(MyApplication.this, placementId + " Load Success.", Toast.LENGTH_SHORT).show();
          }
      });
  1. 加载placement素材
//placementId - 广告位id
//creative type - 素材类型，当前仅支持 icon
//width - 入口位置的素材宽度
//height - 入口位置的素材高度
if(AppLuckSDK.isSDKInit()){
  AppLuckSDK.loadPlacement(placementId, "icon", 150, 150);
}
  1. 展示广告位，在预加载场景下请定时执行以下代码直到广告位成功展示，具体实现可以参考demo。
//指定坐标(像素)展示
if(AppLuckSDK.isSDKInit()){
  if (AppLuckSDK.isPlacementReady(placementId)) {
  	//this: 当前Activity
  	//placementId
  	//top: y坐标
  	//left: x坐标
  	//times: 默认传1
  	AppLuckSDK.showInteractiveEntrance(this, placementId, top, left, times);
  }
}

//获取view自行展示
if(AppLuckSDK.isSDKInit()){
  if (AppLuckSDK.isPlacementReady(placementId)) {
  	LinearLayout llAddView = "{your Layout}";
  	//this: 当前Activity
  	//placementId
  	//times: 默认传1
  	View iconView = AppLuckSDK.showInteractiveEntrance(this, placementId, 1);
  	//展示iconView
  	if (iconView != null) {
  		if (iconView.getParent() != null) {
  		    ViewGroup viewGroup = (ViewGroup) iconView.getParent();
  		    viewGroup.removeView(iconView);
  		}
  		iconView.setLayoutParams(new ViewGroup.LayoutParams(ViewGroup.LayoutParams.WRAP_CONTENT, ViewGroup.LayoutParams.WRAP_CONTENT));
  		llAddView.addView(iconView);
  	}
  }
}
  1. 隐藏placement
//activity - 入口所在的activity
//placementId - 广告位id
AppLuckSDK.hideInteractiveEntrance(activity,placementId);

4.2.2 自行设置入口

  • 直接打开互动广告的场景请直接调用
if(AppLuckSDK.isSDKInit()){
    //唤起webview并加载活动，请传入placementId
    //mode 
    //-- 0.默认模式: 适合固定入口场景如浮标banner等，用户可以自由关闭互动广告界面。
    //-- 1.插屏模式: 适合插屏场景，用户进入10秒后才可关闭。
    //-- 2.激励模式: 适合激励场景，用户完成{times}次活动参与后可关闭互动广告界面，关闭界面时触发激励回调。
    //times
    //-- 当mode为2(激励模式)时用于限制用户需要完成的活动参与次数。
    AppLuckSDK.openInteractiveAds(请传入placementId, mode, times);
}
  • 自行设置入口，等待Appluck预加载完成再展示

4.3 其他事件

AppLuckSDK.setListener(new AppLuckSDK.AppLuckSDKListener() {
	    //SDKInit 失败	
            @Override
            public void onInitFailed(Error error) {
                Log.e("AppLuckSDK", "Init Failed.", error);
                // Toast.makeText(MyApplication.this, "AppLuck SDK Init Failed.", Toast.LENGTH_SHORT).show();
            }
	    
	    //AppLuck 关闭回调
	    //status 0:普通关闭;1:已完成激励任务
	    @Override
            public void onInteractiveAdsHidden(String placementId, int i) {
                
            }
    
        });