跳到主要内容

用户行为添加/更新


前置条件

请在 DataNexus -<数据接入>-<数据源>中新建数据源，参考新建数据源。


请求地址​

https://api.e.qq.com/v1.1/action/add


请求方法​

POST


请求参数​

参数名描述
access_token授权令牌，完成 OAuth 2.0 授权后获得，参考开发者账号及环境
timestamp当前的时间戳，单位为秒，允许客户端请求最大时间误差为 300 秒。MarketingAPI 所使用的时间戳，若无特殊说明，均为秒级时间戳签名算法。MarketingAPI 所使用的时区为 GMT+8，例如当时间戳为 1494840119 时，表示 2017-05-15 17:21:59
nonce随机字串标识，不超过 32 个字符，由调用方自行生成，需保证全局唯一性

请求体类型​

application/json


请求体参数​

名称类型必填描述
account_idintegerY推广帐号 id或DN账号 id
data_source_idintegerY数据源 id，通过DataNexus创建数据源时分配的唯一 id。请注意，当填写的数据源类型为 {WECHAT, WECHAT_MINI_PROGRAM, WECHAT_MINI_GAME} 时，必填 user_id 字段中的 wechat_openid (或 wechat_unionid) 及 wechat_app_id。
actionsarrayY返回数组列表，不能大于 50KB，数组最小长度 1，最大长度 50
action_timeintegerY行为发生时，客户端的时间点。UNIX 时间，单位为秒，如果不填将使用服务端时间填写，最小值 0，最大值 2147483647
user_idobject用户标识，app 数据上报时必填，web 数据上报时可以不填 user_id，但建议填写，方便后续优化
hash_imeistringIMEI 设备号保持小写，进行 md5 编码，字段长度为 64 字节
md5_sha256_imeistring先采用 MD5 算法加密（加密后统一十六进制小写），然后再采用 SHA256 算法加密后的 IMEI，加密前需要格式转化成 14 位或 15 位数字 + 小写字母串，加密后为 64 位“数字(0-9)+小写字母(a-f)”组成的数字字母串，字段长度为 32 字节
hash_idfastringIDFA 设备号保持大写，进行 MD5 编码，字段长度为 32 字节
md5_sha256_idfastring先采用 MD5 算法加密（加密后统一十六进制小写），然后再采用 SHA256 算法加密后的 IDFA，加密前需要格式转化成 32 位的数字 + 大写字母，加密后为 64 位“数字(0-9)+小写字母(a-f)”组成的数字字母串，字段长度为 64 字节
gdt_openidstringGDT Cookie Mapping 分配的 openid，不做处理，字段长度为 64 字节
hash_phonestring电话号码直接 MD5 编码，如 md5(13500000000)，字段长度为 32 字节
sha256_phonestringSHA256 算法加密后的手机号，加密前为 11 位的纯数字串，加密后为不计大小写的 64 位数字字母串，字段长度为 64 字节
hash_android_idstring对 android_id 进行 MD5 编码，字段长度为 32 字节
hash_oaidstringMSA 制定的匿名设备标识符，保留原始值，然后进行 MD5 编码。具体 OAID 介绍请见http://msa-alliance.cn，字段长度为 32 字节
wechat_openidstring微信 openid 保持原值。微信 openid 是微信用户在公众号/小程序 appid 下的唯一用户标识（appid 不同，则获取到的 openid 就不同），可用于永久标记一个用户。您只能上传您已经获得授权关联的 APPID 内的 openID。否则会解析失败。请注意，当所填 user_action_set_id 的类型为{WECHAT, WECHAT_MINI_PROGRAM, WECHAT_MINI_GAME}时，此字段和 wechat_unionid 必填其一，字段长度为 64 字节
wechat_unionidstring微信 unionid 保持原值。微信 unionid 是微信用户在同一个微信开发者账号下的唯一用户标识（开发者账号不同，则获取到的 unionid 就不同），可用于永久标记一个用户。您只能上传您已经获得授权关联的 APPID 所属开发者账号内的 unionid。否则会解析失败。请注意，当所填 user_action_set_id 的类型为{WECHAT, WECHAT_MINI_PROGRAM, WECHAT_MINI_GAME}时，此字段和 wechat_openid 必填其一，字段长度为 64 字节
wechat_app_idstring微信分配的 APPID。请填写所填的 wechat_openid 对应的 APPID。请确保您已经获得所填 APPID 的授权关联，否则将无法通过鉴权。当您填写 wechat_openid 时，此项必填。当您未填 wechat_openid，此项填写无效。请注意，当所填 user_action_set_id 的类型为{WECHAT, WECHAT_MINI_PROGRAM, WECHAT_MINI_GAME}时，此字段必填，字段长度为 64 字节
caidstring全称 CAA Advertising id，中国广告协会互联网广告标。通过采集 IOS 系统 12 个非隐私参数使用固定规则生成的设备指纹，由数字与小写字母组成的 32 位长度的字符串。上报 caid 时 caid_version 为必填项，建议上报最新的 caid 版本，字段长度为 64 字节
caid_versionintegercaid 版本编号。建议上报最新的 caid 版本，最小值 0，最大值 2147483647
action_typeenumY标准行为类型，当值为 'CUSTOM' 时表示自定义行为类型，https://developers.e.qq.com/docs/reference/enum#api_action_type，枚举列表：{ 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, ADD_GROUP, ADD_CUSTOMER_PAGE_VIEW, ADD_CUSTOMER_PAGE_INTERACTIVE, CUSTOMER_PROMOTION_PAGE_VIEW, CUSTOMER_PROMOTION_PAGE_INTERACTIVE, ABNORMAL_ACTION, LIVE_STREAM, SCANCODE_WX, STAY_PAY_7, STAY_PAY_15, STAY_PAY_30, INSURANCE_PAY, RESERVATION_CHECK, PARTICIPATED, COMPLETED, REGULAR_PRICE_COURSE, DROP_OUT, CONFIRM_DELIVERY_ORDER, CANCEL_DELIVERY_ORDER, OPEN_ACCOUNT, DEPOSIT, TRADE, SECURITY_NEGATIVE, AD_CLICK, AD_IMPRESSION}
external_action_idstring用户自定义的行为 id 标识，最大值 255 字节
action_paramstring行为所带的参数，详见 https://developers.e.qq.com/docs/reference/illustration#param_map，最大值 204800 字节
custom_actionstring自定义行为类型，当 action_type=CUSTOM 时必填，最大值 128 字节
traceobject跟踪信息
click_idstring点击ID，字段长度为 64 字节
urlstringurl，网页回传时必须要填写 url，请填写效果数据发生 h5 页面 URL 地址，最大值 2048 字节
product_informobject商品信息
content_typeenum商品库行业。当您需要传输的商品信息为商品库行业标准类目时需要填写；如果传输的商品信息为商品 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_idstring商品库 id。您已经同步到腾讯的商品库所对应的商品库 id，当填了商品 id 时，必须填写商品库 id，字段长度为 64 字节
product_idstring[]与行为相关的商品 id 列表。请填写商品库 id 内对应的商品 id，数组长度为 1000
category_pathstring[]与行为相关的类目名称列表。对于所需回传的每一个商品类目，请按照“一级类目名称/二级类目名称/三级类目名称/四级类目名称”的格式回传完整类目路径，数组长度为 16
channelenum渠道信息，标识该条行为发生在何渠道上，枚举列表：{ NATURAL, TENCENT, BYTEDANCE, KUAISHOU, ALIBABA, BAIDU, OTHERS, UNKNOWN }

