技术文档

【京东商务舱】接口导航

1、创建搜索页推广	2、搜索页推广计划修改
3、根据分类id查询关键词组信息	4、根据页面id查询广告位信息
5、根据投放类型获取广告位页面信息	6、获取标签信息
7、根据sku获取商品信息	8、根据广告位id获取可以投放的日期
9、获取排名信息	10、查询投放计划所投放的关键词
11、获取投放计划的详细信息	12、查询投放计划列表
13、批量更新关键词出价	14、批量添加关键词
15、删除投放计划所投放的关键词	16、获取账户信息
17、查询收支列表

1. 创建搜索页推广

接口名称

jingdong.kuaiche.zn.plan.search.create

功能说明

创建搜索页推广

API用户授权类型

需要

系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	是	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-ddHH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

应用级输入参数

名称	类型	是否必须	示例值	描述
plan_info	String	是		投放计划内容

plan_info JSON结构

名称	类型	是否必须	示例值	描述
name	String	是	“我的投放”	推广名称（最多输入25个字符，建议由日期、广告位、投放内容组成，便于管理）
spaceId	Number	是	200	广告位id（可以由jingdong.kuaiche.zn.space.info.search接口获得）
budget	Number	是	120.50	出价（表示每天出价，精度保留两位小数）
showDay	String[]	是	[“20130803”,”20130809”]	推广计划所选择的排期（格式8位的字符型日期，可以选择的排期可以通过 jingdong.kuaiche.zn.schedule.available.search接口获得）
allowSplit	Number	否	1	出现竞价失败的情况，是否放弃之后的排期，以便释放被冻结的资金，该字段取值为1和2。（1表示放弃，2表示不放弃，默认为2）
save	Number	否	1	取值为0和1。（1表示提交，0表示保存草稿，默认为1）
showType	Number	否	1	播放展示方式，取值为1和2。 1：轮播：表示在排期内，您添加的商品每天都会轮流播放和展示。 2：自定义：表示在排期内按天设置需要播放的素材
materialList	List	是		推广计划的素材信息。要求： 1. 素材必须属于同一个3级分类，比如都是属于：服饰鞋帽-男装-衬衫。 2. 最多只能添加5个素材 3. 素材所属商家必须属于投放广告的商家，只能投放自己的商品。 4. 添加多个素材必须是不同的商品。 5. 添加的素材中不能包含无效的商品。 6. 如果素材播放方式为自定义，即 showType等于2，则所添加的所有素材的showDays属性的并集要与所选择的排期showDay集合相等。轮播方式为轮播，即showType等于1， showDays属性可不用设置。
keywordList	List	是		投放计划选择的关键词组信息

MaterialVO 属性

名称	类型	是否必须	示例值	描述
skuId	Number	是	1000029789”	skuid
title	String	是	“好看的裤子”	商品展示时显示的标题（总长度不能超过24个字，标题可以突出商品的功效、品质、价格等优势，播放商品时将以红色字体显示。）
labelId	String	否	“1”	素材添加的标签id（标签信息可以通过jingdong.kuaiche.zn.material.labels.search接口获得）
showDays	java.lang.Integer[]	否	[20130808,20130809]	素材播放的日期（格式为8位的整形日期）， 1：showType为2，该字段不能为空，且所添加的值必须在所选择的排期showDay中。 2：showType为1，该字段可以不用设置，表示在整个推广计划排期内进行播放。

KeywordVO属性

名称	类型	是否必须	示例值	描述
name	String	是	“nike”	关键词，支持自定义的，长度不超过16个字符
price	Number	是	1.2	关键词出价(单位：元)

返回结果

名称	类型	示例值	描述
result_status	ResultStatus		返回信息描述

ResultStatus 属性

名称	类型	是否必须	示例值	描述
plan_id	Long	否	123456	成功创建推广计划时返回的推广计划id
code	Number	是	0	状态码，取值为0和1 0：表示创建推广计划失败; 1: 表示创建推广计划成功
message	String	否	投放计划名称不能为空！	创建推广计划失败时的信息描述

返回示例

JSON数据格式

{
  "jingdong_kuaiche_zn_plan_search_create_response":{
  "message":"投放计划名称不能为空！",
"code":"0",
"plan_id":"123456"
  }
  }

SDK调用示例（java）

public JdClient client=new DefaultJdClient(SERVER_URL,accessToken,appKey,appSecret);
KuaicheZnPlanSearchCreateRequest request=new KuaicheZnPlanSearchCreateRequest ();
String planInfo="{\"name\":\"lyb-jos-search-自定义5\",\"allowSplit\":2,\"budget\":30,
\"keywordList\":[{\"name\":\"李云彬\",\"price\":1}],\"materialList\":[{\"labelId\":\"1\",
\"showDays\":null,\"skuId\":1100442996,\"title\":\"我通过api进行接口上传的商品，仅供测试！\"}],\"save\":0,\"showDay\":[\"20130922\",\"20130923\"],\"showType\":1,\"spaceId\":42}";
request.setPlanInfo(planInfo );
KuaicheZnPlanSearchCreateResponse response=client.execute(request);

2. 搜索页推广计划修改

接口名称

jingdong.kuaiche.zn.plan.search.modify

功能说明

站内推广-修改搜索页推广计划

API用户授权类型

需要

系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	是	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-ddHH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

应用级输入参数

