基础功能

1.1 原理

SDK提供两种API调用方式

• 通过aplus环境变量直接调用API的方式

• 向SDK的指令队列aplus_queue发送API指令的方式

注：两种方式任选其一，可以混用

1.1.1 通过aplus环境变量直接调用API

API直接调用的方式代码书写上更为简洁，格式如下：

const { aplus } = 小程序平台环境变量 //如微信wx、支付宝my、字节tt、百度 swan等
aplus.${APIName}($arguments) //arguments 为指定 API 的入参

其中APIName包括：

1. setMetaInfo: 覆盖SDK的已有默认设置

2. appendMetaInfo: 追加SDK的默认配置

3. getMetaInfo：获取 SDK 的当前配置

4. record：用于发送事件日志

5. sendPV：用于发送页面日志

arguments为每个API调用的入参

1.1.2 向指令队列aplus_queue发送API指令

向SDK发送API指令的方式，您通过向SDK的指令队列 aplus_queue发送指令，由SDK来执行指令，进而完成您的需求，指令格式如下：

const { aplus_queue } = 小程序平台环境变量 //如微信wx、支付宝my、字节tt、百度 swan等
aplus_queue.push({
 	'action': "$APIName", 
  'arguments': [$arguments] //arguments 为指定 API 的入参
})

• action 参数代表发送指令的 API 名称，其入参为一个字符串，取值为枚举值，可用的枚举值如下

  • aplus.setMetaInfo：覆盖SDK的已有默认设置

  • aplus.appendMetaInfo: 追加SDK的默认配置

  • aplus.getMetaInfo：获取 SDK 的当前配置

  • aplus.record：用于发送事件日志

  • aplus.sendPV：用于发送页面日志

• arguments 参数为 action 中指定 API 的入参，格式是一个数组，数组内的元素顺序与 API 定义的入参顺序一致

1.2 示例

1.2.1 通过aplus环境变量直接调用API示例

const { aplus } = 小程序平台环境变量 //如微信wx、支付宝my、字节tt、百度 swan等

//覆盖 SDK 的默认设置
aplus.setMetaInfo(metaName, metaValue);

//追加 SDK 的默认设置，仅针对metaValue是数组Array或者对象Object的类型有效
aplus.appendMetaInfo(metaName, metaValue)

//获取 SDK 的当前配置
aplus.getMetaInfo(metaName);

//用于发送事件日志
aplus.record(trackerEventCode, eventType, eventParams);

//用于发送页面日志
aplus.sendPV(pageEventConfig, userData);

1.2.2 向指令队列aplus_queue发送API指令调用示例

const { aplus_queue, aplus } = 小程序平台环境变量 //如微信wx、支付宝my、字节tt、百度 swan等

//覆盖 SDK 的默认设置
aplus_queue.push({
  action: 'aplus.setMetaInfo',
  arguments: [metaName, metaValue]
});

//追加 SDK 的默认设置，仅针对metaValue是数组Array或者对象Object的类型有效
aplus_queue.push({
  action: 'aplus.appendMetaInfo',
  arguments: [metaName, metaValue]
});

//获取 SDK 的当前配置
aplus.getMetaInfo(metaName);

//用于发送事件日志
aplus_queue.push({
  action: 'aplus.record',
  arguments: [trackerEventCode, eventType, eventParams]
});

//用于发送页面日志
aplus_queue.push({
  action: 'aplus.sendPV',
  arguments: [pageEventConfig, userData]
});

2 日志打印

const aplusConfig = {
	metaInfo: {
		...
		'DEBUG': true, //开启调试模式
  	...
	}
};

输出日志示例：