有赞云技术支持
    •  0 回帖  •  7.4K 浏览  •  4 年前
 

有赞云开放接口数据场景对接方案

一、背景介绍

微商城“数据中心”目前有店铺来源监控、数据分析等功能，基于这类功能可以做店铺数据分析，监控活动（如广告投放）效果等。目前已开放有“来源监控”相关接口，第三方或商家如果需要打通店铺数据分析的功能，可以通过有赞云开放接口进行对接。

二、业务说明

1. 名词解释

名词 解释
监控页面 是指将要被选择进行推广的一个微页面或者商品页面
跟踪链接 是指为监控的页面，生成一个针对某个来源的链接。该链接会有特殊标记，投放出去后，可以看到从指定来源获取的落地 PV/UV、转化数据等
来源 是指要投放渠道，比如投放 QQ 空间的侧边栏，那来源就可以起名叫做 QQ 空间侧边栏
落地 PV/UV 页面作为第一个被访问页面的浏览器次数和用户数
二跳 PV/UV 用户访问落地页面后，在页面中发生点击行为进入更多店铺内页面的点击次数和用户数
页面跳出率 用户访问落地页面后，没有任何访问就退出页面的比率。计算公式：（落地 UV- 点击 UV）/ 落地 UVx100% ;

2. 使用场景

1、店铺运营者小炮谈好了公众号“H 家”的头条图文推广合作，小炮想知道这次图文推广，给自己店铺实际带来了多少的访客，有多少成交订单。
2、小炮希望能找到哪些客户是从“H 家”带来的，做进一步分析和转化，使用推广分析可以轻松标记。
3、小炮在店铺发展期，测试了多个渠道的推广效果，希望能找个几个靠谱的渠道长期合作，通过推广分析的渠道效果对比，能快速找到数据效果好的渠道。
4、三方系统需要将商家在公众号、分销等渠道进行推广的效果数据如 PV/UV 等，集成到自有平台；
5、三方系统需要在自有平台直接对商城微页面或商品页生成跟踪链接，直接对接其它渠道进行投放。

3. 操作流程

1）要获取跟踪数据，需先创建跟踪链接，可调用创建跟踪链接接口完成。跟踪链接可以针对微页面创建，也可以针对商品详情页创建，每个页面可以添加最多 15 个跟踪链接。
2）创建完跟踪链接后，需要对跟踪链接进行投放，比如投放到公众号、QQ 等，有赞会生成相应的流量和转化交易数据，投放操作由三方平台自行完成。
3）调用接口查询、同步跟踪效果数据，数据包括落地 PV/UV，二跳 PV/UV，页面跳出率，转化下单数等，类似如下。
4）将通过接口获取的数据同步至自有平台进行分析、展示等，具体三方平台可以根据实际需要自行完成分析、展示的功能。

三、涉及 API 接口及调用说明

1、开通推广分析插件，并充值
image.png

推广分析条数：订购推广分析服务后，会赠送 100 条推广监控条数。每次创建一条推广监控，将消耗一条推广监控条数。赠送的 100 条使用完后，需单独购买推广监控条数。如果插件服务期过期，推广条数还未使用完，在续费后，原有推广条数仍可使用。
在商城后台–数据 - 推广分析页面，可获取到该店铺剩余可创建到监控条数；
image.png

——通过哪个接口可以快捷的获取到该店铺的剩余可创建监控条数？
（1）获取某个店铺下监控链接剩余条数:youzan.datacenter.psstock.fetch.3.0.0
（2）链接地址：https://doc.youzanyun.com/doc#/content/API/1-422/detail/api/0/117
（3）调用格式，通过（2）中链接访问后：
image.png

（4）HTTP 调用示例：

curl -X POST "https://open.youzanyun.com/api/youzan.datacenter.psstock.fetch/3.0.0?access_token=c3220121ae0fc6c4e11123370e0d1b03" -H 'content-type: application/json' -d '{}'