名称	类型	是否必须	示例值	描述
plan_info	String	是		投放计划内容

plan_info JSON结构：

名称	类型	是否必须	示例值	描述
name	String	是	“我的投放”	投放计划名称
id	Long	是	123456	投放计划id
spaceId	Number	是	200	广告位id（审核通过，暂停或竞投中的计划不能修改广告位）
budget	Number	是	120.50	日预算
showDay	String[]	是	[“20130803”,”20130809”]	计划排期（格式为8位的字符型日期）
allowSplit	Number	否	1	出现竞价失败的情况，是否放弃之后排期的所有竞价，以便释放被冻结的资金（1表示不放弃，2表示放弃，默认为1）
save	Number	否	1	1表示提交，0表示保存草稿，默认为1( 1.1：对与已结束状态的修改，该字段不起作用，计划将会变为竞投状态中。 1.2：对于未通过状态的修改，save传0，计划将变为未提交状态，save传1，计划将变为待审核状态。 1.3：对于未提交状态的修改，save传0，修改后还是未提交状态，save传1，将变为待审核状态。 1.4：其他状态的修改，该字段可以不传，不会改变计划原状态)
showType	Number	否	1	'播放展示方式,1:轮播（选择的所有素材轮流播放），2：自定义'（按日期设置选择的素材播放，注：materialList showDays属性的并集一定要与showDay集合相等）
materialList	List	是		投放计划的素材信息（修改后的素材信息，必传）
keywordList	List	是		投放计划选择的关键词组信息（修改后的关键词信息，必传）

MaterialVO 属性：

名称	类型	是否必须	示例值	描述
skuId	Number	是	1000029789”	商品id
title	String	是	“好看的裤子”	商品展示显示的标题
labelId	String	否	“1”	素材添加的标签id(可通过jingdong.kuaiche.zn.material.labels.search 接口查询得到)
showDays	java.lang.Integer[]	否	[20130808,20130809]	素材播放的日期（格式为8位的整形日期），如果showType为2，则不能为空且materialList showDays属性的并集一定要与showDay集合相等；； showType为1，该值不传，表示在整个投放计划排期内进行播放。

KeywordVO属性：

名称	类型	是否必须	示例值	描述
name	String	是	“nike”	关键词
price	Number	是	1.2	关键词出价(单位：元)

返回结果

名称	类型	示例值	描述
result_status	ResultStatus		返回信息描述

ResultStatus 属性：

名称	类型	是否必须	示例值	描述
plan_id	Long	否	123456	投放计划id
code	Number	是	0	状态码：0：失败;1:成功
message	String	否	投放计划名称不能为空！	失败信息描述

返回示例

JSON数据格式

{
  "jingdong_kuaiche_zn_plan_search_modify_response":{
  "message":"审核通过，暂停或竞投中的计划不能修改广告位!",
"code":"0",
"plan_id":"123456"
  }
  }

SDK调用示例（java）

public JdClient client=new DefaultJdClient(SERVER_URL,accessToken,appKey,appSecret);
KuaicheZnPlanSearchModifyRequest request=new KuaicheZnPlanSearchModifyRequest();
String planInfo = "{\"id\":240488007,\"name\":\"lyb-jos-search-modify1\",\"allowSplit\":2,\"budget\":300,\"keywordList\":[{\"name\":\"茜韵婡\",\"price\":1}],\"materialList\":[{\"labelId\":\"1\",
\"showDays\":null,\"skuId\":1100442996,\"title\":\"我通过api进行接口上传的商品，仅供测试！\"}],\"save\":0,\"showDay\":[\"20130911\",\"20130924\"],\"showType\":1,\"spaceId\":43}";
request.setPlanInfo(planInfo );
KuaicheZnPlanSearchModifyResponse response=client.execute(request);

3. 根据分类id查询关键词组信息

接口名称：

jingdong.kuaiche.zn.keywordgroup.list.search

功能说明：

根据三级分类id分页查询该分类下推荐的关键词信息

API用户授权类型：

需要

l 系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	是	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-ddHH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

输入应用参数：

名称	类型	是否必须	示例值	描述
third_category_id	Long	是	1354	第三级分类Id (备注：必须是三级分类Id)
sort_field	String	否	weekCtr	排序字段：默认为“weekCtr ”：一周平均点击率可选的有：“searchCount”:关键词一周平均搜索量；“avgPrice”：关键词一周平均出价；“weekCtr ” ：关键词一周平均点击率备注：只能选择其中一个，如果不选，默认为 “weekCtr ”（如果输入值不在可选集合中则使用默认值）
sort_type	Integer	否	2	排序类型：1：升序，2：降序，默认为降序(输入错误值则为默认值)
page_size	Integer	否	10	分页大小默认为：10(输入错误比如输入负数，则使用默认值)
page_index	Integer	否	1	第几页（从1开始）默认为：1（输入错误比如输入负数，则使用默认值)

输出参数：

名称	类型	示例值	描述
return_info	KeywordQueryVO		查询结果信息

对象说明：

KeywordQueryVO属性：

名称	类型	是否必须	示例值	描述
third_category_id	Long	是	1354	调用方传的三级分类Id
sort_field	String	是	weekCtr	调用方传的排序字段（输入错误值则为默认值）
sort_type	Integer	是	2	调用方传的排序类型（输入错误值则为默认值）
total_number	Integer	是	15000	查询总数
page_size	Integer	是	10	调用方传分页大小（输入错误值则为默认值）
page_index	Integer	是	1	调用方传的页码（输入错误值则为默认值）
keyword_data	KeywordGroup[]	是		查询出来的关键词数据

