轻易云
注册体验

领星ERP查询沃尔玛 - 广告 - SP广告 - 广告组接口

所属平台
领星ERP
类型
WebAPI
作用
QUERY
接口版本
1.0
适配器
\Adapter\LingXing\LXQueryAdapter
授权方式
OTHER
描述
多平台 / 广告 / Walmart广告 · POST · 请求参数 14 个(必填 0) · 响应参数 46 个 · 限流令牌桶容量 1
更新日期
2026-11-21

查询沃尔玛 - 广告 - SP广告 - 广告组

POST/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&timestamp=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
  }
}

接口请求参数

序号字段名称类型默认值必填描述
1advertiserIds广告账号ID列表array<any>—可选广告账号ID列表,必填,BigInteger数组,必须至少选择一个店铺
2campaignType广告活动类型列表array<any>—可选广告活动类型列表,必填,String数组,枚举值:sponsoredProducts-manual-SP手动, sponsoredProducts-auto-SP自动, sba-SB品牌广告, video-SV视频广告。注意:1.查询sp广告报告必须且只能携带sponsoredProducts-manual和sponsoredProducts-auto;2.查询sb广告报告必须且只能携带sba;3.查询sv广告报告必须且只能携带video
3day归因天数integer—可选归因天数,必填,数据归因天数,枚举值:3, 14, 30
4endDate结束日期string—可选结束日期,必填,格式:yyyy-MM-dd,且 startDate 和 endDate 间隔不能超过31天
5operationSourceType操作来源string—可选操作来源,必填,openapi调用必传gateway,前端传web
6pageNum页码integer—可选页码,必填,分页时的页码,从1开始
7pageSize每页大小integer—可选每页大小,必填,分页时每页显示的记录数,openapi必传且小于2000
8paging是否分页boolean—可选是否分页,必填,openapi必填true
9startDate开始日期string—可选开始日期,必填,格式:yyyy-MM-dd,且 startDate 和 endDate 间隔不能超过31天
10campaignIds广告活动ID列表array<any>—可选广告活动ID列表,Long数组,按广告活动ID筛选广告组
11orderField排序字段string—可选排序字段,支持对查询结果中的任意字段进行排序(驼峰命名)。包括但不限于:基础指标(numAdsShown/numAdsClicks/adSpend)、销售指标(attributedSales/attributedOrders/attributedUnits/advertisedSkuSales/advertisedSkuUnits)、关联指标(otherSkuSales/otherSkuUnits)、品牌新买家指标(ntbOrders/ntbRevenue/ntbUnits)、计算指标(cpc/ctr/cvr/acos/roas/aov/cpa)、时间字段(startDate/endDate/entityCreateAt)等所有返回的报表字段。不传时默认按广告花费倒序
12orderType排序类型string—可选排序类型,枚举值:ASC-升序, DESC-降序。不传时默认ASC
13searchText搜索文本string—可选搜索文本,模糊搜索广告组名称(ad_group_name)
14status广告组状态列表array<any>—可选广告组状态列表,String数组,枚举值:enabled-启用, disabled-禁用, delete-归档

接口响应参数