（5）JAVA 调用示例：

        Token token = new Token("21ceba9f18821c3319d2eb779cd31a4");
        DefaultYZClient yzClient = new DefaultYZClient(); 
        YouzanDatacenterPsstockFetch youzanDatacenterPsstockFetch = new YouzanDatacenterPsstockFetch();
        //创建参数对象,并设置参数
        YouzanDatacenterPsstockFetchParams youzanDatacenterPsstockFetchParams = new YouzanDatacenterPsstockFetchParams();
        youzanDatacenterPsstockFetch.setAPIParams(youzanDatacenterPsstockFetchParams);
        try {
        YouzanDatacenterPsstockFetchResult result = yzClient.invoke(youzanDatacenterPsstockFetch, token, YouzanDatacenterPsstockFetchResult.class);
            System.out.println(JSON.toJSON(result));
        } catch (SDKException n) {
            n.printStackTrace();
        }
    }
}

2、创建推广监控，生成推广链接，给到推广渠道进行投放

image.png

1）推广名称可记录本次推广的特点，便于后续查找。例如：XX 公众号 612 头条推送 2）推广页面即选择本次推广进入的页面，支持选择的推广页面有：微页面、商品页、商品分组页、店铺主页、秒杀、拼团、优惠券等。知识付费的详情与专栏页已在开发中，近期会更新支持。
3）推广渠道填写本次推广选择合作的渠道名，如：XX 公众号
4）推广花费填写本次推广花费的金额，便于计算推广转化 ROI
5）设置“访问客户打标签” 项，客户通过推广监控链接进入店铺后，将被打上设置的标签，便于后续客户定位及运营。
6）对于多网点商家来说，在广告投放时，新访客进入店铺需要选择网点，可能会造成部分访客连有吸引力的店铺页面都没看到，就离开了。通过设置 “绑定网点”，在访客打开监控链接时，直接进入对应的网点，大大减少访客流失。

image.png

信息填好后，创建完成，生成推广链接、推广二维码、推广小程序码、推广小程序路径，可选择任意一种方式进行投放，也可多种投放、数据均会统计到该推广监控中。
image.png

——通过哪个接口可以快捷的创建推广监控？
（1）创建推广分析 (推广监控):youzan.datacenter.pspagesource.create.3.0.0
（2）链接地址：https://doc.youzanyun.com/doc#/content/API/1-422/detail/api/0/174
（3）重要字段说明：
》》ps_name: 推广名称，建议设置可记录本次推广的特点，便于后续查找；
》》source_name: 推广渠道名称，填写本次推广选择合作的渠道名，如：XX 公众号
》》url：推广链接，可在商城后台选择要推广的商品，复制商品的推广链接地址

（4）调用格式，通过（2）中链接访问后：
image.png

（5）HTTP 调用示例：

curl -X POST "https://open.youzanyun.com/api/youzan.datacenter.pspagesource.create/3.0.0?access_token=c3220121ae0fc6c4e11123370e0d1b03" -H 'content-type: application/json' -d '{"ps_name":"妮子创建的推广分析","url":"https://shop17007558.m.youzan.com/wscgoods/detail/1yk2623s7nrha","source_name":"公众号"}'

（6）JAVA 调用示例：

        Token token = new Token("21ceba9f18821c3319d2eb779cd31a4");
        DefaultYZClient yzClient = new DefaultYZClient();        
        YouzanDatacenterPspagesourceCreate youzanDatacenterPspagesourceCreate = new YouzanDatacenterPspagesourceCreate();
        //创建参数对象,并设置参数
        YouzanDatacenterPspagesourceCreateParams youzanDatacenterPspagesourceCreateParams = new YouzanDatacenterPspagesourceCreateParams();
        youzanDatacenterPspagesourceCreateParams.setPsName("datatest");
        youzanDatacenterPspagesourceCreateParams.setSourceName("公众号");
        youzanDatacenterPspagesourceCreateParams.setUrl("https://shop17007558.m.youzan.com/wscgoods/detail/1yk2623s7nrha");
        youzanDatacenterPspagesourceCreate.setAPIParams(youzanDatacenterPspagesourceCreateParams);
        try {
            YouzanDatacenterPspagesourceCreateResult result = yzClient.invoke(youzanDatacenterPspagesourceCreate, token, YouzanDatacenterPspagesourceCreateResult.class);
            System.out.println(JSON.toJSON(result));
        } catch (SDKException n) {
            n.printStackTrace();
        }
    }
}