KeywordGroup属性：

名称	类型	是否必须	示例值	描述
wgroup_id	Long	是	35146990524	词id
name	String	是	女士白色衬衫	关键词名称
search_num	Long	是	15000	搜索量
base_price	Number	是	0.1	基准价格
avg_price	Number	是	1.1	历史平均出价
week_ctr	Number	是	8.7	周点击率（备注：已经乘以100转化成了百分比）

返回示例

JSON数据格式：

{
"jingdong_kuaiche_zn_keywordgroup_list_search_response":{
"return_info":{
"page_size":"10",
"page_index":"1",
"third_categoryid":"1354",
"keyword_data":[{
"wgroup_id":"35146990524",
"base_price":"0.1",
"week_ctr":"8.7",
"name":"女士白色衬衫",
"avg_price":"1.1",
"search_num":"15000"
}],
"sort_type":"2",
"total_number":"15000",
"sort_field":"weekCtr"
}
}
}

SDK调用示例（java）

public JdClient client=new DefaultJdClient(SERVER_URL,accessToken,appKey,appSecret); KuaicheZnKeywordgroupListSearchRequest request= new KuaicheZnKeywordgroupListSearchRequest();
request.setThirdCategoryId( 1354L );
request.setSortField( "weekCtr" );
request.setSortType(2);
request.setPageSize( 10);
request.setPageIndex( 1 );
KuaicheZnKeywordgroupListSearchResponse response=client.execute(request);

4. 根据页面id查询广告位信息

接口名称：

jingdong.kuaiche.zn.space.info.search

功能说明：

根据页面id查询该页面下的广告位信息

API用户授权类型：

不需要

l 系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	否	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-ddHH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

输入应用参数：

名称	类型	是否必须	示例值	描述
page_id	Number	是		所有page_id均通过jingdong.kuaiche.zn.space.page.by.type.search获得

输出参数：

名称	类型	示例值	描述
space_info_list	SpaceInfo[]		广告位信息

对象说明：

SpaceInfo属性：

名称	类型	是否必须	示例值	描述
id	Number	否		广告位id
name	String	否		广告位名称
detail	String	否		广告位描述
page_id	Number	否		页面分类id
width	Number	否		广告位宽
height	Number	否		广告位高
traffic	Number	否		日均流量
style	Number	否		展示形式
type	Number	否		广告位类型 2:搜索页
status	Number	否		广告位状态 1:能投放 2:不能投放

返回示例

JSON数据格式：

{
  " jingdong_kuaiche_zn_space_info_search_response":{
  "space_info_list":[{
  "id":"",
"detail":"",
"traffic":"",
"height":"",
"style":"",
"status":"",
"width":"",
"name":"",
"page_id":"",
"type":""
  }]
  }
  }

SDK调用示例（java）

pulbic JdClient client=new DefaultJdClient(SERVER_URL,accessToken,appKey,appSecret);
KuaicheZnSpaceInfoSearchRequest request=new KuaicheZnSpaceInfoSearchRequest();
request.setPageId( 123 );
KuaicheZnSpaceInfoSearchResponse response=client.execute(request);

5. 根据投放类型获取广告位页面信息

接口名称：

jingdong.kuaiche.zn.space.page.by.type.search

功能说明：

根据投放类型获取广告位页面信息

API用户授权类型：

不需要

l 系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	否	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-ddHH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

输入应用参数：

名称

类型

是否必须

示例值

描述

type

Number

是

取值为 2

2:搜索结果页

输出参数：

名称	类型	示例值	描述
space_page_info_list	SpacePageInfo[]		广告位页面信息

对象说明：

SpacePageInfo属性：

名称	类型	是否必须	示例值	描述
id	Number	否		页面id
available	Number	否		页面分类是否有效 1有效 0无效
category_name	String	否		页面分类名称
parent_id	Number	否		父页面的id
url	String	否		页面对应的URL
type	Number	否		页面类型 :1 频道页(热门搜索词公用);2 搜索结果页

返回示例

JSON数据格式：

{
  " jingdong_kuaiche_zn_space_page_by_type_search_response":{
  "space_page_info_list":[{
  "id":"",
"category_name":"",
"available":"",
"type":"",
"url":"",
"parent_id":""
  }]
  }
  }

SDK调用示例（java）

pulbic JdClient client=new DefaultJdClient(SERVER_URL,accessToken,appKey,appSecret);
KuaicheZnSpacePageByTypeSearchRequest request=new KuaicheZnSpacePageByTypeSearchRequest();
request.setType( 123 );
KuaicheZnSpacePageByTypeSearchResponse response=client.execute(request);

6. 获取标签信息

接口名称

jingdong.kuaiche.zn.material.labels.search

功能说明

获取标签信息

API用户授权类型

不需要

系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	否	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-ddHH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

应用级输入参数

名称	类型	是否必须	示例值	描述
				此接口无需输入应用级参数，但需要构建空参数360buy_param_json={}

返回结果

名称	类型	示例值	描述
material_label_list	MaterialLableJO[ ]		可用标签信息

MaterialLableJO属性

