1479 lines
41 KiB
JSON
1479 lines
41 KiB
JSON
{
|
|
"openapi": "3.0.0",
|
|
"info": {
|
|
"title": "DataEngine API",
|
|
"version": "1.0.0",
|
|
"description": "DataEngine 数据引擎 API 文档"
|
|
},
|
|
"servers": [
|
|
{
|
|
"url": "http://localhost:8080",
|
|
"description": "本地环境"
|
|
}
|
|
],
|
|
"paths": {
|
|
"/api/interface/controller/createApiInterface": {
|
|
"post": {
|
|
"tags": ["接口管理"],
|
|
"summary": "创建接口",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"platformId": 1,
|
|
"name": "快手广告接口",
|
|
"code": "KUAISHOU_AD_API",
|
|
"url": "https://ad.e.kuaishou.com/rest/openapi/v1/campaign/list",
|
|
"method": "POST",
|
|
"status": "active",
|
|
"authType": "TOKEN",
|
|
"requestConfig": {
|
|
"headers": {
|
|
"Content-Type": "application/json"
|
|
},
|
|
"params": {
|
|
"advertiserId": "123456"
|
|
}
|
|
},
|
|
"responseConfig": {
|
|
"dataPath": "data.list",
|
|
"totalPath": "data.total"
|
|
},
|
|
"limitConfig": {
|
|
"rateLimitPerMinute": 60
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/interface/controller/listApiInterfaces": {
|
|
"get": {
|
|
"tags": ["接口管理"],
|
|
"summary": "获取接口列表",
|
|
"parameters": [
|
|
{"name": "page", "in": "query", "schema": {"type": "integer", "example": 1}},
|
|
{"name": "pageSize", "in": "query", "schema": {"type": "integer", "example": 10}},
|
|
{"name": "platformId", "in": "query", "schema": {"type": "integer"}},
|
|
{"name": "keyword", "in": "query", "schema": {"type": "string"}}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/interface/controller/getApiInterface": {
|
|
"get": {
|
|
"tags": ["接口管理"],
|
|
"summary": "获取接口详情",
|
|
"parameters": [
|
|
{"name": "id", "in": "query", "required": true, "schema": {"type": "integer"}}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/interface/controller/updateApiInterface": {
|
|
"put": {
|
|
"tags": ["接口管理"],
|
|
"summary": "更新接口",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"id": 1,
|
|
"platformId": 1,
|
|
"name": "快手广告接口",
|
|
"code": "KUAISHOU_AD_API",
|
|
"url": "https://ad.e.kuaishou.com/rest/openapi/v1/campaign/list",
|
|
"method": "POST",
|
|
"status": "active",
|
|
"authType": "TOKEN",
|
|
"requestConfig": {
|
|
"headers": {
|
|
"Content-Type": "application/json"
|
|
}
|
|
},
|
|
"responseConfig": {},
|
|
"limitConfig": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/interface/controller/updateApiInterfaceStatus": {
|
|
"put": {
|
|
"tags": ["接口管理"],
|
|
"summary": "更新接口状态",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"id": 1,
|
|
"status": "active"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/interface/controller/deleteApiInterface": {
|
|
"delete": {
|
|
"tags": ["接口管理"],
|
|
"summary": "删除接口",
|
|
"parameters": [
|
|
{"name": "id", "in": "query", "required": true, "schema": {"type": "integer"}}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/datasource/platform/controller/createDatasourcePlatform": {
|
|
"post": {
|
|
"tags": ["数据源平台管理"],
|
|
"summary": "创建数据源平台",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"platformCode": "KUAISHOU",
|
|
"platformName": "快手平台",
|
|
"description": "快手广告数据源",
|
|
"status": "ACTIVE",
|
|
"apiBaseUrl": "https://ad.e.kuaishou.com",
|
|
"authType": "TOKEN",
|
|
"token": "your_token_here",
|
|
"rateLimitPerMinute": 60,
|
|
"rateLimitPerHour": 1000,
|
|
"concurrencyLimit": 10,
|
|
"requestTimeoutMs": 30000,
|
|
"maxRetries": 3,
|
|
"retryDelayMs": 1000,
|
|
"createdBy": "admin",
|
|
"createdAt": "2026-04-30 10:00:00",
|
|
"updatedBy": "admin",
|
|
"updatedAt": "2026-04-30 10:00:00"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/datasource/platform/controller/listDatasourcePlatforms": {
|
|
"get": {
|
|
"tags": ["数据源平台管理"],
|
|
"summary": "获取数据源平台列表",
|
|
"parameters": [
|
|
{"name": "page", "in": "query", "schema": {"type": "integer", "example": 1}},
|
|
{"name": "pageSize", "in": "query", "schema": {"type": "integer", "example": 10}},
|
|
{"name": "keyword", "in": "query", "schema": {"type": "string"}}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/datasource/platform/controller/getDatasourcePlatform": {
|
|
"get": {
|
|
"tags": ["数据源平台管理"],
|
|
"summary": "获取数据源平台详情",
|
|
"parameters": [
|
|
{"name": "id", "in": "query", "required": true, "schema": {"type": "integer"}}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/datasource/platform/controller/getPlatformByCode": {
|
|
"get": {
|
|
"tags": ["数据源平台管理"],
|
|
"summary": "根据编码获取平台信息",
|
|
"parameters": [
|
|
{"name": "platformCode", "in": "query", "required": true, "schema": {"type": "string"}}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/datasource/platform/controller/updateDatasourcePlatform": {
|
|
"put": {
|
|
"tags": ["数据源平台管理"],
|
|
"summary": "更新数据源平台",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"id": 1,
|
|
"platformCode": "KUAISHOU",
|
|
"platformName": "快手平台",
|
|
"description": "快手广告数据源",
|
|
"status": "ACTIVE",
|
|
"apiBaseUrl": "https://ad.e.kuaishou.com",
|
|
"authType": "TOKEN",
|
|
"token": "your_token_here",
|
|
"rateLimitPerMinute": 60,
|
|
"rateLimitPerHour": 1000,
|
|
"concurrencyLimit": 10,
|
|
"requestTimeoutMs": 30000,
|
|
"maxRetries": 3,
|
|
"retryDelayMs": 1000,
|
|
"updatedBy": "admin",
|
|
"updatedAt": "2026-04-30 10:00:00",
|
|
"version": "1"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/datasource/platform/controller/updateDatasourcePlatformStatus": {
|
|
"put": {
|
|
"tags": ["数据源平台管理"],
|
|
"summary": "更新数据源平台状态",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"id": 1,
|
|
"status": "ACTIVE",
|
|
"updatedBy": "admin"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/datasource/platform/controller/deleteDatasourcePlatform": {
|
|
"delete": {
|
|
"tags": ["数据源平台管理"],
|
|
"summary": "删除数据源平台",
|
|
"parameters": [
|
|
{"name": "id", "in": "query", "required": true, "schema": {"type": "integer"}}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/datasource/platform/controller/testPlatformConnection": {
|
|
"post": {
|
|
"tags": ["数据源平台管理"],
|
|
"summary": "测试平台连接",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"platformCode": "KUAISHOU",
|
|
"apiBaseUrl": "https://ad.e.kuaishou.com",
|
|
"authType": "TOKEN",
|
|
"token": "your_token_here"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/datasource/platform/controller/getPlatformStatistics": {
|
|
"get": {
|
|
"tags": ["数据源平台管理"],
|
|
"summary": "获取平台统计信息",
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/field/mapping/config/controller/field-mapping-configs": {
|
|
"post": {
|
|
"tags": ["字段映射配置"],
|
|
"summary": "创建字段映射配置",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"configName": "快手广告计划ID映射",
|
|
"vendorName": "KUAISHOU",
|
|
"apiName": "campaign.list",
|
|
"apiVersion": "v1",
|
|
"sourceField": "campaign_id",
|
|
"sourceFieldType": "string",
|
|
"sourceFieldDesc": "快手广告计划ID",
|
|
"targetField": "campaignId",
|
|
"targetFieldType": "bigint",
|
|
"targetFieldDesc": "系统广告计划ID",
|
|
"transformType": "direct",
|
|
"transformParams": {},
|
|
"validationRules": {
|
|
"pattern": "^[0-9]+$"
|
|
},
|
|
"defaultValue": "",
|
|
"isRequired": true,
|
|
"isActive": true,
|
|
"priority": 0,
|
|
"businessDomain": "advertising",
|
|
"fieldGroup": "basic",
|
|
"configVersion": 1,
|
|
"createdBy": "admin"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/field/mapping/config/controller/field-mapping-configs": {
|
|
"get": {
|
|
"tags": ["字段映射配置"],
|
|
"summary": "获取字段映射配置列表",
|
|
"parameters": [
|
|
{"name": "page", "in": "query", "schema": {"type": "integer", "example": 1}},
|
|
{"name": "pageSize", "in": "query", "schema": {"type": "integer", "example": 10}},
|
|
{"name": "vendorName", "in": "query", "schema": {"type": "string"}},
|
|
{"name": "apiName", "in": "query", "schema": {"type": "string"}},
|
|
{"name": "keyword", "in": "query", "schema": {"type": "string"}}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/field/mapping/config/controller/field-mapping-configs/{id}": {
|
|
"get": {
|
|
"tags": ["字段映射配置"],
|
|
"summary": "获取字段映射配置详情",
|
|
"parameters": [
|
|
{"name": "id", "in": "query", "required": true, "schema": {"type": "integer"}}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/field/mapping/config/controller/field-mapping-configs/{id}": {
|
|
"put": {
|
|
"tags": ["字段映射配置"],
|
|
"summary": "更新字段映射配置",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"id": 1,
|
|
"configName": "快手广告计划ID映射",
|
|
"vendorName": "KUAISHOU",
|
|
"apiName": "campaign.list",
|
|
"sourceField": "campaign_id",
|
|
"targetField": "campaignId",
|
|
"targetFieldType": "bigint",
|
|
"transformType": "direct",
|
|
"isActive": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/field/mapping/config/controller/field-mapping-configs/{id}/status": {
|
|
"put": {
|
|
"tags": ["字段映射配置"],
|
|
"summary": "更新字段映射配置状态",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"id": 1,
|
|
"isActive": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/field/mapping/config/controller/field-mapping-configs/{id}": {
|
|
"delete": {
|
|
"tags": ["字段映射配置"],
|
|
"summary": "删除字段映射配置",
|
|
"parameters": [
|
|
{"name": "id", "in": "query", "required": true, "schema": {"type": "integer"}}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/field/mapping/config/controller/field-mapping-configs/query": {
|
|
"get": {
|
|
"tags": ["字段映射配置"],
|
|
"summary": "根据厂商和接口查询字段映射",
|
|
"parameters": [
|
|
{"name": "vendorName", "in": "query", "required": true, "schema": {"type": "string"}},
|
|
{"name": "apiName", "in": "query", "required": true, "schema": {"type": "string"}}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/field/mapping/config/controller/field-mapping-configs/validate": {
|
|
"post": {
|
|
"tags": ["字段映射配置"],
|
|
"summary": "验证字段映射配置",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"configName": "测试映射配置",
|
|
"vendorName": "KUAISHOU",
|
|
"apiName": "campaign.list",
|
|
"sourceField": "campaign_id",
|
|
"targetField": "campaignId",
|
|
"testValue": "123456"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/account/report/createCidAccountReportDetail": {
|
|
"post": {
|
|
"tags": ["广告账户数据"],
|
|
"summary": "创建广告数据报表详情",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"dataType": "detail",
|
|
"reportDateStr": "2026-04-30",
|
|
"authorId": "123456789",
|
|
"liveName": "测试直播间",
|
|
"photoId": "photo_001",
|
|
"photoName": "测试视频",
|
|
"creativeMaterialType": "VERTICAL_SCREEN",
|
|
"costTotal": 1000.50,
|
|
"t0OrderPaymentAmt": 5000.00,
|
|
"t0Gmv": 5000.00,
|
|
"t0Roi": 5.0,
|
|
"t0OrderCnt": 50,
|
|
"adEffectivePlayNum": 10000,
|
|
"click": 500,
|
|
"adShow": 10000,
|
|
"impression": 10000,
|
|
"conversionNum": 100,
|
|
"merchantRecoFans": 200
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/account/report/batchCreateCidAccountReportDetail": {
|
|
"post": {
|
|
"tags": ["广告账户数据"],
|
|
"summary": "批量创建广告数据报表详情",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"items": [
|
|
{
|
|
"dataType": "detail",
|
|
"reportDateStr": "2026-04-30",
|
|
"authorId": "123456789",
|
|
"liveName": "测试直播间",
|
|
"photoId": "photo_001",
|
|
"photoName": "测试视频",
|
|
"creativeMaterialType": "VERTICAL_SCREEN",
|
|
"costTotal": 1000.50,
|
|
"t0OrderPaymentAmt": 5000.00,
|
|
"t0Gmv": 5000.00,
|
|
"t0Roi": 5.0,
|
|
"t0OrderCnt": 50,
|
|
"adEffectivePlayNum": 10000,
|
|
"click": 500,
|
|
"adShow": 10000
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/account/report/listCidAccountReportDetail": {
|
|
"get": {
|
|
"tags": ["广告账户数据"],
|
|
"summary": "获取广告数据报表详情列表",
|
|
"parameters": [
|
|
{"name": "page", "in": "query", "schema": {"type": "integer"}},
|
|
{"name": "pageSize", "in": "query", "schema": {"type": "integer"}}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/account/report/createCidAccountReportSum": {
|
|
"post": {
|
|
"tags": ["广告账户数据"],
|
|
"summary": "创建广告账户数据汇总",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"dataType": "sum",
|
|
"reportDateStr": "2026-04-30",
|
|
"authorId": "123456789",
|
|
"liveName": "测试直播间",
|
|
"costTotal": 1000.50,
|
|
"t0OrderPaymentAmt": 5000.00,
|
|
"t0Gmv": 5000.00,
|
|
"t0Roi": 5.0,
|
|
"t0OrderCnt": 50,
|
|
"adShow": 10000,
|
|
"click": 500,
|
|
"impression": 10000,
|
|
"conversionNum": 100
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/account/report/batchCreateCidAccountReportSum": {
|
|
"post": {
|
|
"tags": ["广告账户数据"],
|
|
"summary": "批量创建广告账户数据汇总",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"items": [
|
|
{
|
|
"dataType": "sum",
|
|
"reportDateStr": "2026-04-30",
|
|
"authorId": "123456789",
|
|
"liveName": "测试直播间",
|
|
"costTotal": 1000.50,
|
|
"t0OrderPaymentAmt": 5000.00,
|
|
"t0Gmv": 5000.00,
|
|
"t0Roi": 5.0,
|
|
"t0OrderCnt": 50,
|
|
"adShow": 10000,
|
|
"click": 500
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/account/report/listCidAccountReportSum": {
|
|
"get": {
|
|
"tags": ["广告账户数据"],
|
|
"summary": "获取广告账户数据汇总列表",
|
|
"parameters": [
|
|
{"name": "page", "in": "query", "schema": {"type": "integer"}},
|
|
{"name": "pageSize", "in": "query", "schema": {"type": "integer"}}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/campaign/report/createCampaignReportSum": {
|
|
"post": {
|
|
"tags": ["广告计划报表"],
|
|
"summary": "创建广告计划效果指标表",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"reportDateStr": "2026-04-30",
|
|
"campaignId": 123456,
|
|
"campaignName": "测试计划",
|
|
"unitId": 789,
|
|
"unitName": "测试单元",
|
|
"costTotal": 1000.50,
|
|
"t0Gmv": 5000.00,
|
|
"t0Roi": 5.0,
|
|
"t0OrderCnt": 50,
|
|
"adShow": 10000,
|
|
"click": 500,
|
|
"impression": 10000
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/campaign/report/batchCreateCampaignReportSum": {
|
|
"post": {
|
|
"tags": ["广告计划报表"],
|
|
"summary": "批量创建广告计划效果指标表",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"items": [
|
|
{
|
|
"reportDateStr": "2026-04-30",
|
|
"campaignId": 123456,
|
|
"campaignName": "测试计划",
|
|
"costTotal": 1000.50,
|
|
"t0Gmv": 5000.00,
|
|
"t0Roi": 5.0
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/campaign/report/listCampaignReportSum": {
|
|
"get": {
|
|
"tags": ["广告计划报表"],
|
|
"summary": "获取广告计划效果指标表列表",
|
|
"parameters": [
|
|
{"name": "page", "in": "query", "schema": {"type": "integer"}},
|
|
{"name": "pageSize", "in": "query", "schema": {"type": "integer"}}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/campaign/report/createCampaignReportDetail": {
|
|
"post": {
|
|
"tags": ["广告计划报表"],
|
|
"summary": "创建广告效果指标表明细",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"reportDateStr": "2026-04-30",
|
|
"campaignId": 123456,
|
|
"campaignName": "测试计划",
|
|
"unitId": 789,
|
|
"unitName": "测试单元",
|
|
"ageSegment": "24-30",
|
|
"gender": "女",
|
|
"province": "广东",
|
|
"costTotal": 1000.50,
|
|
"t0Gmv": 5000.00,
|
|
"t0Roi": 5.0
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/campaign/report/batchCreateCampaignReportDetail": {
|
|
"post": {
|
|
"tags": ["广告计划报表"],
|
|
"summary": "批量创建广告效果指标表明细",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"items": [
|
|
{
|
|
"reportDateStr": "2026-04-30",
|
|
"campaignId": 123456,
|
|
"unitId": 789,
|
|
"costTotal": 1000.50,
|
|
"t0Gmv": 5000.00
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/campaign/report/listCampaignReportDetail": {
|
|
"get": {
|
|
"tags": ["广告计划报表"],
|
|
"summary": "获取广告效果指标表明细列表",
|
|
"parameters": [
|
|
{"name": "page", "in": "query", "schema": {"type": "integer"}},
|
|
{"name": "pageSize", "in": "query", "schema": {"type": "integer"}}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/unit/report/createUnitReportSum": {
|
|
"post": {
|
|
"tags": ["广告单元报表"],
|
|
"summary": "创建广告效果指标",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"reportDateStr": "2026-04-30",
|
|
"campaignId": 123456,
|
|
"unitId": 789,
|
|
"unitName": "测试单元",
|
|
"costTotal": 1000.50,
|
|
"t0Gmv": 5000.00,
|
|
"t0Roi": 5.0
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/unit/report/batchCreateUnitReportSum": {
|
|
"post": {
|
|
"tags": ["广告单元报表"],
|
|
"summary": "批量创建广告效果指标",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"items": [
|
|
{
|
|
"reportDateStr": "2026-04-30",
|
|
"unitId": 789,
|
|
"costTotal": 1000.50,
|
|
"t0Gmv": 5000.00
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/unit/report/listUnitReportSum": {
|
|
"get": {
|
|
"tags": ["广告单元报表"],
|
|
"summary": "获取广告效果指标列表",
|
|
"parameters": [
|
|
{"name": "page", "in": "query", "schema": {"type": "integer"}},
|
|
{"name": "pageSize", "in": "query", "schema": {"type": "integer"}}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/unit/report/createUnitReportDetail": {
|
|
"post": {
|
|
"tags": ["广告单元报表"],
|
|
"summary": "创建广告效果指标详情",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"reportDateStr": "2026-04-30",
|
|
"unitId": 789,
|
|
"ageSegment": "24-30",
|
|
"gender": "男",
|
|
"costTotal": 1000.50
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/unit/report/batchCreateUnitReportDetail": {
|
|
"post": {
|
|
"tags": ["广告单元报表"],
|
|
"summary": "批量创建广告效果指标详情",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"items": [
|
|
{
|
|
"reportDateStr": "2026-04-30",
|
|
"unitId": 789,
|
|
"costTotal": 1000.50
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/unit/report/listUnitReportDetail": {
|
|
"get": {
|
|
"tags": ["广告单元报表"],
|
|
"summary": "获取广告效果指标详情列表",
|
|
"parameters": [
|
|
{"name": "page", "in": "query", "schema": {"type": "integer"}},
|
|
{"name": "pageSize", "in": "query", "schema": {"type": "integer"}}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/creative/report/createCreativeReportSum": {
|
|
"post": {
|
|
"tags": ["广告创意报表"],
|
|
"summary": "创建广告效果指标表",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"reportDateStr": "2026-04-30",
|
|
"creativeId": 111,
|
|
"creativeName": "测试创意",
|
|
"costTotal": 1000.50,
|
|
"t0Gmv": 5000.00
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/creative/report/batchCreateCreativeReportSum": {
|
|
"post": {
|
|
"tags": ["广告创意报表"],
|
|
"summary": "批量创建广告效果指标表",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"items": [
|
|
{
|
|
"reportDateStr": "2026-04-30",
|
|
"creativeId": 111,
|
|
"costTotal": 1000.50
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/creative/report/listCreativeReportSum": {
|
|
"get": {
|
|
"tags": ["广告创意报表"],
|
|
"summary": "获取广告效果指标表列表",
|
|
"parameters": [
|
|
{"name": "page", "in": "query", "schema": {"type": "integer"}},
|
|
{"name": "pageSize", "in": "query", "schema": {"type": "integer"}}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/creative/report/createCreativeReportDetail": {
|
|
"post": {
|
|
"tags": ["广告创意报表"],
|
|
"summary": "创建广告创意详情",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"reportDateStr": "2026-04-30",
|
|
"creativeId": 111,
|
|
"creativeMaterialType": "VERTICAL_SCREEN",
|
|
"costTotal": 1000.50
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/creative/report/batchCreateCreativeReportDetail": {
|
|
"post": {
|
|
"tags": ["广告创意报表"],
|
|
"summary": "批量创建广告创意详情",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"items": [
|
|
{
|
|
"reportDateStr": "2026-04-30",
|
|
"creativeId": 111,
|
|
"costTotal": 1000.50
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/creative/report/listCreativeReportDetail": {
|
|
"get": {
|
|
"tags": ["广告创意报表"],
|
|
"summary": "获取广告创意详情列表",
|
|
"parameters": [
|
|
{"name": "page", "in": "query", "schema": {"type": "integer"}},
|
|
{"name": "pageSize", "in": "query", "schema": {"type": "integer"}}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/storewide/report/createStorewideReportSum": {
|
|
"post": {
|
|
"tags": ["全站数据报表"],
|
|
"summary": "创建广告效果指标表",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"reportDateStr": "2026-04-30",
|
|
"costTotal": 1000.50,
|
|
"t0Gmv": 5000.00
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/storewide/report/batchCreateStorewideReportSum": {
|
|
"post": {
|
|
"tags": ["全站数据报表"],
|
|
"summary": "批量创建广告效果指标表",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"items": [
|
|
{
|
|
"reportDateStr": "2026-04-30",
|
|
"costTotal": 1000.50
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/storewide/report/listStorewideReportSum": {
|
|
"get": {
|
|
"tags": ["全站数据报表"],
|
|
"summary": "获取广告效果指标表列表",
|
|
"parameters": [
|
|
{"name": "page", "in": "query", "schema": {"type": "integer"}},
|
|
{"name": "pageSize", "in": "query", "schema": {"type": "integer"}}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/storewide/report/createStorewideReportDetail": {
|
|
"post": {
|
|
"tags": ["全站数据报表"],
|
|
"summary": "创建广告效果指标表详情",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"reportDateStr": "2026-04-30",
|
|
"ageSegment": "24-30",
|
|
"costTotal": 1000.50
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/storewide/report/batchCreateStorewideReportDetail": {
|
|
"post": {
|
|
"tags": ["全站数据报表"],
|
|
"summary": "批量创建广告效果指标表详情",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"items": [
|
|
{
|
|
"reportDateStr": "2026-04-30",
|
|
"costTotal": 1000.50
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/storewide/report/listStorewideReportDetail": {
|
|
"get": {
|
|
"tags": ["全站数据报表"],
|
|
"summary": "获取广告效果指标表详情列表",
|
|
"parameters": [
|
|
{"name": "page", "in": "query", "schema": {"type": "integer"}},
|
|
{"name": "pageSize", "in": "query", "schema": {"type": "integer"}}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/material/report/createMaterialReport": {
|
|
"post": {
|
|
"tags": ["素材报表"],
|
|
"summary": "创建素材报表数据",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"reportDateStr": "2026-04-30",
|
|
"authorId": "123456789",
|
|
"photoId": "photo_001",
|
|
"photoName": "测试素材",
|
|
"costTotal": 1000.50,
|
|
"t0Gmv": 5000.00
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/material/report/batchCreateMaterialReport": {
|
|
"post": {
|
|
"tags": ["素材报表"],
|
|
"summary": "批量创建素材报表数据",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"items": [
|
|
{
|
|
"reportDateStr": "2026-04-30",
|
|
"authorId": "123456789",
|
|
"photoId": "photo_001",
|
|
"costTotal": 1000.50
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/material/report/listMaterialReport": {
|
|
"get": {
|
|
"tags": ["素材报表"],
|
|
"summary": "获取素材报表数据列表",
|
|
"parameters": [
|
|
{"name": "page", "in": "query", "schema": {"type": "integer", "example": 1}},
|
|
{"name": "pageSize", "in": "query", "schema": {"type": "integer", "example": 10}},
|
|
{"name": "reportDateStr", "in": "query", "schema": {"type": "string"}},
|
|
{"name": "authorId", "in": "query", "schema": {"type": "string"}},
|
|
{"name": "keyword", "in": "query", "schema": {"type": "string"}}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/population/report/createPopulationReport": {
|
|
"post": {
|
|
"tags": ["人群报表"],
|
|
"summary": "创建人群报表数据",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"reportDateStr": "2026-04-30",
|
|
"campaignId": 123456,
|
|
"ageSegment": "24-30",
|
|
"gender": "女",
|
|
"province": "广东",
|
|
"costTotal": 1000.50
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/population/report/batchCreatePopulationReport": {
|
|
"post": {
|
|
"tags": ["人群报表"],
|
|
"summary": "批量创建人群报表数据",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"items": [
|
|
{
|
|
"reportDateStr": "2026-04-30",
|
|
"campaignId": 123456,
|
|
"costTotal": 1000.50
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/population/report/listPopulationReport": {
|
|
"post": {
|
|
"tags": ["人群报表"],
|
|
"summary": "查询人群报表数据列表",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"page": 1,
|
|
"pageSize": 10,
|
|
"reportDateStr": "2026-04-30",
|
|
"campaignId": 123456
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/task/report/createTaskReport": {
|
|
"post": {
|
|
"tags": ["调控任务报表"],
|
|
"summary": "创建调控任务数据",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"reportDateStr": "2026-04-30",
|
|
"taskId": "task_001",
|
|
"taskName": "测试任务",
|
|
"photoId": "photo_001",
|
|
"costTotal": 1000.50
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/task/report/batchCreateTaskReport": {
|
|
"post": {
|
|
"tags": ["调控任务报表"],
|
|
"summary": "批量创建调控任务数据",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"example": {
|
|
"items": [
|
|
{
|
|
"reportDateStr": "2026-04-30",
|
|
"taskId": "task_001",
|
|
"costTotal": 1000.50
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/task/report/listTaskReport": {
|
|
"get": {
|
|
"tags": ["调控任务报表"],
|
|
"summary": "获取调控任务数据列表",
|
|
"parameters": [
|
|
{"name": "page", "in": "query", "schema": {"type": "integer", "example": 1}},
|
|
{"name": "pageSize", "in": "query", "schema": {"type": "integer", "example": 10}},
|
|
{"name": "reportDateStr", "in": "query", "schema": {"type": "string"}},
|
|
{"name": "photoId", "in": "query", "schema": {"type": "string"}},
|
|
{"name": "keyword", "in": "query", "schema": {"type": "string"}}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "成功"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"components": {
|
|
"schemas": {}
|
|
}
|
|
}
|