修改广告推广意向接口文档
该文档介绍如何通过接口修改推广需求下属关联的所有投放广告的曝光定向。
接口地址
POST https://api.4pyun.com/gate/1.0/adverting/advertising/demand/intention
接口说明
该接口用于修改推广需求下属关联的所有投放广告的曝光定向。
请求参数
主体参数
| 字段名称 | 字段说明 | 类型 | 必填 | 示例值 |
|---|---|---|---|---|
| app_id | 平台分配的接入应用 ID | string | Y | op1234567723122 |
| demand_id | 平台提供的推广需求 ID | string | Y | 77896521112 |
| intention | 业务参数 | Array | Y | 参见 intention 参数 |
intention 参数说明
| 字段名称 | 字段说明 | 类型 | 必填 | 示例值 |
|---|---|---|---|---|
| key | 定向 KEY | string | Y | 参见 intention.key-value 参数说明 |
| value | 定向值 | string | Y | 参见 intention.key-value 参数说明 |
| reverse | 类型 | int | Y | 0：选中，1：过滤 |
intention.key-value 参数值说明
| key | key 值说明 | value 示例值 | value 值说明 |
|---|---|---|---|
| ip_location | IP 归属地 | 广东省:440000 广东省深圳市:440000,440300 广东省深圳市南山区:440000,440300,440305 |
省市区行政编码（用 , 分隔） |
请求示例
广告定向投放 IP 归属地：广东省深圳市南山区和广西省
{
"app_id": "op1234567723122",
"demand_id": 77896521112,
"intention": [
{ "key": "area_code", "value": "440000,440300,440305", "reverse": 0 },
{ "key": "area_code", "value": "450000", "reverse": 0 }
]
}
广告定向过滤 IP 归属地：广西省
{
"app_id": "op1234567723122",
"demand_id": 77896521112,
"intention": [
{ "key": "area_code", "value": "450000", "reverse": 1 }
]
}
返回结果参数说明
| 字段名称 | 字段说明 | 类型 | 必填 | 备注 |
|---|---|---|---|---|
| code | 请求状态码 | string | Y | 1001-成功 其它-读取 message |
| message | 返回描述 | string | N | 返回描述信息 |
| hint | 返回错误说明 | string | N | 返回具体错误描述指导 |
| seqno | 服务器日志标识 | string | Y | 服务器日志标识编码 |
| data_node | 数据节点信息 | string | N | 返回数据节点所在位置 |
| time_cost | 请求耗时（毫秒） | int | N | 请求处理耗时 |
返回结果示例
请求成功
{
"code": "1001",
"seqno": "64369191506987127961410787347922",
"data_node": "CN-South/DEV-3",
"time_cost": 61
}
请求失败
{
"code": "400",
"message": "请求参数错误",
"hint": "检查请求参数`app_id`!",
"seqno": "84735261540785178817961040998334",
"data_node": "CN-South/DEV-3",
"path": "POST /gate/1.0/adverting/advertising/demand/intention"
}
注意事项
- 参数校验：
app_id和demand_id为必填参数，确保正确传递。intention数组中的key和value必须符合intention.key-value参数说明。
- 定向逻辑：
reverse参数为0表示选中定向，1表示过滤定向。
- 错误处理：
- 如果返回
code非1001，请根据message和hint提示检查请求参数。
- 如果返回
- 性能优化：
- 建议批量修改时，合理控制
intention数组的长度，避免请求超时。
- 建议批量修改时，合理控制
以上是修改广告推广意向接口的完整文档。如有疑问，请联系技术支持。