接口文档SDK业务专题开发者工具

用户行为数据 (User Action)

V1.1

loading


本节将为您介绍用户行为数据 (User Action) 相关接口。关于用户行为数据接入更详细的介绍可以参考【数据接入】章节。

所属权限(scope):User Actions


上传用户行为数据
全部接口
V1.1
loading

所属权限 User Actions
请求地址 user_actions/add
请求方法 post

全局参数

全局参数是指每一个接口都需要使用到的参数。详情参考,代码案例参考

参数名称 参数类型
access_token 授权令牌,完成 OAuth 2.0 授权后获得,参考授权认证章节
timestamp

当前的时间戳,单位为秒,允许客户端请求最大时间误差为 300 秒。

MarketingAPI 所使用的时间戳,若无特殊说明,均为秒级时间戳

MarketingAPI 所使用的时区为 GMT+8,例如当时间戳为 1494840119 时,表示 2017-05-15 17:21:59

nonce 随机字串标识,不超过 32 个字符,由调用方自行生成,需保证全局唯一性
fields get 接口增加 fields 字段,用于指定返回参数的字段列表,为选填字段。fields 取值范围为 get 接口返回的 list 中的字段。如不填写,则根据默认值进行返回

请求参数

参数仅适用于腾讯广告平台及微信公众平台。其中,标有的内容表示,该参数在微信公众平台使用时,描述不同。标有*的参数为必填项

