文档中心 > API类目 > 数据服务API

koubei.marketing.campaign.crowd.count (营销活动人群组人数统计接口)

口碑商户人群组数目统计接口

公共参数

请求地址:
环境 HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do
公共请求参数:
参数 类型 是否必填 最大长度 描述 示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 koubei.marketing.campaign.crowd.count
format String 40 仅支持JSON JSON
charset String 10 请求使用的编码格式,如utf-8,gbk,gb2312等 utf-8
sign_type String 10 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 RSA2
sign String 256 商户请求参数的签名串,详见签名 详见示例
timestamp String 19 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 2014-07-24 03:07:50
version String 3 调用的接口版本,固定为:1.0 1.0
app_auth_token String 40 详见应用授权概述
biz_content String - 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
crowd_group_id String 特殊可选 65535 crowd_group_id和conditions不能同时为空
如果crowd_group_id不为空则根据crowd_group_id查询人群分组的信息进行统计,否则以conditions的内容为过滤条件进行统计,如果crowd_group_id和conditions都不为空则优先使用conditions的条件
20160511000000000005901000158694
conditions String 特殊可选 65535 圈人的条件
op:表示操作符,目前支持EQ相等,GT大于,GTEQ大于等于,LT小于,LTEQ小于等于,NEQ不等,LIKE模糊匹配,IN在枚举范围内,NOTIN不在枚举范围内,BETWEEN范围比较,LEFTDAYS几天以内,RIGHTDAYS几天以外,LOCATE地理位置比较,LBS地图位置数据
tagCode:标签code,详细标签code参见附件。标签信息
value:标签值
[{"op":"IN","tagCode":"pam_gender","value":"1"}]
dimensions String 可选 65535 画像分析的维度,目前支持:["pam_age","pam_gender","pam_constellation","pam_hometown_code","pam_city_code","pam_occupation","pam_consume_level","pam_have_baby"],以koubei.marketing.campaign.tags.query接口返回的dimensions为准,各个维度标签的详细信息参见附件,标签信息 ["pam_gender","pam_age"]

公共响应参数

参数 类型 是否必填 最大长度 描述 示例值
code String - 网关返回码,详见文档 40004
msg String - 网关返回码描述,详见文档 Business Failed
sub_code String - 业务返回码,详见文档 ACQ.TRADE_HAS_SUCCESS
sub_msg String - 业务返回码描述,详见文档 交易已被支付
sign String - 签名,详见文档 DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo=

响应参数

参数 类型 是否必填 最大长度 描述 示例值
summary_values String 必填 65535 人群组的汇总统计值total是人数,sum是交易金额 { sum:1000, total:100 }
dimension_values String 选填 65535 各个细分维度的值,label为标签code,value为该标签各个标签值对应的统计信息,本示例表示pam_gender这个标签的男有100人,女有1000人满足入参指定的圈人条件 [{"lalel":"pam_gender","value":{"男":100,"女":1000}}]

请求示例

  • JAVA
  • .NET
  • PHP
  • HTTP请求源码
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
KoubeiMarketingCampaignCrowdCountRequest request = new KoubeiMarketingCampaignCrowdCountRequest();
request.setBizContent("{" +
"\"crowd_group_id\":\"20160511000000000005901000158694\"," +
"\"conditions\":\"[{\\\"op\\\":\\\"IN\\\",\\\"tagCode\\\":\\\"pam_gender\\\",\\\"value\\\":\\\"1\\\"}]\"," +
"\"dimensions\":\"[\\\"pam_gender\\\",\\\"pam_age\\\"]\"" +
"  }");
KoubeiMarketingCampaignCrowdCountResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"koubei_marketing_campaign_crowd_count_response":{
		"msg":"Success",
		"code":"10000",
		"summary_values":"{\r\n  sum:1000,\r\n  total:100\r\n}",
		"dimension_values":"[{\"lalel\":\"pam_gender\",\"value\":{\"男\":100,\"女\":1000}}]"
	},
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

  • JSON示例
{
	"koubei_marketing_campaign_crowd_count_response":{
		"msg":"Service Currently Unavailable",
		"code":"20000",
		"sub_msg":"系统繁忙",
		"sub_code":"isp.unknow-error"
	},
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

业务错误码

错误码 错误描述 解决方案
REQ_VALIDATE_ERROR 请求校验错误 检查参数是否为空,格式是否满足要求,修改后重试
CROWD_COUNT_QUERY_FAIL 人群数目统计失败 稍后重试
SYSTEM_EXCEPTION_ERROR 系统异常 稍后重试

公共错误码

返回
顶部