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

用户行为数据源 (User Action Set)

V1.1

loading


本节将为您介绍用户行为数据源 (User Action Set) 相关接口。


创建用户行为数据源
全部接口
V1.1
loading

所属权限 User Actions
请求地址 user_action_sets/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
type*
enum 用户行为源类型,[枚举详情]
枚举列表:{ WEB, ANDROID, IOS, OFFLINE, WECHAT, WECHAT_MINI_PROGRAM, WECHAT_MINI_GAME }
mobile_app_id
integer 应用 id,IOS:App Store id ; ANDROID:应用宝 id,type=ANDROID 或 IOS 时必填
wechat_app_id
string 微信 AppID,当 type = WECHAT 或 WECHAT_MINI_PROGRAM 或 WECHAT_MINI_GAME 时必填
字段长度最小 2 字节,长度最大 64 字节
name
string 用户行为源名称,当 type=WEB 时必填,当 type=ANDROID 或 IOS 时,若未填写该字段,则默认通过 mobile_app_id 获取名称
字段长度最小 1 字节,长度最大 32 字节
description
string 用户行为源描述
字段长度最小 1 字节,长度最大 128 字节
usages
enum[] 接入用途类型,仅联合专区用户关注,不填时,此字段默认为 NORMAL,[枚举详情]
数组最小长度 1,最大长度 2
枚举列表:{ NORMAL, JOINT_ZONE }

请求示例


curl 'https://api.e.qq.com/v1.1/user_action_sets/add?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-H 'Content-Type: application/json' \
-d '{
    "account_id": "<ACCOUNT_ID>",
    "type": "WEB",
    "name": "webuser_action_set",
    "description": "",
    "usages": []
}'
					

应答字段

名称 类型 描述
user_action_set_id
integer 用户行为源 id,通过 [user_action_sets 接口] 创建用户行为源时分配的唯一 id

应答示例

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "user_action_set_id": "<USER_ACTION_SET_ID>"
    }
}

可视化调试工具


获取用户行为数据源
全部接口
V1.1
loading

所属权限 User Actions
请求地址 user_action_sets/get
请求方法 get

全局参数

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

参数名称 参数类型
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
type
enum[] 用户行为源类型列表,[枚举详情]
枚举列表:{ WEB, ANDROID, IOS, OFFLINE, WECHAT, WECHAT_MINI_PROGRAM, WECHAT_MINI_GAME }

请求示例


curl -G 'https://api.e.qq.com/v1.1/user_action_sets/get?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'user_action_set_id=<USER_ACTION_SET_ID>' \
-d 'type=WEB' 
					

应答字段

名称 类型 描述
list
struct[] 返回数组列表
user_action_set_id
integer 用户行为源 id,通过 [user_action_sets 接口] 创建用户行为源时分配的唯一 id
type
enum 用户行为源类型,[枚举详情]
mobile_app_id
integer 应用 id,IOS:App Store id ; ANDROID:应用宝 id,type=ANDROID 或 IOS 时必填
name
string 用户行为源名称,当 type=WEB 时必填,当 type=ANDROID 或 IOS 时,若未填写该字段,则默认通过 mobile_app_id 获取名称
description
string 用户行为源描述
activate_status
boolean 数据接入状态,true 表示已接入,false 表示未接入
created_time
string 创建时间,格式为 yyyy-MM-dd HH:mm:ss,如 2016-11-01 10:42:56

应答示例

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "list": [
            {
                "type": "WEB",
                "name": "webuser_action_set",
                "description": "",
                "user_action_set_id": "<USER_ACTION_SET_ID>",
                "activate_status": true,
                "created_time": "2017-02-20 16:04:27"
            }
        ]
    }
}

可视化调试工具


获取用户行为数据源报表
全部接口
V1.1
loading

所属权限 User Actions
请求地址 user_action_set_reports/get
请求方法 get

全局参数

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

参数名称 参数类型
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
date_range*
struct 时间范围,日期格式,{"start_date":"2017-03-01","end_date":"2017-04-02"}
start_date*
string 开始时间点对应的时间戳,小于或等于 end_date
字段长度为 10 字节
end_date*
string 结束时间点对应的时间戳,小于或等于今天,且大于或等于 start_date
字段长度为 10 字节
time_granularity*
enum 时间粒度,针对流量的粒度,可选值:DAILY(按天汇总), HOURLY(按小时汇总),默认小时,[枚举详情]
枚举列表:{ DAILY, HOURLY }
aggregation
enum 聚合维度,是否将结果按照指定类型细分,可选值'DOMAIN', 'ACTION_TYPE',[枚举详情]
枚举列表:{ DOMAIN, ACTION_TYPE }

请求示例


curl -G 'https://api.e.qq.com/v1.1/user_action_set_reports/get?access_token=<ACCESS_TOKEN>&timestamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'user_action_set_id=<USER_ACTION_SET_ID>' \
-d 'date_range={"start_date":"YYYY-MM-DD","end_date":"YYYY-MM-DD"}' \
-d 'time_granularity=HOURLY' \
-d 'aggregation=DOMAIN' 
					

应答字段

名称 类型 描述
list
struct[] 返回数组列表
date
string 采样日期,格式:yyyy-MM-dd
hour
integer 小时,当 time_granularity=HOURLY 时有值,返回格式 HH
domain
string 行为发生的域名,当 aggregation=DOMAIN 时有值
action_type
enum 标准行为类型,当 aggregation=ACTION_TYPE 时有值,[枚举详情]
custom_action
string 自定义行为类型,当 aggregation=ACTION_TYPE 时有值
raw_action_count
integer 原始上报行为数
identified_action_count
integer 可识别的行为数
identified_user_count
integer 可识别的独立用户数,当没有指定 aggregation 时,有值

应答示例

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "list": [
            {
                "date": "2017-04-25",
                "hour": "11",
                "domain": "https://example.com",
                "raw_action_count": 4000,
                "identified_action_count": 2100,
                "identified_user_count": 1400
            }
        ]
    }
}

可视化调试工具