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, //開啟調試模式
  	...
	}
};

輸出日志示例：