轻易云
注册体验

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

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

查询沃尔玛 - 广告 - SP广告 - 广告活动

POST/basicOpen/multiplatform/ads/queryCampaignSpList
加工厂
{
  "operation": {
    "method": "POST",
    "path": "/basicOpen/multiplatform/ads/queryCampaignSpList"
  },
  "protocol": "HTTPS",
  "host": "https://openapi.lingxing.com",
  "rateLimit": {
    "tokenBucketCapacity": 1,
    "text": ""
  },
  "requestExample": "curl --location 'https://openapi.lingxing.com/basicOpen/multiplatform/ads/queryCampaignSpList?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\",\"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
  }
}

接口请求参数

序号字段名称类型默认值必填描述
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—可选搜索文本,模糊搜索广告活动名称
14status广告活动状态列表array<any>—可选广告活动状态列表,String数组,枚举值:enabled-启用, paused-暂停, scheduled-已安排, rescheduled-重新安排, live-运行中, proposal-提议, completed-已完成

接口响应参数

序号字段名称类型默认值必填描述
1code响应码integer—必填响应码
2data返回数据object—必填返回数据
2.1list列表数据array<object>—必填列表数据
2.1.1acos广告成本占比ACOSnumber25可选广告成本占比ACOS,计算公式:广告花费 / 广告销售额 * 100%
2.1.2adSpend广告花费number1250.5可选广告花费
2.1.3advertisedSkuSales直接销售额number3500可选直接销售额,广告直接点击归因销售额
2.1.4advertisedSkuUnits直接销量integer70可选直接销量,广告直接点击归因销量
2.1.5advertiserId广告账号IDinteger123456789012345可选广告账号ID
2.1.6aov平均订单值AOVnumber50可选平均订单值AOV,计算公式:广告销售额 / 广告订单
2.1.7appliedTemplate应用的分时策略模板信息array<any>—可选应用的分时策略模板信息,AppliedTemplate对象数组
2.1.8attributedOrders广告订单数integer100可选广告订单数,归因总订单数
2.1.9attributedSales广告销售额number5000可选广告销售额,归因总销售额
2.1.10attributedUnits广告销量integer150可选广告销量,归因总销量
2.1.11benchmarkVal基准值number1.5可选基准值,分时策略的基准值
2.1.12biddingStrategy竞价策略object{"type":"auto"}必填竞价策略,JSON格式字符串
2.1.12.1biddingStrategyStatus竞价策略状态stringactive必填竞价策略状态,strategy为TROAS时返回
2.1.12.2strategy竞价策略stringTROAS必填竞价策略,枚举值:DYNAMIC - 动态竞价,FIXED - 固定竞价, TROAS - 目标竞价
2.1.12.3troas支出回报率string5必填支出回报率,strategy为TROAS时返回
2.1.13budgetType预算类型stringdaily可选预算类型,枚举值:daily-每日预算, total-总预算, both-两者都有
2.1.14campaignId广告活动IDinteger987654321可选广告活动ID
2.1.15campaignName广告活动名称string双十一促销活动可选广告活动名称
2.1.16campaignStatus广告活动状态stringlive可选广告活动状态,枚举值:enabled-启用, paused-暂停, scheduled-已安排, rescheduled-重新安排, live-运行中, proposal-提议, completed-已完成
2.1.17campaignType广告活动类型stringsponsoredProducts可选广告活动类型,枚举值:sponsoredProducts-SP广告, sba-SB品牌广告, video-SV视频广告
2.1.18completeViewRevenue完整观看收入number300可选完整观看收入,仅SV视频广告
2.1.19cpa平均订单成本CPAnumber12.51可选平均订单成本CPA,计算公式:广告花费 / 广告订单
2.1.20cpc点击成本CPCnumber5可选点击成本CPC,计算公式:广告花费 / 点击量
2.1.21ctr点击率CTRnumber5可选点击率CTR,计算公式:点击量 / 曝光量 * 100%
2.1.22cvr转化率CVRnumber40可选转化率CVR,计算公式:广告订单 / 点击量 * 100%
2.1.23dailyBudget广告活动每日预算number500可选广告活动每日预算
2.1.24endDate广告活动结束日期string2024-11-30可选广告活动结束日期
2.1.25entityCreateAt创建时间string2024-11-01 10:00:00可选创建时间,实体创建时间
2.1.26haloCompleteViewRevenue光晕完整观看收入number100可选光晕完整观看收入,仅SV视频广告
2.1.27isApplyTime是否应用分时策略boolean1可选是否应用分时策略
2.1.28key唯一键integer123456789可选唯一键,用于前端列表展示
2.1.29mpAdvertiserName广告账号名称string测试广告账号可选广告账号名称
2.1.30mpSellerName店铺名称string测试店铺可选店铺名称
2.1.31ntbOrderRate品牌新买家订单转化率number12可选品牌新买家订单转化率,计算公式:ntbOrders / numAdsClicks * 100%
2.1.32ntbOrders品牌新买家订单数integer30可选品牌新买家订单数
2.1.33ntbOrdersPercent品牌新买家订单占比number30可选品牌新买家订单占比,计算公式:ntbOrders / attributedOrders * 100%
2.1.34ntbRevenue品牌新买家销售额number1500可选品牌新买家销售额
2.1.35ntbRevenuePercent品牌新买家销售额占比number30可选品牌新买家销售额占比,计算公式:ntbRevenue / attributedSales * 100%
2.1.36ntbUnits品牌新买家销量integer45可选品牌新买家销量
2.1.37ntbUnitsPercent品牌新买家销量占比number30可选品牌新买家销量占比,计算公式:ntbUnits / attributedUnits * 100%
2.1.38numAdsClicks广告点击量integer250可选广告点击量
2.1.39numAdsShown曝光次数integer5000可选曝光次数
2.1.40otherSkuSales关联销售额number1500可选关联销售额,间接归因销售额
2.1.41otherSkuUnits关联销量integer80可选关联销量,间接归因销量
2.1.42reportTag报表标签stringREALTIME可选报表标签,枚举值:REALTIME-实时数据标识
2.1.43roas投入产出比ROASnumber4可选投入产出比ROAS,计算公式:广告销售额 / 广告花费
2.1.44rollover是否结转boolean1可选是否结转,前一天未用的每日预算是否应结转到第二天的每日预算
2.1.45startDate广告活动开始日期string2024-11-01可选广告活动开始日期
2.1.46targetingType投放类型stringmanual可选投放类型,枚举值:manual-手动投放, auto-自动投放
2.1.47totalBudget广告活动总预算number10000可选广告活动总预算
2.1.48totalCompleteViewOrders完整观看订单总数integer5可选完整观看订单总数,仅SV视频广告
2.1.49totalCompleteViewUnits完整观看销量总数integer15可选完整观看销量总数,仅SV视频广告
2.1.50video5SecondViews视频5秒观看次数integer200可选视频5秒观看次数,仅SV视频广告
2.1.51videoCompleteViews视频完整观看次数integer50可选视频完整观看次数,仅SV视频广告
2.1.52videoFirstQuartileViews视频第一四分位观看次数integer100可选视频第一四分位观看次数,仅SV视频广告
2.1.53videoImpressions视频曝光量integer1000可选视频曝光量,仅SV视频广告
2.1.54videoMidpointViews视频中点观看次数integer80可选视频中点观看次数,仅SV视频广告
2.1.55videoThirdQuartileViews视频第三四分位观看次数integer60可选视频第三四分位观看次数,仅SV视频广告
2.1.56videoUnmutes视频取消静音次数integer30可选视频取消静音次数,仅SV视频广告
2.1.57viewThroughOrders浏览订单数integer10可选浏览订单数,仅SV视频广告
2.1.58viewThroughSales浏览销售额number500可选浏览销售额,仅SV视频广告
2.1.59viewThroughUnitsSold浏览销量integer20可选浏览销量,仅SV视频广告
2.1.60viewableImpressions可见曝光量integer800可选可见曝光量,仅SV视频广告
2.2total总记录数integer100必填总记录数
3error_details错误详情array<any>—必填错误详情
4message提示信息string—必填提示信息
5request_id请求idstring—必填请求id
6response_time响应时间string—必填响应时间
7total总记录数integer—必填总记录数

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

需要对接这个接口?

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