/basicOpen/multiplatform/ads/reportCampaignSvList{
"operation": {
"method": "POST",
"path": "/basicOpen/multiplatform/ads/reportCampaignSvList"
},
"protocol": "HTTPS",
"host": "https://openapi.lingxing.com",
"rateLimit": {
"tokenBucketCapacity": 1,
"text": ""
},
"requestExample": "curl --location 'https://openapi.lingxing.com/basicOpen/multiplatform/ads/reportCampaignSvList?access_token=value×tamp=value&sign=value&app_key=value' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"advertiserIds\": [123456789012345],\n \"campaignType\": [\"video\"],\n \"day\": 14,\n \"endDate\": \"2024-11-12\",\n \"operationSourceType\": \"gateway\",\n \"pageNum\": 1,\n \"pageSize\": 20,\n \"paging\": \"1\",\n \"startDate\": \"2024-11-01\",\n \"campaignIds\": [10001,10002],\n \"orderField\": \"adSpend\",\n \"orderType\": \"DESC\",\n \"searchText\": \"Black Friday Campaign\",\n \"status\": [\"enabled\",\"live\"]\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
}
}| No. | Field | Name | Type | Default | Required | Description |
|---|---|---|---|---|---|---|
| 1 | advertiserIds | 广告账号ID列表 | array<any> | — | Optional | 广告账号ID列表,BigInteger数组,必填,必须至少选择一个店铺 |
| 2 | campaignType | 广告活动类型列表 | array<any> | — | Optional | 广告活动类型列表,String数组,必填,枚举值:sponsoredProducts-manual(SP手动), sponsoredProducts-auto(SP自动), sba(SB品牌广告), video(SV视频广告)。注意:查询SV广告报告必须且只能携带video |
| 3 | day | 归因天数 | integer | — | Optional | 归因天数,必填,数据归因天数,枚举值:3, 14, 30 |
| 4 | endDate | 结束日期 | string | — | Optional | 结束日期,必填,格式:yyyy-MM-dd,且 startDate 和 endDate 间隔不能超过31天 |
| 5 | operationSourceType | 操作来源 | string | — | Optional | 操作来源,必填,openapi调用必传gateway,前端传web |
| 6 | pageNum | 页码 | integer | — | Optional | 页码,必填,分页时的页码,从1开始 |
| 7 | pageSize | 每页大小 | integer | — | Optional | 每页大小,必填,openapi必传且小于2000 |
| 8 | paging | 是否分页 | boolean | — | Optional | 是否分页,必填,openapi必填true |
| 9 | startDate | 开始日期 | string | — | Optional | 开始日期,必填,格式:yyyy-MM-dd,且 startDate 和 endDate 间隔不能超过31天 |
| 10 | campaignIds | 广告活动ID列表 | array<any> | — | Optional | 广告活动ID列表,Long数组,指定查询的广告活动ID,支持批量查询 |
| 11 | orderField | 排序字段 | string | — | Optional | 排序字段,支持对查询结果中的任意字段进行排序(驼峰命名)。包括但不限于: 基础指标(numAdsShown/numAdsClicks/adSpend)、销售指标(attributedSales/attributedOrders/attributedUnits/advertisedSkuSales/advertisedSkuUnits)、关联指标(otherSkuSales/otherSkuUnits)、品牌新买家指标(ntbOrders/ntbRevenue/ntbUnits)、计算指标(cpc/ctr/cvr/acos/roas/aov/cpa)、时间字段(startDate/endDate/entityCreateAt)等所有返回的报表字段。不传时默认按广告花费倒序 |
| 12 | orderType | 排序类型 | string | — | Optional | 排序类型,枚举值:ASC-升序, DESC-降序,不传时默认ASC |
| 13 | searchText | 搜索文本 | string | — | Optional | 搜索文本,模糊搜索广告活动名称 |
| 14 | status | 广告活动状态列表 | array<any> | — | Optional | 广告活动状态列表,String数组,枚举值:enabled-启用, paused-暂停, scheduled-已安排, rescheduled-重新安排, live-运行中, proposal-提议, completed-已完成 |
| No. | Field | Name | Type | Default | Required | Description |
|---|---|---|---|---|---|---|
| 1 | code | 响应码 | integer | — | Required | 响应码 |
| 2 | data | 返回数据 | object | — | Required | 返回数据 |
| 2.1 | list | 列表数据 | array<object> | — | Required | 列表数据,ReportAllCampaignListRecordDTO数组,包含广告活动的详细报表信息 |
| 2.1.1 | acos | 广告成本占比ACOS | string | 28.5 | Required | 广告成本占比ACOS,计算公式: 广告花费 / 广告销售额 * 100% |
| 2.1.2 | adSpend | 广告花费 | string | 2500 | Required | 广告花费 |
| 2.1.3 | advertisedSkuSales | 直接销售额 | string | 6800 | Required | 直接销售额,广告直接点击归因销售额 |
| 2.1.4 | advertisedSkuUnits | 直接销量 | string | 180 | Required | 直接销量,广告直接点击归因销量 |
| 2.1.5 | advertiserId | 广告账号ID | string | 123456789012345 | Required | 广告账号ID |
| 2.1.6 | aov | 平均订单值AOV | string | 35.5 | Required | 平均订单值AOV,计算公式: 广告销售额 / 广告订单 |
| 2.1.7 | appliedTemplate | 应用的分时策略模板信息 | array<object> | — | Required | 应用的分时策略模板信息,AppliedTemplate对象数组 |
| 2.1.7.1 | benchmarkFixedVal | 基准固定值 | string | 1.5 | Required | 基准固定值,分时策略的固定基准值 |
| 2.1.7.2 | benchmarkType | 基准类型 | string | 1 | Required | 基准类型,枚举值:1-固定值, 2-动态值 |
| 2.1.7.3 | curBenchmarkVal | 当前基准值 | string | 1.8 | Required | 当前基准值,当前实际使用的基准值 |
| 2.1.7.4 | effectiveTime | 生效时间范围 | object | — | Required | 生效时间范围,EffectiveTime对象 |
| 2.1.7.4.1 | begin | 开始时间 | string | 2024-01-01 00:00:00 | Required | 开始时间,格式:yyyy-MM-dd HH:mm:ss |
| 2.1.7.4.2 | end | 结束时间 | string | 2024-12-31 23:59:59 | Required | 结束时间,格式:yyyy-MM-dd HH:mm:ss |
| 2.1.7.5 | id | 模板ID | string | 100234 | Required | 模板ID,分时策略模板的唯一标识 |
| 2.1.7.6 | taskName | 任务名称 | string | 晚高峰竞价提升策略 | Required | 任务名称,分时策略任务名称 |
| 2.1.7.7 | taskStatus | 任务状态 | string | 1 | Required | 任务状态,枚举值:0-未启用, 1-已启用, 2-已暂停 |
| 2.1.7.8 | taskType | 任务类型 | string | BID_ADJUSTMENT | Required | 任务类型,枚举值:BID_ADJUSTMENT-竞价调整, STATUS_CONTROL-状态控制, BUDGET_ADJUSTMENT-预算调整 |
| 2.1.7.9 | timezone | 时区 | string | America/Los_Angeles | Required | 时区,如:America/Los_Angeles |
| 2.1.8 | attributedOrders | 广告订单数 | string | 135 | Required | 广告订单数,归因总订单数 |
| 2.1.9 | attributedSales | 广告销售额 | string | 8500 | Required | 广告销售额,归因总销售额 |
| 2.1.10 | attributedUnits | 广告销量 | string | 250 | Required | 广告销量,归因总销量 |
| 2.1.11 | benchmarkVal | 基准值 | string | 1.5 | Required | 基准值,分时策略的基准值 |
| 2.1.12 | biddingStrategy | 竞价策略 | object | {"type":"auto","adjustments":[]} | Required | 竞价策略,JSON格式字符串 |
| 2.1.12.1 | biddingStrategyStatus | 竞价策略状态 | string | active | Required | 竞价策略状态,strategy为TROAS时返回 |
| 2.1.12.2 | strategy | 竞价策略 | string | TROAS | Required | 竞价策略,枚举值:DYNAMIC - 动态竞价,FIXED - 固定竞价, TROAS - 目标竞价 |
| 2.1.12.3 | troas | 支出回报率 | string | 5 | Required | 支出回报率,strategy为TROAS时返回 |
| 2.1.13 | budgetType | 预算类型 | string | daily | Required | 预算类型,枚举值:daily-每日预算, total-总预算, both-两者都有 |
| 2.1.14 | campaignId | 广告活动ID | string | 987654321 | Required | 广告活动ID |
| 2.1.15 | campaignName | 广告活动名称 | string | Holiday Video Campaign 2024 | Required | 广告活动名称 |
| 2.1.16 | campaignStatus | 广告活动状态 | string | live | Required | 广告活动状态,枚举值:enabled-启用, paused-暂停, scheduled-已安排, rescheduled-重新安排, live-运行中, proposal-提议, completed-已完成 |
| 2.1.17 | campaignType | 广告活动类型 | string | video | Required | 广告活动类型,枚举值:sponsoredProducts-SP广告, sba-SB品牌广告, video-SV视频广告 |
| 2.1.18 | completeViewRevenue | 完整观看收入 | string | 1250 | Required | 完整观看收入,【仅SV视频广告】 |
| 2.1.19 | cpa | 平均订单成本CPA | string | 8.5 | Required | 平均订单成本CPA,计算公式: 广告花费 / 广告订单 |
| 2.1.20 | cpc | 点击成本CPC | string | 0.85 | Required | 点击成本CPC,计算公式: 广告花费 / 点击量 |
| 2.1.21 | ctr | 点击率CTR | string | 2.5 | Required | 点击率CTR,计算公式: 点击量 / 曝光量 * 100% |
| 2.1.22 | cvr | 转化率CVR | string | 9 | Required | 转化率CVR,计算公式: 广告订单 / 点击量 * 100% |
| 2.1.23 | dailyBudget | 广告活动每日预算 | string | 500 | Required | 广告活动每日预算 |
| 2.1.24 | endDate | 广告活动结束日期 | string | 2024-12-31 | Required | 广告活动结束日期,格式:yyyy-MM-dd |
| 2.1.25 | entityCreateAt | 创建时间 | string | 2024-01-15 | Required | 创建时间,实体创建时间 |
| 2.1.26 | haloCompleteViewRevenue | 光晕完整观看收入 | string | 850 | Required | 光晕完整观看收入,【仅SV视频广告】 |
| 2.1.27 | isApplyTime | 是否应用分时策略 | string | 1 | Required | 是否应用分时策略,分时策略相关 |
| 2.1.28 | key | 唯一键 | string | 987654321 | Required | 唯一键,用于前端列表展示 |
| 2.1.29 | mpAdvertiserName | 广告账号名称 | string | Walmart US Main Account | Required | 广告账号名称 |
| 2.1.30 | mpSellerName | 店铺名称 | string | MyWalmartStore | Required | 店铺名称 |
| 2.1.31 | ntbOrderRate | 品牌新买家订单转化率 | string | 1.33 | Required | 品牌新买家订单转化率,计算公式: ntbOrders / numAdsClicks * 100% |
| 2.1.32 | ntbOrders | 品牌新买家订单数 | string | 20 | Required | 品牌新买家订单数 |
| 2.1.33 | ntbOrdersPercent | 品牌新买家订单占比 | string | 15.5 | Required | 品牌新买家订单占比,计算公式: ntbOrders / attributedOrders * 100% |
| 2.1.34 | ntbRevenue | 品牌新买家销售额 | string | 5500 | Required | 品牌新买家销售额 |
| 2.1.35 | ntbRevenuePercent | 品牌新买家销售额占比 | string | 64.7 | Required | 品牌新买家销售额占比,计算公式: ntbRevenue / attributedSales * 100% |
| 2.1.36 | ntbUnits | 品牌新买家销量 | string | 40 | Required | 品牌新买家销量 |
| 2.1.37 | ntbUnitsPercent | 品牌新买家销量占比 | string | 16 | Required | 品牌新买家销量占比,计算公式: ntbUnits / attributedUnits * 100% |
| 2.1.38 | numAdsClicks | 广告点击量 | string | 1500 | Required | 广告点击量 |
| 2.1.39 | numAdsShown | 曝光次数 | string | 60000 | Required | 曝光次数 |
| 2.1.40 | otherSkuSales | 关联销售额 | string | 1700 | Required | 关联销售额,间接归因销售额 |
| 2.1.41 | otherSkuUnits | 关联销量 | string | 70 | Required | 关联销量,间接归因销量 |
| 2.1.42 | reportTag | 报表标签 | string | REALTIME | Required | 报表标签,枚举值:REALTIME-实时数据标识 |
| 2.1.43 | roas | 投入产出比ROAS | string | 3.5 | Required | 投入产出比ROAS,计算公式: 广告销售额 / 广告花费 |
| 2.1.44 | rollover | 是否结转 | string | 1 | Required | 是否结转,前一天未用的每日预算是否应结转到第二天的每日预算 |
| 2.1.45 | startDate | 广告活动开始日期 | string | 2024-01-01 | Required | 广告活动开始日期,格式:yyyy-MM-dd |
| 2.1.46 | targetingType | 投放类型 | string | manual | Required | 投放类型,枚举值:manual-手动投放, auto-自动投放 |
| 2.1.47 | totalBudget | 广告活动总预算 | string | 10000 | Required | 广告活动总预算 |
| 2.1.48 | totalCompleteViewOrders | 完整观看订单总数 | string | 45 | Required | 完整观看订单总数,【仅SV视频广告】 |
| 2.1.49 | totalCompleteViewUnits | 完整观看销量总数 | string | 55 | Required | 完整观看销量总数,【仅SV视频广告】 |
| 2.1.50 | video5SecondViews | 视频5秒观看次数 | string | 1200 | Required | 视频5秒观看次数,【仅SV视频广告】 |
| 2.1.51 | videoCompleteViews | 视频完整观看次数 | string | 350 | Required | 视频完整观看次数,【仅SV视频广告】 |
| 2.1.52 | videoFirstQuartileViews | 视频第一四分位观看次数 | string | 800 | Required | 视频第一四分位观看次数,【仅SV视频广告】 |
| 2.1.53 | videoImpressions | 视频曝光量 | string | 50000 | Required | 视频曝光量,【仅SV视频广告】 |
| 2.1.54 | videoMidpointViews | 视频中点观看次数 | string | 600 | Required | 视频中点观看次数,【仅SV视频广告】 |
| 2.1.55 | videoThirdQuartileViews | 视频第三四分位观看次数 | string | 450 | Required | 视频第三四分位观看次数,【仅SV视频广告】 |
| 2.1.56 | videoUnmutes | 视频取消静音次数 | string | 95 | Required | 视频取消静音次数,【仅SV视频广告】 |
| 2.1.57 | viewThroughOrders | 浏览订单数 | string | 30 | Required | 浏览订单数,【仅SV视频广告】 |
| 2.1.58 | viewThroughSales | 浏览销售额 | string | 3500 | Required | 浏览销售额,【仅SV视频广告】 |
| 2.1.59 | viewThroughUnitsSold | 浏览销量 | string | 120 | Required | 浏览销量,【仅SV视频广告】 |
| 2.1.60 | viewableImpressions | 可见曝光量 | string | 45000 | Required | 可见曝光量,【仅SV视频广告】 |
| 2.2 | total | 总记录数 | string | 100 | Required | 总记录数,返回符合查询条件的数据总数 |
| 3 | error_details | 错误详情 | array<any> | — | Required | 错误详情 |
| 4 | message | 提示信息 | string | — | Required | 提示信息 |
| 5 | request_id | 请求id | string | — | Required | 请求id |
| 6 | response_time | 响应时间 | string | — | Required | 响应时间 |
| 7 | total | 总记录数 | integer | — | Required | 总记录数 |
The 查询沃尔玛 - 广告 - SV广告 - 广告活动 API (/basicOpen/multiplatform/ads/reportCampaignSvList) of 领星ERP is curated by the API asset management module of the Qeasy Cloud data integration platform and kept in sync with 领星ERP version updates.
Qeasy ships with prebuilt adaptation for this API — contact us to start configuring data integration.