名称 类型 描述
account_id*
integer 推广帐号 id,有操作权限的帐号 id,包括代理商和广告主帐号 id
user_action_set_id*
integer 用户行为源 id,通过 [user_action_sets 接口] 创建用户行为源时分配的唯一 id
actions*
struct[] 返回数组列表,不能大于 50KB
数组最小长度 1,最大长度 50
action_time*
integer 行为发生时,客户端的时间点。UNIX 时间,单位为秒,如果不填将使用服务端时间填写
最小值 0,最大值 2147483647
user_id
struct 用户标识,app 数据上报时必填,web 数据上报时可以不填 user_id,但建议填写,方便后续优化
hash_imei
string IMEI 设备号保持小写,进行 md5 编码
字段长度为 32 字节
hash_idfa
string IDFA 设备号保持大写,进行 MD5 编码
字段长度为 32 字节
gdt_openid
string GDT Cookie Mapping 分配的 openid,不做处理
字段长度最小 1 字节,长度最大 64 字节
hash_phone
string 电话号码直接 MD5 编码,如 md5(13500000000)
字段长度为 32 字节
qaid
string 腾讯设备标识,保留原始值,不需要 MD5 编码。QAID 示例:016AC9BE81C88D616DAF3BEE2A859EDD|02B7F1FB4E35CE340F944BC96F89B6EA。其中,| 用于连接多个版本的 QAID,最多支持使用一个 | 连接两个版本的 QAID。注意:QAID 暂时无法用于 DMP 人群提取
字段长度最小 32 字节,长度最大 65 字节
hash_android_id
string 对 android_id 进行 MD5 编码
字段长度为 32 字节
hash_mac
string mac 地址去掉‘:’ 后保持大写,进行 MD5 编码
字段长度为 32 字节
oaid
string MSA 制定的匿名设备标识符,保留原始值,不需要 MD5 编码。具体 OAID 介绍请见[OAID 介绍]
字段长度最小 32 字节,长度最大 64 字节
wechat_openid
string 微信 openid 保持原值。微信 openid 是微信用户在公众号/小程序 appid 下的唯一用户标识(appid 不同,则获取到的 openid 就不同),可用于永久标记一个用户。您只能上传您已经获得授权关联的 APPID 内的 openID。否则会解析失败。
字段长度最小 1 字节,长度最大 64 字节
wechat_unionid
string 微信 unionid 保持原值。微信 unionid 是微信用户在同一个微信开发者账号下的唯一用户标识(开发者账号不同,则获取到的 unionid 就不同),可用于永久标记一个用户。您只能上传您已经获得授权关联的 APPID 所属开发者账号内的 unionid。否则会解析失败。
字段长度最小 1 字节,长度最大 64 字节
wechat_app_id
string 微信分配的 APPID。请填写所填的 wechat_openid 对应的 APPID。请确保您已经获得所填 APPID 的授权关联,否则将无法通过鉴权。当您填写 wechat_openid 时,此项必填。当您未填 wechat_openid,此项填写无效。
字段长度最小 2 字节,长度最大 64 字节
action_type*
enum 标准行为类型,当值为 'CUSTOM' 时表示自定义行为类型,[枚举详情]
枚举列表:{ CUSTOM, REGISTER, VIEW_CONTENT, CONSULT, ADD_TO_CART, PURCHASE, ACTIVATE_APP, SEARCH, ADD_TO_WISHLIST, INITIATE_CHECKOUT, COMPLETE_ORDER, DOWNLOAD_APP, START_APP, RATE, PAGE_VIEW, RESERVATION, SHARE, APPLY, CLAIM_OFFER, NAVIGATE, PRODUCT_RECOMMEND, VISIT_STORE, TRY_OUT, DELIVER, CONFIRM_EFFECTIVE_LEADS, CONFIRM_POTENTIAL_CUSTOMER, CREATE_ROLE, AUTHORIZE, TUTORIAL_FINISH, SCANCODE, ENTER_BACKGROUND, ENTER_FOREGROUND, TICKET, LOGIN, QUEST, UPDATE_LEVEL, CREATE, PAUSE, RESUME, APP_QUIT, BIND_ACCOUNT, ADD_PAYMENT, PRE_CREDIT, CREDIT, WITHDRAW_DEPOSITS, LANDING_PAGE_CLICK, SELECT_COURSE, RE_FUND, PLATFORM_VIEW, ONE_DAY_LEAVE, PRODUCT_VIEW, PURCHASE_MEMBER_CARD, ONLINE_CONSULT, MAKE_PHONE_CALL, AD_CLICK, AD_IMPRESSION }
external_action_id
string 用户自定义的行为 id 标识
字段长度最小 0 字节,长度最大 255 字节
action_param
string 行为所带的参数,详见 [param_map]
字段长度最小 1 字节,长度最大 204800 字节
custom_action
string 自定义行为类型,当 action_type=CUSTOM 时必填
字段长度最小 1 字节,长度最大 128 字节
trace
struct 跟踪信息
click_id
string 点击 id
字段长度最小 1 字节,长度最大 64 字节
url
string url,网页回传时必须要填写 url,请填写效果数据发生 h5 页面 URL 地址
字段长度最小 1 字节,长度最大 2048 字节
product_inform
struct 商品信息
content_type
enum 商品库行业。当您需要传输的商品信息为商品库行业标准类目时需要填写;如果传输的商品信息为商品 id,则无需填写。,[枚举详情]
枚举列表:{ EC, ESTATE, VIDEO, CAR, NEWS_INFORMATION, BEAUTY_PERSONAL_CARE, RETAIL, EDUCATION, READING, INSURANCE, LOAN, FINANCIAL, BANKCARD, WEDDING, SECURITIES, DECORATION_BUILDING_MATERIAL, CARRIER, GAME }
product_catalog_id
string 商品库 id。指您已经同步到腾讯的商品库所对应的商品库 id。,当填了商品 id 时,必须填写商品库 id。
字段长度最小 1 字节,长度最大 64 字节
product_id
string[] 与行为相关的商品 id 列表。请填写商品库 id 内对应的商品 id
数组最大长度 1000
category_path
string[] 与行为相关的类目名称列表。对于所需回传的每一个商品类目,请按照“一级类目名称/二级类目名称/三级类目名称/四级类目名称”的格式回传完整类目路径。
数组最大长度 16
channel
enum 渠道信息,标识该条行为发生在何渠道上。,[枚举详情]
枚举列表:{ NATURAL, TENCENT, BYTEDANCE, KUAISHOU, ALIBABA, BAIDU, OTHERS, UNKNOWN }

请求示例


curl 'https://api.e.qq.com/v1.1/user_actions/add?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-H 'Content-Type: application/json' \
-d '{
    "account_id": "<ACCOUNT_ID>",
    "user_action_set_id": "<USER_ACTION_SET_ID>",
    "actions": [
        {
            "external_action_id": "external_action_identity",
            "action_time": 1492998081,
            "user_id": {
                "hash_imei": "f9efca36a3c30e1cf28170d86ecbf5e9"
            },
            "action_type": "CUSTOM",
            "custom_action": "my_type",
            "action_param": {
                "content_type": "ecommerce",
                "object": "product",
                "int_example": 123,
                "int_array_example": [
                    123,
                    234
                ],
                "double_example": 123.4500000000000028421709430404007434844970703125,
                "double_array_example": [
                    123.4500000000000028421709430404007434844970703125,
                    234.56000000000000227373675443232059478759765625
                ],
                "bool_example": true,
                "bool_array_example": [
                    true,
                    false
                ],
                "string_example": "123",
                "string_array_example": [
                    "123",
                    "234",
                    "abc"
                ]
            }
        }
    ]
}'
					

应答字段

应答示例

{
    "code": 0,
    "message": "",
    "message_cn": ""
}

可视化调试工具

相关阅读