获取用户行为数据源
所属权限 | ads_management,audience_management,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 个字符,由调用方自行生成,需保证全局唯一性 |
请求参数
标有*的参数为必填项
名称 | 类型 | 描述 |
---|---|---|
account_id*
|
integer | 推广帐号 id,有操作权限的帐号 id,包括代理商和广告主帐号 id |
user_action_set_id
|
integer | 用户行为源 id,通过 [user_action_sets 接口] 创建用户行为源时分配的唯一 id。请注意,当填写的用户行为数据源类型为 {WECHAT, WECHAT_MINI_PROGRAM, WECHAT_MINI_GAME} 时,必填 user_id 字段中的 wechat_openid (或 wechat_unionid) 及 wechat_app_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 字节 |
include_permission
|
boolean | 是否返回数据源权限信息,true 表示返回,false 表示不返回 可选值:{ true, false } |
使用说明
- 为提升数据上报文档阅读体验,相关文档将逐步迁移至 DataNexus。现邀请您抢鲜体验。
请求示例
curl -v -G 'https://api.e.qq.com/v3.0/user_action_sets/get?access_token=<ACCESS_TOKEN>×tamp=<TIMESTAMP>&nonce=<NONCE>' \
-d 'account_id=<ACCOUNT_ID>' \
-d 'user_action_set_id=1111111111' \
-d 'type=[
"WEB"
]' \
-d 'name=webuser_action_set'
应答字段
名称 | 类型 | 描述 |
---|---|---|
list
|
struct[] | 返回数组列表 |
user_action_set_id
|
integer | 用户行为源 id,通过 [user_action_sets 接口] 创建用户行为源时分配的唯一 id。请注意,当填写的用户行为数据源类型为 {WECHAT, WECHAT_MINI_PROGRAM, WECHAT_MINI_GAME} 时,必填 user_id 字段中的 wechat_openid (或 wechat_unionid) 及 wechat_app_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 |
access_way
|
enum | 数据源来源,[枚举详情] |
usages
|
enum[] | 接入用途类型,[枚举详情] |
enable_conversion_claim
|
boolean | 是否开启转化归因,true 表示开启,false 表示不开启,不传则默认开启 |
permission
|
struct | 数据源权限 |
can_create_audience
|
boolean | 是否可以提取人群,true 表示可以,false 表示不可以 |
can_exact_conversion_claim
|
boolean | 是否可以精准归因,true 表示可以,false 表示不可以 |
can_as_serving
|
boolean | 是否可以投放广告,true 表示可以,false 表示不可以 |
应答示例
{
"code": 0,
"message": "",
"message_cn": "",
"data": {
"list": [
{
"type": "WEB",
"name": "webuser_action_set",
"description": "",
"user_action_set_id": 1111111111,
"activate_status": true,
"created_time": "2017-02-20 16:04:27"
}
]
}
}
可视化调试工具
问题仍未解决?
请前往腾讯广告反馈中心在线提交问题,我们的人工客服将为你服务