名称	类型	是否必须	示例值	描述
id	String	是	1	标签id
label_name	String	是	新品	标签名称
buyout_price	Number	是	1.0	按日买断价格
cpc_price	Number	是	0.1	点击价格（/次）

返回示例

JSON数据格式

{
  "jingdong_kuaiche_zn_material_labels_search_response":{
  "material_label_list":[{
  "id":"1",
"label_name":"新品",
"cpc_price":"0.1",
"buyout_price":"1.0"
  }]
  }
  }

SDK调用示例（java）

public JdClient client=new
DefaultJdClient(SERVER_URL,accessToken,appKey,appSecret);
KuaicheZnMaterialLabelsSearchRequest request=new
KuaicheZnMaterialLabelsSearchRequest();
KuaicheZnMaterialLabelsSearchResponse response=client.execute(request);

7. 根据sku获取商品信息

接口名称

jingdong.kuaiche.goods.get

功能说明

根据skuId获取商品信息（需所属商家授权）

API用户授权类型

需要

系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	是	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-ddHH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

应用级输入参数

名称	类型	是否必须	示例值	描述
sku_id	String	是		商品skuid

返回结果

名称	类型	示例值	描述
result	JosGoodsInfo		专柜推广代码

JosGoodsInfo属性

名称	类型	是否必须	示例值	描述
code	Number	否		-1：内部异常，1:成功获取,2:有这个商品但是不属于这个商家,3:没有这个商品存在,4:非法popId，直接返回
wp_name	String	否		三级分类名称
image_url	String	否		商品主图
w_name	String	否		商品名称
wp_id	Number	否		三级分类id
class_names	list	否		各级分类名称
class_ids	list	否		各级分类id
image_urls	list	否		所有图url
sku_similars	JosSkuInfo[]	否		该sku相同款式的 skuid 以及主图

JosSkuInfo属性

名称	类型	是否必须	示例值	描述
sku_id	Number	否		商品skuid
sku_url	String	否		商品主图

返回示例

JSON数据格式

{
       " jingdong_kuaiche_goods_get_response ":{
              "result":{
                     "sku_similars":[{
                            "sku_id":"",
                            "sku_url":""
                     }],
                     "class_names":[{}],
                     "wp_id":"",
                     "image_url":"",
                     "class_ids":[{}],
                     "image_urls":[{}],
                     "wp_name":"",
                     "code":"",
                     "w_name":""
              }
       }
}

SDK调用示例（java）

public JdClient client=new DefaultJdClient(SERVER_URL,accessToken,appKey,appSecret);
KuaicheGoodsGetRequest request=new KuaicheGoodsGetRequest();
request.setSkuId( "jingdong" );
KuaicheGoodsGetResponse response=client.execute(request);

8. 根据广告位id获取可以投放的日期

接口名称

jingdong.kuaiche.zn.schedule.available.search

功能说明

根据广告位id获取可以投放的日期

API用户授权类型

不需要

系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	否	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-ddHH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

应用级输入参数

名称	类型	是否必须	示例值	描述
space_id	Number	是		广告位id

返回结果

名称	类型	示例值	描述
schedule_day_list	List		可以投放的排期日期

返回示例

JSON数据格式

{
"jingdong_kuaiche_zn_schedule_findScheduleCanUse_response":{

}
}

SDK调用示例（java）

public JdClient client=new DefaultJdClient(SERVER_URL,accessToken,appKey,appSecret);
KuaicheZnScheduleFindScheduleCanUseRequest request=new
KuaicheZnScheduleFindScheduleCanUseRequest();
request.setSpaceId( 123 );
KuaicheZnScheduleFindScheduleCanUseResponse response=client.execute(request);

9. 获取排名信息

接口名称：

jingdong.kuaiche.zn.bid.rank.get

功能说明：

根据计划信息获取排名信息

API用户授权类型：

需要

l 系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	是	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-ddHH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

输入应用参数：

名称	类型	是否必须	示例值	描述
plan_json	String	是		需返回的字段列表。可选值：PlanDetailInfo结构体中；把对象转相应的json
cid	Number	否	870	搜索结果页广告不用填写该参数
kwg_id	Number	否		竞价的关键词组id
plan_date	String	否		预测日期格式20130706

plan_json JSON结构

名称	类型	是否必须	示例值	描述
type	Number	是	1	2搜索页预测
Id	Number	否	166084021	该计划提交后生成的id，提交前预测可以不需要该值
name	String	是	“我的投放”	投放计划名称
spaceId	Number	是	200	广告位id
budget	Number	是	120.50	日预算
showDay	String[]	是	[“20130803”,”20130809”]	计划排期（格式为8位的字符型日期）
allowSplit	Number	否	1	出现竞价失败的情况，是否放弃之后排期的所有竞价，以便释放被冻结的资金（1表示不放弃，2表示放弃，默认为1）
save	Number	否	1	1表示提交，0表示保存草稿，默认为1
showType	Number	否	1	'播放展示方式,1:轮播（选择的所有素材轮流播放），2：自定义'（按日期设置选择的素材播放）
materialList	List	是		投放计划的素材信息
keywordList	List	否		投放计划选择的关键词组信息预测用不到此参数，若填请按照创建计划 jingdong.kuaiche.zn.plan.search.create 中KeywordVO属性填写

MaterialVO 属性

