快速开始

前置准备

账号开通

请在首页联系商务开通 💗

SDK 获取

微信小游戏

1.在您的项目中找到合适的目录放入 guiyin.js 文件。

2.引入 js 文件

import { guiyin } from '../js/libs/guiyin.js';

Android

1.在项目根目录下的 build.gradle 中添加如下代码:

repositories {
    ...
    maven {
        allowInsecureProtocol true
        url "http://nexus-beta.bricksdk.com/repository/maven-releases"
    }
    ...
}

2.在项目 app 目录下的 build.gradle 文件中添加如下依赖:

dependencies {
    ...
    implementation "cc.k2games.android.guiyin:guiyin:1.0.0"
    ...
}

iOS

在您的项目目录中拖入GuiyinSDK.framework文件。

接口调用

初始化

微信小游戏

Guiyin.host('您的服务器地址');
Guiyin.init('您在平台申请的的appToken')
  .then(() => {})
  .catch(() => {});

Android

//(选填)需要自己对接，更多OAID相关信息请参考移动安全联盟官网，地址如下：
// https://www.msa-alliance.cn/col.jsp?id=120
GuiyinSDK.setOAID("您的设备的oaid")
//(选填)是否打印日志，默认不打印
GuiyinSDK.setLogEnable(true)
//(选填)设置自己的服务器，默认为归因平台服务地址
GuiyinSDK.setRequestUrl("您的服务器地址")
//初始化
GuiyinSDK.initGuiyin(
    context,
    "您在平台申请的的appToken", object : GuiyinCallBack {
        override fun onInitFailed() {
            //初始化失败
        }

        override fun onInitSuccess() {
           //初始化成功
        }

        override fun onFinishedEventReportingFailed(error: String, data: String?) {
          //事件上报失败
        }

        override fun onFinishedEventReportingSuccess(data: String) {
          //事件上报成功
        }

        override fun onGetReferrer(referrer: String) {
           //获取安装来源
        }
    }
)

IOS

   [GuiyinManager setLogEnable:YES];
   [GuiyinManager setRequestUrl:@"您的服务器地址"];
   [GuiyinManager initWithAppToken:kAppToken success:^(GuiyinCompleteResult * _Nonnull completeResult) {
        GuiyinCompleteResult *result = completeResult;
        NSInteger code = result.code;
        NSDictionary *data = result.data;
        NSLog(@"initSuccess:%ld-----%@",(long)code,data);
    } failure:^(GuiyinCompleteResult * _Nonnull completeResult) {
        GuiyinCompleteResult *result = completeResult;
        NSInteger code = result.code;
        NSDictionary *data = result.data;
        NSLog(@"initFailure:%ld-----%@",(long)code,data);
    }];

事件上报

微信小游戏

/**
 * @param object
 * event_token 事件token，从后台获取 必填
 * user_info 用户信息 非必填
 * action_data 行为数据 非必填
 * revenue_data 付费数据 非必填
 * report_json 其他上报数据 非必填 且不允许有多个层级。
 * referrer 非必填 来源：例如场景ID
 */
Guiyin.track({
  event_token: 'An***wv',
  user_info: {
    user_id: res.user_id, // 您的用户ID
  },
  action_data: {
    current: '首页', // 您所在当前页面名称
    next: '我的', // 将要前往的页面名称
  },
  revenue_data: {
    revenue: 0, // 收入金额（单位：分）
    currency: 'CNY', //货币单位（例如：CNY）
  },
  report_json: {
    key1: 'value1',
    key2: 'value2',
  },
  referrer: '',
})
  .then(() => {})
  .catch((err) => {
    console.log(err);
  });

Android

val trackEventObject = GuiyinTrackEventObject()
//(选填) 您的安装来源
trackEventObject.referrer = "您的来源"
//(选填) 您的用户信息
trackEventObject.userInfo = GuiyinUserInfo("您的用户ID")
//(选填) 您付费数据
trackEventObject.revenueData = GuiyinRevenueData(100, "您的费用单位")
//(选填) 您的行为数据
trackEventObject.actionData =
    GuiyinActionData("您所在当前页面名称", "您将要前往的页面名称")
