上传用户属性数据

开发环境

POST

/v1.3/user_properties/add

请求参数

标有*的参数为必填项

名称	类型	描述
account_id*	integer	推广帐号 id，有操作权限的帐号 id，包括代理商和广告主帐号 id
user_property_set_id*	integer	用户属性数据源 id
wechat_app_id	string	微信用户 OpenID 或 UnionID 对应的微信 AppID ；当 wechat_openid 或 wechat_unionid 非空时，必填字段长度最小 1 字节，
property*	struct[]	用户属性列表数组最大长度 50
outer_user_id*	string	您为用户分配的唯一 id。一般而言，是您在 CRM 或其他后台系统中为该用户分配的 id。您也可以用 user_id 参数中的任一字段（例如手机号/QQ 号）来填写这个标识。字段长度最小 1 字节，长度最大 32 字节
user_id*	struct	用户 id，hash_qq、hash_phone、hash_idfa、hash_imei、hash_mac、wechat_openid 和 wechat_unionid 至少填写一个
hash_qq	string	md5 加密后 qq 号字段长度最小 1 字节，长度最大 64 字节
hash_phone	string	md5 加密后手机号字段长度最小 1 字节，长度最大 64 字节
hash_idfa	string	md5 加密后用户 IDFA 字段长度最小 1 字节，长度最大 64 字节
hash_imei	string	md5 加密后用户 IMEI 字段长度最小 1 字节，长度最大 64 字节
hash_mac	string	md5 加密后 mac 地址字段长度最小 1 字节，长度最大 64 字节
wechat_openid	string	微信用户的 OpenID，仅对特定客户开放字段长度最小 1 字节，长度最大 64 字节
wechat_unionid	string	微信用户的 UnionID，仅对特定客户开放字段长度最小 1 字节，长度最大 64 字节
property_data*	string	属性数据，最多 50 个键值对，键最大长度 20，值最大长度 40.详见 [property_param_map] 字段长度最小 1 字节，长度最大 204800 字节

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST '/v1.3/user_properties/add?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
--header 'access_token;' \
--header 'timestamp;' \
--header 'nonce;' \
--header 'fields;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "account_id": "<ACCOUNT_ID>",
    "user_property_set_id": "<USER_PROPERTY_SET_ID>",
    "wechat_app_id": "<WECHAT_APP_ID>",
    "property": [
        {
            "outer_user_id": "testUser",
            "user_id": {
                "hash_qq": "e10adc3949ba59abbe56e057f20f883e",
                "wechat_openid": "ozYoQszwWGZywZLNEogId_d9O-2Y"
            },
            "property_data": {
                "property1": "value1",
                "property2": "value2"
            }
        }
    ]
}'

响应示例

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

请求参数

Query 参数

access_token

string

必需

示例值:

<ACCESS_TOKEN>

timestamp

string

必需

示例值:

nonce

string

必需

示例值:

<NONCE>

Header 参数

Content-Type

string

必需

示例值:

application/json

access_token

string

必需

以Query Parameter方式在请求路径中传递。授权令牌，完成 OAuth 2.0 授权后获得，参考授权认证章节。

默认值:

<ACCESS_TOKEN>

timestamp

string

必需

以Query Parameter方式在请求路径中传递。当前的时间戳，单位为秒，允许客户端请求最大时间误差为300秒。
MarketingAPI 所使用的时间戳，若无特殊说明，均为秒级时间戳
MarketingAPI 所使用的时区为GMT+8，例如当时间戳为1494840119时，表示 2018-05-15 17:21:59

默认值:

nonce

string

必需

以Query Parameter方式在请求路径中传递。随机字串标识，不超过32个字符，由调用方自行生成，需保证全局唯一性。

默认值:

<NONCE>

fields

string

必需

指定返回的字段列表，为选填字段，如不填写，则根据默认值进行返回

Body 参数application/json

account_id

integer

必需

推广帐号 id，有操作权限的帐号 id，包括代理商和广告主帐号 id

user_property_set_id

integer

必需

用户属性数据源 id

wechat_app_id

string

可选

微信用户 OpenID 或 UnionID 对应的微信 AppID ；当 wechat_openid 或 wechat_unionid 非空时，必填字段长度最小 1 字节，

property

array [object {3}]

必需

用户属性列表数组最大长度 50

outer_user_id

string

必需

您为用户分配的唯一 id。一般而言，是您在 CRM 或其他后台系统中为该用户分配的 id。您也可以用 user_id 参数中的任一字段（例如手机号/QQ 号）来填写这个标识。字段长度最小 1 字节，长度最大 32 字节

user_id

object

可选

用户 id，hash_qq、hash_phone、hash_idfa、hash_imei、hash_mac、wechat_openid 和 wechat_unionid 至少填写一个

property_data

object

可选

属性数据，最多 50 个键值对，键最大长度 20，值最大长度 40.详见 [property_param_map] 字段长度最小 1 字节，长度最大 204800 字节

示例

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

message_cn

string

必需

修改于 2023-11-08 02:47:07

获取用户属性数据源

创建用户行为数据源

上传用户属性数据

请求参数#

请求参数

返回响应

请求参数