Skip to main content

搜索推荐请求

路径:/{version}/engine/game_predict

请求方法(Method):POST

2.2.1 请求参数#

请求体(Body):

参数名字段类型是否必须参数描述
request_idstring请求ID,长度最少15位, 不可重复
api_verstring请求的 API 版本,与文档的接入版本保持一致,比如说文档接入时是 2.1.6 那么 api_ver=2.1.6
appApp媒体(应用)信息
deviceDevice用户设备参数
positionPosition广告位(资源位)信息
querystring搜索关键词
extExt扩展字段

2.2.2.1 App#

App 主要用来保存当前请求的媒体(应用)信息,该信息主要来源于在 游可赢广告管理平台 申请的应用 id等,请保证请求信息与平台配置信息是一致的。

参数名字段类型是否必须参数描述
app_idint媒体app id,从游可盈处申请https://yky.qq.com/
app_verstring应用版本号
app_pkgstring应用包名
channel_idint渠道id

2.2.2.2 Device#

Device 主要用来保存收集到的当前用户的设备信息,该信息主要用来做用户标签、定向、特征工程等,帮助搜索推荐系统推送效果更好的游戏,所以该对象里面的字段要求 尽可能准确填写

参数名字段类型是否必须参数描述
osstring系统类型, 填写"unknown", "ios","android"
osvstring系统版本
qimei36stringqimei36,当不存在imei、oaid、idfa、caid等设备信息时该字段必传
qimei36_md5stringqimei36_md5,和qimei36同理,为qimei36的md5值(小写)
imeistring设备IMEI(仅android设备有)
imei_md5string设备IMEI MD5(小写)(仅android设备)
oaidstring设备OAID(仅android设备有)
oaid_md5string设备OAID MD5(小写)(仅android设备)
android_idstring设备ANDROID_ID(仅android设备有)
android_id_md5string设备ANDROID_ID MD5(小写) (仅android设备)
idfastring设备IDFA(仅iOS设备)
idfa_md5string设备IDFA MD5 (小写)(仅iOS设备)
caidstring设备caid(仅iOS设备)
caid_md5string设备caid MD5 (小写)(仅iOS设备)
networkstring网络类型"unknown", "wifi", "2G", "3G", "4G", "5G"
device_typestring设备类型: 1 手机/平板,2 个人电脑,3 联网电视,4手机,5平板
uastringUser Agent
brandstring设备制造商,例如 "apple","samsung" 小写处理
modelstring设备型号,例如 "iphone" 小写处理
carrierstring运营商,映射关系:
46000 中国移动 (GSM)
46001 中国联通 (GSM)
46002 中国移动 (TD-S)
46003 中国电信(CDMA)
46005 中国电信 (CDMA)
46006 中国联通 (WCDMA)
46007 中国移动 (TD-S)
46011 中国电信 (FDD-LTE)
46020 中国铁通
unknown 未知
widthint设备宽度
heightint设备高度
ipstring客户端IP:请求公网出口IP
ipv6string用户请求IPv6

注意:

●若设备为iOS设备,则 idfa、idfa_md5、caid、caid_md5必填其中之一

●若设备为Android设备,则 imei、imei_md5、oaid、oaid_md5 必填其中之一

●在以上设备信息均没有的情况下,qimei36或者qimei36_md5必填其中之一

2.2.2.3 Position#

Position 主要用来保存当前请求的资源位信息,该信息主要来源于游可赢广告管理平台平台申请的广告位(资源位) ID。

参数名字段类型是否必须参数描述
pos_idint广告资源位id,从游可盈处申请https://yky.qq.com/

2.2.2.4 Ext#

用于记录一些扩展字段

参数名字段类型是否必须参数描述
game_id_listarray string媒体方的游戏id列表
time_outint超时时间
query_infosQueryInfo分词信息

2.2.3 请求响应#

参数名字段类型是否必须参数描述
codenumber错误码,0表示请求成功
msgstring错误说明
dataData返回的详细数据

其中Data结构如下:

参数名字段类型是否必须参数描述
request_idstring请求id,和请求参数中的request_id一致
appsarray Game推荐的游戏信息
tracking_urlTracking行为数据上报链接,需进行宏替换

2.2.3.1 Game#

Game保存了被推荐的游戏的相关信息,其中游戏id已经按照精排分值从大到小排序。

参数名字段类型是否必须参数描述
game_idstring媒体游戏id
rank_valuefloat32分值

2.2.3.2 Tracking#

Tracking保存行为数据上报的相关链接。

参数名字段类型是否必须参数描述
impremission_urlstring曝光链接
click_urlstring点击链接
download_urlstring下载链接