请求体示例​

{
    "account_id": 1111111111,
    "data_source_id": 1111111111,
    "actions": [
        {
            "external_action_id": "示例唯一行为 id_请指定",
            "action_time": 1492998081,
            "user_id": {
                "hash_imei": "f9efca36a..."
            },
            "action_type": "CUSTOM",
            "custom_action": "my_type",
            "action_param": {
                "value": 28,
                "quantity": 5,
                "brand_name": "my_brand",
                "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"
                ]
            },
            "product_inform": {
                "content_type": "EC",
                "category_path": [
                    "家用电器/厨房小电/豆浆机",
                    "本地生活旅游出行/旅游出行/机票火车票"
                ]
            },
            "channel": "CHANNEL_NATURAL"
        }
    ]
}

应答体结构​

名称类型是否一定返回描述
codeintegerY返回码，等于0表示成功，不等于0表示错误，具体见文档附录
messagestringY错误描述，code不等于0时，message为错误描述
message_cnstring中文错误描述，code不等于0时，message_cn为错误情况的中文描述
dataobject资源数据，具体返回内容见各接口定义，只在code等于0时可能返回
errorsobject详细错误信息，只在code不等于0时可能返回

应答示例​

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



FAQ

Q：xx 与 user_actions/add 的区别？

A：一个 DataNexus 数据源下，最多可创建多个数据集，如创建的数据集已达到个数限制（当前为50），需要复用已有的数据集。上报商品数据时，在数据中填写的数据集必须是在填写的数据源下创建的。