获取受众重叠详情

使用此接口获取基准受众与最多 4 个其他 TikTok 自定义受众细分之间的重叠。

请求

地址 https://business-api.tiktok.com/open_api/v1.3/audience/insight/overlap/

方法 GET

Header

|字段|类型|描述|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。|

参数

|字段|类型|描述|
|---|---|---|
|advertiser_id {必填}|string|广告主ID。|
|benchmark_custom_audience_id {必填}|string|选择作为基准受众的自定义受众ID。 <br><p><span style="color:darkred"><b>注意</b></span>：这里输入的受众ID必须能通过您的广告主ID访问，否则将会报错。|
|comparison_custom_audience_ids|string[]|选择作为对比受众的自定义受众ID。<br>最大数量：4<br><p><span style="color:darkred"><b>注意</b></span>：这里输入的受众ID必须能通过您的广告主ID访问，否则将会报错。|

示例

(code curl http)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/audience/insight/overlap/' \
--header 'Content-Type: application/json' \
--header 'Access-Token: {{Access-Token}}' \
--data '{
    "advertiser_id": "{{advertiser_id}}",
    "benchmark_custom_audience_id": "{{benchmark_custom_audience_id}}",
    "comparison_custom_audience_ids": [
        "{{comparison_custom_audience_ids}}",
        "{{comparison_custom_audience_ids}}",
        "{{comparison_custom_audience_ids}}",
        "{{comparison_custom_audience_ids}}"
    ]
}'
(/code)

响应

|字段|类型|描述|
|---|---|---|
|code |number|返回码，详见[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。|
|message |string|返回信息，详见[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。|
|request_id |string|请求的日志ID，唯一标识一个请求。|
|data |object|返回数据。<br><p><span style="color:darkred"><b>注意</b></span>：受众规模少于1,000人的类别将不会显示。|
#|benchmark_audience|object|基准受众数据。|
##|audience_id|string|受众ID。|
##|audience_name|string|受众名称。|
##|audience_size|int|受众规模。|
##|targetable_users_count_range|string|在自定义受众中，近 30 天内处于活跃状态且可被定向的用户的数量范围。|
#|comparison_audiences|object[]|对比受众数据。<br>如果您在请求中输入了`comparison_custom_audience_ids`，将会返回该字段。|
##|audience_id|string|受众ID。|
##|audience_name|string|受众名称。|
##|audience_size|int|受众规模。|
##|targetable_users_count_range|string|在自定义受众中，近 30 天内处于活跃状态且可被定向用户的数量范围。|
##|benchmark_overlap_rate|string|基准受众中可用于对比受众的用户的基础百分比。|
##|benchmark_overlap_rate_range|string|基准受众中可用于对比受众的用户的比例范围。|
##|benchmark_overlap_count_range|string|基准受众中可用于对比受众的用户的数量范围。|

示例

(code curl http)
HTTPS/1.1 200 OK
{
    "code": 0,
    "message": "OK",
    "request_id": "{{request_id}}",
    "data": {
        "benchmark_audience": {
            "audience_id": "{{audience_id}}",
            "audience_name": "{{audience_name}}",
            "audience_size": 29690526,
            "targetable_users_count_range": "15,428,000-18,857,000"
        },
        "comparison_audiences": [
            {
                "audience_id": "{{audience_id}}",
                "audience_name": "{{audience_name}}",
                "audience_size": 4754,
                "targetable_users_count_range": "1,000-2,000",
                "benchmark_overlap_rate": "3%",
                "benchmark_overlap_rate_range": "0%",
                "benchmark_overlap_count_range": "< 1,000"
            },
            {
                "audience_id": "{{audience_id}}",
                "audience_name": "{{audience_name}}",
                "audience_size": 504,
                "targetable_users_count_range": "1,000-2,000",
                "benchmark_overlap_rate": "3%",
                "benchmark_overlap_rate_range": "0%",
                "benchmark_overlap_count_range": "< 1,000"
            },
            {
                "audience_id": "{{audience_id}}",
                "audience_name": "{{audience_name}}",
                "audience_size": 51090,
                "targetable_users_count_range": "25,000-31,000",
                "benchmark_overlap_rate": "3%",
                "benchmark_overlap_rate_range": "0%",
                "benchmark_overlap_count_range": "< 1,000"
            },
            {
                "audience_id": "{{audience_id}}",
                "audience_name": "{{audience_name}}",
                "audience_size": 19449461,
                "targetable_users_count_range": "12,179,000-14,885,000",
                "benchmark_overlap_rate": "7%",
                "benchmark_overlap_rate_range": "6%-9%",
                "benchmark_overlap_count_range": "1,156,000-1,413,000"
            }
        ]
    }
}'
(/code)