公众号管理

1 操作说明

下述表格为公众号事件采集的必要步骤，请按照顺序操作：

1.1 接入公众号

产品路径：「数据采集」-「数据源管理」-「公众号管理」

点击「接入公众号」按钮，弹出右侧「接入数据源」页面完成新建接入公众号，完成接入需要填写如下信息：

「基础信息」

• 公众号名称：填写要接入的公众号名称

• 公众号ID：填写公众号ID，公众号ID不可重复。获取方式见下图：

「分析设置」

• 归属组织：默认为当前组织不可修改，如需在不同组织下接入公众号，需在左侧组下拉框切换组织。

• 归属应用：在下拉选择框选择当前归属组织下的应用。

「接收微信消息」

• 加密模式：分为安全模式与明文模式；

安全模式：EncodingAESKey 用于消息体加解密密钥，与微信公众号平台填写一致。

明文模式：不使用消息体加解密功能，安全系数较低。

• EncodingAESKey 获取地址：公众号后台-基础配置-复制EncodingAESKey。

• Token获取地址：公众号后台-基础配置-复制Token

（注：微信公众号后台URL为用户填写地址，微信公众号将数据发至填写地址后，再同步至Quick Tracking。参考文档）

「匿名用户唯一标识」

必选项，设置以Union或OpenID来作为匿名用户的唯一标识。

• OpenID：用户唯一标识；

• UnionID：用于区分用户的唯一值，设置为UnionID后，需获取access_token。

「获取access_token」

如果有其他业务同时使用了Token，用户需自搭建的中控服务，来统一获取、维护access_token，在分析平台中可从中控服务来获取access_token。（注：选择unionID为匿名用户唯一标识，用户需配置一个控制中心。Quick Tracking通过中控中心来获取token，在微信公众号获取对应的unionID（因每次调用获取token后token会进行刷新，其他位置使用的token也会刷新改变。且获取token次数微信开发平台有限制，用户可以从控制中心获取token，且可控制token的周期））

• 中控服务器地址：填写自建的中控服务地址可以获取到token中控服务地址；

• access_token解析：从中控服务器获取的返回值中解析access_token，通过JSONPah表达式解析，填写 JSONPath表达式，点击「测试」，测试是否解析成功，解析成功则可正常获取。

完成以上步骤点击保存完成创建。

1.2 公众号管理

公众号操作区主要由以下几个部分组成：

• 左侧组织筛选区：切换不同组织下接入的公众号

• 数据展示区：展示已接入的公众号列表，数据包含公众号名称、公众号APPID、创建人、归属应用和操作。注意：分析设置中，一个公众号只能选择归属一个应用。

• 操作区：操作区包含「编辑」与「操作」，点击「编辑」后和新增的界面一致，点击删除则表示从应用中移除了公众号的关联。

1.3 数据分析

接入公众号后的应用，以及有“接入公众号后的应用”的分析视图和小站，系统属性中需要有公众号事件参与分析，其中参与分析的系统属性如下表格：

透出公众号事件的分析模型有：事件分析、漏斗分析、留存分析、分布分析、间隔分析、路径分析、生命周期、归因分析、人群管理。

2 事件及事件属性

微信公众号事件是由微信定义、生成和发送的，开发者仅为订阅这些数据，无法进行自定义。具体可订阅的事件列表如下：

3 事件采集

3.1 服务端埋点参数获取

1. 进入管理控制台-->点击采集信息

2. 主域名：服务端埋点数据上报地址

3. 副域名：默认和主域名一致，私部署客户可以提供副域名作为备用域名

4. ServiceSecret和ServiceID为校验参数，注意保密不可泄漏。

5. code为开发者ID(AppID)，必填来自微信公号平台，且需要在采集管理-数据源管理-公众号管理中配置。

注意：因为上述信息涉及系统安全，所以只有管理员权限才可以看到！

3.2 请求参数

接口地址：https://<收数域名+端口>/server/thirdPartyDataSource

请求参数content-type：application/json

请求JSON参数：

<xml><ToUserName><![CDATA[gh_0b03a4dd7455]]></ToUserName>
<FromUserName><![CDATA[o884561i2yjDrOhC6IqzEzXtPKUo]]></FromUserName>
<CreateTime>1676613107</CreateTime>
<MsgType><![CDATA[text]]></MsgType>
<Content><![CDATA[测试]]></Content>
<MsgId>24003327368861869</MsgId>
</xml>

3.3 鉴权sign生成规则

1. 先将除了sign字段的其他所有请求字段的key和value封装成一个map对象

2. 将这个map对象序列化成JSON字符，生成时需要将key按照自然排序即ascii码排序，java可使用JSONObject.toJSONString(mapObject, SerializerFeature.MapSortField)，

3. 获取serviceSecret

4. sign = MD5(排序完生成的JSON字符 + serviceSecret)

5. 将计算得到的sign放到原始的map对象中，再序列化成JSON字符即为最终完整的JSON请求报文

3.4 响应说明

响应数据content-type：application/json

响应的JSON字符中有两个字段，分别为code、message