//(选填) 您的其他附加数据
trackEventObject.otherReportJson = mapOf("key1" to "value1", "key2" to "value2")
GuiyinSDK.track(
    "您的事件eventToken", trackEventObject
)

IOS

//1.设置事件token进行上报

[GuiyinManager gyTrackEventWith:@"事件token"];

//2.设置事件token和其他上报数据

[GuiyinManager gyTrackEventWith:@"事件token" andReportJson:@"上报的json格式数据"];

//3.设置事件token和数据来源上报

[GuiyinManager gyTrackEventWith:@"事件token" andReferrer:@"数据来源"];

//4.设置事件token和数据来源以及其他数据上报

[GuiyinManager gyTrackEventWith:@"事件token" referrer:@"数据来源" reportJson:@"上报的json格式数据"];

//5.设置事件token和用户ID上报

[GuiyinManager gyTrackEventWith:@"事件token" andUserID:100];

//6.设置事件token和用户ID以及其他数据上报

[GuiyinManager gyTrackEventWith:@"事件token" userID:100 reportJson:@"上报的json格式数据"];

//7.设置事件token和数据来源以及用户ID上报

[GuiyinManager gyTrackEventWith:@"事件token" referrer:@"数据来源" userID:100];

//8.设置事件token、数据来源、用户ID、其他上报数据上报

[GuiyinManager gyTrackEventWith:@"事件token" referrer:@"数据来源" userID:100 reportJson:@"上报的json格式数据"];

//9.设置事件token、用户ID、收入金额（单位：分）、货币单位（例如：CNY）上报

[GuiyinManager gyTrackEventWith:@"事件token" userID:100 revenue:100 currency:@"CNY"];

//10.设置事件token、用户ID、收入金额（单位：分）、货币单位（例如：CNY）、其他数据上报

[GuiyinManager gyTrackEventWith:@"事件token" userID:100 revenue:100 currency:@"CNY" reportJson:@"上报的json格式数据"];

//11.设置事件token、数据来源、用户ID、收入金额（单位：分）、货币单位（例如：CNY）上报

[GuiyinManager gyTrackEventWith:@"事件token" referrer:@"数据来源" userID:100 revenue:100 currency:@"CNY"];

//12.设置事件token、数据来源、用户ID、收入金额（单位：分）、货币单位（例如：CNY）、其他数据上报

[GuiyinManager gyTrackEventWith:@"事件token" referrer:@"数据来源" userID:100 revenue:100 currency:@"CNY" reportJson:@"上报的json格式数据"];

//13.设置事件token、当前页面、下个页面上报

[GuiyinManager gyTrackEventWith:@"事件token" current:@"当前页面" next:@"下个页面"];

//14.设置事件token、当前页面、下个页面、其他上报数据上报

[GuiyinManager gyTrackEventWith:@"事件token" current:@"当前页面" next:@"下个页面" reportJson:@"上报的json格式数据"];

//15.设置事件token、数据来源、当前页面、下个页面上报

[GuiyinManager gyTrackEventWith:@"事件token" referrer:@"数据来源" current:@"当前页面" next:@"下个页面"];

//16.设置事件token、数据来源、当前页面、下个页面、其他上报数据上报

[GuiyinManager gyTrackEventWith:@"事件token" referrer:@"数据来源" current:@"当前页面" next:@"下个页面" reportJson:@"上报的json格式数据"];

//17.全部参数上报
GuiyinObject *object = [[GuiyinObject alloc] init];
object.appToken = @"AppToken";
object.eventToken = @"事件token";
object.revenue = 100;//费用单位
object.userId = 100;//用户ID
object.currency = @"CNY";
object.current = @"test";
object.next = @"text";
object.referrer = @"您的来源";
object.reportJson = @"其他上报json";
[GuiyinManager gyTrackEventAllParametersWith:object];