名称	类型	是否必须	示例值	描述
skuId	Number	是	1000029789”	商品id
title	String	是	“好看的裤子”	商品展示显示的标题
labelId	String	否	“1”	素材添加的标签
showDays	java.lang.Integer[]	否	[20130808,20130809]	素材播放的日期（格式为8位的整形日期），如果showType为2，则不能为空； showType为1，该值不传，表示在整个投放计划排期内进行播放。

输出参数：

名称	类型	示例值	描述
rank_return	RankReturnJO		预测返回信息

对象说明：

RankReturnJO属性：

名称	类型	示例值	描述
response	Number	否	标记码（0：成功 1：参数错误无法计算 2：服务器错误）
rank	Number[]	否	排名信息按照1-n排序
description	String	否	参数描述 reponse为1时，description有3种情况： Zero Rank：表示改预测计划的质量分为0，不能预测 Incorrect Parameter：表示参数出错 No other biddings to compare：表示没有别的计划竞价
plan_date	String	否	预测日期

返回示例

JSON数据格式：

{
  " jingdong_kuaiche_zn_bid_rank_get_response ":{
  "rank_return":{
  "response":"",
"rank":"",
"plan_date":"",
"description":""
  }
  }
  }

SDK调用示例（java）

pulbic JdClient client=new DefaultJdClient(SERVER_URL,accessToken,appKey,appSecret);
KuaicheZnBidRankGetRequest request=new KuaicheZnBidRankGetRequest();
request.setPlanJson( "jingdong" );
request.setCid( 123 );
request.setKwgId( 123 );
request.setPlanDate( "jingdong" );
KuaicheZnBidRankGetResponse response=client.execute(request);

10. 查询投放计划所投放的关键词

接口名称
jingdong.kuaiche.zn.plan.search.keyword.get

API用户授权类型
需要

系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	是	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

应用级输入参数

名称	类型	是否必须	示例值	描述
plan_id	Number	是	350919003	推广计划id

返回结果

名称	类型	示例值	描述
keywords_info	KeywordVO[]		返回投放计划的关键词信息

KeywordVO[]属性

名称	类型	是否必须	示例值	描述
keyword_info	KeywordVO	否		关键词信息

KeywordVO属性

名称	类型	是否必须	示例值	描述
plan_id	Number	否	1111	投放计划id
wgroup_id	Number	否	1212	关键词id
name	String	否	nike	关键词名称
price	Number	否	1.2	关键词出价

返回示例

JSON数据格式

{
    "jingdong_kuaiche_zn_plan_search_keyword_get_response": {
        "keywords_info": [
            {
                "keyword_info": {
                    "wgroup_id": "1212",
                    "price": "1.2",
                    "name": "nike",
                    "plan_id": "1111"
                }
            }
        ]
    }
}

SDK调用示例

public JdClient client=new DefaultJdClient(SERVER_URL,accessToken,appKey,appSecret);
KuaicheZnPlanSearchKeywordGetRequest request=new KuaicheZnPlanSearchKeywordGetRequest();
request.setPlanId( 123 );
KuaicheZnPlanSearchKeywordGetResponse response=client.execute(request);

11. 获取投放计划的详细信息

接口名称：

jingdong.kuaiche.zn.plan.detail.get

功能说明：

获取投放计划详细信息（只适用于搜索页类型的推广计划）

API用户授权类型：

需要

l 系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	是	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-ddHH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

输入应用参数：

名称	类型	是否必须	示例值	描述
plan_id	Number	是	32323232	投放计划id（只适用于搜索页类型的推广计划）

输出参数：

名称	类型	示例值	描述
plan_detail_info	PlanDetailInfo		投放计划详细信息

对象说明：

PlanDetailInfo 属性：

名称	类型	是否必须	示例值	描述
id	Number	是	34344	投放计划Id
name	String	是	羽绒服11推广	投放计划名称
space_id	Number	是	42	投放计划选择的广告位id
type	Number	是	1	投放计划类型: 2:搜索页投放
budget	Number	是	50	投放计划设置的日预算
total_budget	Number	是	500	投放计划预算总价
mode	Number	是	2	投放模式:2：cpd 按日买断，3:cpc 按点击
status	Number	是	6	投放计划的状态: 1:未提交 2:待审核 3:未通 4:申请失败 5:审核通过6:竞投中 7:暂停 8:终止 9:已结束
allow_split	Number	是	1	出现竞价失败的情况，是否放弃之后排期的所有竞价，以便释放被冻结的资金， 1：表示放弃，2：表示不放弃
schedule_start	String	是	"2013-11-07"	投放计划的排期开始时间
schedule_end	String	是	"2013-11-09"	投放计划的排期结束时间
insert_time	String	否		投放计划创建时间
update_time	String	否		投放计划最近更新时间
submit_time	String	否		投放计划提交时间
show_day	String[]	是	["20131107","20131109"]	投放计划选择的排期
show_type	Number	是	1	投放计划素材选择的播放展示方式：1:轮播,2:自定义
material_list	CommodityInfo[]	是		投放计划的素材信息
keyword_list	SelectedKeywordInfo[]	否	[羽绒服，保暖内衣]	投放计划选择的关键词
space_page_vo	SpacePageInfo	是		投放计划所投放的广告位页面信息
space_vo	SpaceInfo	是		投放计划投放的广告位信息

CommodityInfo属性：