3、在推广监控中，可以管理已经创建的监控，进行查看数据、编辑、删除、导出等操作。
image.png

3、可查看某个推广监控的效果数据，有 37 项数据指标可供选择查看，以及详细的商品转化数据。可以了解到，通过这次推广进入页面的客户，都是查看、加购、购买了哪些商品。
image.png
image.png

——通过哪个接口可以获取推广渠道基本信息？
（1）获取推广渠道基本信息:youzan.datacenter.pssource.fetch.3.0.0
（2）链接地址：https://doc.youzanyun.com/doc#/content/API/1-422/detail/api/0/115
（3）重要字段说明：
》》source_name: 推广渠道名称，如 XX 公众号、今日头条等；
》》start_day: 查询一段时间内推广渠道的开始时间，格式：yyyy-MM–dd；
》》end_day: 查询一段时间内推广渠道的结束时间，格式：yyyy-MM–dd；
》》source_ids: 渠道 ID 集合，最大 200 个，用来查询特定渠道的信息，可以从该接口获取到 source_id；
接口：获取推广监控列表
接口链接：https://doc.youzanyun.com/doc#/content/API/1-422/detail/api/0/116
参数：source_id
（4）调用格式，通过（2）中链接访问后：
image.png

（5）HTTP 调用示例：

curl -X POST "https://open.youzanyun.com/api/youzan.datacenter.pssource.fetch/3.0.0?access_token=c3220121ae0fc6c4e11123370e0d1b03" -H 'content-type: application/json' -d '{"source_ids":"83638",
"start_day":"2019-11-01","end_day":"2019-11-31","page":"1","page_size":"20"}'

（5）JAVA 调用示例：

        Token token = new Token("21ceba9f18821c3319d2eb779cd31a4");
        DefaultYZClient yzClient = new DefaultYZClient();        
        YouzanDatacenterPssourceFetch youzanDatacenterPssourceFetch = new YouzanDatacenterPssourceFetch();
        //创建参数对象,并设置参数
        YouzanDatacenterPssourceFetchParams youzanDatacenterPssourceFetchParams = new YouzanDatacenterPssourceFetchParams();
        youzanDatacenterPssourceFetch.setAPIParams(youzanDatacenterPssourceFetchParams);
        try {
        YouzanDatacenterPssourceFetchResult result = yzClient.invoke(youzanDatacenterPssourceFetch, token, YouzanDatacenterPssourceFetchResult.class);
            System.out.println(JSON.toJSON(result));
        } catch (SDKException n) {
            n.printStackTrace();
        }
    }
}

——通过哪个接口可以获取推广渠道基本信息？
（1）获取推广监控列表基本数据, 不包含效果数据:youzan.datacenter.pspagesource.fetch.3.0.0
（2）链接地址：https://doc.youzanyun.com/doc#/content/API/1-422/detail/api/0/116
（3）重要字段说明：
》》ps_name: 推广监控名称
》》start_day: 查询一段时间内推广分析列表的开始时间，格式：yyyy-MM–dd；
》》end_day: 查询一段时间内推广分析列表的结束时间，格式：yyyy-MM–dd；
》》ps_status: 推广监控状态，1: 推广中；2: 推广结束；
》》dcps_list: 推广分析监控追踪 id 集合，最多支持 200 个；可以查询指定 dcps 的推广基本信息，该参数为空代表是查询所有；dcps 即是监控链接 url 后面的 dc_ps 参数；
（4）调用格式，通过（2）中链接访问后：
image.png

