sino-bc-cli 1.8.9 → 1.8.11
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 +124 -97
- package/dist/SKILL.md +83 -30
- package/dist/affordance/auth.md +27 -0
- package/dist/affordance/biz-line.md +11 -11
- package/dist/affordance/dashboard.md +73 -0
- package/dist/affordance/delivery.md +81 -0
- package/dist/affordance/document.md +69 -0
- package/dist/affordance/file.md +43 -0
- package/dist/affordance/im.md +66 -0
- package/dist/affordance/organization.md +45 -0
- package/dist/affordance/project-analysis.md +75 -0
- package/dist/affordance/project-stage.md +40 -0
- package/dist/affordance/project.md +199 -0
- package/dist/affordance/sso.md +1 -1
- package/dist/affordance/task.md +109 -0
- package/dist/affordance/tenant.md +15 -0
- package/dist/affordance/user.md +33 -0
- package/dist/api-doc/README.md +51 -0
- package/dist/api-doc/custom/cli-oauth.md +19 -0
- package/dist/api-doc/oapi/auth.md +57 -0
- package/dist/api-doc/oapi/biz-line-query.md +9 -1
- package/dist/api-doc/oapi/biz-line-strategy.md +500 -312
- package/dist/api-doc/oapi/dashboard.md +202 -0
- package/dist/api-doc/oapi/delivery.md +253 -0
- package/dist/api-doc/oapi/document.md +192 -0
- package/dist/api-doc/oapi/file.md +92 -0
- package/dist/api-doc/oapi/im.md +195 -0
- package/dist/api-doc/oapi/organization.md +86 -0
- package/dist/api-doc/oapi/project-analysis.md +252 -0
- package/dist/api-doc/oapi/project-stage.md +88 -0
- package/dist/api-doc/oapi/project.md +597 -0
- package/dist/api-doc/oapi/sso.md +5 -1
- package/dist/api-doc/oapi/task.md +361 -0
- package/dist/api-doc/oapi/tenant.md +17 -0
- package/dist/api-doc/oapi/user.md +73 -0
- package/dist/generated/api-catalog.json +23976 -143
- package/dist/index.js +1 -1
- package/dist/skills/default/sino-bc-shared/SKILL.md +18 -7
- package/dist/skills/default/sino-bc-shared/references/config-and-env.md +10 -7
- package/dist/skills/default/sino-bc-shared/references/output-contract.md +52 -7
- package/dist/skills/default/sino-bc-shared/references/write-approval.md +4 -4
- package/dist/skills/oapi/sino-bc-auth/SKILL.md +34 -0
- package/dist/skills/oapi/sino-bc-biz-line/SKILL.md +45 -40
- package/dist/skills/oapi/sino-bc-biz-line/references/common-mistakes.md +10 -0
- package/dist/skills/{custom → oapi}/sino-bc-biz-line/references/enums.md +7 -1
- package/dist/skills/oapi/sino-bc-dashboard/SKILL.md +48 -0
- package/dist/skills/oapi/sino-bc-delivery/SKILL.md +53 -0
- package/dist/skills/oapi/sino-bc-document/SKILL.md +51 -0
- package/dist/skills/oapi/sino-bc-file/SKILL.md +46 -0
- package/dist/skills/oapi/sino-bc-im/SKILL.md +49 -0
- package/dist/skills/oapi/sino-bc-organization/SKILL.md +44 -0
- package/dist/skills/oapi/sino-bc-project/SKILL.md +69 -0
- package/dist/skills/oapi/sino-bc-project-analysis/SKILL.md +48 -0
- package/dist/skills/oapi/sino-bc-project-analysis/references/analysis-workflow.md +17 -0
- package/dist/skills/oapi/sino-bc-project-analysis/references/filters-and-metrics.md +32 -0
- package/dist/skills/oapi/sino-bc-project-stage/SKILL.md +47 -0
- package/dist/skills/oapi/sino-bc-sso/SKILL.md +15 -17
- package/dist/skills/oapi/sino-bc-task/SKILL.md +57 -0
- package/dist/skills/oapi/sino-bc-task/references/state-machine.md +18 -0
- package/dist/skills/oapi/sino-bc-tenant/SKILL.md +32 -0
- package/dist/skills/oapi/sino-bc-user/SKILL.md +48 -0
- package/package.json +4 -5
- package/dist/api-doc/custom/README.md +0 -92
- package/dist/skills/custom/sino-bc-biz-line/references/common-mistakes.md +0 -8
- package/dist/skills/oapi/sino-bc-biz-line/references/long-tail-api.md +0 -18
- package/dist/skills/oapi/sino-bc-sso/references/long-tail-api.md +0 -9
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# 业务线策略
|
|
2
2
|
|
|
3
|
-
>
|
|
3
|
+
> **网关地址**:缺省 `https://agent.beyondclick.com`,可用 `/set-config gateway-url` 改写;业务与登录共用该根。不要直连上游服务地址。
|
|
4
4
|
>
|
|
5
5
|
> **调用路径**:等于下方列出的 path(即 OpenAPI / catalog 路由),由 CLI 拼到网关地址后发出。
|
|
6
6
|
|
|
@@ -10,324 +10,383 @@
|
|
|
10
10
|
|
|
11
11
|
`POST /sino-opti-hive/biz-line/list`
|
|
12
12
|
|
|
13
|
+
主体上下文:`tenant=false`。
|
|
14
|
+
|
|
15
|
+
角色范围:`未声明`。
|
|
16
|
+
|
|
13
17
|
查询业务线分页列表。需要查询业务线关联项目和广告账号,使用业务线ID查询【业务线关联项目列表】。
|
|
14
18
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
| 字段 | 类型 | 说明 |
|
|
18
|
-
| --- | --- | --- |
|
|
19
|
-
| `pageNum` | integer | 页码,从 1 开始 |
|
|
20
|
-
| `pageSize` | integer | 每页条数 |
|
|
21
|
-
| `sortType` | string | 排序字段(继承 PageRequest.sortType)。SPEND=按上期周消耗;WEEK_OVER_WEEK=按上期周消耗环比;PERIOD=按本期策略周期;TRAFFIC_LIGHT=按上期红绿灯。不传时默认按业务线 id 倒序 |
|
|
22
|
-
| `sortDirection` | string | 排序方向:ASC 升序,DESC 降序;默认 DESC |
|
|
23
|
-
| `name` | string | 业务线名称,模糊搜索 |
|
|
24
|
-
| `status` | integer | 状态:1=进行中 2=已完成 3=已暂停 |
|
|
25
|
-
| `ssoTeamCode` | string | 组别 code,精确筛选(多选请用 ssoTeamCodeList) |
|
|
26
|
-
| `ssoTeamCodeList` | array | 组别 code 列表,多选 |
|
|
27
|
-
| `trafficLightList` | array | 红绿灯筛选(策略表现):1=绿灯KPI达标,2=黄灯距KPIGAP20%内,3=红灯距KPIGAP20%以上,4=红灯已暂停,5=黄灯存在风险,6=绿灯KPI达标且项目顺利。 |
|
|
28
|
-
| `adCategoryProjectId` | integer | 投放品类:取接口biz-line-open-placement-categories |
|
|
29
|
-
| `idList` | array | 业务线 ID 列表 |
|
|
30
|
-
| `pmUserIds` | array | PM 用户 ID 多选(OR 语义:命中任一 PM) |
|
|
31
|
-
| `projectRatingList` | array | 项目评级多选:S、A、B、C |
|
|
32
|
-
| `businessRegionList` | array | 商务地区:EAST_CHINA=华东 SOUTH_CHINA=华南 NORTH_CHINA=华北 |
|
|
33
|
-
| `newCustomerTag` | string | 新客标签单选,NEW_TAG = 新客 NONE_NEW_TAG = 非新客
|
|
19
|
+
**输入参数(--data)**
|
|
20
|
+
|
|
21
|
+
| 字段 | 类型 | 位置 | 必填 | 说明 |
|
|
22
|
+
| --- | --- | --- | --- | --- |
|
|
23
|
+
| `pageNum` | integer | body | 是 | 页码,从 1 开始 |
|
|
24
|
+
| `pageSize` | integer | body | 是 | 每页条数 |
|
|
25
|
+
| `sortType` | string | body | 否 | 排序字段(继承 PageRequest.sortType)。SPEND=按上期周消耗;WEEK_OVER_WEEK=按上期周消耗环比;PERIOD=按本期策略周期;TRAFFIC_LIGHT=按上期红绿灯。不传时默认按业务线 id 倒序 |
|
|
26
|
+
| `sortDirection` | string | body | 否 | 排序方向:ASC 升序,DESC 降序;默认 DESC |
|
|
27
|
+
| `name` | string | body | 否 | 业务线名称,模糊搜索 |
|
|
28
|
+
| `status` | integer | body | 否 | 状态:1=进行中 2=已完成 3=已暂停 |
|
|
29
|
+
| `ssoTeamCode` | string | body | 否 | 组别 code,精确筛选(多选请用 ssoTeamCodeList) |
|
|
30
|
+
| `ssoTeamCodeList` | array | body | 否 | 组别 code 列表,多选 |
|
|
31
|
+
| `trafficLightList` | array | body | 否 | 红绿灯筛选(策略表现):1=绿灯KPI达标,2=黄灯距KPIGAP20%内,3=红灯距KPIGAP20%以上,4=红灯已暂停,5=黄灯存在风险,6=绿灯KPI达标且项目顺利。 |
|
|
32
|
+
| `adCategoryProjectId` | integer | body | 否 | 投放品类:取接口biz-line-open-placement-categories |
|
|
33
|
+
| `idList` | array | body | 否 | 业务线 ID 列表 |
|
|
34
|
+
| `pmUserIds` | array | body | 否 | PM 用户 ID 多选(OR 语义:命中任一 PM) |
|
|
35
|
+
| `projectRatingList` | array | body | 否 | 项目评级多选:S、A、B、C |
|
|
36
|
+
| `businessRegionList` | array | body | 否 | 商务地区:EAST_CHINA=华东 SOUTH_CHINA=华南 NORTH_CHINA=华北 |
|
|
37
|
+
| `newCustomerTag` | string | body | 否 | 新客标签单选,NEW_TAG = 新客 NONE_NEW_TAG = 非新客
|
|
34
38
|
|
|
|
35
|
-
| `weekOverWeekFilter` | string | 周消耗环比筛选,DOWN_20 = 周消耗下降20%及以上 |
|
|
39
|
+
| `weekOverWeekFilter` | string | body | 否 | 周消耗环比筛选,DOWN_20 = 周消耗下降20%及以上 |
|
|
36
40
|
|
|
37
41
|
## 2. 业务线详情
|
|
38
42
|
|
|
39
43
|
`POST /sino-opti-hive/biz-line/detail`
|
|
40
44
|
|
|
45
|
+
主体上下文:`tenant=false`。
|
|
46
|
+
|
|
47
|
+
角色范围:`未声明`。
|
|
48
|
+
|
|
41
49
|
业务线详情
|
|
42
50
|
|
|
43
|
-
|
|
51
|
+
**输入参数(--data)**
|
|
44
52
|
|
|
45
|
-
| 字段 | 类型 | 说明 |
|
|
46
|
-
| --- | --- | --- |
|
|
47
|
-
| `id` | integer | |
|
|
53
|
+
| 字段 | 类型 | 位置 | 必填 | 说明 |
|
|
54
|
+
| --- | --- | --- | --- | --- |
|
|
55
|
+
| `id` | integer | body | 是 | |
|
|
48
56
|
|
|
49
57
|
## 3. 新建业务线
|
|
50
58
|
|
|
51
59
|
`POST /sino-opti-hive/biz-line/save`
|
|
52
60
|
|
|
61
|
+
主体上下文:`tenant=false`。
|
|
62
|
+
|
|
63
|
+
角色范围:`未声明`。
|
|
64
|
+
|
|
53
65
|
⚠️ 写操作。成功时 result 为新建业务线详情 BizLineDetailVO。
|
|
54
66
|
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
| 字段 | 类型 | 说明 |
|
|
58
|
-
| --- | --- | --- |
|
|
59
|
-
| `name` | string | 业务线名称,业务/产品线名称不可重复 |
|
|
60
|
-
| `mediaChannels` | array | 投放渠道 code。通过 GET /sino-opti-hive/biz-line-open/channels 取 code;名称见同接口 name |
|
|
61
|
-
| `strategyControlDegree` | integer | 策略掌控程度:1弱(以客户策略为主) 2强(以我方提供策略) 3中(与客户共创) |
|
|
62
|
-
| `adCategoryIndustryIds` | array | 投放行业 ID。通过 GET /sino-opti-hive/biz-line-open/placement-categories 取一级节点 id |
|
|
63
|
-
| `adCategoryProjectIds` | array | 投放品类 ID。通过 GET /sino-opti-hive/biz-line-open/placement-categories 取二级 children.id;选其他时可为空,改填 adCategoryOther |
|
|
64
|
-
| `adCategoryOther` | string | 投放品类-其他说明 |
|
|
65
|
-
| `customerTypeIds` | array | 客户类型 ID。通过 GET /sino-opti-hive/dict/items?sceneCode=CUSTOMER_TYPE 取 id |
|
|
66
|
-
| `customerTypeOther` | string | 客户类型-其他说明 |
|
|
67
|
-
| `amUserIds` | array | AM 用户 ID。通过 POST /sino-opti-hive/sso-team/getMemberList 取 userId;也可 POST /sino-opti-hive/user/getSsoUserList 按姓名搜 |
|
|
68
|
-
| `pmUserIds` | array | PM 用户 ID。通过 POST /sino-opti-hive/sso-team/getMemberList 取 userId;也可 POST /sino-opti-hive/user/getSsoUserList 按姓名搜 |
|
|
69
|
-
| `customerInfrastructure` | array | 1=数据追踪方式:AdJust,2=数据追踪方式:AF,3=数据追踪方式:其他MMP,4=数据追踪方式:客户BI,5=数据追踪方式:媒体后台,6=素材产出方式:CB,7=素材产出方式:客户提供,8=素材产出方式:内部设计师制作,9=素材产出方式:无需素材(ASA、推流等),10=基建情况:基建完善,11=基建情况:三方回传数据异常,12=基建情况:APP埋点异常 |
|
|
70
|
-
| `coreIndex` | string | 核心指标 |
|
|
71
|
-
| `monthlyMaterialCount` | string | 月度上新素材量 |
|
|
72
|
-
| `projectInitStatus` | string | 项目初始化状态 |
|
|
73
|
-
| `projectBrief` | string | 项目 Brief |
|
|
74
|
-
| `corporationIds` | array | 关联签约主体 ID(字符串)。通过 POST /sino-opti-hive/corporation/page 获取签约主体 ID |
|
|
75
|
-
| `projectIds` | array | 关联项目 ID |
|
|
76
|
-
| `ssoTeamCode` | string | 组别 code,单选,必填。通过 GET /sino-opti-hive/sso-team/group-list 取 code |
|
|
77
|
-
| `businessRegion` | string | EAST_CHINA=华东,SOUTH_CHINA=华南,NORTH_CHINA=华北。必填 |
|
|
78
|
-
| `projectRating` | string | S、A、B、C。非新客必填 |
|
|
79
|
-
| `newCustomerTag` | string | NEW_TAG=是(新客),NONE_NEW_TAG=否(非新客) |
|
|
67
|
+
**输入参数(--data)**
|
|
68
|
+
|
|
69
|
+
| 字段 | 类型 | 位置 | 必填 | 说明 |
|
|
70
|
+
| --- | --- | --- | --- | --- |
|
|
71
|
+
| `name` | string | body | 是 | 业务线名称,业务/产品线名称不可重复 |
|
|
72
|
+
| `mediaChannels` | array | body | 否 | 投放渠道 code。通过 GET /sino-opti-hive/biz-line-open/channels 取 code;名称见同接口 name |
|
|
73
|
+
| `strategyControlDegree` | integer | body | 否 | 策略掌控程度:1弱(以客户策略为主) 2强(以我方提供策略) 3中(与客户共创) |
|
|
74
|
+
| `adCategoryIndustryIds` | array | body | 否 | 投放行业 ID。通过 GET /sino-opti-hive/biz-line-open/placement-categories 取一级节点 id |
|
|
75
|
+
| `adCategoryProjectIds` | array | body | 否 | 投放品类 ID。通过 GET /sino-opti-hive/biz-line-open/placement-categories 取二级 children.id;选其他时可为空,改填 adCategoryOther |
|
|
76
|
+
| `adCategoryOther` | string | body | 否 | 投放品类-其他说明 |
|
|
77
|
+
| `customerTypeIds` | array | body | 否 | 客户类型 ID。通过 GET /sino-opti-hive/dict/items?sceneCode=CUSTOMER_TYPE 取 id |
|
|
78
|
+
| `customerTypeOther` | string | body | 否 | 客户类型-其他说明 |
|
|
79
|
+
| `amUserIds` | array | body | 否 | AM 用户 ID。通过 POST /sino-opti-hive/sso-team/getMemberList 取 userId;也可 POST /sino-opti-hive/user/getSsoUserList 按姓名搜 |
|
|
80
|
+
| `pmUserIds` | array | body | 否 | PM 用户 ID。通过 POST /sino-opti-hive/sso-team/getMemberList 取 userId;也可 POST /sino-opti-hive/user/getSsoUserList 按姓名搜 |
|
|
81
|
+
| `customerInfrastructure` | array | body | 否 | 1=数据追踪方式:AdJust,2=数据追踪方式:AF,3=数据追踪方式:其他MMP,4=数据追踪方式:客户BI,5=数据追踪方式:媒体后台,6=素材产出方式:CB,7=素材产出方式:客户提供,8=素材产出方式:内部设计师制作,9=素材产出方式:无需素材(ASA、推流等),10=基建情况:基建完善,11=基建情况:三方回传数据异常,12=基建情况:APP埋点异常 |
|
|
82
|
+
| `coreIndex` | string | body | 否 | 核心指标 |
|
|
83
|
+
| `monthlyMaterialCount` | string | body | 否 | 月度上新素材量 |
|
|
84
|
+
| `projectInitStatus` | string | body | 否 | 项目初始化状态 |
|
|
85
|
+
| `projectBrief` | string | body | 否 | 项目 Brief |
|
|
86
|
+
| `corporationIds` | array | body | 否 | 关联签约主体 ID(字符串)。通过 POST /sino-opti-hive/corporation/page 获取签约主体 ID |
|
|
87
|
+
| `projectIds` | array | body | 否 | 关联项目 ID |
|
|
88
|
+
| `ssoTeamCode` | string | body | 是 | 组别 code,单选,必填。通过 GET /sino-opti-hive/sso-team/group-list 取 code |
|
|
89
|
+
| `businessRegion` | string | body | 是 | EAST_CHINA=华东,SOUTH_CHINA=华南,NORTH_CHINA=华北。必填 |
|
|
90
|
+
| `projectRating` | string | body | 否 | S、A、B、C。非新客必填 |
|
|
91
|
+
| `newCustomerTag` | string | body | 否 | NEW_TAG=是(新客),NONE_NEW_TAG=否(非新客) |
|
|
80
92
|
|
|
81
93
|
## 4. 更新业务线
|
|
82
94
|
|
|
83
95
|
`POST /sino-opti-hive/biz-line/update`
|
|
84
96
|
|
|
97
|
+
主体上下文:`tenant=false`。
|
|
98
|
+
|
|
99
|
+
角色范围:`未声明`。
|
|
100
|
+
|
|
85
101
|
更新业务线信息
|
|
86
102
|
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
| 字段 | 类型 | 说明 |
|
|
90
|
-
| --- | --- | --- |
|
|
91
|
-
| `id` | integer | 通过 POST /sino-opti-hive/biz-line/list 取
|
|
92
|
-
| `status` | integer | 状态:1进行中 2已完成 3已暂停 |
|
|
93
|
-
| `name` | string | 业务线名称,业务/产品线名称不可重复 |
|
|
94
|
-
| `mediaChannels` | array | 投放渠道 code。通过 GET /sino-opti-hive/biz-line-open/channels 取 code;名称见同接口 name |
|
|
95
|
-
| `strategyControlDegree` | integer | 策略掌控程度:1弱(以客户策略为主) 2强(以我方提供策略) 3中(与客户共创) |
|
|
96
|
-
| `adCategoryIndustryIds` | array | 投放行业 ID。通过 GET /sino-opti-hive/biz-line-open/placement-categories 取一级节点 id |
|
|
97
|
-
| `adCategoryProjectIds` | array | 投放品类 ID。通过 GET /sino-opti-hive/biz-line-open/placement-categories 取二级 children.id;选其他时可为空,改填 adCategoryOther |
|
|
98
|
-
| `adCategoryOther` | string | 投放品类-其他说明 |
|
|
99
|
-
| `customerTypeIds` | array | 客户类型 ID。通过 GET /sino-opti-hive/dict/items?sceneCode=CUSTOMER_TYPE 取 id |
|
|
100
|
-
| `customerTypeOther` | string | 客户类型-其他说明 |
|
|
101
|
-
| `amUserIds` | array | AM 用户 ID。通过 POST /sino-opti-hive/sso-team/getMemberList 取 userId;也可 POST /sino-opti-hive/user/getSsoUserList 按姓名搜 |
|
|
102
|
-
| `pmUserIds` | array | PM 用户 ID。通过 POST /sino-opti-hive/sso-team/getMemberList 取 userId;也可 POST /sino-opti-hive/user/getSsoUserList 按姓名搜 |
|
|
103
|
-
| `customerInfrastructure` | array | 1=数据追踪方式:AdJust,2=数据追踪方式:AF,3=数据追踪方式:其他MMP,4=数据追踪方式:客户BI,5=数据追踪方式:媒体后台,6=素材产出方式:CB,7=素材产出方式:客户提供,8=素材产出方式:内部设计师制作,9=素材产出方式:无需素材(ASA、推流等),10=基建情况:基建完善,11=基建情况:三方回传数据异常,12=基建情况:APP埋点异常 |
|
|
104
|
-
| `coreIndex` | string | 核心指标 |
|
|
105
|
-
| `monthlyMaterialCount` | string | 月度上新素材量 |
|
|
106
|
-
| `projectInitStatus` | string | 项目初始化状态 |
|
|
107
|
-
| `projectBrief` | string | 项目 Brief |
|
|
108
|
-
| `corporationIds` | array | 关联签约主体 ID(字符串)。通过 POST /sino-opti-hive/corporation/page 获取签约主体 ID |
|
|
109
|
-
| `projectIds` | array | 关联项目 ID。通过 POST /sino-opti-hive/optimize/project/queryByPage 获取;按 ID 反查名称用 POST /sino-opti-hive/optimize/project/listByIds |
|
|
110
|
-
| `ssoTeamCode` | string | 组别 code,单选,必填。通过 GET /sino-opti-hive/sso-team/group-list 取 code |
|
|
111
|
-
| `businessRegion` | string | EAST_CHINA=华东,SOUTH_CHINA=华南,NORTH_CHINA=华北。必填 |
|
|
112
|
-
| `projectRating` | string | S、A、B、C。非新客必填 |
|
|
113
|
-
| `newCustomerTag` | string | NEW_TAG=是(新客),NONE_NEW_TAG=否(非新客) |
|
|
103
|
+
**输入参数(--data)**
|
|
104
|
+
|
|
105
|
+
| 字段 | 类型 | 位置 | 必填 | 说明 |
|
|
106
|
+
| --- | --- | --- | --- | --- |
|
|
107
|
+
| `id` | integer | body | 是 | 通过 POST /sino-opti-hive/biz-line/list 取 id |
|
|
108
|
+
| `status` | integer | body | 是 | 状态:1进行中 2已完成 3已暂停 |
|
|
109
|
+
| `name` | string | body | 是 | 业务线名称,业务/产品线名称不可重复 |
|
|
110
|
+
| `mediaChannels` | array | body | 否 | 投放渠道 code。通过 GET /sino-opti-hive/biz-line-open/channels 取 code;名称见同接口 name |
|
|
111
|
+
| `strategyControlDegree` | integer | body | 否 | 策略掌控程度:1弱(以客户策略为主) 2强(以我方提供策略) 3中(与客户共创) |
|
|
112
|
+
| `adCategoryIndustryIds` | array | body | 否 | 投放行业 ID。通过 GET /sino-opti-hive/biz-line-open/placement-categories 取一级节点 id |
|
|
113
|
+
| `adCategoryProjectIds` | array | body | 否 | 投放品类 ID。通过 GET /sino-opti-hive/biz-line-open/placement-categories 取二级 children.id;选其他时可为空,改填 adCategoryOther |
|
|
114
|
+
| `adCategoryOther` | string | body | 否 | 投放品类-其他说明 |
|
|
115
|
+
| `customerTypeIds` | array | body | 否 | 客户类型 ID。通过 GET /sino-opti-hive/dict/items?sceneCode=CUSTOMER_TYPE 取 id |
|
|
116
|
+
| `customerTypeOther` | string | body | 否 | 客户类型-其他说明 |
|
|
117
|
+
| `amUserIds` | array | body | 否 | AM 用户 ID。通过 POST /sino-opti-hive/sso-team/getMemberList 取 userId;也可 POST /sino-opti-hive/user/getSsoUserList 按姓名搜 |
|
|
118
|
+
| `pmUserIds` | array | body | 否 | PM 用户 ID。通过 POST /sino-opti-hive/sso-team/getMemberList 取 userId;也可 POST /sino-opti-hive/user/getSsoUserList 按姓名搜 |
|
|
119
|
+
| `customerInfrastructure` | array | body | 否 | 1=数据追踪方式:AdJust,2=数据追踪方式:AF,3=数据追踪方式:其他MMP,4=数据追踪方式:客户BI,5=数据追踪方式:媒体后台,6=素材产出方式:CB,7=素材产出方式:客户提供,8=素材产出方式:内部设计师制作,9=素材产出方式:无需素材(ASA、推流等),10=基建情况:基建完善,11=基建情况:三方回传数据异常,12=基建情况:APP埋点异常 |
|
|
120
|
+
| `coreIndex` | string | body | 否 | 核心指标 |
|
|
121
|
+
| `monthlyMaterialCount` | string | body | 否 | 月度上新素材量 |
|
|
122
|
+
| `projectInitStatus` | string | body | 否 | 项目初始化状态 |
|
|
123
|
+
| `projectBrief` | string | body | 否 | 项目 Brief |
|
|
124
|
+
| `corporationIds` | array | body | 否 | 关联签约主体 ID(字符串)。通过 POST /sino-opti-hive/corporation/page 获取签约主体 ID |
|
|
125
|
+
| `projectIds` | array | body | 否 | 关联项目 ID。通过 POST /sino-opti-hive/optimize/project/queryByPage 获取;按 ID 反查名称用 POST /sino-opti-hive/optimize/project/listByIds |
|
|
126
|
+
| `ssoTeamCode` | string | body | 是 | 组别 code,单选,必填。通过 GET /sino-opti-hive/sso-team/group-list 取 code |
|
|
127
|
+
| `businessRegion` | string | body | 是 | EAST_CHINA=华东,SOUTH_CHINA=华南,NORTH_CHINA=华北。必填 |
|
|
128
|
+
| `projectRating` | string | body | 否 | S、A、B、C。非新客必填 |
|
|
129
|
+
| `newCustomerTag` | string | body | 否 | NEW_TAG=是(新客),NONE_NEW_TAG=否(非新客) |
|
|
114
130
|
|
|
115
131
|
## 5. 更新业务线状态
|
|
116
132
|
|
|
117
133
|
`POST /sino-opti-hive/biz-line/status/update`
|
|
118
134
|
|
|
135
|
+
主体上下文:`tenant=false`。
|
|
136
|
+
|
|
137
|
+
角色范围:`未声明`。
|
|
138
|
+
|
|
119
139
|
⚠️ 写操作。仅更新状态与操作人;成功时 result 为 Boolean。status:1进行中 2已完成 3已暂停。
|
|
120
140
|
|
|
121
|
-
|
|
141
|
+
**输入参数(--data)**
|
|
122
142
|
|
|
123
|
-
| 字段 | 类型 | 说明 |
|
|
124
|
-
| --- | --- | --- |
|
|
125
|
-
| `id` | integer | |
|
|
126
|
-
| `status` | integer | 状态:1进行中 2已完成 3已暂停;对应 BizLineStatusEnum |
|
|
143
|
+
| 字段 | 类型 | 位置 | 必填 | 说明 |
|
|
144
|
+
| --- | --- | --- | --- | --- |
|
|
145
|
+
| `id` | integer | body | 是 | |
|
|
146
|
+
| `status` | integer | body | 是 | 状态:1进行中 2已完成 3已暂停;对应 BizLineStatusEnum |
|
|
127
147
|
|
|
128
148
|
## 6. 删除业务线
|
|
129
149
|
|
|
130
150
|
`POST /sino-opti-hive/biz-line/del`
|
|
131
151
|
|
|
152
|
+
主体上下文:`tenant=false`。
|
|
153
|
+
|
|
154
|
+
角色范围:`未声明`。
|
|
155
|
+
|
|
132
156
|
⚠️ 写操作。成功时 result 为 Boolean,表示是否删除成功。
|
|
133
157
|
|
|
134
|
-
|
|
158
|
+
**输入参数(--data)**
|
|
135
159
|
|
|
136
|
-
| 字段 | 类型 | 说明 |
|
|
137
|
-
| --- | --- | --- |
|
|
138
|
-
| `id` | integer | |
|
|
160
|
+
| 字段 | 类型 | 位置 | 必填 | 说明 |
|
|
161
|
+
| --- | --- | --- | --- | --- |
|
|
162
|
+
| `id` | integer | body | 是 | |
|
|
139
163
|
|
|
140
164
|
## 7. 查询投放策略分页列表
|
|
141
165
|
|
|
142
166
|
`POST /sino-opti-hive/biz-line/strategy/list`
|
|
143
167
|
|
|
168
|
+
主体上下文:`tenant=false`。
|
|
169
|
+
|
|
170
|
+
角色范围:`未声明`。
|
|
171
|
+
|
|
144
172
|
查询投放策略分页列表
|
|
145
173
|
|
|
146
|
-
|
|
174
|
+
**输入参数(--data)**
|
|
147
175
|
|
|
148
|
-
| 字段 | 类型 | 说明 |
|
|
149
|
-
| --- | --- | --- |
|
|
150
|
-
| `pageNum` | integer | 页码,从 1 开始 |
|
|
151
|
-
| `pageSize` | integer | 每页条数 |
|
|
152
|
-
| `sortDirection` | string | 创建日期排序 DESC 或 ASC,默认 DESC |
|
|
153
|
-
| `bizLineId` | integer | 可选,不传则按权限查全部可见业务线。 |
|
|
154
|
-
| `trafficLight` | integer | 红绿灯筛选(策略表现):1=绿灯KPI达标,2=黄灯距KPIGAP20%内,3=红灯距KPIGAP20%以上,4=红灯已暂停,5=黄灯存在风险,6=绿灯KPI达标且项目顺利。 |
|
|
176
|
+
| 字段 | 类型 | 位置 | 必填 | 说明 |
|
|
177
|
+
| --- | --- | --- | --- | --- |
|
|
178
|
+
| `pageNum` | integer | body | 是 | 页码,从 1 开始 |
|
|
179
|
+
| `pageSize` | integer | body | 是 | 每页条数 |
|
|
180
|
+
| `sortDirection` | string | body | 否 | 创建日期排序 DESC 或 ASC,默认 DESC |
|
|
181
|
+
| `bizLineId` | integer | body | 否 | 可选,不传则按权限查全部可见业务线。 |
|
|
182
|
+
| `trafficLight` | integer | body | 否 | 红绿灯筛选(策略表现):1=绿灯KPI达标,2=黄灯距KPIGAP20%内,3=红灯距KPIGAP20%以上,4=红灯已暂停,5=黄灯存在风险,6=绿灯KPI达标且项目顺利。 |
|
|
155
183
|
|
|
156
184
|
## 8. 查询投放策略消耗信息
|
|
157
185
|
|
|
158
186
|
`POST /sino-opti-hive/biz-line/strategy/spend`
|
|
159
187
|
|
|
188
|
+
主体上下文:`tenant=false`。
|
|
189
|
+
|
|
190
|
+
角色范围:`未声明`。
|
|
191
|
+
|
|
160
192
|
查询投放策略消耗信息
|
|
161
193
|
|
|
162
|
-
|
|
194
|
+
**输入参数(--data)**
|
|
163
195
|
|
|
164
|
-
| 字段 | 类型 | 说明 |
|
|
165
|
-
| --- | --- | --- |
|
|
166
|
-
| `strategyId` | integer | 通过 POST /sino-opti-hive/biz-line/strategy/list 取
|
|
196
|
+
| 字段 | 类型 | 位置 | 必填 | 说明 |
|
|
197
|
+
| --- | --- | --- | --- | --- |
|
|
198
|
+
| `strategyId` | integer | body | 是 | 通过 POST /sino-opti-hive/biz-line/strategy/list 取 id,或 POST /sino-opti-hive/biz-line/strategy/period-list 取 items.id |
|
|
167
199
|
|
|
168
200
|
## 9. 新建投放策略
|
|
169
201
|
|
|
170
202
|
`POST /sino-opti-hive/biz-line/strategy/save`
|
|
171
203
|
|
|
204
|
+
主体上下文:`tenant=false`。
|
|
205
|
+
|
|
206
|
+
角色范围:`未声明`。
|
|
207
|
+
|
|
172
208
|
新建投放策略,投放策略按周填写
|
|
173
209
|
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
| 字段 | 类型 | 说明 |
|
|
177
|
-
| --- | --- | --- |
|
|
178
|
-
| `bizLineId` | integer | 通过 POST /sino-opti-hive/biz-line/list 取
|
|
179
|
-
| `periodStart` | string | 策略周期起(日期) |
|
|
180
|
-
| `periodEnd` | string | 策略周期止(日期) |
|
|
181
|
-
| `budgetStrategyTags` | array | 预算策略标签 ID。通过 GET /sino-opti-hive/dict/items?sceneCode=BUDGET_STRATEGY 取 id |
|
|
182
|
-
| `budgetStrategySupplement` | string | 预算策略补充说明 |
|
|
183
|
-
| `mediaStrategyTags` | array | 媒介策略标签 ID。通过 GET /sino-opti-hive/dict/items?sceneCode=MEDIA_STRATEGY 取 id |
|
|
184
|
-
| `mediaStrategySupplement` | string | 媒介策略补充说明 |
|
|
185
|
-
| `audienceStrategyTags` | array | 受众策略标签 ID。通过 GET /sino-opti-hive/dict/items?sceneCode=AUDIENCE_STRATEGY 取 id |
|
|
186
|
-
| `audienceStrategySupplement` | string | 受众策略补充说明 |
|
|
187
|
-
| `creativeStrategy` | string | 素材创意策略说明,最大 5000 字 |
|
|
188
|
-
| `previewPeriodStart` | string | 上期(preview)策略周期起;缺省为本期 periodStart 的上一自然周周一 |
|
|
189
|
-
| `previewPeriodEnd` | string | 上期(preview)策略周期止;缺省为 previewPeriodStart+6(周日) |
|
|
190
|
-
| `previewBudgetStrategyTags` | array | 上期预算策略标签 ID。通过 GET /sino-opti-hive/dict/items?sceneCode=BUDGET_STRATEGY 取 id |
|
|
191
|
-
| `previewBudgetStrategySupplement` | string | 上期预算策略补充说明 |
|
|
192
|
-
| `previewMediaStrategyTags` | array | 上期媒介策略标签 ID。通过 GET /sino-opti-hive/dict/items?sceneCode=MEDIA_STRATEGY 取 id |
|
|
193
|
-
| `previewMediaStrategySupplement` | string | 上期媒介策略补充说明 |
|
|
194
|
-
| `previewAudienceStrategyTags` | array | 上期受众策略标签 ID。通过 GET /sino-opti-hive/dict/items?sceneCode=AUDIENCE_STRATEGY 取 id |
|
|
195
|
-
| `previewAudienceStrategySupplement` | string | 上期受众策略补充说明 |
|
|
196
|
-
| `previewCreativeStrategy` | string | 上期素材创意策略说明,最大 5000 字 |
|
|
197
|
-
| `trafficLight` | integer | 红绿灯:1 KPI达标、2 距GAP 20%内、3 距GAP 20%以上、4 已暂停、5 存在风险、6 KPI达标且项目顺利 |
|
|
198
|
-
| `coreIssueCategories` | array | 1=受众策略问题,2=跨媒介策略问题,3=媒介广告产品使用策略问题,4=出价策略问题,5=素材策略问题,6=素材执行问题,7=素材管理问题,8=投放规划问题,9=媒体素材政策/尺度/风控问题,10=媒体适配/潜力问题,11=市场选择/竞争问题,12=客户对接不顺畅,13=客户侧:数据对接问题,14=客户侧:产品问题/投放生命周期问题,15=客户侧:运营/基建问题,16=客户侧:存在投放限制,17=客户侧:转自投,18=客户侧:需求临时无规划,19=客户侧:KPI不合理,20=投放生命周期问题/素材疲劳问题,21=内部团队人员调配问题,22=其他 |
|
|
199
|
-
| `issuesAndOpportunities` | string | 项目问题&机会,最大 5000 字 |
|
|
200
|
-
| `spend` | string | 周期投放消耗(回顾,展示用字符串),最大 50 字 |
|
|
201
|
-
| `customerSatisfaction` | integer | 客户满意度:1满意 2不满意 |
|
|
202
|
-
| `satisfactionReason` | string | 满意度原因说明,最大 5000 字 |
|
|
203
|
-
| `coreEffectIndex` | string | 核心效果指标,最大 5000 字 |
|
|
204
|
-
| `budgetStrategyEffect` | integer | 预算策略效果:1有效 2无效 3待观察 |
|
|
205
|
-
| `budgetStrategyLearning` | string | 预算策略 learning |
|
|
206
|
-
| `mediaStrategyEffect` | integer | 媒介策略效果:1有效 2无效 3待观察 |
|
|
207
|
-
| `mediaStrategyLearning` | string | 媒介策略 learning |
|
|
208
|
-
| `audienceStrategyEffect` | integer | 受众策略效果:1有效 2无效 3待观察 |
|
|
209
|
-
| `audienceStrategyLearning` | string | 受众策略 learning |
|
|
210
|
-
| `creativeStrategyEffect` | integer | 素材策略效果:1有效 2无效 3待观察 |
|
|
211
|
-
| `creativeStrategyLearning` | string | 素材策略 learning |
|
|
210
|
+
**输入参数(--data)**
|
|
211
|
+
|
|
212
|
+
| 字段 | 类型 | 位置 | 必填 | 说明 |
|
|
213
|
+
| --- | --- | --- | --- | --- |
|
|
214
|
+
| `bizLineId` | integer | body | 是 | 通过 POST /sino-opti-hive/biz-line/list 取 id |
|
|
215
|
+
| `periodStart` | string | body | 是 | 策略周期起(日期) |
|
|
216
|
+
| `periodEnd` | string | body | 是 | 策略周期止(日期) |
|
|
217
|
+
| `budgetStrategyTags` | array | body | 是 | 预算策略标签 ID。通过 GET /sino-opti-hive/dict/items?sceneCode=BUDGET_STRATEGY 取 id |
|
|
218
|
+
| `budgetStrategySupplement` | string | body | 是 | 预算策略补充说明 |
|
|
219
|
+
| `mediaStrategyTags` | array | body | 是 | 媒介策略标签 ID。通过 GET /sino-opti-hive/dict/items?sceneCode=MEDIA_STRATEGY 取 id |
|
|
220
|
+
| `mediaStrategySupplement` | string | body | 是 | 媒介策略补充说明 |
|
|
221
|
+
| `audienceStrategyTags` | array | body | 是 | 受众策略标签 ID。通过 GET /sino-opti-hive/dict/items?sceneCode=AUDIENCE_STRATEGY 取 id |
|
|
222
|
+
| `audienceStrategySupplement` | string | body | 是 | 受众策略补充说明 |
|
|
223
|
+
| `creativeStrategy` | string | body | 是 | 素材创意策略说明,最大 5000 字 |
|
|
224
|
+
| `previewPeriodStart` | string | body | 否 | 上期(preview)策略周期起;缺省为本期 periodStart 的上一自然周周一 |
|
|
225
|
+
| `previewPeriodEnd` | string | body | 否 | 上期(preview)策略周期止;缺省为 previewPeriodStart+6(周日) |
|
|
226
|
+
| `previewBudgetStrategyTags` | array | body | 否 | 上期预算策略标签 ID。通过 GET /sino-opti-hive/dict/items?sceneCode=BUDGET_STRATEGY 取 id |
|
|
227
|
+
| `previewBudgetStrategySupplement` | string | body | 否 | 上期预算策略补充说明 |
|
|
228
|
+
| `previewMediaStrategyTags` | array | body | 否 | 上期媒介策略标签 ID。通过 GET /sino-opti-hive/dict/items?sceneCode=MEDIA_STRATEGY 取 id |
|
|
229
|
+
| `previewMediaStrategySupplement` | string | body | 否 | 上期媒介策略补充说明 |
|
|
230
|
+
| `previewAudienceStrategyTags` | array | body | 否 | 上期受众策略标签 ID。通过 GET /sino-opti-hive/dict/items?sceneCode=AUDIENCE_STRATEGY 取 id |
|
|
231
|
+
| `previewAudienceStrategySupplement` | string | body | 否 | 上期受众策略补充说明 |
|
|
232
|
+
| `previewCreativeStrategy` | string | body | 否 | 上期素材创意策略说明,最大 5000 字 |
|
|
233
|
+
| `trafficLight` | integer | body | 否 | 红绿灯:1 KPI达标、2 距GAP 20%内、3 距GAP 20%以上、4 已暂停、5 存在风险、6 KPI达标且项目顺利 |
|
|
234
|
+
| `coreIssueCategories` | array | body | 否 | 1=受众策略问题,2=跨媒介策略问题,3=媒介广告产品使用策略问题,4=出价策略问题,5=素材策略问题,6=素材执行问题,7=素材管理问题,8=投放规划问题,9=媒体素材政策/尺度/风控问题,10=媒体适配/潜力问题,11=市场选择/竞争问题,12=客户对接不顺畅,13=客户侧:数据对接问题,14=客户侧:产品问题/投放生命周期问题,15=客户侧:运营/基建问题,16=客户侧:存在投放限制,17=客户侧:转自投,18=客户侧:需求临时无规划,19=客户侧:KPI不合理,20=投放生命周期问题/素材疲劳问题,21=内部团队人员调配问题,22=其他 |
|
|
235
|
+
| `issuesAndOpportunities` | string | body | 否 | 项目问题&机会,最大 5000 字 |
|
|
236
|
+
| `spend` | string | body | 否 | 周期投放消耗(回顾,展示用字符串),最大 50 字 |
|
|
237
|
+
| `customerSatisfaction` | integer | body | 否 | 客户满意度:1满意 2不满意 |
|
|
238
|
+
| `satisfactionReason` | string | body | 否 | 满意度原因说明,最大 5000 字 |
|
|
239
|
+
| `coreEffectIndex` | string | body | 否 | 核心效果指标,最大 5000 字 |
|
|
240
|
+
| `budgetStrategyEffect` | integer | body | 否 | 预算策略效果:1有效 2无效 3待观察 |
|
|
241
|
+
| `budgetStrategyLearning` | string | body | 否 | 预算策略 learning |
|
|
242
|
+
| `mediaStrategyEffect` | integer | body | 否 | 媒介策略效果:1有效 2无效 3待观察 |
|
|
243
|
+
| `mediaStrategyLearning` | string | body | 否 | 媒介策略 learning |
|
|
244
|
+
| `audienceStrategyEffect` | integer | body | 否 | 受众策略效果:1有效 2无效 3待观察 |
|
|
245
|
+
| `audienceStrategyLearning` | string | body | 否 | 受众策略 learning |
|
|
246
|
+
| `creativeStrategyEffect` | integer | body | 否 | 素材策略效果:1有效 2无效 3待观察 |
|
|
247
|
+
| `creativeStrategyLearning` | string | body | 否 | 素材策略 learning |
|
|
212
248
|
|
|
213
249
|
## 10. 更新投放策略
|
|
214
250
|
|
|
215
251
|
`POST /sino-opti-hive/biz-line/strategy/update`
|
|
216
252
|
|
|
253
|
+
主体上下文:`tenant=false`。
|
|
254
|
+
|
|
255
|
+
角色范围:`未声明`。
|
|
256
|
+
|
|
217
257
|
更新投放策略
|
|
218
258
|
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
| 字段 | 类型 | 说明 |
|
|
222
|
-
| --- | --- | --- |
|
|
223
|
-
| `id` | integer | 通过 POST /sino-opti-hive/biz-line/strategy/list 取
|
|
224
|
-
| `version` | integer | 乐观锁版本号 |
|
|
225
|
-
| `overwrite` | boolean | 默认 false:版本冲突则报错;true 强制覆盖 |
|
|
226
|
-
| `bizLineId` | integer | 通过 POST /sino-opti-hive/biz-line/list 取
|
|
227
|
-
| `periodStart` | string | 策略周期起(日期) |
|
|
228
|
-
| `periodEnd` | string | 策略周期止(日期) |
|
|
229
|
-
| `budgetStrategyTags` | array | 预算策略标签 ID。通过 GET /sino-opti-hive/dict/items?sceneCode=BUDGET_STRATEGY 取 id |
|
|
230
|
-
| `budgetStrategySupplement` | string | 预算策略补充说明 |
|
|
231
|
-
| `mediaStrategyTags` | array | 媒介策略标签 ID。通过 GET /sino-opti-hive/dict/items?sceneCode=MEDIA_STRATEGY 取 id |
|
|
232
|
-
| `mediaStrategySupplement` | string | 媒介策略补充说明 |
|
|
233
|
-
| `audienceStrategyTags` | array | 受众策略标签 ID。通过 GET /sino-opti-hive/dict/items?sceneCode=AUDIENCE_STRATEGY 取 id |
|
|
234
|
-
| `audienceStrategySupplement` | string | 受众策略补充说明 |
|
|
235
|
-
| `creativeStrategy` | string | 素材创意策略说明,最大 5000 字 |
|
|
236
|
-
| `previewPeriodStart` | string | 上期(preview)策略周期起;缺省为本期 periodStart 的上一自然周周一 |
|
|
237
|
-
| `previewPeriodEnd` | string | 上期(preview)策略周期止;缺省为 previewPeriodStart+6(周日) |
|
|
238
|
-
| `previewBudgetStrategyTags` | array | 上期预算策略标签 ID。通过 GET /sino-opti-hive/dict/items?sceneCode=BUDGET_STRATEGY 取 id |
|
|
239
|
-
| `previewBudgetStrategySupplement` | string | 上期预算策略补充说明 |
|
|
240
|
-
| `previewMediaStrategyTags` | array | 上期媒介策略标签 ID。通过 GET /sino-opti-hive/dict/items?sceneCode=MEDIA_STRATEGY 取 id |
|
|
241
|
-
| `previewMediaStrategySupplement` | string | 上期媒介策略补充说明 |
|
|
242
|
-
| `previewAudienceStrategyTags` | array | 上期受众策略标签 ID。通过 GET /sino-opti-hive/dict/items?sceneCode=AUDIENCE_STRATEGY 取 id |
|
|
243
|
-
| `previewAudienceStrategySupplement` | string | 上期受众策略补充说明 |
|
|
244
|
-
| `previewCreativeStrategy` | string | 上期素材创意策略说明,最大 5000 字 |
|
|
245
|
-
| `trafficLight` | integer | 红绿灯:1 KPI达标、2 距GAP 20%内、3 距GAP 20%以上、4 已暂停、5 存在风险、6 KPI达标且项目顺利 |
|
|
246
|
-
| `coreIssueCategories` | array | 1=受众策略问题,2=跨媒介策略问题,3=媒介广告产品使用策略问题,4=出价策略问题,5=素材策略问题,6=素材执行问题,7=素材管理问题,8=投放规划问题,9=媒体素材政策/尺度/风控问题,10=媒体适配/潜力问题,11=市场选择/竞争问题,12=客户对接不顺畅,13=客户侧:数据对接问题,14=客户侧:产品问题/投放生命周期问题,15=客户侧:运营/基建问题,16=客户侧:存在投放限制,17=客户侧:转自投,18=客户侧:需求临时无规划,19=客户侧:KPI不合理,20=投放生命周期问题/素材疲劳问题,21=内部团队人员调配问题,22=其他 |
|
|
247
|
-
| `issuesAndOpportunities` | string | 项目问题&机会,最大 5000 字 |
|
|
248
|
-
| `spend` | string | 周期消耗(回顾,展示用字符串),最大 50 字 |
|
|
249
|
-
| `customerSatisfaction` | integer | 客户满意度:1满意 2不满意 |
|
|
250
|
-
| `satisfactionReason` | string | 满意度原因说明,最大 5000 字 |
|
|
251
|
-
| `coreEffectIndex` | string | 核心效果指标,最大 5000 字 |
|
|
252
|
-
| `budgetStrategyEffect` | integer | 预算策略效果:1有效 2无效 3待观察 |
|
|
253
|
-
| `budgetStrategyLearning` | string | 预算策略 learning |
|
|
254
|
-
| `mediaStrategyEffect` | integer | 媒介策略效果:1有效 2无效 3待观察 |
|
|
255
|
-
| `mediaStrategyLearning` | string | 媒介策略 learning |
|
|
256
|
-
| `audienceStrategyEffect` | integer | 受众策略效果:1有效 2无效 3待观察 |
|
|
257
|
-
| `audienceStrategyLearning` | string | 受众策略 learning |
|
|
258
|
-
| `creativeStrategyEffect` | integer | 素材策略效果:1有效 2无效 3待观察 |
|
|
259
|
-
| `creativeStrategyLearning` | string | 素材策略 learning |
|
|
259
|
+
**输入参数(--data)**
|
|
260
|
+
|
|
261
|
+
| 字段 | 类型 | 位置 | 必填 | 说明 |
|
|
262
|
+
| --- | --- | --- | --- | --- |
|
|
263
|
+
| `id` | integer | body | 是 | 通过 POST /sino-opti-hive/biz-line/strategy/list 取 id,或 POST /sino-opti-hive/biz-line/strategy/period-list 取 items.id |
|
|
264
|
+
| `version` | integer | body | 是 | 乐观锁版本号 |
|
|
265
|
+
| `overwrite` | boolean | body | 否 | 默认 false:版本冲突则报错;true 强制覆盖 |
|
|
266
|
+
| `bizLineId` | integer | body | 是 | 通过 POST /sino-opti-hive/biz-line/list 取 id |
|
|
267
|
+
| `periodStart` | string | body | 是 | 策略周期起(日期) |
|
|
268
|
+
| `periodEnd` | string | body | 是 | 策略周期止(日期) |
|
|
269
|
+
| `budgetStrategyTags` | array | body | 是 | 预算策略标签 ID。通过 GET /sino-opti-hive/dict/items?sceneCode=BUDGET_STRATEGY 取 id |
|
|
270
|
+
| `budgetStrategySupplement` | string | body | 是 | 预算策略补充说明 |
|
|
271
|
+
| `mediaStrategyTags` | array | body | 是 | 媒介策略标签 ID。通过 GET /sino-opti-hive/dict/items?sceneCode=MEDIA_STRATEGY 取 id |
|
|
272
|
+
| `mediaStrategySupplement` | string | body | 是 | 媒介策略补充说明 |
|
|
273
|
+
| `audienceStrategyTags` | array | body | 是 | 受众策略标签 ID。通过 GET /sino-opti-hive/dict/items?sceneCode=AUDIENCE_STRATEGY 取 id |
|
|
274
|
+
| `audienceStrategySupplement` | string | body | 是 | 受众策略补充说明 |
|
|
275
|
+
| `creativeStrategy` | string | body | 是 | 素材创意策略说明,最大 5000 字 |
|
|
276
|
+
| `previewPeriodStart` | string | body | 否 | 上期(preview)策略周期起;缺省为本期 periodStart 的上一自然周周一 |
|
|
277
|
+
| `previewPeriodEnd` | string | body | 否 | 上期(preview)策略周期止;缺省为 previewPeriodStart+6(周日) |
|
|
278
|
+
| `previewBudgetStrategyTags` | array | body | 否 | 上期预算策略标签 ID。通过 GET /sino-opti-hive/dict/items?sceneCode=BUDGET_STRATEGY 取 id |
|
|
279
|
+
| `previewBudgetStrategySupplement` | string | body | 否 | 上期预算策略补充说明 |
|
|
280
|
+
| `previewMediaStrategyTags` | array | body | 否 | 上期媒介策略标签 ID。通过 GET /sino-opti-hive/dict/items?sceneCode=MEDIA_STRATEGY 取 id |
|
|
281
|
+
| `previewMediaStrategySupplement` | string | body | 否 | 上期媒介策略补充说明 |
|
|
282
|
+
| `previewAudienceStrategyTags` | array | body | 否 | 上期受众策略标签 ID。通过 GET /sino-opti-hive/dict/items?sceneCode=AUDIENCE_STRATEGY 取 id |
|
|
283
|
+
| `previewAudienceStrategySupplement` | string | body | 否 | 上期受众策略补充说明 |
|
|
284
|
+
| `previewCreativeStrategy` | string | body | 否 | 上期素材创意策略说明,最大 5000 字 |
|
|
285
|
+
| `trafficLight` | integer | body | 否 | 红绿灯:1 KPI达标、2 距GAP 20%内、3 距GAP 20%以上、4 已暂停、5 存在风险、6 KPI达标且项目顺利 |
|
|
286
|
+
| `coreIssueCategories` | array | body | 否 | 1=受众策略问题,2=跨媒介策略问题,3=媒介广告产品使用策略问题,4=出价策略问题,5=素材策略问题,6=素材执行问题,7=素材管理问题,8=投放规划问题,9=媒体素材政策/尺度/风控问题,10=媒体适配/潜力问题,11=市场选择/竞争问题,12=客户对接不顺畅,13=客户侧:数据对接问题,14=客户侧:产品问题/投放生命周期问题,15=客户侧:运营/基建问题,16=客户侧:存在投放限制,17=客户侧:转自投,18=客户侧:需求临时无规划,19=客户侧:KPI不合理,20=投放生命周期问题/素材疲劳问题,21=内部团队人员调配问题,22=其他 |
|
|
287
|
+
| `issuesAndOpportunities` | string | body | 否 | 项目问题&机会,最大 5000 字 |
|
|
288
|
+
| `spend` | string | body | 否 | 周期消耗(回顾,展示用字符串),最大 50 字 |
|
|
289
|
+
| `customerSatisfaction` | integer | body | 否 | 客户满意度:1满意 2不满意 |
|
|
290
|
+
| `satisfactionReason` | string | body | 否 | 满意度原因说明,最大 5000 字 |
|
|
291
|
+
| `coreEffectIndex` | string | body | 否 | 核心效果指标,最大 5000 字 |
|
|
292
|
+
| `budgetStrategyEffect` | integer | body | 否 | 预算策略效果:1有效 2无效 3待观察 |
|
|
293
|
+
| `budgetStrategyLearning` | string | body | 否 | 预算策略 learning |
|
|
294
|
+
| `mediaStrategyEffect` | integer | body | 否 | 媒介策略效果:1有效 2无效 3待观察 |
|
|
295
|
+
| `mediaStrategyLearning` | string | body | 否 | 媒介策略 learning |
|
|
296
|
+
| `audienceStrategyEffect` | integer | body | 否 | 受众策略效果:1有效 2无效 3待观察 |
|
|
297
|
+
| `audienceStrategyLearning` | string | body | 否 | 受众策略 learning |
|
|
298
|
+
| `creativeStrategyEffect` | integer | body | 否 | 素材策略效果:1有效 2无效 3待观察 |
|
|
299
|
+
| `creativeStrategyLearning` | string | body | 否 | 素材策略 learning |
|
|
260
300
|
|
|
261
301
|
## 11. 删除投放策略
|
|
262
302
|
|
|
263
303
|
`POST /sino-opti-hive/biz-line/strategy/del`
|
|
264
304
|
|
|
305
|
+
主体上下文:`tenant=false`。
|
|
306
|
+
|
|
307
|
+
角色范围:`未声明`。
|
|
308
|
+
|
|
265
309
|
删除投放策略
|
|
266
310
|
|
|
267
|
-
|
|
311
|
+
**输入参数(--data)**
|
|
268
312
|
|
|
269
|
-
| 字段 | 类型 | 说明 |
|
|
270
|
-
| --- | --- | --- |
|
|
271
|
-
| `id` | integer | 通过 POST /sino-opti-hive/biz-line/strategy/list 取
|
|
313
|
+
| 字段 | 类型 | 位置 | 必填 | 说明 |
|
|
314
|
+
| --- | --- | --- | --- | --- |
|
|
315
|
+
| `id` | integer | body | 是 | 通过 POST /sino-opti-hive/biz-line/strategy/list 取 id,或 POST /sino-opti-hive/biz-line/strategy/period-list 取 items.id |
|
|
272
316
|
|
|
273
317
|
## 12. 查询业务线关联项目和广告账号
|
|
274
318
|
|
|
275
319
|
`POST /sino-opti-hive/biz-line/project-list`
|
|
276
320
|
|
|
321
|
+
主体上下文:`tenant=false`。
|
|
322
|
+
|
|
323
|
+
角色范围:`未声明`。
|
|
324
|
+
|
|
277
325
|
根据业务线 ID 查询业务线关联项目和广告账号
|
|
278
326
|
|
|
279
327
|
|
|
280
|
-
|
|
328
|
+
**输入参数(--data)**
|
|
281
329
|
|
|
282
|
-
| 字段 | 类型 | 说明 |
|
|
283
|
-
| --- | --- | --- |
|
|
284
|
-
| `bizLineId` | integer | 业务线 ID,必填 |
|
|
330
|
+
| 字段 | 类型 | 位置 | 必填 | 说明 |
|
|
331
|
+
| --- | --- | --- | --- | --- |
|
|
332
|
+
| `bizLineId` | integer | body | 是 | 业务线 ID,必填 |
|
|
285
333
|
|
|
286
334
|
## 13. 查询项目分页列表
|
|
287
335
|
|
|
288
336
|
`POST /sino-opti-hive/optimize/project/queryByPage`
|
|
289
337
|
|
|
338
|
+
主体上下文:`tenant=false`。
|
|
339
|
+
|
|
340
|
+
角色范围:`未声明`。
|
|
341
|
+
|
|
290
342
|
查询项目分页列表
|
|
291
343
|
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
| 字段 | 类型 | 说明 |
|
|
295
|
-
| --- | --- | --- |
|
|
296
|
-
| `pageNum` | integer | 页码,从 1 开始 |
|
|
297
|
-
| `pageSize` | integer | 每页条数 |
|
|
298
|
-
| `sortType` | string | lastWeekSpend=上周消耗;lastWeekSpendQoq=上周消耗环比;createTime=创建时间。不传默认 createTime |
|
|
299
|
-
| `sortDirection` | string | ASC 升序,DESC 降序;默认 DESC |
|
|
300
|
-
| `corporationId` | integer | 签约主体 ID |
|
|
301
|
-
| `corporationIdList` | array | 签约主体 ID 多选 |
|
|
302
|
-
| `projectId` | integer | 项目 ID,精确匹配 |
|
|
303
|
-
| `projectIdList` | array | 项目 ID 多选。已知 ID 时直接传入;本接口出参 projectId 也可回填 |
|
|
304
|
-
| `projectName` | string | 项目名称,模糊查询 |
|
|
305
|
-
| `projectKeyword` | string | 项目 ID 精确,或项目名称分词模糊(空格分词,词之间 AND) |
|
|
306
|
-
| `startDate` | string | 项目周期开始日期 yyyy-MM-dd |
|
|
307
|
-
| `endDate` | string | 项目周期结束日期 yyyy-MM-dd |
|
|
308
|
-
| `projectUserIdList` | array | 项目成员用户 ID 多选。通过 POST /sino-opti-hive/sso-team/getMemberList 取 userId,也可 POST /sino-opti-hive/user/getSsoUserList 按姓名搜 |
|
|
309
|
-
| `ssoTeamCodeList` | array | 组别 code 多选,按该组别下 PM 成员筛项目。通过 GET /sino-opti-hive/sso-team/group-list 取 code |
|
|
310
|
-
| `adAccountId` | string | 广告账号 ID 模糊查询,至少 2 个字符 |
|
|
311
|
-
| `demandOrderKeyword` | string | 需求单编号精确,或需求单名称分词模糊(空格分词) |
|
|
312
|
-
| `signalLightList` | array | 项目红绿灯多选,与出参 signalLight 同值(字符串,不是业务线策略 trafficLight 的整数枚举) |
|
|
313
|
-
| `projectStatusList` | array | 项目执行状态多选。本接口查的是项目(非需求):4=待分配,5=执行中,6=已暂停,7=已完成,8=终止。出参 projectStatusName 为对应中文名 |
|
|
314
|
-
| `isLast7DSpend` | array | 0=否,1=是。仅传一个值时生效;同时传 0 和 1 等于不筛 |
|
|
315
|
-
| `uploadInfoTypeList` | array | 0=无上传,1=仅上传brief,2=仅上传mediaPlan,3=上传brief和mediaPlan。多选 |
|
|
316
|
-
| `serviceCodeList` | array | 服务/产品 code 多选。不传时服务端默认 1、85(代投类项目) |
|
|
317
|
-
| `bizLineIdList` | array | 按已关联业务线过滤项目。通过 POST /sino-opti-hive/biz-line/list 取
|
|
344
|
+
**输入参数(--data)**
|
|
345
|
+
|
|
346
|
+
| 字段 | 类型 | 位置 | 必填 | 说明 |
|
|
347
|
+
| --- | --- | --- | --- | --- |
|
|
348
|
+
| `pageNum` | integer | body | 否 | 页码,从 1 开始 |
|
|
349
|
+
| `pageSize` | integer | body | 否 | 每页条数 |
|
|
350
|
+
| `sortType` | string | body | 否 | lastWeekSpend=上周消耗;lastWeekSpendQoq=上周消耗环比;createTime=创建时间。不传默认 createTime |
|
|
351
|
+
| `sortDirection` | string | body | 否 | ASC 升序,DESC 降序;默认 DESC |
|
|
352
|
+
| `corporationId` | integer | body | 否 | 签约主体 ID |
|
|
353
|
+
| `corporationIdList` | array | body | 否 | 签约主体 ID 多选 |
|
|
354
|
+
| `projectId` | integer | body | 否 | 项目 ID,精确匹配 |
|
|
355
|
+
| `projectIdList` | array | body | 否 | 项目 ID 多选。已知 ID 时直接传入;本接口出参 projectId 也可回填 |
|
|
356
|
+
| `projectName` | string | body | 否 | 项目名称,模糊查询 |
|
|
357
|
+
| `projectKeyword` | string | body | 否 | 项目 ID 精确,或项目名称分词模糊(空格分词,词之间 AND) |
|
|
358
|
+
| `startDate` | string | body | 否 | 项目周期开始日期 yyyy-MM-dd |
|
|
359
|
+
| `endDate` | string | body | 否 | 项目周期结束日期 yyyy-MM-dd |
|
|
360
|
+
| `projectUserIdList` | array | body | 否 | 项目成员用户 ID 多选。通过 POST /sino-opti-hive/sso-team/getMemberList 取 userId,也可 POST /sino-opti-hive/user/getSsoUserList 按姓名搜 |
|
|
361
|
+
| `ssoTeamCodeList` | array | body | 否 | 组别 code 多选,按该组别下 PM 成员筛项目。通过 GET /sino-opti-hive/sso-team/group-list 取 code |
|
|
362
|
+
| `adAccountId` | string | body | 否 | 广告账号 ID 模糊查询,至少 2 个字符 |
|
|
363
|
+
| `demandOrderKeyword` | string | body | 否 | 需求单编号精确,或需求单名称分词模糊(空格分词) |
|
|
364
|
+
| `signalLightList` | array | body | 否 | 项目红绿灯多选,与出参 signalLight 同值(字符串,不是业务线策略 trafficLight 的整数枚举) |
|
|
365
|
+
| `projectStatusList` | array | body | 否 | 项目执行状态多选。本接口查的是项目(非需求):4=待分配,5=执行中,6=已暂停,7=已完成,8=终止。出参 projectStatusName 为对应中文名 |
|
|
366
|
+
| `isLast7DSpend` | array | body | 否 | 0=否,1=是。仅传一个值时生效;同时传 0 和 1 等于不筛 |
|
|
367
|
+
| `uploadInfoTypeList` | array | body | 否 | 0=无上传,1=仅上传brief,2=仅上传mediaPlan,3=上传brief和mediaPlan。多选 |
|
|
368
|
+
| `serviceCodeList` | array | body | 否 | 服务/产品 code 多选。不传时服务端默认 1、85(代投类项目) |
|
|
369
|
+
| `bizLineIdList` | array | body | 否 | 按已关联业务线过滤项目。通过 POST /sino-opti-hive/biz-line/list 取 id |
|
|
318
370
|
|
|
319
371
|
## 14. Facebook广告策略维度数据
|
|
320
372
|
|
|
321
373
|
`POST /sino-icenter/mcp/strategy/dimension/facebook/ad/list`
|
|
322
374
|
|
|
375
|
+
主体上下文:`tenant=false`。
|
|
376
|
+
|
|
377
|
+
角色范围:`未声明`。
|
|
378
|
+
|
|
323
379
|
查询 Facebook(Meta)渠道的广告策略配置数据。按指定广告账户和日期范围,返回广告的策略设置明细(广告目标、成效目标、创意类型、出价方式、调整出价、受众类型、兴趣词包、年龄、性别等),用于分析某批账户在某段时间内各广告的策略配置分布。本接口只返回策略维度,不含消耗、点击等成效指标,需要成效数据请改用「Facebook广告策略成效数据」接口。
|
|
324
380
|
|
|
325
381
|
【国家维度特别说明】
|
|
326
|
-
country_code
|
|
382
|
+
country_code(国家)只能单独传,或与 calendar_date(投放日期)两个一起传;与其他任何维度同传都会报错「[country_code]只能和[calendar_date]同时传入」。
|
|
383
|
+
传入 country_code 时服务端转走跨渠道广告数据接口取数,由此有两点差异:
|
|
384
|
+
一是 dimensionValues 里额外支持 country_code 作为过滤条件,传国家码数组即可按国家筛选;不传 country_code 维度时该过滤条件无效。
|
|
385
|
+
二是 headerMap 的列名来自跨渠道接口,calendar_date 列名为「日期」而不是「投放日期」,country_code 列名为「国家/地区」;展示列名请以 headerMap 实际返回值为准,不要写死。
|
|
327
386
|
|
|
328
387
|
【入参填写规则】
|
|
329
388
|
1. startDate / endDate:字符串,格式 yyyy-MM-dd,两者都必填。
|
|
330
|
-
2. dimensionValues:过滤条件,结构是「字段名 → 取值数组」的键值对(Java 类型 Map<String, List<Object>>)。每个 key 是字段 code,对应的 value 必须是数组,即使只筛一个值也要用数组包裹;同一个 key
|
|
389
|
+
2. dimensionValues:过滤条件,结构是「字段名 → 取值数组」的键值对(Java 类型 Map<String, List<Object>>)。每个 key 是字段 code,对应的 value 必须是数组,即使只筛一个值也要用数组包裹;同一个 key 内的多个值之间是「或」关系,命中任意一个即返回。本接口默认只有 account_id 这一个 key 生效;当 dimensions 里传了 country_code 时,额外支持 country_code 作为过滤条件。传入其余 key 不会报错,但也不会产生任何过滤效果。
|
|
331
390
|
3. dimensions:分组维度数组,必填。传多个维度时按多个字段组合分组,效果等同 SQL 的 GROUP BY 多列,维度越多返回行数越多、粒度越细。
|
|
332
391
|
4. 排序:单字段排序用 order(字段名)+ orderType(desc / asc);多字段排序用 orders,结构是「字段名 → 排序方向」的有序键值对,按书写顺序依次排序,例如 {"calendar_date":"desc","account_id":"asc"}。两者可同时使用,order 指定的字段会追加到 orders 之后。
|
|
333
392
|
5. 分页:page 从 1 开始(默认 1),size 为每页条数(默认 10)。返回的 result.total 是总条数,据此判断是否还有下一页。
|
|
@@ -357,29 +416,62 @@ result.data 为数据行数组,每行的每个字段有两个 key:
|
|
|
357
416
|
二是展示值,key 加 display_ 前缀,直接呈现给用户时用这个,空值为 "-"。
|
|
358
417
|
result.headerMap 是字段 code 到中文列名的映射,用于给用户展示列名。
|
|
359
418
|
result.total 为总条数,result.page 和 result.size 为当前分页。
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
|
365
|
-
|
|
|
366
|
-
| `
|
|
367
|
-
| `
|
|
368
|
-
| `
|
|
369
|
-
| `
|
|
370
|
-
| `
|
|
371
|
-
| `
|
|
372
|
-
| `
|
|
373
|
-
| `
|
|
374
|
-
| `size` | integer | 每页条数,默认 10,建议显式指定。返回的 result.total 为总条数,据此判断是否还有下一页。 |
|
|
419
|
+
|
|
420
|
+
**输入参数(--data)**
|
|
421
|
+
|
|
422
|
+
| 字段 | 类型 | 位置 | 必填 | 说明 |
|
|
423
|
+
| --- | --- | --- | --- | --- |
|
|
424
|
+
| `startDate` | string | body | 是 | 统计开始日期,字符串,格式 yyyy-MM-dd,例如 "2026-08-01"。必填。 |
|
|
425
|
+
| `endDate` | string | body | 是 | 统计结束日期,字符串,格式 yyyy-MM-dd,例如 "2026-08-31"。必填,需大于等于 startDate。 |
|
|
426
|
+
| `dimensionValues` | object | body | 是 | 过滤条件。结构为「字段名 → 取值数组」的键值对(Java 类型 Map<String, List<Object>>),value 必须是数组,即使只筛一个值也要用数组包裹。本接口默认只有 account_id 一个 key 生效;当 dimensions 里传了 country_code 时,额外支持 country_code 作为过滤条件(国家码数组)。其余 key 传入不报错但无过滤效果。示例:{"account_id": ["act_123", "act_456"]} |
|
|
427
|
+
| `dimensions` | array | body | 是 | 分组维度,字符串数组,必传且不能为空数组(传空数组返回结果为空)。传多个维度时按多字段组合分组,等同 SQL 的 GROUP BY 多列,维度越多粒度越细、返回行数越多。各维度含义:calendar_date(投放日期)、account_id(广告账户ID)、account_name(广告账户名称)、campaign_id(广告系列ID)、campaign_name(广告系列名称)、adgroup_id(广告组ID)、adgroup_name(广告组名称)、ad_id(广告ID)、ad_name(广告名称)、bid_amount(调整出价)、objective(广告目标)、optimization_goal(成效目标)、ad_format(创意类型)、bid_strategy(出价方式)、audience_type(受众类型)、targeting_interests(兴趣词包)、targeting_flexible_interests(弹性兴趣词包)、targeting_exclusion_interests(排除兴趣词包)、targeting_age(年龄)、targeting_genders(性别)、country_code(国家,只能单独传或与 calendar_date 两个一起传) |
|
|
428
|
+
| `order` | string | body | 否 | 单字段排序的字段名,填单个 code,取值范围为 dimensions 的可选值。不必包含在已传的字段中,服务端会自动补入参与排序,但该字段不会作为列返回。与 orders 可同时使用,order 指定的字段会追加到 orders 之后。 |
|
|
429
|
+
| `orderType` | string | body | 否 | 排序方向,配合 order 使用。desc 降序,asc 升序,默认 asc。 |
|
|
430
|
+
| `orders` | object | body | 否 | 多字段排序,结构为「字段名 → 排序方向」的有序键值对(Java 类型 LinkedHashMap<String, String>),按 key 的书写顺序依次排序,方向取值 desc 或 asc。示例:{"calendar_date":"desc","account_id":"asc"}。只需单字段排序时用 order + orderType 即可,不必传本字段。 |
|
|
431
|
+
| `page` | integer | body | 否 | 页码,从 1 开始,默认 1。 |
|
|
432
|
+
| `size` | integer | body | 否 | 每页条数,默认 10,建议显式指定。返回的 result.total 为总条数,据此判断是否还有下一页。 |
|
|
375
433
|
|
|
376
434
|
## 15. Google广告策略维度数据
|
|
377
435
|
|
|
378
436
|
`POST /sino-icenter/mcp/strategy/dimension/google/ad/list`
|
|
379
437
|
|
|
438
|
+
主体上下文:`tenant=false`。
|
|
439
|
+
|
|
440
|
+
角色范围:`未声明`。
|
|
441
|
+
|
|
380
442
|
查询 Google 渠道的广告策略配置数据。按指定广告账户和日期范围,返回广告的策略设置明细(成效目标、创意类型、出价方式、CPC/CPM/CPV 出价、广告系列类型、关键字等),用于分析某批账户在某段时间内各广告的策略配置分布。Google 渠道不支持广告目标和兴趣词包维度,出价字段使用 cpc_bid_amount、cpm_bid_amount、cpv_bid_amount 三个独立维度。本接口只返回策略维度,不含消耗、点击等成效指标,需要成效数据请改用「Google广告策略成效数据」接口。
|
|
381
443
|
|
|
382
|
-
|
|
444
|
+
【国家维度特别说明】
|
|
445
|
+
country_code(国家)只能单独传,或与 calendar_date(投放日期)两个一起传;与其他任何维度同传都会报错「[country_code]只能和[calendar_date]同时传入」。
|
|
446
|
+
传入 country_code 时服务端转走跨渠道广告数据接口取数,由此有两点差异:
|
|
447
|
+
一是 dimensionValues 里额外支持 country_code 作为过滤条件,传国家码数组即可按国家筛选;不传 country_code 维度时该过滤条件无效。
|
|
448
|
+
二是 headerMap 的列名来自跨渠道接口,calendar_date 列名为「日期」而不是「投放日期」,country_code 列名为「国家/地区」;展示列名请以 headerMap 实际返回值为准,不要写死。
|
|
449
|
+
|
|
450
|
+
【入参填写规则】
|
|
451
|
+
1. startDate / endDate:字符串,格式 yyyy-MM-dd,两者都必填。
|
|
452
|
+
2. dimensionValues:过滤条件,结构是「字段名 → 取值数组」的键值对(Java 类型 Map<String, List<Object>>)。每个 key 是字段 code,对应的 value 必须是数组,即使只筛一个值也要用数组包裹;同一个 key 内的多个值之间是「或」关系,命中任意一个即返回。本接口默认只有 account_id 这一个 key 生效;当 dimensions 里传了 country_code 时,额外支持 country_code 作为过滤条件。传入其余 key 不会报错,但也不会产生任何过滤效果。
|
|
453
|
+
3. dimensions:分组维度数组,必填。传多个维度时按多个字段组合分组,效果等同 SQL 的 GROUP BY 多列,维度越多返回行数越多、粒度越细。
|
|
454
|
+
4. 排序:单字段排序用 order(字段名)+ orderType(desc / asc);多字段排序用 orders,结构是「字段名 → 排序方向」的有序键值对,按书写顺序依次排序,例如 {"calendar_date":"desc","account_id":"asc"}。两者可同时使用,order 指定的字段会追加到 orders 之后。
|
|
455
|
+
5. 分页:page 从 1 开始(默认 1),size 为每页条数(默认 10)。返回的 result.total 是总条数,据此判断是否还有下一页。
|
|
456
|
+
|
|
457
|
+
【请求示例】
|
|
458
|
+
{
|
|
459
|
+
"startDate": "2026-08-01",
|
|
460
|
+
"endDate": "2026-08-31",
|
|
461
|
+
"dimensionValues": {
|
|
462
|
+
"account_id": [
|
|
463
|
+
"<广告账户ID,格式同 account_id 维度返回值>"
|
|
464
|
+
]
|
|
465
|
+
},
|
|
466
|
+
"dimensions": [
|
|
467
|
+
"calendar_date",
|
|
468
|
+
"optimization_goal"
|
|
469
|
+
],
|
|
470
|
+
"order": "calendar_date",
|
|
471
|
+
"orderType": "desc",
|
|
472
|
+
"page": 1,
|
|
473
|
+
"size": 20
|
|
474
|
+
}
|
|
383
475
|
|
|
384
476
|
【返回格式】
|
|
385
477
|
result.data 为数据行数组,每行的每个字段有两个 key:
|
|
@@ -387,34 +479,40 @@ result.data 为数据行数组,每行的每个字段有两个 key:
|
|
|
387
479
|
二是展示值,key 加 display_ 前缀,直接呈现给用户时用这个,空值为 "-"。
|
|
388
480
|
result.headerMap 是字段 code 到中文列名的映射,用于给用户展示列名。
|
|
389
481
|
result.total 为总条数,result.page 和 result.size 为当前分页。
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
|
395
|
-
|
|
|
396
|
-
| `
|
|
397
|
-
| `
|
|
398
|
-
| `
|
|
399
|
-
| `
|
|
400
|
-
| `
|
|
401
|
-
| `
|
|
402
|
-
| `
|
|
403
|
-
| `
|
|
404
|
-
| `size` | integer | 每页条数,默认10,建议显式传且不超过1000 |
|
|
482
|
+
|
|
483
|
+
**输入参数(--data)**
|
|
484
|
+
|
|
485
|
+
| 字段 | 类型 | 位置 | 必填 | 说明 |
|
|
486
|
+
| --- | --- | --- | --- | --- |
|
|
487
|
+
| `startDate` | string | body | 是 | 开始日期,格式 yyyy-MM-dd,例如 2026-08-01 |
|
|
488
|
+
| `endDate` | string | body | 是 | 结束日期,格式 yyyy-MM-dd,例如 2026-08-31 |
|
|
489
|
+
| `dimensionValues` | object | body | 是 | 过滤条件。结构为「字段名 → 取值数组」的键值对(Java 类型 Map<String, List<Object>>),value 必须是数组,即使只筛一个值也要用数组包裹。本接口默认只有 account_id 一个 key 生效;当 dimensions 里传了 country_code 时,额外支持 country_code 作为过滤条件(国家码数组)。其余 key 传入不报错但无过滤效果。示例:{"account_id": ["act_123", "act_456"]} |
|
|
490
|
+
| `dimensions` | array | body | 是 | 分组维度,必传且不能为空数组,否则返回结果为空。各维度含义:calendar_date(投放日期)、account_id(广告账户ID)、account_name(广告账户名称)、campaign_id(广告系列ID)、campaign_name(广告系列名称)、adgroup_id(广告组ID)、adgroup_name(广告组名称)、ad_id(广告ID)、ad_name(广告名称)、optimization_goal(成效目标)、ad_format(创意类型)、bid_strategy(出价方式)、audience_type(受众类型)、targeting_age(年龄)、targeting_genders(性别)、cpc_bid_amount(CPC出价)、cpm_bid_amount(CPM出价)、cpv_bid_amount(CPV出价)、advertising_channel_type(广告系列类型)、keywords(关键字)、country_code(国家,只能单独传或与 calendar_date 两个一起传) |
|
|
491
|
+
| `order` | string | body | 否 | 排序字段,填单个 code,取值范围为 dimensions 的可选值。不必包含在已传的字段中,服务端会自动补入参与排序,但该字段不会作为列返回 |
|
|
492
|
+
| `orderType` | string | body | 否 | 排序方向,默认 asc |
|
|
493
|
+
| `orders` | object | body | 否 | 多字段排序,结构为「字段名 → 排序方向」的有序键值对(Java 类型 LinkedHashMap<String, String>),按 key 的书写顺序依次排序,方向取值 desc 或 asc。示例:{"calendar_date":"desc","account_id":"asc"}。只需单字段排序时用 order + orderType 即可,不必传本字段。 |
|
|
494
|
+
| `page` | integer | body | 否 | 页码,从1开始,默认1 |
|
|
495
|
+
| `size` | integer | body | 否 | 每页条数,默认10,建议显式传且不超过1000 |
|
|
405
496
|
|
|
406
497
|
## 16. TikTok广告策略维度数据
|
|
407
498
|
|
|
408
499
|
`POST /sino-icenter/mcp/strategy/dimension/tiktok/ad/list`
|
|
409
500
|
|
|
501
|
+
主体上下文:`tenant=false`。
|
|
502
|
+
|
|
503
|
+
角色范围:`未声明`。
|
|
504
|
+
|
|
410
505
|
查询 TikTok 渠道的广告策略配置数据。按指定广告账户和日期范围,返回广告的策略设置明细(广告目标、成效目标、创意类型、出价方式、调整出价、转化出价、深度转化出价、兴趣词包、年龄、性别等),用于分析某批账户在某段时间内各广告的策略配置分布。转化出价和深度转化出价是 TikTok 渠道独有的维度。本接口只返回策略维度,不含消耗、点击等成效指标,需要成效数据请改用「TikTok广告策略成效数据」接口。
|
|
411
506
|
|
|
412
507
|
【国家维度特别说明】
|
|
413
|
-
country_code
|
|
508
|
+
country_code(国家)只能单独传,或与 calendar_date(投放日期)两个一起传;与其他任何维度同传都会报错「[country_code]只能和[calendar_date]同时传入」。
|
|
509
|
+
传入 country_code 时服务端转走跨渠道广告数据接口取数,由此有两点差异:
|
|
510
|
+
一是 dimensionValues 里额外支持 country_code 作为过滤条件,传国家码数组即可按国家筛选;不传 country_code 维度时该过滤条件无效。
|
|
511
|
+
二是 headerMap 的列名来自跨渠道接口,calendar_date 列名为「日期」而不是「投放日期」,country_code 列名为「国家/地区」;展示列名请以 headerMap 实际返回值为准,不要写死。
|
|
414
512
|
|
|
415
513
|
【入参填写规则】
|
|
416
514
|
1. startDate / endDate:字符串,格式 yyyy-MM-dd,两者都必填。
|
|
417
|
-
2. dimensionValues:过滤条件,结构是「字段名 → 取值数组」的键值对(Java 类型 Map<String, List<Object>>)。每个 key 是字段 code,对应的 value 必须是数组,即使只筛一个值也要用数组包裹;同一个 key
|
|
515
|
+
2. dimensionValues:过滤条件,结构是「字段名 → 取值数组」的键值对(Java 类型 Map<String, List<Object>>)。每个 key 是字段 code,对应的 value 必须是数组,即使只筛一个值也要用数组包裹;同一个 key 内的多个值之间是「或」关系,命中任意一个即返回。本接口默认只有 account_id 这一个 key 生效;当 dimensions 里传了 country_code 时,额外支持 country_code 作为过滤条件。传入其余 key 不会报错,但也不会产生任何过滤效果。
|
|
418
516
|
3. dimensions:分组维度数组,必填。传多个维度时按多个字段组合分组,效果等同 SQL 的 GROUP BY 多列,维度越多返回行数越多、粒度越细。
|
|
419
517
|
4. 排序:单字段排序用 order(字段名)+ orderType(desc / asc);多字段排序用 orders,结构是「字段名 → 排序方向」的有序键值对,按书写顺序依次排序,例如 {"calendar_date":"desc","account_id":"asc"}。两者可同时使用,order 指定的字段会追加到 orders 之后。
|
|
420
518
|
5. 分页:page 从 1 开始(默认 1),size 为每页条数(默认 10)。返回的 result.total 是总条数,据此判断是否还有下一页。
|
|
@@ -444,31 +542,40 @@ result.data 为数据行数组,每行的每个字段有两个 key:
|
|
|
444
542
|
二是展示值,key 加 display_ 前缀,直接呈现给用户时用这个,空值为 "-"。
|
|
445
543
|
result.headerMap 是字段 code 到中文列名的映射,用于给用户展示列名。
|
|
446
544
|
result.total 为总条数,result.page 和 result.size 为当前分页。
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
|
452
|
-
|
|
|
453
|
-
| `
|
|
454
|
-
| `
|
|
455
|
-
| `
|
|
456
|
-
| `
|
|
457
|
-
| `
|
|
458
|
-
| `
|
|
459
|
-
| `
|
|
460
|
-
| `
|
|
461
|
-
| `size` | integer | 每页条数,默认 10,建议显式指定。返回的 result.total 为总条数,据此判断是否还有下一页。 |
|
|
545
|
+
|
|
546
|
+
**输入参数(--data)**
|
|
547
|
+
|
|
548
|
+
| 字段 | 类型 | 位置 | 必填 | 说明 |
|
|
549
|
+
| --- | --- | --- | --- | --- |
|
|
550
|
+
| `startDate` | string | body | 是 | 统计开始日期,字符串,格式 yyyy-MM-dd,例如 "2026-08-01"。必填。 |
|
|
551
|
+
| `endDate` | string | body | 是 | 统计结束日期,字符串,格式 yyyy-MM-dd,例如 "2026-08-31"。必填,需大于等于 startDate。 |
|
|
552
|
+
| `dimensionValues` | object | body | 是 | 过滤条件。结构为「字段名 → 取值数组」的键值对(Java 类型 Map<String, List<Object>>),value 必须是数组,即使只筛一个值也要用数组包裹。本接口默认只有 account_id 一个 key 生效;当 dimensions 里传了 country_code 时,额外支持 country_code 作为过滤条件(国家码数组)。其余 key 传入不报错但无过滤效果。示例:{"account_id": ["act_123", "act_456"]} |
|
|
553
|
+
| `dimensions` | array | body | 是 | 分组维度,字符串数组,必传且不能为空数组(传空数组返回结果为空)。传多个维度时按多字段组合分组,等同 SQL 的 GROUP BY 多列,维度越多粒度越细、返回行数越多。各维度含义:calendar_date(投放日期)、account_id(广告账户ID)、account_name(广告账户名称)、campaign_id(广告系列ID)、campaign_name(广告系列名称)、adgroup_id(广告组ID)、adgroup_name(广告组名称)、ad_id(广告ID)、ad_name(广告名称)、bid_amount(调整出价)、objective(广告目标)、optimization_goal(成效目标)、ad_format(创意类型)、bid_strategy(出价方式)、audience_type(受众类型)、targeting_interests(兴趣词包)、targeting_age(年龄)、targeting_genders(性别)、conversion_bid(转化出价)、deep_cpabid(深度转化出价)、country_code(国家,只能单独传或与 calendar_date 两个一起传) |
|
|
554
|
+
| `order` | string | body | 否 | 单字段排序的字段名,填单个 code,取值范围为 dimensions 的可选值。不必包含在已传的字段中,服务端会自动补入参与排序,但该字段不会作为列返回。与 orders 可同时使用,order 指定的字段会追加到 orders 之后。 |
|
|
555
|
+
| `orderType` | string | body | 否 | 排序方向,配合 order 使用。desc 降序,asc 升序,默认 asc。 |
|
|
556
|
+
| `orders` | object | body | 否 | 多字段排序,结构为「字段名 → 排序方向」的有序键值对(Java 类型 LinkedHashMap<String, String>),按 key 的书写顺序依次排序,方向取值 desc 或 asc。示例:{"calendar_date":"desc","account_id":"asc"}。只需单字段排序时用 order + orderType 即可,不必传本字段。 |
|
|
557
|
+
| `page` | integer | body | 否 | 页码,从 1 开始,默认 1。 |
|
|
558
|
+
| `size` | integer | body | 否 | 每页条数,默认 10,建议显式指定。返回的 result.total 为总条数,据此判断是否还有下一页。 |
|
|
462
559
|
|
|
463
560
|
## 17. Facebook广告策略成效数据
|
|
464
561
|
|
|
465
562
|
`POST /sino-icenter/mcp/strategy/metrics/facebook/ad/list`
|
|
466
563
|
|
|
564
|
+
主体上下文:`tenant=false`。
|
|
565
|
+
|
|
566
|
+
角色范围:`未声明`。
|
|
567
|
+
|
|
467
568
|
查询 Facebook(Meta)渠道广告的策略维度加成效指标数据。在广告策略配置(广告目标、成效目标、创意类型、出价方式、受众定向等)的分组下,返回消耗、曝光、点击、购买、安装等成效指标,用于分析哪种策略配置带来更好的投放效果。
|
|
468
569
|
|
|
570
|
+
【国家维度特别说明】
|
|
571
|
+
country_code(国家)只能单独传,或与 calendar_date(投放日期)两个一起传;与其他任何维度同传都会报错「[country_code]只能和[calendar_date]同时传入」。
|
|
572
|
+
传入 country_code 时服务端转走跨渠道广告数据接口取数,indicators 里的 12 个指标在该接口同样支持、照常返回聚合值,但有两点差异:
|
|
573
|
+
一是 dimensionValues 里额外支持 country_code 作为过滤条件,传国家码数组即可按国家筛选;不传 country_code 维度时该过滤条件无效。
|
|
574
|
+
二是 headerMap 的列名来自跨渠道接口,calendar_date 列名为「日期」而不是「投放日期」,country_code 列名为「国家/地区」;展示列名请以 headerMap 实际返回值为准,不要写死。
|
|
575
|
+
|
|
469
576
|
【入参填写规则】
|
|
470
577
|
1. startDate / endDate:字符串,格式 yyyy-MM-dd,两者都必填。
|
|
471
|
-
2. dimensionValues:过滤条件,结构是「字段名 → 取值数组」的键值对(Java 类型 Map<String, List<Object>>)。每个 key 是字段 code,对应的 value 必须是数组,即使只筛一个值也要用数组包裹;同一个 key
|
|
578
|
+
2. dimensionValues:过滤条件,结构是「字段名 → 取值数组」的键值对(Java 类型 Map<String, List<Object>>)。每个 key 是字段 code,对应的 value 必须是数组,即使只筛一个值也要用数组包裹;同一个 key 内的多个值之间是「或」关系,命中任意一个即返回。本接口默认只有 account_id 这一个 key 生效;当 dimensions 里传了 country_code 时,额外支持 country_code 作为过滤条件。传入其余 key 不会报错,但也不会产生任何过滤效果。
|
|
472
579
|
3. dimensions:分组维度数组,必填。传多个维度时按多个字段组合分组,效果等同 SQL 的 GROUP BY 多列,维度越多返回行数越多、粒度越细。
|
|
473
580
|
4. indicators:成效指标数组,必填。指标会在 dimensions 指定的分组粒度上做求和聚合。
|
|
474
581
|
5. 排序:单字段排序用 order(字段名)+ orderType(desc / asc);多字段排序用 orders,结构是「字段名 → 排序方向」的有序键值对,按书写顺序依次排序,例如 {"spend_usd":"desc","clicks":"asc"}。两者可同时使用,order 指定的字段会追加到 orders 之后。
|
|
@@ -505,28 +612,69 @@ result.data 为数据行数组,每行的每个字段有两个 key:
|
|
|
505
612
|
result.headerMap 是字段 code 到列名的映射,维度列名为中文,指标列名为英文(如 spend_usd 对应 Spend)。
|
|
506
613
|
result.total 为总条数,result.page 和 result.size 为当前分页。
|
|
507
614
|
result.conflictField 是传入但当前渠道不支持的指标,会被忽略且不报错,为空数组表示全部指标都生效。
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
|
513
|
-
|
|
|
514
|
-
| `
|
|
515
|
-
| `
|
|
516
|
-
| `
|
|
517
|
-
| `
|
|
518
|
-
| `
|
|
519
|
-
| `
|
|
520
|
-
| `
|
|
521
|
-
| `
|
|
522
|
-
| `
|
|
523
|
-
| `size` | integer | 每页条数,默认 10,建议显式指定。返回的 result.total 为总条数,据此判断是否还有下一页。 |
|
|
615
|
+
|
|
616
|
+
**输入参数(--data)**
|
|
617
|
+
|
|
618
|
+
| 字段 | 类型 | 位置 | 必填 | 说明 |
|
|
619
|
+
| --- | --- | --- | --- | --- |
|
|
620
|
+
| `startDate` | string | body | 是 | 统计开始日期,字符串,格式 yyyy-MM-dd,例如 "2026-08-01"。必填。 |
|
|
621
|
+
| `endDate` | string | body | 是 | 统计结束日期,字符串,格式 yyyy-MM-dd,例如 "2026-08-31"。必填,需大于等于 startDate。成效数据最多支持查询近21天,超出范围可能返回空数据。 |
|
|
622
|
+
| `dimensionValues` | object | body | 是 | 过滤条件。结构为「字段名 → 取值数组」的键值对(Java 类型 Map<String, List<Object>>),value 必须是数组,即使只筛一个值也要用数组包裹。本接口默认只有 account_id 一个 key 生效;当 dimensions 里传了 country_code 时,额外支持 country_code 作为过滤条件(国家码数组)。其余 key 传入不报错但无过滤效果。示例:{"account_id": ["act_123", "act_456"]} |
|
|
623
|
+
| `dimensions` | array | body | 是 | 分组维度,字符串数组,必传且不能为空数组(传空数组返回结果为空)。传多个维度时按多字段组合分组,等同 SQL 的 GROUP BY 多列,维度越多粒度越细、返回行数越多。各维度含义:calendar_date(投放日期)、account_id(广告账户ID)、account_name(广告账户名称)、campaign_id(广告系列ID)、campaign_name(广告系列名称)、adgroup_id(广告组ID)、adgroup_name(广告组名称)、ad_id(广告ID)、ad_name(广告名称)、objective(广告目标)、optimization_goal(成效目标)、ad_format(创意类型)、bid_strategy(出价方式)、audience_type(受众类型)、targeting_interests(兴趣词包)、targeting_flexible_interests(弹性兴趣词包)、targeting_exclusion_interests(排除兴趣词包)、targeting_age(年龄)、targeting_genders(性别)、country_code(国家,只能单独传或与 calendar_date 两个一起传) |
|
|
624
|
+
| `indicators` | array | body | 是 | 成效指标,字符串数组,必传且不能为空数组。指标会在 dimensions 指定的分组粒度上做求和聚合。各指标含义:spend_usd(消耗金额,美元)、impressions(曝光量)、clicks(点击量)、video_views(视频观看次数)、add_to_cart(添加购物车次数)、checkouts(发起结账次数)、purchase(购买次数)、purchase_value(购买金额,美元)、installs(应用安装量)、complete_registration(完成注册量)、leads(留下潜客信息次数)、engagement(互动次数) |
|
|
625
|
+
| `order` | string | body | 否 | 单字段排序的字段名,填单个 code,取值范围为 dimensions 或 indicators 的可选值。不必包含在已传的字段中,服务端会自动补入参与排序,但该字段不会作为列返回。与 orders 可同时使用,order 指定的字段会追加到 orders 之后。 |
|
|
626
|
+
| `orderType` | string | body | 否 | 排序方向,配合 order 使用。desc 降序,asc 升序,默认 asc。 |
|
|
627
|
+
| `orders` | object | body | 否 | 多字段排序,结构为「字段名 → 排序方向」的有序键值对(Java 类型 LinkedHashMap<String, String>),按 key 的书写顺序依次排序,方向取值 desc 或 asc。示例:{"spend_usd":"desc","clicks":"asc"}。只需单字段排序时用 order + orderType 即可,不必传本字段。 |
|
|
628
|
+
| `page` | integer | body | 否 | 页码,从 1 开始,默认 1。 |
|
|
629
|
+
| `size` | integer | body | 否 | 每页条数,默认 10,建议显式指定。返回的 result.total 为总条数,据此判断是否还有下一页。 |
|
|
524
630
|
|
|
525
631
|
## 18. Google广告策略成效数据
|
|
526
632
|
|
|
527
633
|
`POST /sino-icenter/mcp/strategy/metrics/google/ad/list`
|
|
528
634
|
|
|
529
|
-
|
|
635
|
+
主体上下文:`tenant=false`。
|
|
636
|
+
|
|
637
|
+
角色范围:`未声明`。
|
|
638
|
+
|
|
639
|
+
查询 Google 渠道广告的策略维度加成效指标数据。在广告策略配置(成效目标、创意类型、出价方式、广告系列类型、关键字等)的分组下,返回消耗、曝光、点击、购买、安装等成效指标,用于分析哪种策略配置带来更好的投放效果。Google 渠道不支持广告目标和兴趣词包维度。
|
|
640
|
+
|
|
641
|
+
【国家维度特别说明】
|
|
642
|
+
country_code(国家)只能单独传,或与 calendar_date(投放日期)两个一起传;与其他任何维度同传都会报错「[country_code]只能和[calendar_date]同时传入」。
|
|
643
|
+
传入 country_code 时服务端转走跨渠道广告数据接口取数,indicators 里的 12 个指标在该接口同样支持、照常返回聚合值,但有两点差异:
|
|
644
|
+
一是 dimensionValues 里额外支持 country_code 作为过滤条件,传国家码数组即可按国家筛选;不传 country_code 维度时该过滤条件无效。
|
|
645
|
+
二是 headerMap 的列名来自跨渠道接口,calendar_date 列名为「日期」而不是「投放日期」,country_code 列名为「国家/地区」;展示列名请以 headerMap 实际返回值为准,不要写死。
|
|
646
|
+
|
|
647
|
+
【入参填写规则】
|
|
648
|
+
1. startDate / endDate:字符串,格式 yyyy-MM-dd,两者都必填。
|
|
649
|
+
2. dimensionValues:过滤条件,结构是「字段名 → 取值数组」的键值对(Java 类型 Map<String, List<Object>>)。每个 key 是字段 code,对应的 value 必须是数组,即使只筛一个值也要用数组包裹;同一个 key 内的多个值之间是「或」关系,命中任意一个即返回。本接口默认只有 account_id 这一个 key 生效;当 dimensions 里传了 country_code 时,额外支持 country_code 作为过滤条件。传入其余 key 不会报错,但也不会产生任何过滤效果。
|
|
650
|
+
3. dimensions:分组维度数组,必填。传多个维度时按多个字段组合分组,效果等同 SQL 的 GROUP BY 多列,维度越多返回行数越多、粒度越细。
|
|
651
|
+
4. indicators:成效指标数组,必填。指标会在 dimensions 指定的分组粒度上做求和聚合。
|
|
652
|
+
5. 排序:单字段排序用 order(字段名)+ orderType(desc / asc);多字段排序用 orders,结构是「字段名 → 排序方向」的有序键值对,按书写顺序依次排序,例如 {"spend_usd":"desc","clicks":"asc"}。两者可同时使用,order 指定的字段会追加到 orders 之后。
|
|
653
|
+
6. 分页:page 从 1 开始(默认 1),size 为每页条数(默认 10)。返回的 result.total 是总条数,据此判断是否还有下一页。
|
|
654
|
+
|
|
655
|
+
【请求示例】
|
|
656
|
+
{
|
|
657
|
+
"startDate": "2026-08-01",
|
|
658
|
+
"endDate": "2026-08-31",
|
|
659
|
+
"dimensionValues": {
|
|
660
|
+
"account_id": [
|
|
661
|
+
"<广告账户ID,格式同 account_id 维度返回值>"
|
|
662
|
+
]
|
|
663
|
+
},
|
|
664
|
+
"dimensions": [
|
|
665
|
+
"calendar_date",
|
|
666
|
+
"optimization_goal"
|
|
667
|
+
],
|
|
668
|
+
"indicators": [
|
|
669
|
+
"spend_usd",
|
|
670
|
+
"impressions",
|
|
671
|
+
"clicks"
|
|
672
|
+
],
|
|
673
|
+
"order": "spend_usd",
|
|
674
|
+
"orderType": "desc",
|
|
675
|
+
"page": 1,
|
|
676
|
+
"size": 20
|
|
677
|
+
}
|
|
530
678
|
|
|
531
679
|
【返回格式】
|
|
532
680
|
result.data 为数据行数组,每行的每个字段有两个 key:
|
|
@@ -535,28 +683,69 @@ result.data 为数据行数组,每行的每个字段有两个 key:
|
|
|
535
683
|
result.headerMap 是字段 code 到列名的映射,维度列名为中文,指标列名为英文(如 spend_usd 对应 Spend)。
|
|
536
684
|
result.total 为总条数,result.page 和 result.size 为当前分页。
|
|
537
685
|
result.conflictField 是传入但当前渠道不支持的指标,会被忽略且不报错,为空数组表示全部指标都生效。
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
|
543
|
-
|
|
|
544
|
-
| `
|
|
545
|
-
| `
|
|
546
|
-
| `
|
|
547
|
-
| `
|
|
548
|
-
| `
|
|
549
|
-
| `
|
|
550
|
-
| `
|
|
551
|
-
| `
|
|
552
|
-
| `
|
|
553
|
-
| `size` | integer | 每页条数,默认10,建议显式传且不超过1000 |
|
|
686
|
+
|
|
687
|
+
**输入参数(--data)**
|
|
688
|
+
|
|
689
|
+
| 字段 | 类型 | 位置 | 必填 | 说明 |
|
|
690
|
+
| --- | --- | --- | --- | --- |
|
|
691
|
+
| `startDate` | string | body | 是 | 开始日期,格式 yyyy-MM-dd,例如 2026-08-01 |
|
|
692
|
+
| `endDate` | string | body | 是 | 结束日期,格式 yyyy-MM-dd,例如 2026-08-31。最多支持查询近21天 |
|
|
693
|
+
| `dimensionValues` | object | body | 是 | 过滤条件。结构为「字段名 → 取值数组」的键值对(Java 类型 Map<String, List<Object>>),value 必须是数组,即使只筛一个值也要用数组包裹。本接口默认只有 account_id 一个 key 生效;当 dimensions 里传了 country_code 时,额外支持 country_code 作为过滤条件(国家码数组)。其余 key 传入不报错但无过滤效果。示例:{"account_id": ["act_123", "act_456"]} |
|
|
694
|
+
| `dimensions` | array | body | 是 | 分组维度,必传且不能为空数组,否则返回结果为空。各维度含义:calendar_date(投放日期)、account_id(广告账户ID)、account_name(广告账户名称)、campaign_id(广告系列ID)、campaign_name(广告系列名称)、adgroup_id(广告组ID)、adgroup_name(广告组名称)、ad_id(广告ID)、ad_name(广告名称)、optimization_goal(成效目标)、ad_format(创意类型)、bid_strategy(出价方式)、audience_type(受众类型)、targeting_age(年龄)、targeting_genders(性别)、cpc_bid_amount(CPC出价)、cpm_bid_amount(CPM出价)、cpv_bid_amount(CPV出价)、advertising_channel_type(广告系列类型)、keywords(关键字)、country_code(国家,只能单独传或与 calendar_date 两个一起传) |
|
|
695
|
+
| `indicators` | array | body | 是 | 成效指标,必传且不能为空数组。各指标含义:spend_usd(消耗金额,美元)、impressions(曝光量)、clicks(点击量)、video_views(视频观看次数)、add_to_cart(添加购物车次数)、checkouts(发起结账次数)、purchase(购买次数)、purchase_value(购买金额,美元)、installs(应用安装量)、complete_registration(完成注册量)、leads(留下潜客信息次数)、engagement(互动次数) |
|
|
696
|
+
| `order` | string | body | 否 | 排序字段,填单个 code,取值范围为 dimensions 或 indicators 的可选值。不必包含在已传的字段中,服务端会自动补入参与排序,但该字段不会作为列返回 |
|
|
697
|
+
| `orderType` | string | body | 否 | 排序方向,默认 asc |
|
|
698
|
+
| `orders` | object | body | 否 | 多字段排序,结构为「字段名 → 排序方向」的有序键值对(Java 类型 LinkedHashMap<String, String>),按 key 的书写顺序依次排序,方向取值 desc 或 asc。示例:{"spend_usd":"desc","clicks":"asc"}。只需单字段排序时用 order + orderType 即可,不必传本字段。 |
|
|
699
|
+
| `page` | integer | body | 否 | 页码,从1开始,默认1 |
|
|
700
|
+
| `size` | integer | body | 否 | 每页条数,默认10,建议显式传且不超过1000 |
|
|
554
701
|
|
|
555
702
|
## 19. TikTok广告策略成效数据
|
|
556
703
|
|
|
557
704
|
`POST /sino-icenter/mcp/strategy/metrics/tiktok/ad/list`
|
|
558
705
|
|
|
559
|
-
|
|
706
|
+
主体上下文:`tenant=false`。
|
|
707
|
+
|
|
708
|
+
角色范围:`未声明`。
|
|
709
|
+
|
|
710
|
+
查询 TikTok 渠道广告的策略维度加成效指标数据。在广告策略配置(广告目标、成效目标、创意类型、出价方式、转化出价、深度转化出价、兴趣词包等)的分组下,返回消耗、曝光、点击、购买、安装等成效指标,用于分析哪种策略配置带来更好的投放效果。
|
|
711
|
+
|
|
712
|
+
【国家维度特别说明】
|
|
713
|
+
country_code(国家)只能单独传,或与 calendar_date(投放日期)两个一起传;与其他任何维度同传都会报错「[country_code]只能和[calendar_date]同时传入」。
|
|
714
|
+
传入 country_code 时服务端转走跨渠道广告数据接口取数,indicators 里的 12 个指标在该接口同样支持、照常返回聚合值,但有两点差异:
|
|
715
|
+
一是 dimensionValues 里额外支持 country_code 作为过滤条件,传国家码数组即可按国家筛选;不传 country_code 维度时该过滤条件无效。
|
|
716
|
+
二是 headerMap 的列名来自跨渠道接口,calendar_date 列名为「日期」而不是「投放日期」,country_code 列名为「国家/地区」;展示列名请以 headerMap 实际返回值为准,不要写死。
|
|
717
|
+
|
|
718
|
+
【入参填写规则】
|
|
719
|
+
1. startDate / endDate:字符串,格式 yyyy-MM-dd,两者都必填。
|
|
720
|
+
2. dimensionValues:过滤条件,结构是「字段名 → 取值数组」的键值对(Java 类型 Map<String, List<Object>>)。每个 key 是字段 code,对应的 value 必须是数组,即使只筛一个值也要用数组包裹;同一个 key 内的多个值之间是「或」关系,命中任意一个即返回。本接口默认只有 account_id 这一个 key 生效;当 dimensions 里传了 country_code 时,额外支持 country_code 作为过滤条件。传入其余 key 不会报错,但也不会产生任何过滤效果。
|
|
721
|
+
3. dimensions:分组维度数组,必填。传多个维度时按多个字段组合分组,效果等同 SQL 的 GROUP BY 多列,维度越多返回行数越多、粒度越细。
|
|
722
|
+
4. indicators:成效指标数组,必填。指标会在 dimensions 指定的分组粒度上做求和聚合。
|
|
723
|
+
5. 排序:单字段排序用 order(字段名)+ orderType(desc / asc);多字段排序用 orders,结构是「字段名 → 排序方向」的有序键值对,按书写顺序依次排序,例如 {"spend_usd":"desc","clicks":"asc"}。两者可同时使用,order 指定的字段会追加到 orders 之后。
|
|
724
|
+
6. 分页:page 从 1 开始(默认 1),size 为每页条数(默认 10)。返回的 result.total 是总条数,据此判断是否还有下一页。
|
|
725
|
+
|
|
726
|
+
【请求示例】
|
|
727
|
+
{
|
|
728
|
+
"startDate": "2026-08-01",
|
|
729
|
+
"endDate": "2026-08-31",
|
|
730
|
+
"dimensionValues": {
|
|
731
|
+
"account_id": [
|
|
732
|
+
"<广告账户ID,格式同 account_id 维度返回值>"
|
|
733
|
+
]
|
|
734
|
+
},
|
|
735
|
+
"dimensions": [
|
|
736
|
+
"calendar_date",
|
|
737
|
+
"optimization_goal"
|
|
738
|
+
],
|
|
739
|
+
"indicators": [
|
|
740
|
+
"spend_usd",
|
|
741
|
+
"impressions",
|
|
742
|
+
"clicks"
|
|
743
|
+
],
|
|
744
|
+
"order": "spend_usd",
|
|
745
|
+
"orderType": "desc",
|
|
746
|
+
"page": 1,
|
|
747
|
+
"size": 20
|
|
748
|
+
}
|
|
560
749
|
|
|
561
750
|
【返回格式】
|
|
562
751
|
result.data 为数据行数组,每行的每个字段有两个 key:
|
|
@@ -565,19 +754,18 @@ result.data 为数据行数组,每行的每个字段有两个 key:
|
|
|
565
754
|
result.headerMap 是字段 code 到列名的映射,维度列名为中文,指标列名为英文(如 spend_usd 对应 Spend)。
|
|
566
755
|
result.total 为总条数,result.page 和 result.size 为当前分页。
|
|
567
756
|
result.conflictField 是传入但当前渠道不支持的指标,会被忽略且不报错,为空数组表示全部指标都生效。
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
|
|
|
573
|
-
|
|
|
574
|
-
| `
|
|
575
|
-
| `
|
|
576
|
-
| `
|
|
577
|
-
| `
|
|
578
|
-
| `
|
|
579
|
-
| `
|
|
580
|
-
| `
|
|
581
|
-
| `
|
|
582
|
-
| `
|
|
583
|
-
| `size` | integer | 每页条数,默认10,建议显式传且不超过1000 |
|
|
757
|
+
|
|
758
|
+
**输入参数(--data)**
|
|
759
|
+
|
|
760
|
+
| 字段 | 类型 | 位置 | 必填 | 说明 |
|
|
761
|
+
| --- | --- | --- | --- | --- |
|
|
762
|
+
| `startDate` | string | body | 是 | 开始日期,格式 yyyy-MM-dd,例如 2026-08-01 |
|
|
763
|
+
| `endDate` | string | body | 是 | 结束日期,格式 yyyy-MM-dd,例如 2026-08-31。最多支持查询近21天 |
|
|
764
|
+
| `dimensionValues` | object | body | 是 | 过滤条件。结构为「字段名 → 取值数组」的键值对(Java 类型 Map<String, List<Object>>),value 必须是数组,即使只筛一个值也要用数组包裹。本接口默认只有 account_id 一个 key 生效;当 dimensions 里传了 country_code 时,额外支持 country_code 作为过滤条件(国家码数组)。其余 key 传入不报错但无过滤效果。示例:{"account_id": ["act_123", "act_456"]} |
|
|
765
|
+
| `dimensions` | array | body | 是 | 分组维度,必传且不能为空数组,否则返回结果为空。各维度含义:calendar_date(投放日期)、account_id(广告账户ID)、account_name(广告账户名称)、campaign_id(广告系列ID)、campaign_name(广告系列名称)、adgroup_id(广告组ID)、adgroup_name(广告组名称)、ad_id(广告ID)、ad_name(广告名称)、optimization_goal(成效目标)、ad_format(创意类型)、bid_strategy(出价方式)、audience_type(受众类型)、targeting_age(年龄)、targeting_genders(性别)、objective(广告目标)、targeting_interests(兴趣词包)、conversion_bid(转化出价)、deep_cpabid(深度转化出价)、country_code(国家,只能单独传或与 calendar_date 两个一起传) |
|
|
766
|
+
| `indicators` | array | body | 是 | 成效指标,必传且不能为空数组。各指标含义:spend_usd(消耗金额,美元)、impressions(曝光量)、clicks(点击量)、video_views(视频观看次数)、add_to_cart(添加购物车次数)、checkouts(发起结账次数)、purchase(购买次数)、purchase_value(购买金额,美元)、installs(应用安装量)、complete_registration(完成注册量)、leads(留下潜客信息次数)、engagement(互动次数) |
|
|
767
|
+
| `order` | string | body | 否 | 排序字段,填单个 code,取值范围为 dimensions 或 indicators 的可选值。不必包含在已传的字段中,服务端会自动补入参与排序,但该字段不会作为列返回 |
|
|
768
|
+
| `orderType` | string | body | 否 | 排序方向,默认 asc |
|
|
769
|
+
| `orders` | object | body | 否 | 多字段排序,结构为「字段名 → 排序方向」的有序键值对(Java 类型 LinkedHashMap<String, String>),按 key 的书写顺序依次排序,方向取值 desc 或 asc。示例:{"spend_usd":"desc","clicks":"asc"}。只需单字段排序时用 order + orderType 即可,不必传本字段。 |
|
|
770
|
+
| `page` | integer | body | 否 | 页码,从1开始,默认1 |
|
|
771
|
+
| `size` | integer | body | 否 | 每页条数,默认10,建议显式传且不超过1000 |
|