获取用户行为数据源

开发环境

GET

/v1.3/user_action_sets/get

使用说明

为提升数据上报文档阅读体验，相关文档将逐步迁移至 DataNexus。现邀请您抢鲜体验。

应答字段

名称	类型	描述
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 表示不可以

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET '/v1.3/user_action_sets/get' \
--header 'access_token;' \
--header 'timestamp;' \
--header 'nonce;' \
--header 'fields;' \
--data-urlencode 'account_id=<ACCOUNT_ID>' \
--data-urlencode 'user_action_set_id=1111111111' \
--data-urlencode 'type=WEB' \
--data-urlencode 'name=webuser_action_set'

响应示例

{
    "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"
            }
        ]
    }
}

请求参数

Header 参数

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/x-www-form-urlencoded

account_id

integer

必需

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

示例值:

<ACCOUNT_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。

示例值:

1111111111

type

string

可选

用户行为源类型列表，[枚举详情]
枚举列表：{ WEB, ANDROID, IOS, OFFLINE, WECHAT, WECHAT_MINI_PROGRAM, WECHAT_MINI_GAME }

示例值:

WEB

name

string

必需

用户行为源名称，当 type=WEB 时必填，当 type=ANDROID 或 IOS 时，若未填写该字段，则默认通过 mobile_app_id 获取名称
字段长度最小 1 字节，长度最大 32 字节

示例值:

webuser_action_set

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

message_cn

string

必需

data

object

必需

list

array [object {6}]

返回数组列表

必需

修改于 2023-11-08 02:57:36

创建用户行为数据源

获取用户行为数据源报表

获取用户行为数据源

应答字段#

请求参数

返回响应

应答字段