（5）HTTP 调用示例：

curl -X POST "https://open.youzanyun.com/api/youzan.datacenter.pspagesource.fetch/3.0.0?access_token=c3220121ae0fc6c4e11123370e0d1b03" -H 'content-type: application/json' -d '{"ps_status":"推广中",
"start_day":"2019-11-01","end_day":"2019-11-31","page":"1","page_size":"20"}'

（6）JAVA 调用示例：

        Token token = new Token("21ceba9f18821c3319d2eb779cd31a4");
        DefaultYZClient yzClient = new DefaultYZClient();  
        YouzanDatacenterPspagesourceFetch youzanDatacenterPspagesourceFetch = new YouzanDatacenterPspagesourceFetch();
        //创建参数对象,并设置参数
        YouzanDatacenterPspagesourceFetchParams youzanDatacenterPspagesourceFetchParams = new YouzanDatacenterPspagesourceFetchParams();
        youzanDatacenterPspagesourceFetch.setAPIParams(youzanDatacenterPspagesourceFetchParams);
        try {
        YouzanDatacenterPspagesourceFetchResult result = yzClient.invoke(youzanDatacenterPspagesourceFetch, token, YouzanDatacenterPspagesourceFetchResult.class);
            System.out.println(JSON.toJSON(result));
        } catch (SDKException n) {
            n.printStackTrace();
        }
    }
}

——通过哪个接口可以获取推广分析详细推广数据？
（1）获取推广分析详细推广数据:youzan.datacenter.pspagesource.data.fetch.3.0.0
注：该数据获取为 t+1 的数据，比如今天只能查看昨天推广链接产生的效果数据
（2）链接地址：https://doc.youzanyun.com/doc#/content/API/1-422/detail/api/0/113
（3）重要字段说明：
》》start_day: 查询开始时间，格式：yyyy-MM–dd；
》》end_day: 查询结束时间，格式：yyyy-MM–dd；
》》dcps_list: 追踪信息集合，最大支持 200 个；查找特定链接的信息时可以指定相应的 dcps 追踪号；该追踪号在创建追踪链接时生成，也可以根据推广名称在获取推广信息接口中获取。不传该参数即可以分页获取店铺下所有推广链接的数据；
（4）调用格式，通过（2）中链接访问后：
image.png

（5）HTTP 调用示例：

curl -X POST "https://open.youzanyun.com/api/youzan.datacenter.pspagesource.data.fetch/3.0.0?access_token=c3220121ae0fc6c4e11123370e0d1b03" -H 'content-type: application/json' -d '{}'

（6）JAVA 调用示例：

        Token token = new Token("21ceba9f18821c3319d2eb779cd31a4");
        DefaultYZClient yzClient = new DefaultYZClient();  
        YouzanDatacenterPspagesourceDataFetch youzanDatacenterPspagesourceDataFetch = new YouzanDatacenterPspagesourceDataFetch();
        //创建参数对象,并设置参数
        YouzanDatacenterPspagesourceDataFetchParams youzanDatacenterPspagesourceDataFetchParams = new YouzanDatacenterPspagesourceDataFetchParams();
        youzanDatacenterPspagesourceDataFetch.setAPIParams(youzanDatacenterPspagesourceDataFetchParams);
        try {
        YouzanDatacenterPspagesourceDataFetchResult result = yzClient.invoke(youzanDatacenterPspagesourceDataFetch, token, YouzanDatacenterPspagesourceDataFetchResult.class);
            System.out.println(JSON.toJSON(result));
        } catch (SDKException n) {
            n.printStackTrace();
        }
    }
}

5、在推广监控中，可将监控信息进行批量导出，进行自主分析或推广效果汇报。
image.png

6、通过效果对比，可以查看各个监控之前的数据效果对比，以及渠道效果对比、推广标签效果对比。
image.png
image.png

渠道对比与推广标签效果对比，能帮助商家有效提高汇总统计效率，节约人力。