/basicOpen/multiplatform/ads/queryReportPageTypeSvList{
"operation": {
"method": "POST",
"path": "/basicOpen/multiplatform/ads/queryReportPageTypeSvList"
},
"protocol": "HTTPS",
"host": "https://openapi.lingxing.com",
"rateLimit": {
"tokenBucketCapacity": 1,
"text": ""
},
"requestExample": "curl --location 'https://openapi.lingxing.com/basicOpen/multiplatform/ads/queryReportPageTypeSvList?access_token=value×tamp=value&sign=value&app_key=value' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"advertiserIds\": [123456789012345,987654321098765],\n \"campaignType\": [\"video\"],\n \"endDate\": \"2024-12-31\",\n \"startDate\": \"2024-01-01\",\n \"adGroupIds\": [123456789,987654321],\n \"campaignIds\": [123456789,987654321],\n \"companyId\": 123456,\n \"day\": 14,\n \"operationSourceType\": \"web\",\n \"orderField\": \"adSpend\",\n \"orderType\": \"DESC\",\n \"pageNum\": 1,\n \"pageSize\": 20,\n \"pageType\": [\"search\",\"item\"],\n \"paging\": \"1\",\n \"searchText\": \"春季促销活动\",\n \"searchType\": \"value\",\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
}
}| 序号 | 字段 | 名称 | 类型 | 默认值 | 必填 | 描述 |
|---|---|---|---|---|---|---|
| 1 | advertiserIds | 广告账号ID列表 | array<any> | — | 可选 | 广告账号ID列表,BigInteger数组,必填,必须至少选择一个店铺 |
| 2 | campaignType | 广告活动类型列表 | array<any> | — | 可选 | 广告活动类型列表,String数组,必填,枚举值:sponsoredProducts-manual(SP手动), sponsoredProducts-auto(SP自动), sba(SB品牌广告), video(SV视频广告)。注意:查询SV广告报告必须且只能携带video |
| 3 | endDate | 结束日期 | string | — | 可选 | 结束日期,必填,格式:yyyy-MM-dd,且 startDate 和 endDate 间隔不能超过31天 |
| 4 | startDate | 开始日期 | string | — | 可选 | 开始日期,必填,格式:yyyy-MM-dd,且 startDate 和 endDate 间隔不能超过31天 |
| 5 | adGroupIds | 广告组ID列表 | array<any> | — | 可选 | 广告组ID列表,Long数组,按广告组ID筛选 |
| 6 | campaignIds | 广告活动ID列表 | array<any> | — | 可选 | 广告活动ID列表,Long数组,按广告活动ID筛选 |
| 7 | companyId | 公司ID | integer | — | 可选 | 公司ID |
| 8 | day | 归因天数 | integer | — | 可选 | 归因天数,数据归因天数,枚举值:3, 14, 30,默认14天 |
| 9 | operationSourceType | 操作来源 | string | — | 可选 | 操作来源,默认网页操作 |
| 10 | orderField | 排序字段 | string | — | 可选 | 排序字段,支持对查询结果中的任意字段进行排序(驼峰命名)。包括:基础指标(numAdsShown/numAdsClicks/adSpend)、销售指标(attributedSales/attributedOrders/attributedUnits/advertisedSkuSales/advertisedSkuUnits)、关联指标(otherSkuSales/otherSkuUnits)、品牌新买家指标(ntbOrders/ntbRevenue/ntbUnits)、计算指标(cpc/ctr/cvr/acos/roas/aov/cpa)、时间字段(startDate/endDate/entityCreateAt)等所有返回的报表字段。不传时默认按广告花费倒序 |
| 11 | orderType | 排序类型 | string | — | 可选 | 排序类型,枚举值:ASC-升序, DESC-降序,不传时默认ASC |
| 12 | pageNum | 页码 | integer | — | 可选 | 页码,分页时的页码,从1开始 |
| 13 | pageSize | 每页大小 | integer | — | 可选 | 每页大小,分页时每页显示的记录数,最大200 |
| 14 | pageType | 页面类型列表 | array<any> | — | 可选 | 页面类型列表,String数组,枚举值:browse-浏览, item-商品, search-搜索, topic-主题, category-分类, homepage-首页, other-其他 |
| 15 | paging | 是否分页 | boolean | — | 可选 | 是否分页,默认为true |
| 16 | searchText | 搜索文本 | string | — | 可选 | 搜索文本,模糊搜索广告活动名称(campaign_name) |
| 17 | searchType | 搜索类型 | string | — | 可选 | 搜索类型,目前不用传 |
| 18 | status | 广告活动状态列表 | array<any> | — | 可选 | 广告活动状态列表,String数组,枚举值:enabled-启用, paused-暂停, scheduled-已安排, rescheduled-重新安排, live-运行中, proposal-提议, completed-已完成 |
| 序号 | 字段 | 名称 | 类型 | 默认值 | 必填 | 描述 |
|---|---|---|---|---|---|---|
| 1 | code | 响应码 | integer | — | 必填 | 响应码 |
| 2 | data | 返回数据 | object | — | 必填 | 返回数据 |
| 2.1 | list | 列表数据 | array<object> | — | 必填 | 列表数据,页面类型报表详细数据列表 |
| 2.1.1 | acos | 广告成本销售比(ACoS) | string | 18.5 | 必填 | 广告成本销售比(ACoS),计算公式:adSpend / attributedSales * 100% |
| 2.1.2 | adGroupId | 广告组ID | string | 456789123 | 必填 | 广告组ID,广告组的唯一标识 |
| 2.1.3 | adGroupName | 广告组名称 | string | 双十一大促广告组 | 必填 | 广告组名称 |
| 2.1.4 | adSpend | 广告花费 | string | 567.89 | 必填 | 广告花费,广告投放的总花费金额 |
| 2.1.5 | advertisedSkuSales | 广告SKU销售额 | string | 5678.9 | 必填 | 广告SKU销售额,直接被广告的SKU的销售额 |
| 2.1.6 | advertisedSkuUnits | 广告SKU销量 | string | 156 | 必填 | 广告SKU销量,直接被广告的SKU的销售数量 |
| 2.1.7 | advertiserId | 广告账号ID | string | 987654321098765 | 必填 | 广告账号ID,广告账号的唯一标识 |
| 2.1.8 | aov | 平均订单价值(AOV) | string | 56.78 | 必填 | 平均订单价值(AOV),计算公式:attributedSales / attributedOrders |
| 2.1.9 | attributedOrders | 归因订单数 | string | 125 | 必填 | 归因订单数,广告产生的订单总数 |
| 2.1.10 | attributedSales | 归因销售额 | string | 7890.12 | 必填 | 归因销售额,广告产生的总销售额 |
| 2.1.11 | attributedUnits | 归因销量 | string | 234 | 必填 | 归因销量,广告产生的总销售数量 |
| 2.1.12 | campaignAndTargetingName | 广告活动和定向名称 | string | 双十一大促-搜索定向 | 必填 | 广告活动和定向名称,广告活动名称和定向条件的组合显示 |
| 2.1.13 | campaignId | 广告活动ID | string | 123456789 | 必填 | 广告活动ID,广告活动的唯一标识 |
| 2.1.14 | campaignName | 广告活动名称 | string | 双十一大促活动 | 必填 | 广告活动名称 |
| 2.1.15 | campaignStatus | 广告活动状态 | string | enabled | 必填 | 广告活动状态,枚举值:enabled-启用, paused-暂停, scheduled-已安排, rescheduled-重新安排, live-运行中, proposal-提议, completed-已完成 |
| 2.1.16 | campaignType | 广告活动类型 | string | video | 必填 | 广告活动类型,枚举值:sponsoredProducts-manual(SP手动), sponsoredProducts-auto(SP自动), sba(SB品牌广告), video(SV视频广告) |
| 2.1.17 | cpa | 单次转化成本(CPA) | string | 4.56 | 必填 | 单次转化成本(CPA),计算公式:adSpend / attributedOrders |
| 2.1.18 | cpc | 单次点击成本(CPC) | string | 0.52 | 必填 | 单次点击成本(CPC),计算公式:adSpend / numAdsClicks |
| 2.1.19 | ctr | 点击率(CTR) | string | 2.45 | 必填 | 点击率(CTR),计算公式:numAdsClicks / numAdsShown * 100% |
| 2.1.20 | cvr | 转化率(CVR) | string | 3.62 | 必填 | 转化率(CVR),计算公式:attributedOrders / numAdsClicks * 100% |
| 2.1.21 | date | 日期 | string | 2024-11-12 | 必填 | 日期,数据统计日期,格式:yyyy-MM-dd |
| 2.1.22 | entityCreateAt | 实体创建时间 | string | 2024-11-12 10:30:00 | 必填 | 实体创建时间,记录创建的时间戳 |
| 2.1.23 | inStoreAdvertisedSales | 店内广告销售额 | string | 2345.67 | 必填 | 店内广告销售额,线下店铺广告产生的销售额 |
| 2.1.24 | inStoreAttributedSales | 店内归因销售额 | string | 3456.78 | 必填 | 店内归因销售额,线下店铺广告直接产生的销售额 |
| 2.1.25 | inStoreOrders | 店内订单数 | string | 87 | 必填 | 店内订单数,线下店铺产生的订单数量 |
| 2.1.26 | inStoreOtherSales | 店内其他销售额 | string | 1234.56 | 必填 | 店内其他销售额,线下店铺其他SKU的销售额 |
| 2.1.27 | inStoreUnitsSold | 店内销售数量 | string | 234 | 必填 | 店内销售数量,线下店铺销售的商品数量 |
| 2.1.28 | key | 唯一标识键 | string | 20241112_456789123_search | 必填 | 唯一标识键,用于区分每条记录的唯一键值 |
| 2.1.29 | mpAdvertiserName | 多平台广告商名称 | string | Walmart广告账号A | 必填 | 多平台广告商名称,广告账号的名称 |
| 2.1.30 | mpSellerName | 多平台卖家名称 | string | Walmart官方旗舰店 | 必填 | 多平台卖家名称,平台上的店铺/卖家名称 |
| 2.1.31 | ntbOrderRate | 新品牌买家订单率 | string | 36 | 必填 | 新品牌买家订单率,与ntbOrdersPercent相同,计算公式:ntbOrders / attributedOrders * 100% |
| 2.1.32 | ntbOrders | 新品牌买家订单数 | string | 45 | 必填 | 新品牌买家订单数,首次购买该品牌的买家产生的订单数 |
| 2.1.33 | ntbOrdersPercent | 新品牌买家订单占比 | string | 32.5 | 必填 | 新品牌买家订单占比,计算公式:ntbOrders / attributedOrders * 100% |
| 2.1.34 | ntbRevenue | 新品牌买家销售额 | string | 2345.67 | 必填 | 新品牌买家销售额,首次购买该品牌的买家产生的销售额 |
| 2.1.35 | ntbRevenuePercent | 新品牌买家销售额占比 | string | 28.5 | 必填 | 新品牌买家销售额占比,计算公式:ntbRevenue / attributedSales * 100% |
| 2.1.36 | ntbUnits | 新品牌买家销量 | string | 38 | 必填 | 新品牌买家销量,首次购买该品牌的买家购买数量 |
| 2.1.37 | ntbUnitsPercent | 新品牌买家销量占比 | string | 30.5 | 必填 | 新品牌买家销量占比,计算公式:ntbUnits / attributedUnits * 100% |
| 2.1.38 | numAdsClicks | 广告点击次数 | string | 3456 | 必填 | 广告点击次数,广告被点击的总次数 |
| 2.1.39 | numAdsShown | 广告展示次数 | string | 145678 | 必填 | 广告展示次数,广告被展示的总次数 |
| 2.1.40 | otherSkuSales | 其他SKU销售额 | string | 1234.56 | 必填 | 其他SKU销售额,广告带来的非直接关联SKU的销售额 |
| 2.1.41 | otherSkuUnits | 其他SKU销量 | string | 78 | 必填 | 其他SKU销量,广告带来的非直接关联SKU的销售数量 |
| 2.1.42 | pageType | 页面类型 | string | search | 必填 | 页面类型,广告展示的页面类型,枚举值:browse-浏览, item-商品, search-搜索, topic-主题, category-分类, homepage-首页, other-其他 |
| 2.1.43 | roas | 广告支出回报率(ROAS) | string | 3.45 | 必填 | 广告支出回报率(ROAS),计算公式:attributedSales / adSpend |
| 2.2 | total | 总记录数 | string | 1523 | 必填 | 总记录数,返回符合条件的数据总数 |
| 3 | error_details | 错误详情 | array<any> | — | 必填 | 错误详情 |
| 4 | message | 提示信息 | string | — | 必填 | 提示信息 |
| 5 | request_id | 请求id | string | — | 必填 | 请求id |
| 6 | response_time | 响应时间 | string | — | 必填 | 响应时间 |
| 7 | total | 总记录数 | integer | — | 必填 | 总记录数 |
领星ERP的接口:查询沃尔玛 - 广告 - SV广告 - 页面类型(/basicOpen/multiplatform/ads/queryReportPageTypeSvList),由轻易云数据集成平台 API 资产管理模块整理收纳,并随领星ERP版本更新同步更新。