sino-bc-cli 1.6.0 → 1.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +47 -33
- package/dist/SKILL.md +26 -36
- package/dist/api-doc/README.md +17 -42
- package/dist/index.js +1 -1
- package/package.json +1 -1
- package/dist/api-doc/icenter-mcp-strategy-dimension-facebook-ad-list.md +0 -170
- package/dist/api-doc/icenter-mcp-strategy-dimension-google-ad-list.md +0 -170
- package/dist/api-doc/icenter-mcp-strategy-dimension-tiktok-ad-list.md +0 -172
- package/dist/api-doc/icenter-mcp-strategy-metrics-facebook-ad-list.md +0 -202
- package/dist/api-doc/icenter-mcp-strategy-metrics-google-ad-list.md +0 -201
- package/dist/api-doc/icenter-mcp-strategy-metrics-tiktok-ad-list.md +0 -204
- package/dist/api-doc/icenter-mcp-version-query.md +0 -71
|
@@ -1,170 +0,0 @@
|
|
|
1
|
-
# Facebook广告策略维度数据
|
|
2
|
-
|
|
3
|
-
- **name**:`icenter-mcp-strategy-dimension-facebook-ad-list`
|
|
4
|
-
- **displayName**:Facebook广告策略维度数据
|
|
5
|
-
- **Tool ID**:`309b7030fff848ccb6377c374c26574c`
|
|
6
|
-
- **请求方法**:`POST`
|
|
7
|
-
- **集成类型**:REST
|
|
8
|
-
- **超时**:20000 ms
|
|
9
|
-
- **状态**:Online / Public / enabled
|
|
10
|
-
|
|
11
|
-
## 接口地址
|
|
12
|
-
|
|
13
|
-
```
|
|
14
|
-
https://test-agent.beyondclick.com/sino-icenter/mcp/strategy/dimension/facebook/ad/list
|
|
15
|
-
```
|
|
16
|
-
|
|
17
|
-
- **baseUrl**:`https://test-agent.beyondclick.com`(网关地址,三环境同一地址,唯一来源 `src/constants/gateway.ts` 的 `GATEWAY_CONFIG`)
|
|
18
|
-
- **path**:`/sino-icenter/mcp/strategy/dimension/facebook/ad/list`
|
|
19
|
-
|
|
20
|
-
> 一律经网关调用,不要直连 iCenter 服务地址。
|
|
21
|
-
|
|
22
|
-
## 说明
|
|
23
|
-
|
|
24
|
-
查询 Facebook(Meta)渠道的广告策略配置数据。按指定广告账户和日期范围,返回广告的策略设置明细(广告目标、成效目标、创意类型、出价方式、调整出价、受众类型、兴趣词包、年龄、性别等),用于分析某批账户在某段时间内各广告的策略配置分布。
|
|
25
|
-
|
|
26
|
-
本接口**只返回策略维度**,不含消耗、点击等成效指标。需要成效数据请改用 [`icenter-mcp-strategy-metrics-facebook-ad-list`](./icenter-mcp-strategy-metrics-facebook-ad-list.md)。
|
|
27
|
-
|
|
28
|
-
**国家维度特别说明**:`country_code` 必须单独传入,不能和任何其他维度同时传,否则会报错「country_code 不能和其他维度同时传入」。查国家维度时服务端会转走跨渠道广告数据接口,只返回按国家分组的数据。
|
|
29
|
-
|
|
30
|
-
## 请求头
|
|
31
|
-
|
|
32
|
-
| Header | 值 |
|
|
33
|
-
| --- | --- |
|
|
34
|
-
| Content-Type | `application/json` |
|
|
35
|
-
|
|
36
|
-
## 请求参数
|
|
37
|
-
|
|
38
|
-
请求体为 JSON object。
|
|
39
|
-
|
|
40
|
-
| 字段 | 类型 | 必填 | 默认值 | 说明 |
|
|
41
|
-
| --- | --- | --- | --- | --- |
|
|
42
|
-
| startDate | string | 是 | — | 开始日期,格式 `yyyy-MM-dd`,例如 `2026-08-01` |
|
|
43
|
-
| endDate | string | 是 | — | 结束日期,格式 `yyyy-MM-dd`,例如 `2026-08-31` |
|
|
44
|
-
| dimensionValues | object | 是 | — | 过滤条件,**仅支持 `account_id` 一个 key**,传其他 key 会报错 |
|
|
45
|
-
| dimensions | string[] | 是 | — | 分组维度,必传且**不能为空数组**,否则返回结果为空 |
|
|
46
|
-
| order | string | 否 | — | 排序字段,填单个维度 code,取值范围为 `dimensions` 的可选值。不必包含在已传的 `dimensions` 中,服务端会自动补入参与排序,但该字段不会作为列返回 |
|
|
47
|
-
| orderType | string | 否 | `asc` | 排序方向:`desc` / `asc` |
|
|
48
|
-
| page | integer | 否 | `1` | 页码,从 1 开始 |
|
|
49
|
-
| size | integer | 否 | `10` | 每页条数,建议显式传且不超过 1000 |
|
|
50
|
-
|
|
51
|
-
### dimensionValues
|
|
52
|
-
|
|
53
|
-
| 字段 | 类型 | 必填 | 说明 |
|
|
54
|
-
| --- | --- | --- | --- |
|
|
55
|
-
| account_id | string[] | 是 | 广告账户 ID(带格式),必须带 `act_` 前缀,例如 `act_1036928420879324`。最多传 500 个 |
|
|
56
|
-
|
|
57
|
-
### dimensions 可选值
|
|
58
|
-
|
|
59
|
-
| code | 含义 |
|
|
60
|
-
| --- | --- |
|
|
61
|
-
| calendar_date | 投放日期 |
|
|
62
|
-
| account_id | 广告账户 |
|
|
63
|
-
| account_name | 账户名称 |
|
|
64
|
-
| campaign_id | 广告系列 ID |
|
|
65
|
-
| campaign_name | 广告系列名称 |
|
|
66
|
-
| adgroup_id | 广告组 ID |
|
|
67
|
-
| adgroup_name | 广告组名称 |
|
|
68
|
-
| ad_id | 广告 ID |
|
|
69
|
-
| ad_name | 广告名称 |
|
|
70
|
-
| bid_amount | 调整出价 |
|
|
71
|
-
| objective | 广告目标 |
|
|
72
|
-
| optimization_goal | 成效目标 |
|
|
73
|
-
| ad_format | 创意类型 |
|
|
74
|
-
| bid_strategy | 出价方式 |
|
|
75
|
-
| audience_type | 受众类型 |
|
|
76
|
-
| targeting_interests | 兴趣词包 |
|
|
77
|
-
| targeting_flexible_interests | 弹性兴趣词包 |
|
|
78
|
-
| targeting_exclusion_interests | 排除兴趣词包 |
|
|
79
|
-
| targeting_age | 年龄 |
|
|
80
|
-
| targeting_genders | 性别 |
|
|
81
|
-
| country_code | 国家(必须单独传,不能和其他维度同时传) |
|
|
82
|
-
|
|
83
|
-
## 返回格式
|
|
84
|
-
|
|
85
|
-
- `result.data` 为数据行数组,每行的每个字段有两个 key:
|
|
86
|
-
- **原始值**:key 即请求的 code,如 `account_id: "act_1036928420879324"`,做计算或比较时用这个
|
|
87
|
-
- **展示值**:key 加 `display_` 前缀,如 `display_account_id`,直接呈现给用户时用这个,空值为 `"-"`
|
|
88
|
-
- `result.headerMap` 是字段 code 到列名的映射,如 `{"objective": "广告目标"}`,用于给用户展示列名
|
|
89
|
-
- `result.total` 为总条数,`result.page` 和 `result.size` 为当前分页
|
|
90
|
-
- 外层 `code=0` 表示成功;非 0 时 `result` 为 `null`,失败原因在 `message` 字段里
|
|
91
|
-
|
|
92
|
-
## 请求示例
|
|
93
|
-
|
|
94
|
-
```json
|
|
95
|
-
{
|
|
96
|
-
"startDate": "2026-08-01",
|
|
97
|
-
"endDate": "2026-08-31",
|
|
98
|
-
"dimensionValues": {
|
|
99
|
-
"account_id": ["act_1036928420879324"]
|
|
100
|
-
},
|
|
101
|
-
"dimensions": [
|
|
102
|
-
"account_id",
|
|
103
|
-
"ad_id",
|
|
104
|
-
"ad_name",
|
|
105
|
-
"objective",
|
|
106
|
-
"optimization_goal",
|
|
107
|
-
"ad_format",
|
|
108
|
-
"bid_strategy",
|
|
109
|
-
"audience_type"
|
|
110
|
-
],
|
|
111
|
-
"order": "ad_id",
|
|
112
|
-
"orderType": "asc",
|
|
113
|
-
"page": 1,
|
|
114
|
-
"size": 20
|
|
115
|
-
}
|
|
116
|
-
```
|
|
117
|
-
|
|
118
|
-
## 成功响应示例
|
|
119
|
-
|
|
120
|
-
```json
|
|
121
|
-
{
|
|
122
|
-
"code": 0,
|
|
123
|
-
"message": "success",
|
|
124
|
-
"result": {
|
|
125
|
-
"page": 1,
|
|
126
|
-
"size": 20,
|
|
127
|
-
"total": 1,
|
|
128
|
-
"headerMap": {
|
|
129
|
-
"account_id": "广告账户",
|
|
130
|
-
"ad_id": "广告ID",
|
|
131
|
-
"ad_name": "广告名称",
|
|
132
|
-
"objective": "广告目标",
|
|
133
|
-
"optimization_goal": "成效目标",
|
|
134
|
-
"ad_format": "创意类型",
|
|
135
|
-
"bid_strategy": "出价方式",
|
|
136
|
-
"audience_type": "受众类型"
|
|
137
|
-
},
|
|
138
|
-
"data": [
|
|
139
|
-
{
|
|
140
|
-
"account_id": "act_1036928420879324",
|
|
141
|
-
"display_account_id": "act_1036928420879324",
|
|
142
|
-
"ad_id": "120210000000000001",
|
|
143
|
-
"display_ad_id": "120210000000000001",
|
|
144
|
-
"ad_name": "示例广告",
|
|
145
|
-
"display_ad_name": "示例广告",
|
|
146
|
-
"objective": "CONVERSIONS",
|
|
147
|
-
"display_objective": "转化",
|
|
148
|
-
"optimization_goal": "OFFSITE_CONVERSIONS",
|
|
149
|
-
"display_optimization_goal": "网站转化",
|
|
150
|
-
"ad_format": "SINGLE_IMAGE",
|
|
151
|
-
"display_ad_format": "单图",
|
|
152
|
-
"bid_strategy": "LOWEST_COST_WITHOUT_CAP",
|
|
153
|
-
"display_bid_strategy": "最低成本",
|
|
154
|
-
"audience_type": "INTEREST",
|
|
155
|
-
"display_audience_type": "兴趣"
|
|
156
|
-
}
|
|
157
|
-
]
|
|
158
|
-
}
|
|
159
|
-
}
|
|
160
|
-
```
|
|
161
|
-
|
|
162
|
-
## 失败响应示例
|
|
163
|
-
|
|
164
|
-
```json
|
|
165
|
-
{
|
|
166
|
-
"code": 1,
|
|
167
|
-
"message": "dimensionValues 仅支持 account_id",
|
|
168
|
-
"result": null
|
|
169
|
-
}
|
|
170
|
-
```
|
|
@@ -1,170 +0,0 @@
|
|
|
1
|
-
# Google广告策略维度数据
|
|
2
|
-
|
|
3
|
-
- **name**:`icenter-mcp-strategy-dimension-google-ad-list`
|
|
4
|
-
- **displayName**:Google广告策略维度数据
|
|
5
|
-
- **Tool ID**:`8d4fbfda08ea40d2b789ba9b334106af`
|
|
6
|
-
- **请求方法**:`POST`
|
|
7
|
-
- **集成类型**:REST
|
|
8
|
-
- **超时**:20000 ms
|
|
9
|
-
- **状态**:Online / Public / enabled
|
|
10
|
-
|
|
11
|
-
## 接口地址
|
|
12
|
-
|
|
13
|
-
```
|
|
14
|
-
https://test-agent.beyondclick.com/sino-icenter/mcp/strategy/dimension/google/ad/list
|
|
15
|
-
```
|
|
16
|
-
|
|
17
|
-
- **baseUrl**:`https://test-agent.beyondclick.com`(网关地址,三环境同一地址,唯一来源 `src/constants/gateway.ts` 的 `GATEWAY_CONFIG`)
|
|
18
|
-
- **path**:`/sino-icenter/mcp/strategy/dimension/google/ad/list`
|
|
19
|
-
|
|
20
|
-
> 一律经网关调用,不要直连 iCenter 服务地址。
|
|
21
|
-
|
|
22
|
-
## 说明
|
|
23
|
-
|
|
24
|
-
查询 Google 渠道的广告策略配置数据。按指定广告账户和日期范围,返回广告的策略设置明细(成效目标、创意类型、出价方式、CPC/CPM/CPV 出价、广告系列类型、关键字等),用于分析某批账户在某段时间内各广告的策略配置分布。
|
|
25
|
-
|
|
26
|
-
Google 渠道**不支持广告目标和兴趣词包维度**,出价字段使用 `cpc_bid_amount`、`cpm_bid_amount`、`cpv_bid_amount` 三个独立维度。
|
|
27
|
-
|
|
28
|
-
本接口**只返回策略维度**,不含消耗、点击等成效指标。需要成效数据请改用 [`icenter-mcp-strategy-metrics-google-ad-list`](./icenter-mcp-strategy-metrics-google-ad-list.md)。
|
|
29
|
-
|
|
30
|
-
**国家维度特别说明**:`country_code` 必须单独传入,不能和任何其他维度同时传,否则会报错「country_code 不能和其他维度同时传入」。查国家维度时服务端会转走跨渠道广告数据接口,只返回按国家分组的数据。
|
|
31
|
-
|
|
32
|
-
## 请求头
|
|
33
|
-
|
|
34
|
-
| Header | 值 |
|
|
35
|
-
| --- | --- |
|
|
36
|
-
| Content-Type | `application/json` |
|
|
37
|
-
|
|
38
|
-
## 请求参数
|
|
39
|
-
|
|
40
|
-
请求体为 JSON object。
|
|
41
|
-
|
|
42
|
-
| 字段 | 类型 | 必填 | 默认值 | 说明 |
|
|
43
|
-
| --- | --- | --- | --- | --- |
|
|
44
|
-
| startDate | string | 是 | — | 开始日期,格式 `yyyy-MM-dd`,例如 `2026-08-01` |
|
|
45
|
-
| endDate | string | 是 | — | 结束日期,格式 `yyyy-MM-dd`,例如 `2026-08-31` |
|
|
46
|
-
| dimensionValues | object | 是 | — | 过滤条件,**仅支持 `account_id` 一个 key**,传其他 key 会报错 |
|
|
47
|
-
| dimensions | string[] | 是 | — | 分组维度,必传且**不能为空数组**,否则返回结果为空 |
|
|
48
|
-
| order | string | 否 | — | 排序字段,填单个维度 code,取值范围为 `dimensions` 的可选值。不必包含在已传的 `dimensions` 中,服务端会自动补入参与排序,但该字段不会作为列返回 |
|
|
49
|
-
| orderType | string | 否 | `asc` | 排序方向:`desc` / `asc` |
|
|
50
|
-
| page | integer | 否 | `1` | 页码,从 1 开始 |
|
|
51
|
-
| size | integer | 否 | `10` | 每页条数,建议显式传且不超过 1000 |
|
|
52
|
-
|
|
53
|
-
### dimensionValues
|
|
54
|
-
|
|
55
|
-
| 字段 | 类型 | 必填 | 说明 |
|
|
56
|
-
| --- | --- | --- | --- |
|
|
57
|
-
| account_id | string[] | 是 | 广告账户 ID(带格式),必须带前缀,例如 `act_1036928420879324`。最多传 500 个 |
|
|
58
|
-
|
|
59
|
-
### dimensions 可选值
|
|
60
|
-
|
|
61
|
-
| code | 含义 |
|
|
62
|
-
| --- | --- |
|
|
63
|
-
| calendar_date | 投放日期 |
|
|
64
|
-
| account_id | 广告账户 |
|
|
65
|
-
| account_name | 账户名称 |
|
|
66
|
-
| campaign_id | 广告系列 ID |
|
|
67
|
-
| campaign_name | 广告系列名称 |
|
|
68
|
-
| adgroup_id | 广告组 ID |
|
|
69
|
-
| adgroup_name | 广告组名称 |
|
|
70
|
-
| ad_id | 广告 ID |
|
|
71
|
-
| ad_name | 广告名称 |
|
|
72
|
-
| optimization_goal | 成效目标 |
|
|
73
|
-
| ad_format | 创意类型 |
|
|
74
|
-
| bid_strategy | 出价方式 |
|
|
75
|
-
| audience_type | 受众类型 |
|
|
76
|
-
| targeting_age | 年龄 |
|
|
77
|
-
| targeting_genders | 性别 |
|
|
78
|
-
| cpc_bid_amount | CPC 出价 |
|
|
79
|
-
| cpm_bid_amount | CPM 出价 |
|
|
80
|
-
| cpv_bid_amount | CPV 出价 |
|
|
81
|
-
| advertising_channel_type | 广告系列类型 |
|
|
82
|
-
| keywords | 关键字 |
|
|
83
|
-
| country_code | 国家(必须单独传,不能和其他维度同时传) |
|
|
84
|
-
|
|
85
|
-
> Google 渠道**不含** `objective`(广告目标)、`targeting_interests`(兴趣词包)。
|
|
86
|
-
|
|
87
|
-
## 返回格式
|
|
88
|
-
|
|
89
|
-
- `result.data` 为数据行数组,每行的每个字段有两个 key:
|
|
90
|
-
- **原始值**:key 即请求的 code,做计算或比较时用这个
|
|
91
|
-
- **展示值**:key 加 `display_` 前缀,直接呈现给用户时用这个,空值为 `"-"`
|
|
92
|
-
- `result.headerMap` 是字段 code 到中文列名的映射,用于给用户展示列名
|
|
93
|
-
- `result.total` 为总条数,`result.page` 和 `result.size` 为当前分页
|
|
94
|
-
- 外层 `code=0` 表示成功;非 0 时 `result` 为 `null`,失败原因在 `message` 字段里
|
|
95
|
-
|
|
96
|
-
## 请求示例
|
|
97
|
-
|
|
98
|
-
```json
|
|
99
|
-
{
|
|
100
|
-
"startDate": "2026-08-01",
|
|
101
|
-
"endDate": "2026-08-31",
|
|
102
|
-
"dimensionValues": {
|
|
103
|
-
"account_id": ["act_1036928420879324"]
|
|
104
|
-
},
|
|
105
|
-
"dimensions": [
|
|
106
|
-
"account_id",
|
|
107
|
-
"ad_id",
|
|
108
|
-
"ad_name",
|
|
109
|
-
"optimization_goal",
|
|
110
|
-
"ad_format",
|
|
111
|
-
"bid_strategy",
|
|
112
|
-
"advertising_channel_type"
|
|
113
|
-
],
|
|
114
|
-
"order": "ad_id",
|
|
115
|
-
"orderType": "asc",
|
|
116
|
-
"page": 1,
|
|
117
|
-
"size": 20
|
|
118
|
-
}
|
|
119
|
-
```
|
|
120
|
-
|
|
121
|
-
## 成功响应示例
|
|
122
|
-
|
|
123
|
-
```json
|
|
124
|
-
{
|
|
125
|
-
"code": 0,
|
|
126
|
-
"message": "success",
|
|
127
|
-
"result": {
|
|
128
|
-
"page": 1,
|
|
129
|
-
"size": 20,
|
|
130
|
-
"total": 1,
|
|
131
|
-
"headerMap": {
|
|
132
|
-
"account_id": "广告账户",
|
|
133
|
-
"ad_id": "广告ID",
|
|
134
|
-
"ad_name": "广告名称",
|
|
135
|
-
"optimization_goal": "成效目标",
|
|
136
|
-
"ad_format": "创意类型",
|
|
137
|
-
"bid_strategy": "出价方式",
|
|
138
|
-
"advertising_channel_type": "广告系列类型"
|
|
139
|
-
},
|
|
140
|
-
"data": [
|
|
141
|
-
{
|
|
142
|
-
"account_id": "act_1036928420879324",
|
|
143
|
-
"display_account_id": "act_1036928420879324",
|
|
144
|
-
"ad_id": "120210000000000001",
|
|
145
|
-
"display_ad_id": "120210000000000001",
|
|
146
|
-
"ad_name": "示例广告",
|
|
147
|
-
"display_ad_name": "示例广告",
|
|
148
|
-
"optimization_goal": "CONVERSIONS",
|
|
149
|
-
"display_optimization_goal": "转化",
|
|
150
|
-
"ad_format": "RESPONSIVE_SEARCH_AD",
|
|
151
|
-
"display_ad_format": "自适应搜索广告",
|
|
152
|
-
"bid_strategy": "TARGET_CPA",
|
|
153
|
-
"display_bid_strategy": "目标 CPA",
|
|
154
|
-
"advertising_channel_type": "SEARCH",
|
|
155
|
-
"display_advertising_channel_type": "搜索"
|
|
156
|
-
}
|
|
157
|
-
]
|
|
158
|
-
}
|
|
159
|
-
}
|
|
160
|
-
```
|
|
161
|
-
|
|
162
|
-
## 失败响应示例
|
|
163
|
-
|
|
164
|
-
```json
|
|
165
|
-
{
|
|
166
|
-
"code": 1,
|
|
167
|
-
"message": "country_code 不能和其他维度同时传入",
|
|
168
|
-
"result": null
|
|
169
|
-
}
|
|
170
|
-
```
|
|
@@ -1,172 +0,0 @@
|
|
|
1
|
-
# TikTok广告策略维度数据
|
|
2
|
-
|
|
3
|
-
- **name**:`icenter-mcp-strategy-dimension-tiktok-ad-list`
|
|
4
|
-
- **displayName**:TikTok广告策略维度数据
|
|
5
|
-
- **Tool ID**:`277feb43274646ad9fed802d6de50a87`
|
|
6
|
-
- **请求方法**:`POST`
|
|
7
|
-
- **集成类型**:REST
|
|
8
|
-
- **超时**:20000 ms
|
|
9
|
-
- **状态**:Online / Public / enabled
|
|
10
|
-
|
|
11
|
-
## 接口地址
|
|
12
|
-
|
|
13
|
-
```
|
|
14
|
-
https://test-agent.beyondclick.com/sino-icenter/mcp/strategy/dimension/tiktok/ad/list
|
|
15
|
-
```
|
|
16
|
-
|
|
17
|
-
- **baseUrl**:`https://test-agent.beyondclick.com`(网关地址,三环境同一地址,唯一来源 `src/constants/gateway.ts` 的 `GATEWAY_CONFIG`)
|
|
18
|
-
- **path**:`/sino-icenter/mcp/strategy/dimension/tiktok/ad/list`
|
|
19
|
-
|
|
20
|
-
> 一律经网关调用,不要直连 iCenter 服务地址。
|
|
21
|
-
|
|
22
|
-
## 说明
|
|
23
|
-
|
|
24
|
-
查询 TikTok 渠道的广告策略配置数据。按指定广告账户和日期范围,返回广告的策略设置明细(广告目标、成效目标、创意类型、出价方式、调整出价、转化出价、深度转化出价、兴趣词包、年龄、性别等),用于分析某批账户在某段时间内各广告的策略配置分布。
|
|
25
|
-
|
|
26
|
-
转化出价(`conversion_bid`)和深度转化出价(`deep_cpabid`)是 TikTok 渠道独有的维度。
|
|
27
|
-
|
|
28
|
-
本接口**只返回策略维度**,不含消耗、点击等成效指标。需要成效数据请改用 [`icenter-mcp-strategy-metrics-tiktok-ad-list`](./icenter-mcp-strategy-metrics-tiktok-ad-list.md)。
|
|
29
|
-
|
|
30
|
-
**国家维度特别说明**:`country_code` 必须单独传入,不能和任何其他维度同时传,否则会报错「country_code 不能和其他维度同时传入」。查国家维度时服务端会转走跨渠道广告数据接口,只返回按国家分组的数据。
|
|
31
|
-
|
|
32
|
-
## 请求头
|
|
33
|
-
|
|
34
|
-
| Header | 值 |
|
|
35
|
-
| --- | --- |
|
|
36
|
-
| Content-Type | `application/json` |
|
|
37
|
-
|
|
38
|
-
## 请求参数
|
|
39
|
-
|
|
40
|
-
请求体为 JSON object。
|
|
41
|
-
|
|
42
|
-
| 字段 | 类型 | 必填 | 默认值 | 说明 |
|
|
43
|
-
| --- | --- | --- | --- | --- |
|
|
44
|
-
| startDate | string | 是 | — | 开始日期,格式 `yyyy-MM-dd`,例如 `2026-08-01` |
|
|
45
|
-
| endDate | string | 是 | — | 结束日期,格式 `yyyy-MM-dd`,例如 `2026-08-31` |
|
|
46
|
-
| dimensionValues | object | 是 | — | 过滤条件,**仅支持 `account_id` 一个 key**,传其他 key 会报错 |
|
|
47
|
-
| dimensions | string[] | 是 | — | 分组维度,必传且**不能为空数组**,否则返回结果为空 |
|
|
48
|
-
| order | string | 否 | — | 排序字段,填单个维度 code,取值范围为 `dimensions` 的可选值。不必包含在已传的 `dimensions` 中,服务端会自动补入参与排序,但该字段不会作为列返回 |
|
|
49
|
-
| orderType | string | 否 | `asc` | 排序方向:`desc` / `asc` |
|
|
50
|
-
| page | integer | 否 | `1` | 页码,从 1 开始 |
|
|
51
|
-
| size | integer | 否 | `10` | 每页条数,建议显式传且不超过 1000 |
|
|
52
|
-
|
|
53
|
-
### dimensionValues
|
|
54
|
-
|
|
55
|
-
| 字段 | 类型 | 必填 | 说明 |
|
|
56
|
-
| --- | --- | --- | --- |
|
|
57
|
-
| account_id | string[] | 是 | 广告账户 ID(带格式),必须带前缀,例如 `act_1036928420879324`。最多传 500 个 |
|
|
58
|
-
|
|
59
|
-
### dimensions 可选值
|
|
60
|
-
|
|
61
|
-
| code | 含义 |
|
|
62
|
-
| --- | --- |
|
|
63
|
-
| calendar_date | 投放日期 |
|
|
64
|
-
| account_id | 广告账户 |
|
|
65
|
-
| account_name | 账户名称 |
|
|
66
|
-
| campaign_id | 广告系列 ID |
|
|
67
|
-
| campaign_name | 广告系列名称 |
|
|
68
|
-
| adgroup_id | 广告组 ID |
|
|
69
|
-
| adgroup_name | 广告组名称 |
|
|
70
|
-
| ad_id | 广告 ID |
|
|
71
|
-
| ad_name | 广告名称 |
|
|
72
|
-
| bid_amount | 调整出价 |
|
|
73
|
-
| objective | 广告目标 |
|
|
74
|
-
| optimization_goal | 成效目标 |
|
|
75
|
-
| ad_format | 创意类型 |
|
|
76
|
-
| bid_strategy | 出价方式 |
|
|
77
|
-
| audience_type | 受众类型 |
|
|
78
|
-
| targeting_interests | 兴趣词包 |
|
|
79
|
-
| targeting_age | 年龄 |
|
|
80
|
-
| targeting_genders | 性别 |
|
|
81
|
-
| conversion_bid | 转化出价 |
|
|
82
|
-
| deep_cpabid | 深度转化出价 |
|
|
83
|
-
| country_code | 国家(必须单独传,不能和其他维度同时传) |
|
|
84
|
-
|
|
85
|
-
## 返回格式
|
|
86
|
-
|
|
87
|
-
- `result.data` 为数据行数组,每行的每个字段有两个 key:
|
|
88
|
-
- **原始值**:key 即请求的 code,做计算或比较时用这个
|
|
89
|
-
- **展示值**:key 加 `display_` 前缀,直接呈现给用户时用这个,空值为 `"-"`
|
|
90
|
-
- `result.headerMap` 是字段 code 到中文列名的映射,用于给用户展示列名
|
|
91
|
-
- `result.total` 为总条数,`result.page` 和 `result.size` 为当前分页
|
|
92
|
-
- 外层 `code=0` 表示成功;非 0 时 `result` 为 `null`,失败原因在 `message` 字段里
|
|
93
|
-
|
|
94
|
-
## 请求示例
|
|
95
|
-
|
|
96
|
-
```json
|
|
97
|
-
{
|
|
98
|
-
"startDate": "2026-08-01",
|
|
99
|
-
"endDate": "2026-08-31",
|
|
100
|
-
"dimensionValues": {
|
|
101
|
-
"account_id": ["act_1036928420879324"]
|
|
102
|
-
},
|
|
103
|
-
"dimensions": [
|
|
104
|
-
"account_id",
|
|
105
|
-
"ad_id",
|
|
106
|
-
"ad_name",
|
|
107
|
-
"objective",
|
|
108
|
-
"optimization_goal",
|
|
109
|
-
"ad_format",
|
|
110
|
-
"bid_strategy",
|
|
111
|
-
"conversion_bid"
|
|
112
|
-
],
|
|
113
|
-
"order": "ad_id",
|
|
114
|
-
"orderType": "asc",
|
|
115
|
-
"page": 1,
|
|
116
|
-
"size": 20
|
|
117
|
-
}
|
|
118
|
-
```
|
|
119
|
-
|
|
120
|
-
## 成功响应示例
|
|
121
|
-
|
|
122
|
-
```json
|
|
123
|
-
{
|
|
124
|
-
"code": 0,
|
|
125
|
-
"message": "success",
|
|
126
|
-
"result": {
|
|
127
|
-
"page": 1,
|
|
128
|
-
"size": 20,
|
|
129
|
-
"total": 1,
|
|
130
|
-
"headerMap": {
|
|
131
|
-
"account_id": "广告账户",
|
|
132
|
-
"ad_id": "广告ID",
|
|
133
|
-
"ad_name": "广告名称",
|
|
134
|
-
"objective": "广告目标",
|
|
135
|
-
"optimization_goal": "成效目标",
|
|
136
|
-
"ad_format": "创意类型",
|
|
137
|
-
"bid_strategy": "出价方式",
|
|
138
|
-
"conversion_bid": "转化出价"
|
|
139
|
-
},
|
|
140
|
-
"data": [
|
|
141
|
-
{
|
|
142
|
-
"account_id": "act_1036928420879324",
|
|
143
|
-
"display_account_id": "act_1036928420879324",
|
|
144
|
-
"ad_id": "120210000000000001",
|
|
145
|
-
"display_ad_id": "120210000000000001",
|
|
146
|
-
"ad_name": "示例广告",
|
|
147
|
-
"display_ad_name": "示例广告",
|
|
148
|
-
"objective": "CONVERSIONS",
|
|
149
|
-
"display_objective": "转化",
|
|
150
|
-
"optimization_goal": "CONVERT",
|
|
151
|
-
"display_optimization_goal": "转化",
|
|
152
|
-
"ad_format": "SINGLE_VIDEO",
|
|
153
|
-
"display_ad_format": "单视频",
|
|
154
|
-
"bid_strategy": "BID_TYPE_CUSTOM",
|
|
155
|
-
"display_bid_strategy": "自定义出价",
|
|
156
|
-
"conversion_bid": "12.5",
|
|
157
|
-
"display_conversion_bid": "12.5"
|
|
158
|
-
}
|
|
159
|
-
]
|
|
160
|
-
}
|
|
161
|
-
}
|
|
162
|
-
```
|
|
163
|
-
|
|
164
|
-
## 失败响应示例
|
|
165
|
-
|
|
166
|
-
```json
|
|
167
|
-
{
|
|
168
|
-
"code": 1,
|
|
169
|
-
"message": "country_code 不能和其他维度同时传入",
|
|
170
|
-
"result": null
|
|
171
|
-
}
|
|
172
|
-
```
|