微信小程序SDK接入指南

微信公众平台注册小程序

首先从 地址下载。

或者者身份在微信小程序后台->设置->设置服务器域名添加合法域名 和 。具体如下图所示:

在小程序编辑器中,查看控制台中的是否有加载的请求,并且为200,具体如下图所示:

在需要布码的模块引入模块。

接口定义以及详细描述:

, () , , .

@ : , .

@ : , .

注意事项以及使用说明: 该接口为采集初始化接口,需要在小程序的 ()生命周期方法内调用,请确保在()方法的最开始处调用。

调用示例:.("732681087","1.2.0");

接口定义以及详细描述

,

@ : , '

@ : {} ,

' , .

注意事项以及使用说明: 该接口为基础事件采集接口,参数不能为空,为空时无采集数据入库。为事件的自定义属性值,为{}结构,可传递或者{},其中/层级只支持一级扩展。详细请参看调用示例。

调用示例:

接口定义以及详细描述

,

@ : {},

注意事项以及使用说明: 该接口为小程序转发共享事件,事件名为内定字段,者只需要传入自定义的属性即可。值可为空或者。 如该接口不能满足相关采集业务,可通过基础采集事件自定义实现。 调用示例:

接口定义以及详细描述

.

@ : , '

, . .

@ : , ' , ()

@ : {} .

注意事项以及使用说明: 如果想要统计一个事件的持续时长,比如阅读文章时长,订单生成到付款结束的时长等,都可使用这两个接口来共同实现数据统计。 其中接口记录一个事件开始的开始时间,接口为时间的结算接口,并可传入相关事件的自定义属性值,如不需要可为{}/。 事件名不能为空,为空时无采集数据入库。同时,两个接口必须匹配使用,匹配使用时事件名必须保持一致,否则无法统计相关事件的时长信息。 调用示例:

接口定义以及详细描述:

, , .

@ : , .

@ : , .

@ : , .

@ : {} , , , , ...

: (, , , ) {}

注意事项以及使用说明: 如果想要统计用户登录后的用户信息,可使用该接口来实现。 参数可作为当前用户登录的账名。和为微信特有字段。这三个字段必须传入一个有效值,不能同时为空或者。 为用户自定义属性信息,为{}结构,可为空/. 调用示例:

接口定义以及详细描述:

@ :

@ : {} , .

注意事项以及使用说明: 如果想要统计用户注册信息,可使用该接口来实现。 为对象,具体字段信息参看调用示例。 调用示例:

接口定义以及详细描述:

, .

@ : , .

@ : , /

注意事项以及使用说明: 如果想要统计业务上的异常或者错误信息,可用该接口来实现,比如登录失败,异常捕获等。 调用示例:

.(, );

接口定义以及详细描述:

, "" , ' ' "" ,, .

, "" ( ), ...

@ : , '

@ : {} ,

注意事项以及使用说明: 当小程序页面切换时,会自动采集事件。如果用户期望在不切换页面的时候某些区域或者动态的弹层也作为一个事件来采集,则可以使用该接口来实现。 参数不能为空,为空时无采集数据入库。 为的自定义属性,可以为{}/. 调用示例:

接口定义以及详细描述:

, ( ) , .

, ()

@ :

@ : {} .

注意事项以及使用说明: 当小程序页面切换时,会自动采集事件。默认采集的 名称为当前页面的路径值,没有具体的业务含义,提供了一次修改该值的机会,用户可以根据自己的业务场景来自定义自动采集的中的相关的值。 该接口必须在每个页面的()方法一开始出即可调用,否则修改值可能无效。 参数为自定义的具有业务含义的页面名称. 如果为空/,则修改无效。 为页面的自定义属性,如果为空,但有效,则修改依然有效, 此时依然为当前页面的路径值。 调用示例:

示例:.();

示例:.(); 默认为关闭状态。打开后在小程序编辑器中的看到输出的信息,包括调用的各个接口信息以及发送包数据。

接口定义以及详细描述:

- , .

@ : ,

@ : {}, .

@ : {}/, .

注意事项以及使用说明:  所有电商接口共用此接口,通过不同的参数来实现接口分发。 参数值为内定字段,包括:

"_" //(商品展示信息)

"__" //(商品详情信息)

"__" //(添加购物车信息)

"__" //(删除购物车信息)

"__" //(生成订单详细信息)

"_" //(付款信息)