名称	类型	是否必须	示例值	描述
sku_id	Number	是	1009735		商品skuId
title	String	是	男装双11		投放计划展示的商品标题
original_title	String	是	男装		商品原标题
material_url	String[]	是	["http://img14.360buyimg.com/n2/test/g1/M00/00/00/wKjI5FI211AIAAAAAAvqH_kipG8AAAAAgKNzYQAC-o3272.jpg"]		商品图片URL,数组第一个URL表示商品主图
target_url	String	是	http://item.jd.com/lining.html		商品在京东主站上的目标URL
price	Number	是	200		商品的价格
material_spu	CommoditySpu[]	否			同款商品的sku信息
id	Number	是	2222		记录主键
plan_id	Number	是	232222		投放计划id
space_id	Number	是	43		投放计划的广告位Id
review_status	Number	是	3		商品的审核状态 1.未审核2.未通过3.通过'
review_mark	String	否			商品审核未通过的原因
show_days	java.lang.Integer[]	否	[20131107,20131109]		商品对应的播放日期，自定义播放类型才有
material_label	MaterialLabelVO	否			商品所选择的标签信息，选择了才有此数据

MaterialLabelVO属性：

名称	类型	是否必须	示例值	描述
id	Number	是	434232	标签Id
label_buyoutPrice	Number	是	2	cpd 按天买断价格
label_cpcPrice	Number	是	0.1	cpc价格按点击价格（/次）
label_name	String	是	爆款	标签名字

CommoditySpu属性：

名称	类型	是否必须	示例值	描述
material_id	Number	是	334323	对应CommodityInfo的属性id
sku_id	Number	是	34342423	商品skuId
image_url	String	是	/test/g1/M00/00/00/wKjI5FI211AIAAAAAAvqH_kipG8AAAAAgKNzYQAC-o3272.jpg	商品图片url ，域名主图的域名

SelectedKeywordInfo属性：

名称	类型	是否必须	示例值	描述
id	Number	是	34343	主键
plan_id	Number	是	4343242	投放计划id
name	String	是	男装	关键词名称
wgroup_id	String	是	111112	词id
price	Number	是	2.00	该关键词的用户出价

SpacePageInfo 属性：

名称	类型	是否必须	示例值	描述
id	Number	是	1221221	主键
available	Number	是	1	页面分类是否有效 1有效 0无效
category_name	String	是	男装	页面分类名称
parent_id	Number	是	1222122	父页面的id
url	String	是	http://list.jd.com/1315-1342-3982-0-0-0-0-0-0-0-1-1-1-1-1-72-4137-0.html	页面对应的 URL
type	Number	是	2	页面类型 2 搜索结果页

SpaceInfo属性：

名称	类型	是否必须	示例值	描述
id	Number	是	1122233	主键id
name	String	是	左下图片广告位	广告位名称
detail	String	是	左下图片广告位	广告位描述
page_id	Number	是	1314	广告位所属的页面分类id
width	Number	是	200	广告位宽
height	Number	是	178	广告位高
traffic	Number	是	3000	日均流量
style	Number	是	1	广告位展示形式 :1: 图片 2: 文字3: 图片+文字
type	Number	是	1	广告位类型1: 频道页 2: 搜索页

返回示例

JSON数据格式：

{
    "jingdong_kuaiche_zn_plan_detail_get_response": {
        "plan_detail_info": {
            "budget": "",
            "status": "",
            "space_vo": {
                "id": "",
                "detail": "",
                "traffic": "",
                "height": "",
                "style": "",
                "width": "",
                "name": "",
                "page_id": "",
                "type": ""
            },
            "schedule_start": "",
            "insert_time": "",
            "space_id": "",
            "type": "",
            "keyword_list": [
                {
                    "wgroup_id": "",
                    "id": "",
                    "price": "",
                    "name": "",
                    "plan_id": ""
                }
            ],
            "show_day": "",
            "mode": "",
            "id": "",
            "space_page_vo": {
                "id": "",
                "category_name": "",
                "available": "",
                "type": "",
                "url": "",
                "parent_id": ""
            },
            "update_time": "",
            "schedule_end": "",
            "name": "",
            "total_budget": "",
            "material_list": [
                {
                    "material_url": "",
                    "review_mark": "",
                    "material_spu": [
                        {
                            "image_url": "",
                            "sku_id": "",
                            "material_id": ""
                        }
                    ],
                    "space_id": "",
                    "plan_id": "",
                    "id": "",
                    "title": "",
                    "price": "",
                    "show_days": [
                        {

                        }
                    ],
                    "original_title": "",
                    "sku_id": "",
                    "target_url": "",
                    "material_label": {
                        "label_cpcPrice": "",
                        "label_buyoutPrice": "",
                        "label_name": "",
                        "id": ""
                    },
                    "review_status": ""
                }
            ],
            "show_type": "",
            "submit_time": "",
            "allow_split": ""
        }
    }
}

SDK调用示例（java）

public JdClient client=new DefaultJdClient(SERVER_URL,accessToken,appKey,appSecret);
KuaicheZnPlanDetailGetRequest request=new KuaicheZnPlanDetailGetRequest();
request.setPlanId(301894001L );
KuaicheZnPlanDetailGetResponse response=client.execute(request);

12. 查询投放计划列表

接口名称：

jingdong.kuaiche.zn.plan.list.search

功能说明：

查询投放计划列表

API用户授权类型：

需要

l 系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	是	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-ddHH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

输入应用参数：

