人群覆盖数预估

开发环境

POST

/v1.3/custom_audience_estimations/get

请求参数

标有*的参数为必填项

名称	类型	描述
account_id*	integer	推广帐号 id，有操作权限的帐号 id，包括代理商和广告主帐号 id
type*	string	人群类型，目前仅支持 COMBINE 类型的人群
audience_spec*	struct	人群信息，AudienceSpec 内部字段，和 type 相关
combine_spec	struct	组合人群信息，当 type=COMBINE 时必填，最多允许用 500 个人群做组合，并且不支持 LOOKALIKE 人群和 COMBINE 人群做组合
include*	struct[]	包含的人群，注意这是个二维数组，第一层数组元素之间为 AND 关系，第二层数组元素之间为 OR 关系数组最小长度 1，最大长度 500
audience_id*	integer	人群 id 或标签 id，通过 [custom_audiences] 模块创建客户人群或[custom_tags] 模块创建客户标签获得，即此处支持填写"audience_id":"<AUDIENCE_ID>"，也支持填写"audience_id":"<TAG_ID>"，不支持 LOOKALIKE 和 COMBINE 人群的 id
time_window	integer	时间窗，仅对客户标签有效，目前仅支持以下几个时间窗选项：1、3、7、10、15、30、90、180、365 最小值 1，最大值 365
exclude	struct[]	排除的人群，注意这是个二维数组，第一层数组元素之间为 AND 关系，第二层数组元素之间为 OR 关系数组最大长度 500
audience_id*	integer	人群 id 或标签 id，通过 [custom_audiences] 模块创建客户人群或[custom_tags] 模块创建客户标签获得，即此处支持填写"audience_id":"<AUDIENCE_ID>"，也支持填写"audience_id":"<TAG_ID>"，不支持 LOOKALIKE 和 COMBINE 人群的 id
time_window	integer	时间窗，仅对客户标签有效，目前仅支持以下几个时间窗选项：1、3、7、10、15、30、90、180、365 最小值 1，最大值 365

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST '/v1.3/custom_audience_estimations/get' \
--header 'access_token;' \
--header 'timestamp;' \
--header 'nonce;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "account_id": "<ACCOUNT_ID>",
    "type": "COMBINE",
    "audience_spec": {
        "combine_spec": {
            "include": [
                [
                    {
                        "audience_id": 1234567
                    },
                    {
                        "audience_id": 7654321
                    }
                ]
            ]
        }
    }
}'

响应示例

{
    "code": 0,
    "message": "",
    "message_cn": "",
    "data": {
        "user_count": 21343
    }
}

请求参数

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>

Body 参数application/json

account_id

string

必需

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

type

string

必需

人群类型，目前仅支持 COMBINE 类型的人群

audience_spec

object

必需

人群信息，AudienceSpec 内部字段，和 type 相关

combine_spec

object

必需

组合人群信息，当 type=COMBINE 时必填，最多允许用 500 个人群做组合，并且不支持 LOOKALIKE 人群和 COMBINE 人群做组合

示例

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

message_cn

string

必需

data

object

必需

user_count

integer

必需

预估出来的人群覆盖数

修改于 2023-11-08 02:24:25

获取客户人群数据文件

添加人群授权