通用规范

不管选择何种方式接入数据，为了满足当前场景的数据应用要求，需按照以下规范上报用户实体数据。

1 用户 ID

其中，用户ID在 Android APP、iOS APP、微信应用（小程序、小游戏、公众号）、web应用、线下等端，识别用户的设备号或用户id不同，因此不同端有不同的合法ID类型。具体如下。

信息分类	数据源类型	合法ID类型
用户ID	Android应用	imei、oaid、android_id、手机号、click_id
用户ID	iOS应用	caid（推荐）、idfa（iOS 14版本及以上，不建议上报）、手机号
用户ID	微信应用	openid、unionid、clickid
用户ID	web应用	imei、oaid、android_id、手机号、click_id、idfa、caid、openid、unionid
用户ID	线下	imei、oaid、android_id、手机号、click_id、idfa、caid、openid、unionid

2 公共信息

用户实体基础信息结构如下。

名称	类型	必填	描述
account_id	integer	Y	推广帐号 id或 DataNexus 账号 id
user_action_set_id	integer	Y	数据源 id，通过DataNexus创建数据源时分配的唯一 id。请注意，当填写的数据源类型为 {WECHAT, WECHAT_MINI_PROGRAM, WECHAT_MINI_GAME} 时，必填 user_id 字段中的 wechat_openid (或 wechat_unionid) 及 wechat_app_id。
actions	array	Y	返回数组列表，不能大于 50KB，数组最小长度 1，最大长度 50
action_time	integer	Y	行为发生时，客户端的时间点。UNIX 时间，单位为秒，如果不填将使用服务端时间填写，最大值 2147483647
user_id	object	C	用户标识，app 数据上报时必填，user_id 与 click_id 二选一必填
hash_imei	string		Android 设备填写，md5 后的 IMEI 设备号，详见加密方法
md5_sha256_imei	string		Android 设备填写，md5 和 sha 256 后的 IMEI 设备号，详见加密方法
hash_android_id	string		Android 设备填写，md5 后的 android_id 设备号，详见加密方法
hash_oaid	string		Android 设备填写，md5 后的 oaid 设备号，详见加密方法
md5_sha256_oaid	string	C	Android 设备填写，md5 和 sha 256 后的 oaid 设备号，详见加密方法
hash_idfa	string		iOS 设备填写，md5 后的 IDFA 设备号，详见加密方法
md5_sha256_idfa	string		iOS 设备填写，md5 和 sha 256 后的 IDFA 设备号，详见加密方法
gdt_openid	string		GDT Cookie Mapping 分配的 openid，不做处理，字段长度为 64 字节
hash_phone	string		电话号码直接 MD5 编码，如 md5(13500000000)，字段长度为 32 字节
sha256_phone	string		SHA256 算法加密后的手机号，加密前为 11 位的纯数字串，加密后为不计大小写的 64 位数字字母串，字段长度为 64 字节
wechat_openid	string		微信 openid 保持原值。微信 openid 是微信用户在公众号/小程序 appid 下的唯一用户标识（appid 不同，则获取到的 openid 就不同），可用于永久标记一个用户。您只能上传您已经获得授权关联的 APPID 内的 openID。否则会解析失败。请注意，当所填 user_action_set_id 的类型为{WECHAT, WECHAT_MINI_PROGRAM, WECHAT_MINI_GAME}时，此字段和 wechat_unionid 必填其一，字段长度为 64 字节
wechat_unionid	string		微信 unionid 保持原值。微信 unionid 是微信用户在同一个微信开发者账号下的唯一用户标识（开发者账号不同，则获取到的 unionid 就不同），可用于永久标记一个用户。您只能上传您已经获得授权关联的 APPID 所属开发者账号内的 unionid。否则会解析失败。请注意，当所填 user_action_set_id 的类型为{WECHAT, WECHAT_MINI_PROGRAM, WECHAT_MINI_GAME}时，此字段和 wechat_openid 必填其一，字段长度为 64 字节
wechat_app_id	string		微信分配的 APPID。请填写所填的 wechat_openid 对应的 APPID。请确保您已经获得所填 APPID 的授权关联，否则将无法通过鉴权。当您填写 wechat_openid 时，此项必填。当您未填 wechat_openid，此项填写无效。请注意，当所填 user_action_set_id 的类型为{WECHAT, WECHAT_MINI_PROGRAM, WECHAT_MINI_GAME}时，此字段必填，字段长度为 64 字节
caid	string		iOS 设备填写，全称 CAA Advertising id，中国广告协会互联网广告标，详见加密方法
caid_version	integer		caid 版本编号。建议上报最新的 caid 版本，最大值 2147483647
action_type	enum	Y	标准行为类型，见枚举值，当值为 'CUSTOM' 时表示自定义行为类型
outer_action_id	string		用户自定义的行为 id 标识，最大值 255 字节
action_param	object		行为所带的参数，最大值 204800 字节
claim_type	integer		归因类型，腾讯平台会基于归因类型进行对应方式的归因，见枚举值
value	integer		订单价值，单位：分，100代表1元。体现转化带来的价值，一般在 action_type 为 COMPLETE_ORDER 或 PURCHASE 行为时选填
object	string		行为对象，例如 action_type 为 VIEW_CONTENT 时，object=product代表“商品页面浏览
length_of_stay	integer		停留时间，单位：天，例如action_type为START_APP作为留存行为时必填，length_of_stay=1，表示上报的是次日留存行为。枚举值：1、3、5、7，对应归因优化目标次日留存、移动app 3日留存、移动app 5日留存、移动app 7日留存
consult_type	string		咨询类型，见枚举值
trust	integer		反作弊过滤，广告主判定该转化行为，是否真实可靠。见枚举值；为空/不上报，与trust=0处理逻辑一致
custom_action	string		自定义行为类型，当 action_type=CUSTOM 时必填，最大值 128 字节
trace	object		跟踪信息
click_id	string		点击ID，user_id 与 click_id 二选一必填，广点通的click_id长度是20位数字+字母组合；微信的click_id长度是10-50，如wx0im5kwh44gh2yq，字段长度为 64 字节
url	string	C	网页应用填写，url，请填写效果数据发生 h5 页面 URL 地址，如datanexus.qq.com，最大值 2048 字节
product_inform	object		商品信息
content_type	enum		商品库行业。当您需要传输的商品信息为商品库行业标准类目时需要填写，详见枚举值
product_catalog_id	string		商品库 id。您已经同步到腾讯的商品库所对应的商品库 id，当填了商品 id 时，必须填写商品库 id，字段长度为 64 字节
product_id	string[]		与行为相关的商品 id 列表。请填写商品库 id 内对应的商品 id，数组最大长度为 1000
category_path	string[]		与行为相关的类目名称列表。对于所需回传的每一个商品类目，请按照“一级类目名称/二级类目名称/三级类目名称/四级类目名称”的格式回传完整类目路径，数组最大长度为 16
channel	enum		渠道信息，标识该条行为发生在何渠道上，详见枚举值，转化归因场景中，填写TENCENT或留空时，数据进入转化归因
ext_info	object		拓展设备信息
package_name	string		app 安装包名称，长度最大 255 字节
app_version	string		app 安装包版本，长度最大 255 字节
mac	string		mac，长度最大 255 字节
device_brand	string		设备品牌，长度最大 255 字节
model	string		设备机型，长度最大 255 字节
os_version	string		操作系统版本，长度最大 255 字节
language	string		设备的系统语言，长度最大 255 字节
ip	string		设备 ip，需上报行为发生时的 ip，长度最大 255 字节
user_agent	string		设备 User-Agent 信息，长度最大 255 字节
wifi_name	string		设备使用 wifi 名称，长度最大 512 字节