/basicOpen/multiplatform/ads/queryGmvCampaignReportList{
"operation": {
"method": "POST",
"path": "/basicOpen/multiplatform/ads/queryGmvCampaignReportList"
},
"protocol": "HTTPS",
"host": "https://openapi.lingxing.com",
"rateLimit": {
"tokenBucketCapacity": 1,
"text": ""
},
"requestExample": "curl --location 'https://openapi.lingxing.com/multiplatform/ads/queryGmvCampaignReportList?access_token=value×tamp=value&sign=value&app_key=value' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"endDate\": \"2024-11-30\",\n \"length\": 20,\n \"page\": 1,\n \"startDate\": \"2024-11-01\",\n \"advertiserIds\": [123456789012345,123456789012346],\n \"bidTypeCodes\": [\"CUSTOM\",\"NO_BID\"],\n \"campaignId\": 1234567890123456789,\n \"campaignIds\": [1234567890,1234567891],\n \"gmvMaxPromotionTypeCodes\": [\"LIVE\",\"PRODUCT\"],\n \"itemGroupIds\": [111111,222222],\n \"orderField\": \"cost\",\n \"orderType\": \"DESC\",\n \"ownerBcIds\": [1001,1002],\n \"scheduleEndDate\": \"2024-12-31\",\n \"scheduleStartDate\": \"2024-11-01\",\n \"status\": [\"ENABLE\",\"DISABLE\"],\n \"storeIds\": [123456,234567],\n \"summaryCurrency\": \"USD\"\n}'",
"responseExample": {
"code": 0,
"message": "success",
"error_details": [],
"request_id": "a0d54debf93140f3b58d1ed81e8e3583.178.17255922733991817",
"response_time": "2024-11-12 16:00:00",
"data": {
"list": [],
"total": 100
},
"total": 1
}
}| 序号 | 字段 | 名称 | 类型 | 默认值 | 必填 | 描述 |
|---|---|---|---|---|---|---|
| 1 | endDate | 结束日期 | string | — | 可选 | 结束日期,必填,格式:yyyy-MM-dd,与开始日期间隔不超过31天 |
| 2 | length | 每页条数 | integer | — | 可选 | 每页条数,必填,小于2000 |
| 3 | page | 页码 | integer | — | 可选 | 页码,必填,从1开始 |
| 4 | startDate | 开始日期 | string | — | 可选 | 开始日期,必填,格式:yyyy-MM-dd |
| 5 | advertiserIds | 广告账号ID列表 | array<any> | — | 可选 | 广告账号ID列表,Long数组,用于筛选特定广告账号 |
| 6 | bidTypeCodes | 优化模式编码列表 | array<any> | — | 可选 | 优化模式编码列表,String数组,枚举值:CUSTOM-目标ROI, NO_BID-最大投放量 |
| 7 | campaignId | 推广系列ID | integer | — | 可选 | 推广系列ID,用于筛选单个推广系列 |
| 8 | campaignIds | 推广系列ID列表 | array<any> | — | 可选 | 推广系列ID列表,Long数组,用于查询多个推广系列 |
| 9 | gmvMaxPromotionTypeCodes | GMV Max类型编码列表 | array<any> | — | 可选 | GMV Max类型编码列表,String数组,枚举值:PRODUCT-商品GMV, LIVE-直播GMV |
| 10 | itemGroupIds | 广告商品ID列表 | array<any> | — | 可选 | 广告商品ID列表,Long数组,用于筛选特定商品 |
| 11 | orderField | 排序字段名称 | string | — | 可选 | 排序字段名称,如:cost, orders, roi |
| 12 | orderType | 排序类型 | string | — | 可选 | 排序类型,枚举值:ASC-升序, DESC-降序 |
| 13 | ownerBcIds | 广告主账号ID列表 | array<any> | — | 可选 | 广告主账号ID列表,Long数组,业务负责人的BC ID列表 |
| 14 | scheduleEndDate | 排期结束日期 | string | — | 可选 | 排期结束日期,格式:yyyy-MM-dd |
| 15 | scheduleStartDate | 排期开始日期 | string | — | 可选 | 排期开始日期,格式:yyyy-MM-dd |
| 16 | status | 推广系列操作状态编码列表 | array<any> | — | 可选 | 推广系列操作状态编码列表,String数组,枚举值:ENABLE-已开启, DISABLE-已暂停, DELETE-已删除 |
| 17 | storeIds | 店铺ID列表 | array<any> | — | 可选 | 店铺ID列表,Long数组,用于筛选特定店铺的数据 |
| 18 | summaryCurrency | 汇总币种编码 | string | — | 可选 | 汇总币种编码,用于统一汇总不同币种的数据 |
| 序号 | 字段 | 名称 | 类型 | 默认值 | 必填 | 描述 |
|---|---|---|---|---|---|---|
| 1 | code | 响应码 | integer | — | 必填 | 响应码 |
| 2 | data | 返回数据 | object | — | 必填 | 返回数据 |
| 2.1 | list | 报告列表 | array<object> | — | 必填 | 报告列表,Report对象数组 |
| 2.1.1 | advertiserId | 广告账号ID | string | 123456789012345 | 必填 | 广告账号ID |
| 2.1.2 | bidTypeCode | 优化模式编码 | string | CUSTOM | 必填 | 优化模式编码,枚举值:CUSTOM-目标ROI, NO_BID-最大投放量 |
| 2.1.3 | bidTypeName | 优化模式名称 | string | 目标ROI | 必填 | 优化模式名称,如:目标ROI、最大投放量 |
| 2.1.4 | campaignId | 推广系列ID | string | 1234567890123456789 | 必填 | 推广系列ID |
| 2.1.5 | campaignName | 推广系列名称 | string | 双十一促销活动 | 必填 | 推广系列名称 |
| 2.1.6 | cost | 成本 | string | 1586.5 | 必填 | 成本,广告花费总金额 |
| 2.1.7 | costPerLiveView | 直播播放平均成本 | string | 0.0104 | 必填 | 直播播放平均成本,计算公式:cost / liveViews |
| 2.1.8 | costPerLiveView10Second | 直播播放达10秒平均成本 | string | 0.0132 | 必填 | 直播播放达10秒平均成本,计算公式:cost / liveViews10Second |
| 2.1.9 | costPerOrder | 平均下单成本 | string | 15.86 | 必填 | 平均下单成本,计算公式:cost / orders |
| 2.1.10 | currencyCode | 币种编码 | string | USD | 必填 | 币种编码,如:USD, CNY, EUR |
| 2.1.11 | currencyRateMissingCount | 币种汇率缺失计数 | string | 0 | 必填 | 币种汇率缺失计数,标识汇率数据缺失的天数 |
| 2.1.12 | endDate | 结束日期 | string | 2024-11-30 | 必填 | 结束日期,格式:yyyy-MM-dd |
| 2.1.13 | gmvMaxPromotionTypeCode | GMV Max类型编码 | string | LIVE | 必填 | GMV Max类型编码,枚举值:PRODUCT-商品GMV, LIVE-直播GMV |
| 2.1.14 | gmvMaxPromotionTypeName | GMV Max类型名称 | string | 直播GMV | 必填 | GMV Max类型名称,如:商品GMV、直播GMV |
| 2.1.15 | grossRevenue | 总收入 | string | 5156.13 | 必填 | 总收入,GMV总金额 |
| 2.1.16 | itemGroups | 商品列表 | array<object> | — | 必填 | 商品列表,ItemGroup对象数组,包含该推广系列关联的商品信息 |
| 2.1.16.1 | campaignId | 推广系列ID | string | 1234567890123456789 | 必填 | 推广系列ID |
| 2.1.16.2 | itemGroupId | 商品SPU ID | string | 111111 | 必填 | 商品SPU ID |
| 2.1.16.3 | orders | 订单数 | string | 25 | 必填 | 订单数,该商品带来的订单量 |
| 2.1.16.4 | productImageUrl | 商品图片URL | string | https://example.com/image/product123.jpg | 必填 | 商品图片URL,商品主图的完整URL地址 |
| 2.1.16.5 | title | 商品标题 | string | TikTok爆款商品 | 必填 | 商品标题,商品的完整标题 |
| 2.1.17 | liveFollows | 直播关注数 | string | 256 | 必填 | 直播关注数,直播间新增关注数量 |
| 2.1.18 | liveViews | 直播播放量 | string | 15230 | 必填 | 直播播放量,直播间总观看次数 |
| 2.1.19 | liveViews10Second | 直播播放达10秒播放量 | string | 12050 | 必填 | 直播播放达10秒播放量,观看超过10秒的次数 |
| 2.1.20 | maxDeliveryBudget | 最大投放量预算 | string | 10000 | 必填 | 最大投放量预算,最大投放量模式下的预算限额 |
| 2.1.21 | netCost | 净成本 | string | 158.5 | 必填 | 净成本,扣除退款等后的实际成本 |
| 2.1.22 | operationStatusCode | 操作状态编码 | string | ENABLE | 必填 | 操作状态编码,枚举值:ENABLE-已开启, DISABLE-已暂停, DELETE-已删除 |
| 2.1.23 | operationStatusName | 操作状态名称 | string | 已开启 | 必填 | 操作状态名称,如:已开启、已暂停、已删除 |
| 2.1.24 | orders | 订单数 | string | 100 | 必填 | 订单数,广告带来的总订单量 |
| 2.1.25 | productSpecificTypeCode | 选择商品的维度编码 | string | DIMENSION_SPU | 必填 | 选择商品的维度编码,标识商品选择的维度类型 |
| 2.1.26 | roasBid | 目标ROI | string | 2.5 | 必填 | 目标ROI,目标ROI模式下设置的目标值 |
| 2.1.27 | roi | ROI(投资回报率) | string | 3.25 | 必填 | ROI(投资回报率),计算公式:grossRevenue / cost |
| 2.1.28 | scheduleEndTime | 排期结束时间 | string | 2024-11-30 23:59:59 | 必填 | 排期结束时间,格式:yyyy-MM-dd HH:mm:ss |
| 2.1.29 | scheduleStartTime | 排期起始时间 | string | 2024-11-01 00:00:00 | 必填 | 排期起始时间,格式:yyyy-MM-dd HH:mm:ss |
| 2.1.30 | startDate | 开始日期 | string | 2024-11-01 | 必填 | 开始日期,格式:yyyy-MM-dd |
| 2.1.31 | storeCode | 店铺编码 | string | STORE_001 | 必填 | 店铺编码 |
| 2.1.32 | storeId | 店铺ID | string | 123456 | 必填 | 店铺ID |
| 2.1.33 | storeName | 店铺名称 | string | TikTok官方旗舰店 | 必填 | 店铺名称 |
| 2.1.34 | subjectId | 报告主体ID | string | 1234567890 | 必填 | 报告主体ID,用于标识报告的唯一性 |
| 2.1.35 | targetRoiBudget | 目标ROI预算 | string | 3 | 必填 | 目标ROI预算,目标ROI模式下的预算限额 |
| 2.1.36 | reportDate | 当startDate与endDate一致时返回 | string | 2024-11-30 | 可选 | 当startDate与endDate一致时返回 |
| 2.2 | total | 总数 | string | 158 | 必填 | 总数,返回符合条件的总记录数 |
| 3 | error_details | 错误详情 | array<any> | — | 必填 | 错误详情 |
| 4 | message | 提示信息 | string | — | 必填 | 提示信息 |
| 5 | request_id | 请求id | string | — | 必填 | 请求id |
| 6 | response_time | 响应时间 | string | — | 必填 | 响应时间 |
| 7 | total | 总记录数 | integer | — | 必填 | 总记录数 |
领星ERP的接口:查询TikTok - GMV MAX - 推广系列(/basicOpen/multiplatform/ads/queryGmvCampaignReportList),由轻易云数据集成平台 API 资产管理模块整理收纳,并随领星ERP版本更新同步更新。