/basicOpen/multiplatform/ads/queryGroupSpList{
"operation": {
"method": "POST",
"path": "/basicOpen/multiplatform/ads/queryGroupSpList"
},
"protocol": "HTTPS",
"host": "https://openapi.lingxing.com",
"rateLimit": {
"tokenBucketCapacity": 1,
"text": ""
},
"requestExample": "curl --location 'https://openapi.lingxing.com/basicOpen/multiplatform/ads/queryGroupSpList?access_token=value×tamp=value&sign=value&app_key=value' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"advertiserIds\": [\"123456789012345\"],\n \"campaignType\": [\"sponsoredProducts-manual\",\"sponsoredProducts-auto\"],\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\": [123456789,987654321],\n \"orderField\": \"adSpend\",\n \"orderType\": \"DESC\",\n \"searchText\": \"测试广告组\",\n \"status\": [\"enabled\",\"disabled\"]\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视频广告。注意:1.查询sp广告报告必须且只能携带sponsoredProducts-manual和sponsoredProducts-auto;2.查询sb广告报告必须且只能携带sba;3.查询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 | 搜索文本,模糊搜索广告组名称(ad_group_name) |
| 14 | status | 广告组状态列表 | array<any> | — | Optional | 广告组状态列表,String数组,枚举值:enabled-启用, disabled-禁用, delete-归档 |
| No. | Field | Name | Type | Default | Required | Description |
|---|---|---|---|---|---|---|
| 1 | code | 响应码 | integer | — | Required | 响应码 |
| 2 | data | 返回数据 | object | — | Required | 返回数据 |
| 2.1 | list | 广告组列表数据 | array<object> | — | Required | 广告组列表数据 |
| 2.1.1 | acos | 广告成本占比ACOS | number | 12.5 | Optional | 广告成本占比ACOS,计算公式: 广告花费 / 广告销售额 * 100% |
| 2.1.2 | adGroupId | 广告组ID | integer | 987654321 | Optional | 广告组ID |
| 2.1.3 | adGroupName | 广告组名称 | string | 测试广告组 | Optional | 广告组名称 |
| 2.1.4 | adGroupStatus | 广告组状态 | string | enabled | Optional | 广告组状态,枚举值:enabled-启用, disabled-禁用, delete-归档 |
| 2.1.5 | adSpend | 广告花费 | number | 1500.5 | Optional | 广告花费 |
| 2.1.6 | advertisedSkuSales | 直接销售额 | number | 8500 | Optional | 直接销售额,广告直接点击归因销售额 |
| 2.1.7 | advertisedSkuUnits | 直接销量 | number | 100 | Optional | 直接销量,广告直接点击归因销量 |
| 2.1.8 | advertiserId | 广告账号ID | integer | 123456789012345 | Optional | 广告账号ID |
| 2.1.9 | aov | 平均订单值AOV | number | 80 | Optional | 平均订单值AOV,计算公式: 广告销售额 / 广告订单 |
| 2.1.10 | attributedOrders | 广告订单数 | integer | 150 | Optional | 广告订单数,归因总订单数 |
| 2.1.11 | attributedSales | 广告销售额 | number | 12000 | Optional | 广告销售额,归因总销售额 |
| 2.1.12 | attributedUnits | 广告销量 | integer | 200 | Optional | 广告销量,归因总销量 |
| 2.1.13 | campaignId | 广告活动ID | integer | 123456789 | Optional | 广告活动ID |
| 2.1.14 | campaignName | 广告活动名称 | string | 测试广告活动 | Optional | 广告活动名称 |
| 2.1.15 | campaignStatus | 广告活动状态 | string | enabled | Optional | 广告活动状态,枚举值:enabled-启用, paused-暂停, scheduled-已安排, rescheduled-重新安排, live-运行中, proposal-提议, completed-已完成 |
| 2.1.16 | campaignType | 广告活动类型 | string | sponsoredProducts | Optional | 广告活动类型,枚举值:sponsoredProducts-SP广告, sba-SB品牌广告, video-SV视频广告 |
| 2.1.17 | cpa | 平均订单成本CPA | number | 10 | Optional | 平均订单成本CPA,计算公式: 广告花费 / 广告订单 |
| 2.1.18 | cpc | 点击成本CPC | number | 3 | Optional | 点击成本CPC,计算公式: 广告花费 / 点击量 |
| 2.1.19 | ctr | 点击率CTR | number | 5 | Optional | 点击率CTR,计算公式: 点击量 / 曝光量 * 100% |
| 2.1.20 | cvr | 转化率CVR | number | 30 | Optional | 转化率CVR,计算公式: 广告订单 / 点击量 * 100% |
| 2.1.21 | entityCreateAt | 创建时间 | string | 2024-11-01T10:00:00 | Optional | 创建时间,实体创建时间 |
| 2.1.22 | key | 唯一键 | integer | 987654321 | Optional | 唯一键,用于前端列表展示 |
| 2.1.23 | mpAdvertiserName | 广告账号名称 | string | 主账号 | Optional | 广告账号名称 |
| 2.1.24 | mpSellerName | 店铺名称 | string | Walmart旗舰店 | Optional | 店铺名称 |
| 2.1.25 | ntbOrderRate | 品牌新买家订单转化率 | number | 6 | Optional | 品牌新买家订单转化率,计算公式: ntbOrders / numAdsClicks * 100% |
| 2.1.26 | ntbOrders | 品牌新买家订单数 | integer | 30 | Optional | 品牌新买家订单数 |
| 2.1.27 | ntbOrdersPercent | 品牌新买家订单占比 | number | 20 | Optional | 品牌新买家订单占比,计算公式: ntbOrders / attributedOrders * 100% |
| 2.1.28 | ntbRevenue | 品牌新买家销售额 | number | 2500 | Optional | 品牌新买家销售额 |
| 2.1.29 | ntbRevenuePercent | 品牌新买家销售额占比 | number | 20.83 | Optional | 品牌新买家销售额占比,计算公式: ntbRevenue / attributedSales * 100% |
| 2.1.30 | ntbUnits | 品牌新买家销量 | integer | 40 | Optional | 品牌新买家销量 |
| 2.1.31 | ntbUnitsPercent | 品牌新买家销量占比 | number | 20 | Optional | 品牌新买家销量占比,计算公式: ntbUnits / attributedUnits * 100% |
| 2.1.32 | numAdsClicks | 广告点击量 | integer | 500 | Optional | 广告点击量 |
| 2.1.33 | numAdsShown | 曝光次数 | integer | 10000 | Optional | 曝光次数 |
| 2.1.34 | otherSkuSales | 关联销售额 | number | 3500 | Optional | 关联销售额,间接归因销售额 |
| 2.1.35 | otherSkuUnits | 关联销量 | number | 50 | Optional | 关联销量,间接归因销量 |
| 2.1.36 | roas | 投入产出比ROAS | number | 8 | Optional | 投入产出比ROAS,计算公式: 广告销售额 / 广告花费 |
| 2.1.37 | targetingType | 投放类型 | string | manual | Optional | 投放类型,枚举值:manual-手动投放, auto-自动投放 |
| 2.2 | total | 总记录数 | integer | 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 查询沃尔玛 - 广告 - SP广告 - 广告组 API (/basicOpen/multiplatform/ads/queryGroupSpList) 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.