3.5 java demo参考

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import com.alibaba.fastjson.serializer.SerializerFeature;
import com.google.gson.Gson;
import okhttp3.*;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Controller;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.nio.charset.Charset;
import java.util.HashMap;
import java.util.Map;

/**
* ThirdPartyDataSourceApiDemo 接入第三方数据源demo
*
* @author chengtao
*/
public class ThirdPartyDataSourceApiDemo {
     private static final Logger logger = LoggerFactory.getLogger(ThirdPartyDataSourceApiDemo.class);

    /**
     * 主域名
     */
    private static final String API_URL = "*****";

    /**
     * 对应服务端埋点信息中的：ServiceID
     */
    private static final String SERVICE_ID = "*****";

    /**
     * 对应服务端埋点信息中的：ServiceSecret
     */
    private static final String SERVICE_SECRET = "*****";

    /**
     * client日志
     */
    private static final OkHttpClient client = new OkHttpClient();

    /**
     * 获取微信公众号日志信息并转发到QT收数（需要在微信公众号管理后台中配置该接口）
     * 
     * @param request
     * @throws IOException
     */
    @RequestMapping("/token")
    @ResponseBody
    public void token(HttpServletRequest request) throws IOException {
        //获取微信公众号官方请求中的全部参数信息，并封装成json
        Map<String, String[]> paramMap = request.getParameterMap();

        JSONObject json = paramMapToJson(paramMap);

        //向报文中添加服务ID
        json.put("app_id",SERVICE_ID);

        //向报文中添加ts
        json.put("ts", String.valueOf(System.currentTimeMillis()));

        //填写公众号ID
        String code = "******";
        json.put("code", code);

        //获取微信公众号xml数据
        String weChatOAData = new String(InputStreamUtil.getBytes(request));
        json.put("weChatOAData", weChatOAData);

        //计算签名
        String sign = MD5Util.md5(JSONObject.toJSONString(json, SerializerFeature.MapSortField) + SERVICE_SECRET);

        json.put("sign", sign);

        String desJsonString = JSON.toJSONString(json, SerializerFeature.DisableCircularReferenceDetect);

        Request newRequest = new Request.Builder()
                .URL(API_URL + "/server")
                .post(RequestBody.create(MediaType.parse("application/json"),
                        desJsonString))
                .build();
        try {
            Response response = client.newCall(newRequest).execute();
            if (!response.isSuccessful()) {
                System.out.printf("[DEMO] 发送日志失败 %s%n", response);
            } else {
                System.out.printf("[DEMO] 发送成功 %s%n",
                        response.body().string());
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    private static JSONObject paramMapToJson(Map<String, String[]> paramMap) {
        Map<String, Object> bodyMap = new HashMap<>();
        for (Map.Entry<String, String[]> entry : paramMap.entrySet()) {
            String key = entry.getKey();
            String[] value = entry.getValue();
            if (value.length == 1) {
                bodyMap.put(key, value[0]);
            } else {
                bodyMap.put(key, value);
            }
        }
        return JSON.parseObject(new Gson().toJson(bodyMap));
    }

    private static String getBodyString(HttpServletRequest request) {
        StringBuilder sb = new StringBuilder();
        InputStream inputStream = null;
        BufferedReader reader = null;
        try {
            inputStream = request.getInputStream();
            reader = new BufferedReader(new InputStreamReader(inputStream, Charset.forName("UTF-8")));
            String line = "";
            while ((line = reader.readLine()) != null) {
                sb.append(line);
            }
        } catch (IOException e) {
            logger.error("read body error", e);
            throw new RuntimeException("read body error");
        } finally {
            if (inputStream != null) {
                try {
                    inputStream.close();
                } catch (IOException e) {
                    logger.error("close inputStream error", e);
                }
            }
            if (reader != null) {
                try {
                    reader.close();
                } catch (IOException e) {
                    logger.error("close reader error", e);
                }
            }
        }
        return sb.toString();
    }
}


public class MD5Util {

    public static String md5(String s) {
        char hexDigits[] = {'0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'};
        try {
            byte[] btInput = s.getBytes();
            // 获得MD5摘要算法的 MessageDigest 对象
            MessageDigest mdInst = MessageDigest.getInstance("MD5");
            // 使用指定的字节更新摘要
            mdInst.update(btInput);
            // 获得密文
            byte[] md = mdInst.digest();
            // 把密文转换成十六进制的字符串形式
            int j = md.length;
            char str[] = new char[j * 2];
            int k = 0;
            for (int i = 0; i < j; i++) {
                byte byte0 = md[i];
                str[k++] = hexDigits[byte0 >>> 4 & 0xf];
                str[k++] = hexDigits[byte0 & 0xf];
            }
            return new String(str);
        } catch (Exception e) {
            return null;
        }
    }

    /**
     * 单元测试
     */
    public static void main(String[] args) {
        StringBuilder dtskey = new StringBuilder("abc12390");
        dtskey.append('\0').append("~!@#$%^&*()_+");
        System.out.println(MD5Util.md5(dtskey.toString()));
        System.out.println(MD5Util.md5("20121221"));
        System.out.println(MD5Util.md5("加密"));
    }
}