名称	类型	是否必须	示例值	描述
plan_name	String	否		投放计划名称
mode	String	否		投放模式 2：买断（cpd按日） 3：cpc按点击
status	Number	否		状态 1未提交2待审核3未通过 5审核通过6竞投中7暂停8终止9已结束'
is_query_by_status	String	否		是否是按状态查询（1: 是 ; 0: 否）
begin	Number	否		排期开始时间
end	Number	否		排期结束时间
page_size	Number	否		分页大小
page_index	Number	否		第几页

输出参数：

名称	类型	示例值	描述
plan_list_info	QueryPlanReturnInfo		查询投放计划列表

对象说明：

QueryPlanReturnInfo 属性：

名称	类型	是否必须	示例值	描述
id	Number	否		计划Id
name	String	否		推广计划名称
space_id	Number	否		所在的广告位Id
type	Number	否		计划类型 2:搜索页投放
budget	Number	否		日预算
total_budget	Number	否		计划预算总价
mode	Number	否		投放模式：2：cpd按日买断 3：cpc按点击
status	Number	否		状态1:未提交 2:待审核 3:未通 4:申请失败 5:审核通过6:竞投中 7:暂停 8:终止 9:已结束
status_name	String	否		状态的名称
allow_split	Number	否		出现竞价失败的情况，是否放弃之后排期的所有竞价，以便释放被冻结的资金
schedule_start	String	否		排期开始时间
schedule_end	String	否		排期结束时间
insert_time	String	否		计划创建时间
update_time	String	否		计划更新时间
submit_time	String	否		计划提交时间
show_type	Number	否		播放展示方式1:轮播2:自定义
bid_status	Number	否		当天的竞价状态：1竞价成功，2:竞价失败,3:未排期只有"status"为6时，才会有bid_status_字段
ad_space_name	String	否		投放广告位名称

返回示例

JSON数据格式：

{
  " jingdong_kuaiche_zn_plan_list_search_response":{
  "plan_list_info":{
  "plan_list":[{
  "budget":"",
"bid_status":"",
"status":"",
"schedule_start":"",
"insert_time":"",
"space_id":"",
"type":"",
"ad_space_name":"",
"mode":"",
"id":"",
"update_time":"",
"status_name":"",
"schedule_end":"",
"name":"",
"total_budget":"",
"show_type":"",
"submit_time":"",
"allow_split":""
  }],
"total_number":""
  }
  }
  }

SDK调用示例（java）

pulbic JdClient client=new DefaultJdClient(SERVER_URL,accessToken,appKey,appSecret);
KuaicheZnPlanListSearchRequest request=new KuaicheZnPlanListSearchRequest();
request.setPlanName( "jingdong" );
request.setMode( "jingdong" );
request.setStatus( 123 );
request.setIsQueryByStatus( "jingdong" );
request.setBegin( 123 );
request.setEnd( 123 );
request.setPageSize( 123 );
request.setPageIndex( 123 );
KuaicheZnPlanListSearchResponse response=client.execute(request);

13. 批量更新关键词出价

接口名称
jingdong.kuaiche.zn.plan.search.keyword.update

API用户授权类型

需要

系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	是	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

应用级输入参数

