数字广告监测及验证统一SDK(iOS)

数字广告监测及验证统一SDK(iOS)

 

# 数字广告监测及验证统一SDK (iOS) 部署指南

### 步骤1:添加iOS SDK 到工程中
1. [点此下载](http://event.mmachina.cn/download/1401.html) (下载内容为:监测及验证统一SDK (iOS) 安装包)iOS SDK (如需浏览此开源项目和 demo 工程请到 https://gitee.com/MMAChinaSDK 注册账号)
2. 将SDK发布文件中,release目录下的**MobileTracking.h** 、**libMobileTracking.a**、**sdkconfig.xml** 三个文件拷贝到项目工程中,将 **sdkconfig.xml** 上传到 web 服务器,使其可以通过 web 方式访问,假设其地址为 **http://xxxxxx.com/sdkconfig.xml**(其后会用到)。
3. 在项目工程 App 的 Target Build Settings 中的 **Other Linker Flags** 选项里添加 **-lxml2** **-all_load** 或 **-lxml2** **-force_load** 静态库的绝对路径
4. 添加SDK需要的Framework
   在需要添加SDK的项目的 Xcode 开发环境中选择 TARGETS–>Build Phases–>Link Binary With Libraries–> + 添加以下framework框架:
“`
    CoreLocation.framework
    libxml2.2.tbd
AdSupport.framework
CoreTelephony.framework
  SystemConfiguration.framework
“`
### 步骤2:使用方法
在使用的文件中引用
**#import “MobileTracking.h”**.
使用说明:
#### 1、初始化方法
在进行监测之前,必须进行初始化,通过以上的代码进行初始化操作
“`
[MobileTracking sharedInstance]
“`
#### 2、配置远程配置文件地址方法
SDK 会自动下载远程的配置文件,使用最新的配置文件进行参数的组装。
“`
[[MobileTracking sharedInstance] configFromUrl:@“http://xxxxxx.com/sdkconfig.xml”];
“`
#### 3、曝光的监测
通过调用以下的代码进行曝光的监测,
– view:参数为第三方公司的监测地址
– ad:参数为当前广告视图对象(**可视化广告监测为必传字段,普通广告监测默认缺省。**)
– videoPlayType:参数为当前视频广告的播放类型(**视频可视化广告监测为可选字段,1-自动播放,2-手动播放,0-无法识别。**)
– impressionType:参数为曝光的类型。(**普通广告监测的类型为必选字段,0-Tracked ads,1-曝光**)
3.1 曝光监测
“`
// impressionType=1 表示这是曝光监测。此时如果传0,表示这是Tracked ads监测
[[MobileTracking sharedInstance] view:@”http://example.com/xxxxxx” ad:adView impressionType:1];
“`
  备注:SDK曝光监测接口现已升级为曝光/Track Ads接口, 支持曝光或Tracked Ads监测。
    1、曝光的定义:只有广告物料已经加载在客户端并至少已经开始渲染(Begin to render,简称BtR)时,才应称之为“曝光”事件。“渲染”指的是绘制物料的过程,或者指将物料添加到文档对象模型的过程。
    2、Tracked Ads的定义:当监测代码已经下载到客户端时(即便广告不一定渲染),称该事件为“Tracked Ads”事件。
    开发者应根据广告实际展示情况,选择调用曝光或Tracked Ads监测,详细调用过程如上面的示例。如果进行曝光调用,则SDK会查验传入的广告View对象是否已开始渲染,如果是,则SDK会向监测方发出曝光上报;如果不是,则SDK会向监测方发出Tracked Ads上报。如果进行Tracked Ads调用,则SDK会直接向监测方发出Tracked Ads上报。
3.2 可见性广告监测
“`
[[MobileTracking sharedInstance] view:@”http://example.com/xxxxxx” ad:adview];
“`
   备注:对广告进行可见性监测时,广告必须是满足开始渲染(Begin to render,简称BtR)条件的合法曝光,否则SDK不会执行可见监测。在调用可见曝光监测接口时,SDK会查验传入的广告View对象是否已开始渲染,如果是,则SDK会向监测方发出曝光上报,并继续进行可见监测,直到满足可见/不可见条件,再结束可见监测流程;如果不是,则SDK会向监测方发出Tracked Ads上报,并结束可见监测流程。
3.3 视频可见性广告监测
“`
[[MobileTracking sharedInstance] viewVideo:@”http://example.com/xxxxxx” ad:adview videoPlayType:type];
“`
3.4 可见性广告JS监测
“`
[[MobileTracking sharedInstance] jsView:@”http://example.com/xxxxxx” ad:adview];
“`
3.5 视频可见性广告JS监测
“`
[[MobileTracking sharedInstance] jsViewVideo:@”http://example.com/xxxxxx” ad:adview];
“`
3.6 可见性广告监测停止,广告播放结束时调用
“`
[[MobileTracking sharedInstance] stop:@”http://example.com/xxxxxx”];
“`
#### 4、点击监测
通过调用以下的代码进行点击的监测,参数为第三方公司的监测地址
“`
[[MobileTracking sharedInstance] click:@”http://example.com/xxxxxx”];
“`
#### 5、进入后台时调用
主要用于保存当前监测数据,不被丢失。建议放在AppDelegate的applicationDidEnterBackground方法中
“`
[[MobileTracking sharedInstance] didEnterBackground];
“`
#### 6、回到前台时调用
重新读取缓存数据,主要用于保证当前监测数据,及时上报,建议放在AppDelegate的applicationWillEnterForeground方法中
“`
[[MobileTracking sharedInstance] didEnterForeground];
“`
#### 7、应用结束时调用
主要用于保存当前监测数据,不被丢失。
“`
[[MobileTracking sharedInstance] willTerminate];
“`
#### 7、开启调试日志
建议在测试时候打开
“`
[[MobileTracking sharedInstance] enableLog:YES];
“`
### 步骤3:验证和调试
SDK 的测试有两个方面:
1. 参数是否齐全,URL 拼接方式是否正确
2. 请求次数和第三方监测平台是否能对应上
请联系第三方监测平台完成测试

数字广告监测及验证统一SDK(Android)

数字广告监测及验证统一SDK(Android)

 

# 数字广告监测及验证统一SDK (Android) 部署指南

## 适用范围
  Android SDK适用于 **Android 2.3.3(API Level 10)**及以上的设备。
  ## 集成SDK
  ### 步骤1: 导入SDK
  [点此下载](http://event.mmachina.cn/download/1402.html) (下载内容:监测及验证统一SDK (Android) 安装包)Android SDK (如需浏览此开源项目和 demo 工程请到 https://gitee.com/MMAChinaSDK 注册账号)
  请根据所用IDE选择导入方式:
  #### Eclipse ADT
  将 SDK 中的  `jar` 文件拷贝到工程的 `libs` 文件夹中:右键选择jar包 **–>** **Build Path –> Add to Build Path**。
#### Android Studio
1. 在 Android Studio 项目的 `app` 文件夹中,新建 `libs` 文件夹。
2. 将 SDK `jar` 文件拷贝到新建的 `libs` 文件夹中。
3. 修改 `app` 文件夹中的 `build.gradle` 文件,添加 `dependencies` 依赖项:
“`
dependencies {
      …
      implementation files(‘libs/mmachina_sdk.jar’)
      …
  }
“`
#### 导入签名库
将SDK中的 `libMMASignature.so`  文件拷贝到工程 `libs/armeabi` 目录下, SDK `lib_abi` 目录下对应不同CPU架构下的库文件,建议拷贝该目录下所有到工程 **app/libs **文件夹下,如果考虑APK大小,至少要包含主流架构:`armeabi`、`armeabi-v7a`、`arm64-v8a`。
#### 导入离线配置
将 `sdkconfig.xml` 配置文件拷贝到工程的 `assets` 目录下,在网络不好或者离线状态下读取缺省配置可以正常监测。同时 **配置文件** 上传到  web 服务器,使其可以通过 web 方式访问,便于后期灵活远程变更配置。
#### 配置权限
##### 常规权限
满足基本监测需要如下权限:
| 权限                 | 用途                                                         |
| ——————– | ———————————————————— |
| INTERNET             | 允许程序联网和上报监测数据。                                 |
| ACCESS_NETWORK_STATE | 允许检测网络连接状态,在网络异常状态下避免数据发送,节省流量和电量。 |
| READ_PHONE_STATE     | 允许访问手机设备的信息,通过获取的信息来唯一标识用户。       |
| ACCESS_WIFI_STATE    | 允许读取WiFi相关信息,在合适的网络环境下更新配置。           |
##### 扩展权限
在基本监测的基础上,如果想要回传**位置相关信息**,除了监测代码对应**sdkconfig**内**Company**标签的<isTrackLocation>项设置为**true**,还额外需要如下权限:
| 权限                   | 用途                                   |
| ———————- | ————————————– |
| ACCESS_FINE_LOCATION   | 通过GPS方式获取位置信息。              |
| ACCESS_COARSE_LOCATION | 通过WiFi或移动基站的方式获取位置信息。 |
示例代码
“`
<!–?xml version=”1.0″ encoding=”utf-8″?–>
<manifest xmlns:android=”http://schemas.android.com/apk/res/android”
    package=”cn.com.mma.mobile.tracking.demo”>
    <!– SDK 所需常规权限 –>
    <uses-permission android:name=”android.permission.INTERNET” />
    <uses-permission android:name=”android.permission.ACCESS_NETWORK_STATE” />
    <uses-permission android:name=”android.permission.READ_PHONE_STATE” />
    <uses-permission android:name=”android.permission.ACCESS_NETWORK_STATE”/>
  <!– 如果获取位置信息,需要声明以下权限 –>
  <uses-permission android:name=”android.permission.ACCESS_FINE_LOCATION”/>
  <uses-permission android:name=”android.permission.ACCESS_COARSE_LOCATION”/>
<application ……>
  <activity ……>
  ……
  </activity>
    </application>
</manifest>
“`
### 步骤2:使用方法
#### 引入类
在您需要使用 SDK 监测功能的类中,**import** 相关类:
“`
import cn.com.mma.mobile.tracking.api.Countly;
“`
#### SDK初始化
接口定义:
“`
public void init(Context context, String configURL)
“`
参数说明:
| 参数      | 类型    | 说明                        |
| ——— | ——- | ————————— |
| context   | Context | APP or Activity 上下文      |
| configURL | String  | 更新sdkconfig配置的远程地址 |
代码示例:在您的工程中的 Application 或者 Activity 中的 **onCreate** 中添加如下代码:
“`
Countly.sharedInstance().init(this, “sdkconfig远程地址”);
“`
#### 曝光监测
SDK曝光监测接口现已升级为曝光/Track Ads接口, 支持曝光或Tracked Ads监测。
曝光的定义:只有广告物料已经加载在客户端并至少已经开始渲染(Begin to render,简称BtR)时,才应称之为“曝光”事件。
“渲染”指的是绘制物料的过程,或者指将物料添加到文档对象模型的过程。
接口定义:
“`
public  void onExpose(String adURL,View adview,int type)
“`
参数说明:
| 参数   | 类型   | 说明                               |
| —— | —— | ———————————- |
| adURL  | String | 广告位曝光监测代码                 |
| adview | View   | 广告展示视图对象                   |
| type   | int    | 0 代表Tracked Ads监测; 1 代表曝光 |
示例代码:
“`
Countly.sharedInstance().onExpose(“http://example.com/axxx,bxxxx,c2,i0,h”,adview,1);
“`
#### 点击监测
接口定义:
“`
public  void onClick(String adURL)
“`
参数说明:
| 参数  | 类型   | 说明               |
| —– | —— | —————— |
| adURL | String | 广告位点击监测代码 |
示例代码:
“`
Countly.sharedInstance().onClick(“http://example.com/axxx,bxxxx,c3,i0,h”);
“`
#### 可见性曝光监测
描述:对广告进行可见性监测时,广告必须是满足开始渲染(Begin to render,简称BtR)条件的合法曝光,否则SDK不会执行可见监测。
在调用可见曝光监测接口时,SDK会查验传入的广告View对象是否已开始渲染,如果是,则SDK会向监测方发出曝光上报,并继续进行可见监测,直到满足可见/不可见条件,再结束可见监测流程;如果不是,则SDK会向监测方发出Tracked Ads上报,并结束可见监测流程。
接口定义:
“`
public  void onExpose(String adURL, View adView)
“`
参数说明:
| 参数   | 类型   | 说明               |
| —— | —— | —————— |
| adURL  | String | 广告位曝光监测代码 |
| adView | View   | 广告展示视图对象   |
注意:对于需要可见性曝光的广告监测,第二个参数(**View**)为必选项,且需要传入当前广告展示的视图对象,否则可能造成SDK无法成功可见性曝光监测。
示例代码:
“`
Countly.sharedInstance().onExpose(“http://vxyz.admaster.com.cn/w/a86218,b1778712,c2343,i0,m202,8a2,8b2,2j,h”,adview);
“`
#### 可见性视频曝光监测
接口定义:
“`
public void onVideoExpose(String adURL, View videoView, int videoPlayType)
“`
参数说明:
| 参数          | 类型   | 说明                                               |
| ————- | —— | ————————————————– |
| adURL         | String | 广告位曝光监测代码                                 |
| videoView     | View   | 视频广告展示视图对象                               |
| videoPlayType | int    | 视频播放类型<br>1-自动播放,2-手动播放,0-无法识别 |
注意:对于需要可见性视频曝光的广告监测,第二个参数(**View**)为必选项,需要传入当前广告展示的视图对象且监测代码需要配置**视频时长及进度监测点**,否则可能造成SDK无法成功可见性视频曝光监测。
示例代码:
“`
        String adURL = “http://v.admaster.com.cn/i/a90981,b1899468,c2,i0,m202,8a2,8b2,2p,2u2,2g,2f=3,2v50,2w15,2×0010,va1,2a2p,2j,2d1234,h”;
        Countly.sharedInstance().onVideoExpose(adURL, adView, 2);
“`
#### 停止可见性监测
接口定义:
“`
public void stop(String adURL)
“`
参数说明:
| 参数  | 类型   | 说明               |
| —– | —— | —————— |
| adURL | String | 广告位曝光监测代码 |
SDK提供主动关闭可见性监测的功能,需要传入**已经开启可见性监测的广告位曝光监测代码**,如果传入错位的监测代码可能导致停止不生效。
示例代码:
“`
        String adURL = “http://vxyz.admaster.com.cn/w/a86218,b1778712,c2343,i0,m202,8a2,8b2,2j,h”;
        Countly.sharedInstance().onExpose(adURL, adView);
        new Handler().postDelayed(new Runnable(){
            public void run() {
                //5s后停止监测
                Countly.sharedInstance().stop(adURL);
            }
        }, 5000);
“`
#### 可见性曝光JS监测
接口定义:
“`
public void onJSExpose(String adURL, View adView)
public void onJSVideoExpose(String adURL, View adView)
“`
参数说明:
| 参数   | 类型   | 说明               |
| —— | —— | —————— |
| adURL  | String | 广告位曝光监测代码 |
| adView | View   | 广告展示视图对象   |
SDK提供通过 `JS方式` 对广告进行可见性监测,需要在 `sdkconfig` 添加JS监测配置,且需要传入当前广告展示的视图对象,否则可能造成SDK无法进行可见性曝光JS监测。
示例代码:
“`
String adURL = “http://vxyz.admaster.com.cn/w/a86218,b1778712,c2343,i0,m202,8a2,8b2,2j,h”;
Countly.sharedInstance().onJSExpose(adURL, adView);
Countly.sharedInstance().onJSVideoExpose(adURL, adView);
“`
#### 调试模式
调试模式下,SDK会有LOG输出,APP发布时建议不要开启。(请在**初始化之前设置Log开关**,默认为false)。
接口定义:
“`
public void setLogState(boolean debugmode)
“`
参数说明:
| 参数      | 类型    | 说明                                   |
| ——— | ——- | ————————————– |
| debugmode | boolean | true为打开SDK Log, false为关闭SDK Log |
示例代码:
“`
Countly.sharedInstance().setLogState(true);
“`
#### 释放内存
SDK提供释放内存的接口,一般在应用即将退出时调用,或者等待系统内存管理自动释放。
接口定义:
“`
public  void terminateSDK()
“`
示例代码:
“`
Countly.sharedInstance().terminateSDK();
“`
#### 混淆配置
如果开发者的应用需要混淆,请在 `Proguard` 混淆配置文件中增加以下规则,以避免 SDK 不可用。
“`
# SDK用到了v4包里的API,请确保v4相关support包不被混淆
-keep class android.support.v4.** { *; }
-dontwarn android.support.v4.**
“`
### 步骤3:验证和调试
SDK 的测试有两个方面:
1. 参数是否齐全,URL 拼接方式是否正确。
2. 请求次数和第三方监测平台是否能对应上。
请联系第三方监测平台完成测试。

MMA中国广告监测 通用 SDK (Android)

MMA中国广告监测 通用 SDK (Android)

 

MMA 通用 SDK 说明文档

MMA Android SDK 部署指南

步骤1:添加 MMA Android SDK 到工程中

  1. 点此下载MMA Android SDK (如需浏览此开源项目和 demo 工程请到http://git.oschina.net/注册账号后邮件联系 fuliuwei@admaster.com.cn)
  2. 将 MMA SDK 的 mma_android_sdk_v1.3.3.jar 拷贝到 libs 目录下并添加为 JAR 包;
  3. 将libMMANDKSignature.so 拷贝到 libs\armeabi 目录下;
  4. 把sdkconfig.xml配置文件拷贝到工程里的assets目录下,同时将 sdkconfig.xml 上传到 web 服务器,使其可以通过 web 方式访问,假设其地址为 CONFIG_URL(其后会用到)。

对于Eclipse工程,请参照下面的步骤添加 JAR 包:

  1. 在 “Package Explorer” 窗口中右击你的工程并选择 “Properties”
  2. 在左侧面板中选择 “Java Build Path”
  3. 在主窗口中选择 “Libraries”页签
  4. 点击“Add JARs…”按钮
  5. 选择您拷贝到libs目录下的 mma_sdk.jar
  6. 点击 “OK” 完成添加。

步骤2:修改 AndroidManifest.xml 文件

修改 AndroidManifest.xml 文件,新增网络连接请求和读取手机状态的权限:

<uses-permission android:name="android.permission.INTERNET" /> 
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" /> 
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" /> 
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" /> 
<uses-permission android:name="android.permission.READ_PHONE_STATE" />

步骤3:为广告添加监测代码

在有广告监测需求的 Activity 中的 onStart() 方法中调用 Countly.sharedInstance().init(this, CONFIG_URL); 进行初始化,其中 CONFIG_URL 为远程配置文件的地址,当广告产生曝光时,控制触发以下代码

String TEST_TRACKING_URL = "http://admaster.mobi/android/log/a222,c123,b132,";//TEST_TRACKING_URL 为对应的曝光代码  
Countly.sharedInstance().onExpose(TEST_TRACKING_URL);

当广告被点击时,控制触发以下代码

String TEST_TRACKING_URL = "http://admaster.mobi/android/log/a222,c123,b132,";//TEST_TRACKING_URL 为对应的曝光代码
Countly.sharedInstance().onClick(TEST_TRACKING_URL); 

代码示例(具体请见 demo 项目源码)

package com.mmandroid_demo;
import android.app.Activity;
import android.os.Bundle;
import android.view.View;
import android.widget.Button;
import cn.com.mma.mobile.tracking.api.Countly;
import cn.com.mma.mobile.tracking.util.Logger;
/**
 * 此工程是为使用SDK的用户提供的demo
 * 
 * @author lincoln
 * 
 */
public class MainActivity extends Activity {
 int count = 0;
/**
 * sdkconfig.xml配置文件服务器存放地址
 */
 public static final String CONFIG_URL = "http://admaster.mobi/sdkconfig.xml";
 /**
 * 点击监测地址
 */
 public static final String TEST_TRACKING_URL = "http://admaster.mobi/android/log/a222,c123,b132,";
@Override
 protected void onCreate(Bundle savedInstanceState) {
 super.onCreate(savedInstanceState);
 setContentView(R.layout.activity_main);
/**
 * 初始化SDK
 */
 Countly.sharedInstance().init(this, CONFIG_URL);
}
/**
 * 点击广告,发送消息
 */
 public void sendClickMsg(View view) {
 Countly.sharedInstance().onClick(TEST_TRACKING_URL);
 }
 /**
 * 曝光广告,发送消息
 */
 public void sendExposeMsg(View view) {
 Countly.sharedInstance().onExpose(TEST_TRACKING_URL);
 }
}

步骤4:验证和调试

SDK 的测试有两个方面:

  1. 参数是否齐全,URL 拼接方式是否正确
  2. 请求次数和第三方监测平台是否能对应上

针对第一点,使用 Admaster SDK 测试平台进行测试和验证,登入 http://developer.admaster.com.cn/, 根据页面上的提示进行调用, 页面会实时显示出服务器接收到的信息,如果和本地的设备相关信息一致,则表示测试通过。

针对第二点,建议使用第三方监测系统的正式环境进行测试,主要对比媒体自身广告系统监测数据和第三方监测数据数量上的差异。

MMA中国广告监测 通用 SDK (iOS)

MMA中国广告监测 通用 SDK (iOS)

 

MMA 通用 SDK 说明文档

MMA iOS SDK 部署指南

步骤1:添加 MMA iOS SDK 到工程中

  1. 点此下载MMA iOS SDK (如需浏览此开源项目和 demo 工程请到http://git.oschina.net/注册账号后邮件联系 fuliuwei@admaster.com.cn)
  2. 将SDK发布文件中,release目录下的MobileTracking.hlibMobileTracking.asdkconfig.xml三个文件拷贝到项目工程中,将 sdkconfig.xml 上传到 web 服务器,使其可以通过 web 方式访问,假设其地址为 http://xxxxxx.com/sdkconfig.xml(其后会用到)。
  3. 在项目工程 App 的 Target Build Settings 中的 Other Linker Flags 选项里添加 -lxml2 -all_load-lxml2 -force_load静态库的绝对路径

步骤2:配置文件sdkconfig.xml的使用方法

在使用的文件中引用 #import “MobileTracking.h”.

使用说明:

1、初始化方法

[MobileTracking sharedInstance]

在进行监测之前,必须进行初始化,通过以上的代码进行初始化操作,建议放在AppDelegate的didFinishLaunchingWithOptions方法中。

2、配置远程配置文件地址方法

[[MobileTracking sharedInstance] configFromUrl:@“http://xxxxxx.com/sdkconfig.xml”];

SDK 会自动下载远程的配置文件,使用最新的配置文件进行参数的组装。

3、点击和曝光的监测

通过调用以下的代码进行曝光的监测,参数为第三方公司的监测地址

[[MobileTracking sharedInstance] view:@"http://vxyz.admaster.com.cn/v/a17298,b81949763,c3194,i0,m201”];

通过调用以下的代码进行点击的监测,参数为第三方公司的监测地址

[[MobileTracking sharedInstance] click:@"http://vxyz.admaster.com.cn/v/a17298,b81949763,c3194,i0,m201"];

4、进入后台时调用

[[MobileTracking sharedInstance] didEnterBackground];

建议放在AppDelegate的applicationDidEnterBackground方法中

5、回到前台时调用

[[MobileTracking sharedInstance] didEnterForeground];

建议放在AppDelegate的applicationWillEnterForeground方法中

6、应用结束时调用

[[MobileTracking sharedInstance] willTerminate];

7、开启调试日志

[[MobileTracking sharedInstance] enableLog:YES];

建议在测试时候打开

步骤3:验证和调试

SDK 的测试有两个方面:

  1. 参数是否齐全,URL 拼接方式是否正确
  2. 请求次数和第三方监测平台是否能对应上

针对第一点,使用 Admaster SDK 测试平台进行测试和验证,登入 http://developer.admaster.com.cn/, 根据页面上的提示进行调用, 页面会实时显示出服务器接收到的信息,如果和本地的设备相关信息一致,则表示测试通过。

针对第二点,建议使用第三方监测系统的正式环境进行测试,主要对比媒体自身广告系统监测数据和第三方监测数据数量上的差异。