序号字段名称类型默认值必填描述
1code响应码integer—必填响应码
2data返回数据object—必填返回数据
2.1list广告组列表数据array<object>—必填广告组列表数据
2.1.1acos广告成本占比ACOSnumber12.5可选广告成本占比ACOS,计算公式: 广告花费 / 广告销售额 * 100%
2.1.2adGroupId广告组IDinteger987654321可选广告组ID
2.1.3adGroupName广告组名称string测试广告组可选广告组名称
2.1.4adGroupStatus广告组状态stringenabled可选广告组状态,枚举值:enabled-启用, disabled-禁用, delete-归档
2.1.5adSpend广告花费number1500.5可选广告花费
2.1.6advertisedSkuSales直接销售额number8500可选直接销售额,广告直接点击归因销售额
2.1.7advertisedSkuUnits直接销量number100可选直接销量,广告直接点击归因销量
2.1.8advertiserId广告账号IDinteger123456789012345可选广告账号ID
2.1.9aov平均订单值AOVnumber80可选平均订单值AOV,计算公式: 广告销售额 / 广告订单
2.1.10attributedOrders广告订单数integer150可选广告订单数,归因总订单数
2.1.11attributedSales广告销售额number12000可选广告销售额,归因总销售额
2.1.12attributedUnits广告销量integer200可选广告销量,归因总销量
2.1.13campaignId广告活动IDinteger123456789可选广告活动ID
2.1.14campaignName广告活动名称string测试广告活动可选广告活动名称
2.1.15campaignStatus广告活动状态stringenabled可选广告活动状态,枚举值:enabled-启用, paused-暂停, scheduled-已安排, rescheduled-重新安排, live-运行中, proposal-提议, completed-已完成
2.1.16campaignType广告活动类型stringsponsoredProducts可选广告活动类型,枚举值:sponsoredProducts-SP广告, sba-SB品牌广告, video-SV视频广告
2.1.17cpa平均订单成本CPAnumber10可选平均订单成本CPA,计算公式: 广告花费 / 广告订单
2.1.18cpc点击成本CPCnumber3可选点击成本CPC,计算公式: 广告花费 / 点击量
2.1.19ctr点击率CTRnumber5可选点击率CTR,计算公式: 点击量 / 曝光量 * 100%
2.1.20cvr转化率CVRnumber30可选转化率CVR,计算公式: 广告订单 / 点击量 * 100%
2.1.21entityCreateAt创建时间string2024-11-01T10:00:00可选创建时间,实体创建时间
2.1.22key唯一键integer987654321可选唯一键,用于前端列表展示
2.1.23mpAdvertiserName广告账号名称string主账号可选广告账号名称
2.1.24mpSellerName店铺名称stringWalmart旗舰店可选店铺名称
2.1.25ntbOrderRate品牌新买家订单转化率number6可选品牌新买家订单转化率,计算公式: ntbOrders / numAdsClicks * 100%
2.1.26ntbOrders品牌新买家订单数integer30可选品牌新买家订单数
2.1.27ntbOrdersPercent品牌新买家订单占比number20可选品牌新买家订单占比,计算公式: ntbOrders / attributedOrders * 100%
2.1.28ntbRevenue品牌新买家销售额number2500可选品牌新买家销售额
2.1.29ntbRevenuePercent品牌新买家销售额占比number20.83可选品牌新买家销售额占比,计算公式: ntbRevenue / attributedSales * 100%
2.1.30ntbUnits品牌新买家销量integer40可选品牌新买家销量
2.1.31ntbUnitsPercent品牌新买家销量占比number20可选品牌新买家销量占比,计算公式: ntbUnits / attributedUnits * 100%
2.1.32numAdsClicks广告点击量integer500可选广告点击量
2.1.33numAdsShown曝光次数integer10000可选曝光次数
2.1.34otherSkuSales关联销售额number3500可选关联销售额,间接归因销售额
2.1.35otherSkuUnits关联销量number50可选关联销量,间接归因销量
2.1.36roas投入产出比ROASnumber8可选投入产出比ROAS,计算公式: 广告销售额 / 广告花费
2.1.37targetingType投放类型stringmanual可选投放类型,枚举值:manual-手动投放, auto-自动投放
2.2total总记录数integer100必填总记录数
3error_details错误详情array<any>—必填错误详情
4message提示信息string—必填提示信息
5request_id请求idstring—必填请求id
6response_time响应时间string—必填响应时间
7total总记录数integer—必填总记录数

领星ERP的接口:查询沃尔玛 - 广告 - SP广告 - 广告组(/basicOpen/multiplatform/ads/queryGroupSpList),由轻易云数据集成平台 API 资产管理模块整理收纳,并随领星ERP版本更新同步更新。

需要对接这个接口?

轻易云已预置该接口的适配能力,联系我们即可开始配置数据集成。