名称	类型	是否必须	示例值	描述
plan_id	Number	是		推广计划id
keyword_price	String	是	[{\"wgroupId\":\"123455\",\"price\":2},{\"wgroupId\":\"1323232\",\"price\":6}]	关键词id(wgroupId)和价格(price)信息集合的json串，价格小于0.1，默认为0.1

返回结果

名称	类型	示例值	描述
result_status	ResultStatus		返回信息描述

ResultStatus属性

名称	类型	是否必须	示例值	描述
result_code	Number	否	0	状态码：0：失败;1:成功
result_message	String	否	更新关键词出价失败！	失败信息描述

返回示例
JSON数据格式

{
    "jingdong_kuaiche_zn_plan_search_keyword_update_response": {
        "result_status": {
            "result_message": "更新关键词出价失败！",
            "result_code": "0"
        }
    }
}

SDK调用示例

public JdClient client=new DefaultJdClient(SERVER_URL,accessToken,appKey,appSecret);
KuaicheZnPlanSearchKeywordUpdateRequest request=new KuaicheZnPlanSearchKeywordUpdateRequest();
request.setPlanId( 123 );
request.setKeywordPrice( "jingdong" );
KuaicheZnPlanSearchKeywordUpdateResponse response=client.execute(request);

14. 批量添加关键词

接口名称
jingdong.kuaiche.zn.plan.search.keyword.add

API用户授权类型

需要

系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	是	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

应用级输入参数

名称	类型	是否必须	示例值	描述
plan_id	Number	是		推广计划id
keyword_price	String	是		关键词(name)和价格(price)信息集合的json串，价格小于0.1，将设置为0.1，添加已有关键词会更新出价

返回结果

名称	类型	示例值	描述
result_status	ResultStatus		返回信息描述

ResultStatus属性

名称	类型	是否必须	示例值	描述
result_code	Number	否	0	状态码：0：失败;1:成功
result_message	String	否	添加关键词失败！	失败信息描述

返回示例
JSON数据格式

{
    "jingdong_kuaiche_zn_plan_search_keyword_add_response": {
        "result_status": {
            "result_message": "添加关键词失败！",
            "result_code": "0"
        }
    }
}

SDK调用示例

public JdClient client=new DefaultJdClient(SERVER_URL,accessToken,appKey,appSecret);
KuaicheZnPlanSearchKeywordAddRequest request=new KuaicheZnPlanSearchKeywordAddRequest();
request.setPlanId( 123 );
request.setKeywordPrice( "jingdong" );
KuaicheZnPlanSearchKeywordAddResponse response=client.execute(request);

15. 删除投放计划所投放的关键词

接口名称
jingdong.kuaiche.zn.plan.search.keyword.delete

API用户授权类型
需要

系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	是	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

应用级输入参数

名称	类型	是否必须	示例值	描述
plan_id	Number	是	350919003	推广计划id
keyword_ids	String	是	[1,2,3]	要删除的关键词id集合的json串

返回结果

名称	类型	示例值	描述
result_status	ResultStatus		返回信息描述

ResultStatus属性

名称	类型	是否必须	示例值	描述
result_code	Number	否	0	状态码：0：失败;1:成功
result_message	String	否	删除关键词失败！	失败信息描述

返回示例
JSON数据格式

{
    "jingdong_kuaiche_zn_plan_search_keyword_delete_response": {
        "result_status": {
            "result_message": "删除关键词失败！",
            "result_code": "0"
        }
    }
}

SDK调用示例

public JdClient client=new DefaultJdClient(SERVER_URL,accessToken,appKey,appSecret);
KuaicheZnPlanSearchKeywordDeleteRequest request=new KuaicheZnPlanSearchKeywordDeleteRequest();
request.setPlanId( 123 );
request.setKeywordIds( "jingdong" );
KuaicheZnPlanSearchKeywordDeleteResponse response=client.execute(request);

16. 财务-获取账户信息

接口名称

jingdong.kuaiche.account.get

功能说明

获得商家账户余额，可用余额，冻结金额信息

API用户授权类型

需要

系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	是	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-ddHH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

应用级输入参数

名称	类型	是否必须	示例值	描述
				此接口无需输入应用级参数，但需要构建空参数360buy_param_json={}

返回结果

名称	类型	示例值	描述
account	AccountVO		账户信息

AccountVO 属性

名称	类型	是否必须	示例值	描述
total_amount	String	否		总余额
available_amount	String	否		可用余额
freeze_amount	String	否		冻结金额

返回示例

JSON数据格式

{
  "jingdong_kuaiche_account_get_response":{
  "freeze_amount":"",
"total_amount":"",
"available_amount":""
  }
  }

SDK调用示例（java）

public JdClient client=new DefaultJdClient(SERVER_URL,accessToken,appKey,appSecret);
KuaicheAccountGetRequest request=new KuaicheAccountGetRequest();
KuaicheAccountGetResponse response=client.execute(request);

17. 查询收支列表

接口名称
jingdong.kuaiche.account.incomexpense.search

API用户授权类型
需要

系统级别输入参数

名称	类型	是否必须	描述
method	String	是	API接口名称
access_token	String	是	采用OAuth授权方式为必填参数
app_key	String	是	应用的app_key
sign	String	是	签名
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，例如：2011-06-16 13:23:30。京东API服务端允许客户端请求时间误差为6分钟
format	String	否	暂时只支持json
v	String	否	API协议版本，可选值:2.0

应用级输入参数

名称	类型	是否必须	描述
in_out_type	Number	否	收支类型,1收入，2支出
type	Number	否	投放类型：1101 充值;1102 转款;2201 站外定向扣费;2202 站内搜索扣费
check_type	Number	否	0，最近一周1，最近一个月,2，最近三个月
page_index	Number	否	当前页
page_size	Number	否	分页大小范围大于0小于30

返回结果

名称	类型	示例值	描述
page_info	PageInfo		支出分页对象

PageInfo属性

名称	类型	是否必须	描述
page_index	Number	否	当前页
page_total	Number	否	总页数
page_size	Number	否	每页记录数
datas	IncomeExpenseVO[]	否	数据集合

IncomeExpenseVO[]属性

名称	类型	是否必须	示例值	描述
data	IncomeExpenseVO	否		数据实体

IncomeExpenseVO属性

名称	类型	是否必须	描述
swift_number	Number	否	流水单号
creat_time	String	否	操作时间
amount	Number	否	金额
in_out_type	Number	否	收支类型
remark	String	否	备注（费用名称）
show_date	String	否	统计日期

返回示例
JSON数据格式

{
    "jingdong_kuaiche_account_incomexpense_search_response": {
        "page_info": {
            "datas": [
                {
                    "data": {
                        "amount": "",
                        "swift_number": "",
                        "creat_time": "",
                        "remark": "",
                        "in_out_type": "",
                        "show_date": ""
                    }
                }
            ],
            "page_size": "",
            "page_total": "",
            "page_index": ""
        }
    }
}

SDK调用示例

public JdClient client=new DefaultJdClient(SERVER_URL,accessToken,appKey,appSecret);
KuaicheAccountIncomexpenseSearchRequest request=new KuaicheAccountIncomexpenseSearchRequest();
request.setInOutType( 123 );
request.setType( 123 );
request.setCheckType( 123 );
request.setPageIndex( 123 );
request.setPageSize( 123 );
KuaicheAccountIncomexpenseSearchResponse response=client.execute(request);

返回顶部

服务目录

公告栏

接入流程

开发指南

常用工具

业务流程

常见问题

面向买家服务

面向商家服务

京麦服务市场

供应商服务

京东云服务

KeywordVO属性