APICloud SDK 使用说明

最后更新于：2018-08-02 11:45:20

在使用前，请先阅读数据模型的介绍。

sharedInstance

login

track

flush

概述

APICloud SDK 封装了神策数据Android & iOS SDK，集成了神策初始化SDK、设置登录Id、埋点、强制同步数据等功能，获取收集事件的URL和获取配置信息的URL。

sharedInstance

初始化SDK

sharedInstance({params})

params

serverURL：

  • 类型：字符串
  • 描述：(必填项)收集事件的URL

configureURL：

  • 类型：字符串
  • 描述：(必填项)配置信息的URL

debugMode：

  • 类型：字符串
  • 描述：debug模式
  • debugMode 有三种形式
    • debugOff - 关闭debug模式
    • debugOnly - 打开 Debug 模式，校验数据，但不进行数据导入
    • debugAndTrack - 打开 Debug 模式，校验数据，并将数据导入到神策分析中
注意：正式发布app时请将 `debugMode` 指定成 `debugOff` 模式！

示例代码

apiready = function() {
    var saAPICloud = api.require('sensorsAnalyticsAPICloudSDK');
    saAPICloud.sharedInstance({
        serverURL: 'your server url', 
           configureURL: 'your configure url', 
        debugMode: 'your debug mode'
    });
}

login

设置当前用户的 loginId

login({params})

params

loginId：

  • 类型：字符串
  • 描述：(必填项)用户的登录id，不能为空，且长度不能大于255

示例代码

document.getElementById('login').onclick = function() {
    var saAPICloud = api.require('sensorsAnalyticsAPICloudSDK');
    saAPICloud.login({
        loginId: '123456'
    });
}

track

track事件

track({params})

params

event：

  • 类型：字符串
  • 描述：(必填项)事件名称，名称需要满足一般的命名规则，即不能以数字开头，且只包含：大小写字母、数字、下划线和$

properties：

  • 类型：json格式
  • 描述：(选填项)事件属性，属性名需要满足一般的命名规则

示例代码

document.getElementById('track').onclick = function() {
    var saAPICloud = api.require('sensorsAnalyticsAPICloudSDK');
    saAPICloud.track({
        event:'ViewProduct',
        properties:{
               ProductID:123456,
               ProductCatalog:'Laptop Computer',
               IsAddedToFav: false
        }
    });
}

flush

手动同步数据

flush()

示例代码

document.getElementById('flush').onclick = function() {
    var saAPICloud = api.require('sensorsAnalyticsAPICloudSDK');
    saAPICloud.flush();
}

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本