"_" //(退货信息)

"__" //(添加收藏夹信息),

"__" //(删除收藏夹信息)

参数值为相关的详细的产品信息,为{}结构,字段为内定字段,每个对应的结构都不一致,具体参看下面每个接口的调用示例。 参数为每个事件的自定义属性信息,可以为空{}/。字段和值均为用户自定义。

调用示例: 必填字段: _, __

. 是否必须根据具体接口来定

"__": '', //与产品关联的券代码(例如 _13).选填

"__": 3,//产品数量,选填

"__": {//与产品相关的自定义属性,{}. 选填

"_3": "_4",

"_4": "_4"

},

"__":' '//产品在列表或(例如搜索结果),选填

}

]

= { "__1": "__1","__2": "__2" };

.("_",, );

调用示例: 必填字段: _, __

. 是否必须根据具体接口来定

"__": '', //与产品关联的券代码(例如 _13).选填

"__": 3,//产品数量,选填

"__": {//与产品相关的自定义属性,{}. 选填

"_3": "_4",

"_4": "_4"

},

"__":' '//产品在列表或(例如搜索结果),选填

}

= { "__1": "__1", "__2": "__2" };

.("__", , );

调用示例: 必填字段: _, __

. 是否必须根据具体接口来定

"__": '', //与产品关联的券代码(例如 _13).选填

"__": 3,//产品数量,选填

"__": {//与产品相关的自定义属性,{}. 选填

"_3": "_4",

"_4": "_4"

},

"__":' '//产品在列表或(例如搜索结果),选填

}

= { "__1": "__1", "__2": "__2" };

.("__", , );

调用示例: 必填字段: _, __

. 是否必须根据具体接口来定

"__": '', //与产品关联的券代码(例如 _13).选填

"__": 3,//产品数量,选填

"__": {//与产品相关的自定义属性,{}. 选填

"_3": "_4",

"_4": "_4"

},

"__":' '//产品在列表或(例如搜索结果),选填

}

= { "__1": "__1", "__2": "__2" };

.("__", , );

调用示例: 必填字段: _, __,  __

. 是否必须根据具体接口来定

"__": '', //与产品关联的券代码(例如 _13).选填

"__": 3,//产品数量,选填

"__": {//与产品相关的自定义属性,{}. 选填

"_3": "_4",

"_4": "_4"

},

"__":' '//产品在列表或(例如搜索结果),选填

]

}

= { "__1": "__1", "__2": "__2" };

.("__", , );

必填字段: __, _, __,  __

. 是否必须根据具体接口来定

"__": '', //与产品关联的券代码(例如 _13).选填

"__": 3,//产品数量,选填

"__": {//与产品相关的自定义属性,{}. 选填

"_3": "_4",

"_4": "_4"

},

"__":' '//产品在列表或(例如搜索结果),选填

]

}

= { "___1": "___1", "___2": "___2" };

.("_", , );

必填字段: __, _, __

. 是否必须根据具体接口来定

"__": '', //与产品关联的券代码(例如 _13).选填

"__": 3,//产品数量,选填

"__": {//与产品相关的自定义属性,{}. 选填

"_3": "_4",

"_4": "_4"

},

"__":' '//产品在列表或(例如搜索结果),选填

]

}

= { "___1": "___1", "___2": "___2" };

.("_", , );

必填字段: _, __

. 是否必须根据具体接口来定

"__": '', //与产品关联的券代码(例如 _13).选填

"__": 3,//产品数量,选填

"__": {//与产品相关的自定义属性,{}. 选填

"_3": "_4",

"_4": "_4"

},

"__":' '//产品在列表或(例如搜索结果),选填

}

= { "____1": "____1", "____2": "____2" };

.("__", , );

必填字段: _, __

. 是否必须根据具体接口来

"__": '', //与产品关联的券代码(例如 _13).选填

"__": 3,//产品数量,选填

"__": {//与产品相关的自定义属性,{}. 选填

"_3": "_4",

"_4": "_4"

},

"__":' '//产品在列表或(例如搜索结果),选填

}

= { "____1": "____1", "____2": "____2" };

.("__", , );

如何生成携带自定义场景值参数的码,详情请参考小程序官方文档:调用接口传参添加参数名为__,如下图:

或者在小程序工具中测试场景时亦可添加启动参数__,如下图:

© 版权声明
THE END
分享