人群价值分析

请求参数

标有*的参数为必填项

名称	类型	描述
account_id*	integer	指定查询的广告主 id
filtering*	struct[]	过滤条件，详见 [过滤条件]
field*	string	过滤字段, 可选值：{ account_id, audience_id, audience_platform, adgroup_id, campaign_id, action_type, model_id, audience_predict_task_id }（注：audience_id 和 audience_platform 需要同时填写）
operator*	enum	当 field 取值 audience_platform 时，枚举列表：{ EQUALS }；当 field 取值 account_id,audience_id,adgroup_id,campaign_id,action_type,model_id,audience_predict_task_id 时，枚举列表：{ IN }
values*	string[]	字段取值，values 数组的个数限制与 operator 的取值相关，当 field 取值 account_id,audience_id,adgroup_id,campaign_id,action_type,model_id,audience_predict_task_id 时，values 数组元素个数限制为 1 个，详见 [过滤条件] 当 field 取值 audience_platform 时，枚举列表：{ DMP, TDC, TDP } 当 field 取值 action_type 且 operator 取值 IN 时，枚举列表：{ CLICK, EXPOSURE, ORDER, APP_FINISH_DOWNLOAD, APP_INSTALL, APP_ACTIVATE, REGISTRATION_APP, APP _ONE_DAY_RETENTION, ADD_TO_CART_APP, APP_PURCHASE, APP_APPLY, REGISTRATION_WEB, ADD_TO_CART_WEB, WEB_ONLINE_CONSULT, WEB_MAKE_PHONE_CALL, WEB_RESERVE_PHONE_NUMBER, WEB_RESERVATION, APPLY_WEB, WEB_DELIVER, PURCHASE_WEB, WEB_VIEW_COMMODITY_PAGE }
date_range*	struct	时间范围，日期格式，{"start_date":"2019-05-06","end_date":"2019-05-06"}，时间跨度最多 30 天
start_date*	string	开始时间，大于等于 2019-05-06，不能早于 1 年前，且小于 end_date 字段长度为 10 字节
end_date*	string	结束时间，小于今天，且大于 start_date 字段长度为 10 字节
group_by	string[]	聚合参数，可选值{ account_id,audience_id,adgroup_id,wechat_adgroup_id,campaign_id,wechat_campaign_id,action_type,model_id,audience_predict_task_id }

curl --location --request GET '/v1.3/custom_audience_reports/get' \ --header 'access_token;' \ --header 'timestamp;' \ --header 'nonce;' \ --data-urlencode 'account_id=25610' \ --data-urlencode 'filtering=[{"field":"adgroup_id","operator":"IN","values":["102000060"]},{"field":"action_type","operator":"IN","values":["CLICK","EXPOSURE"]}]' \ --data-urlencode 'date_range={"start_date":"2019-05-06","end_date":"2019-05-17"}' \ --data-urlencode 'group_by=["account_id","audience_id","action_type"]'

{ "code": 0, "message": "", "message_cn": "", "data": { "list": [ { "account_id": 25610, "audience_id": 5600762, "action_type": "CLICK", "cost": 85000, "action_count": 876, "user_count": 829 }, { "account_id": 25610, "audience_id": 5600762, "action_type": "EXPOSURE", "cost": 0, "action_count": 78162, "user_count": 32161 } ] } }

请求参数

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>

Body 参数application/x-www-form-urlencoded

account_id

integer

必需

指定查询的广告主 id

示例值:

25610

filtering

string

必需

过滤条件，详见 [过滤条件]

示例值:

[{"field":"adgroup_id","operator":"IN","values":["102000060"]},{"field":"action_type","operator":"IN","values":["CLICK","EXPOSURE"]}]

date_range

string

必需

时间范围，日期格式，{"start_date":"2019-05-06","end_date":"2019-05-06"}，时间跨度最多 30 天

示例值:

{"start_date":"2019-05-06","end_date":"2019-05-17"}

group_by

string

可选

聚合参数，可选值{ account_id,audience_id,adgroup_id,wechat_adgroup_id,campaign_id,wechat_campaign_id,action_type,model_id,audience_predict_task_id }

示例值:

["account_id","audience_id","action_type"]

application/json

Body

code

integer

必需

message

string

必需

message_cn

string

必需

data

object

必需

list

array [object {6}]

返回数组列表

必需

请求参数#

请求参数

返回响应

请求参数