Qeasy Cloud
Get Started

领星ERP 查询沃尔玛 - 广告 - SB广告 - 关键词 API

Platform
领星ERP
Type
WebAPI
Effect
QUERY
API Version
1.0
Adapter
\Adapter\LingXing\LXQueryAdapter
Auth Mode
OTHER
Description
多平台 / 广告 / Walmart广告 · POST · 请求参数 14 个(必填 0) · 响应参数 86 个 · 限流令牌桶容量 1
Updated At
2026-11-21

查询沃尔玛 - 广告 - SB广告 - 关键词

POST/basicOpen/multiplatform/ads/reportKeywordSbList
Factory
{
  "operation": {
    "method": "POST",
    "path": "/basicOpen/multiplatform/ads/reportKeywordSbList"
  },
  "protocol": "HTTPS",
  "host": "https://openapi.lingxing.com",
  "rateLimit": {
    "tokenBucketCapacity": 1,
    "text": ""
  },
  "requestExample": "curl --location 'https://openapi.lingxing.com/basicOpen/multiplatform/ads/reportKeywordSbList?access_token=value&timestamp=value&sign=value&app_key=value' \\\n--header 'Content-Type: application/json' \\\n--data '{\n    \"advertiserIds\": [123456789012345,987654321098765],\n    \"campaignType\": [\"sba\"],\n    \"endDate\": \"2024-12-31\",\n    \"startDate\": \"2024-01-01\",\n    \"adGroupIds\": [123456,789012],\n    \"campaignIds\": [123456789,987654321],\n    \"day\": 14,\n    \"orderField\": \"adSpend\",\n    \"orderType\": \"DESC\",\n    \"pageNum\": 1,\n    \"pageSize\": 20,\n    \"paging\": \"1\",\n    \"searchText\": \"双十一优惠\",\n    \"status\": [\"enabled\",\"paused\"]\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
  }
}

Request Parameters

No.FieldNameTypeDefaultRequiredDescription
1advertiserIds广告账号ID列表array<any>—Optional广告账号ID列表,BigInteger数组,必填,必须至少选择一个店铺
2campaignType广告活动类型列表array<any>—Optional广告活动类型列表,String数组,必填,枚举值:sponsoredProducts-manual(SP手动), sponsoredProducts-auto(SP自动), sba(SB品牌广告), video(SV视频广告)。注意:查询SB广告报告必须且只能携带sba
3endDate结束日期string—Optional结束日期,必填,格式:yyyy-MM-dd,且 startDate 和 endDate 间隔不能超过31天
4startDate开始日期string—Optional开始日期,必填,格式:yyyy-MM-dd,且 startDate 和 endDate 间隔不能超过31天
5adGroupIds广告组ID列表array<any>—Optional广告组ID列表,Integer数组,按广告组ID筛选
6campaignIds广告活动ID列表array<any>—Optional广告活动ID列表,Long数组,按广告活动ID筛选
7day归因天数integer—Optional归因天数,数据归因天数,枚举值:3, 14, 30,默认14天
8orderField排序字段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)等所有返回的报表字段。不传时默认按广告花费倒序
9orderType排序类型string—Optional排序类型,枚举值:ASC-升序, DESC-降序,不传时默认ASC
10pageNum页码integer—Optional页码,分页时的页码,从1开始
11pageSize每页大小integer—Optional每页大小,分页时每页显示的记录数,最大200
12paging是否分页boolean—Optional是否分页,默认为true
13searchText搜索文本string—Optional搜索文本,模糊搜索关键词文本(keyword_text)
14status关键词状态列表array<any>—Optional关键词状态列表,String数组,枚举值:enabled-启用, paused-暂停

Response Parameters

No.FieldNameTypeDefaultRequiredDescription
1code响应码integer—Required响应码
2data返回数据object—Required返回数据
2.1list列表数据array<object>—Required列表数据,关键词报表详细数据列表
2.1.1acos广告成本占比(ACoS)string11.21Required广告成本占比(ACoS),计算公式:广告花费 / 广告销售额 * 100%
2.1.2adGroupId广告组IDstring654321987Required广告组ID
2.1.3adGroupName广告组名称stringSB品牌关键词组Required广告组名称
2.1.4adGroupStatus广告组状态stringenabledRequired广告组状态,枚举值:enabled-启用, disabled-禁用, delete-归档
2.1.5adSpend广告花费string2352.45Required广告花费,广告投放的总花费金额
2.1.6advertisedSkuSales直接销售额string12456.78Required直接销售额,广告直接点击归因销售额
2.1.7advertisedSkuUnits直接销量string198Required直接销量,广告直接点击归因销量
2.1.8advertiserId广告账号IDstring987654321098765Required广告账号ID
2.1.9aov平均订单值(AOV)string75.89Required平均订单值(AOV),计算公式:广告销售额 / 广告订单
2.1.10appliedTemplate应用的分时策略模板信息array<object>—Required应用的分时策略模板信息,AppliedTemplate对象数组
2.1.10.1benchmarkFixedVal基准固定值string1.5Required基准固定值,分时策略的固定基准值
2.1.10.2benchmarkType基准类型string1Required基准类型,枚举值:1-固定值, 2-动态值
2.1.10.3curBenchmarkVal当前基准值string1.8Required当前基准值,当前实际使用的基准值
2.1.10.4effectiveTime生效时间范围object—Required生效时间范围,EffectiveTime对象
2.1.10.4.1begin开始时间string2024-01-01 00:00:00Required开始时间,格式:yyyy-MM-dd HH:mm:ss
2.1.10.4.2end结束时间string2024-12-31 23:59:59Required结束时间,格式:yyyy-MM-dd HH:mm:ss
2.1.10.5id模板IDstring100234Required模板ID,分时策略模板的唯一标识
2.1.10.6taskName任务名称string晚高峰竞价提升策略Required任务名称,分时策略任务名称
2.1.10.7taskStatus任务状态string1Required任务状态,枚举值:0-未启用, 1-已启用, 2-已暂停
2.1.10.8taskType任务类型stringBID_ADJUSTMENTRequired任务类型,枚举值:BID_ADJUSTMENT-竞价调整, STATUS_CONTROL-状态控制, BUDGET_ADJUSTMENT-预算调整
2.1.10.9timezone时区stringAmerica/Los_AngelesRequired时区,如:America/Los_Angeles
2.1.11attributedOrders广告订单数string250Required广告订单数,归因总订单数
2.1.12attributedSales广告销售额string20987.65Required广告销售额,归因总销售额
2.1.13attributedUnits广告销量string276Required广告销量,归因总销量
2.1.14benchmarkVal基准值string1.8Required基准值,分时策略的基准值
2.1.15campaignId广告活动IDstring987654321Required广告活动ID
2.1.16campaignName广告活动名称string双十一关键词推广Required广告活动名称
2.1.17campaignStatus广告活动状态stringliveRequired广告活动状态,枚举值:enabled-启用, paused-暂停, scheduled-已安排, rescheduled-重新安排, live-运行中, proposal-提议, completed-已完成
2.1.18campaignType广告活动类型stringsbaRequired广告活动类型,枚举值:sponsoredProducts-SP广告, sba-SB品牌广告, video-SV视频广告
2.1.19completeViewRevenue完整观看收入--【仅SV视频广告】string0Required完整观看收入--【仅SV视频广告】
2.1.20cpa平均订单成本(CPA)string9.87Required平均订单成本(CPA),计算公式:广告花费 / 广告订单
2.1.21cpc点击成本(CPC)string0.68Required点击成本(CPC),计算公式:广告花费 / 点击量
2.1.22ctr点击率(CTR)string3.12Required点击率(CTR),计算公式:点击量 / 曝光量 * 100%
2.1.23cvr转化率(CVR)string7.24Required转化率(CVR),计算公式:广告订单 / 点击量 * 100%
2.1.24entityCreateAt创建时间string2024-11-12 16:45:00Required创建时间,实体创建时间
2.1.25haloCompleteViewRevenue光晕完整观看收入--【仅SV视频广告】string0Required光晕完整观看收入--【仅SV视频广告】
2.1.26inStoreAdvertisedSales实体店广告销售额(未使用)string0Required实体店广告销售额(未使用)
2.1.27inStoreAttributedSales实体店销售额string4567.89Required实体店销售额,实体店归因总销售额
2.1.28inStoreOrders实体店订单数string67Required实体店订单数,实体店归因订单数
2.1.29inStoreOtherSales实体店关联销售额string1890.23Required实体店关联销售额,实体店间接归因销售额
2.1.30inStoreUnitsSold实体店销量string156Required实体店销量,实体店归因销量
2.1.31isApplyTime是否应用分时策略string1Required是否应用分时策略,true-已应用, false-未应用
2.1.32key唯一键string88776655Required唯一键,用于前端列表展示,取值为keywordId
2.1.33keywordBid关键词竞价string1.35Required关键词竞价,当前关键词的竞价
2.1.34keywordId关键词IDstring88776655Required关键词ID,关键词的唯一标识
2.1.35keywordName关键词文本string双十一特惠Required关键词文本,关键词内容
2.1.36keywordState关键词状态(旧字段)string—Required关键词状态(旧字段),已废弃,使用keywordStatus
2.1.37keywordStatus关键词状态stringenabledRequired关键词状态,枚举值:enabled-启用, paused-暂停, deleted-已删除
2.1.38matchType匹配类型stringphraseRequired匹配类型,枚举值:exact-精确匹配, phrase-短语匹配, broad-广泛匹配
2.1.39mpAdvertiserName广告账号名称stringWalmart广告账号CRequired广告账号名称
2.1.40mpSellerName店铺名称stringWalmart精品店Required店铺名称
2.1.41ntbOrderRate品牌新买家订单转化率string2.58Required品牌新买家订单转化率,计算公式:ntbOrders / numAdsClicks * 100%
2.1.42ntbOrders品牌新买家订单数string89Required品牌新买家订单数,首次购买该品牌的买家产生的订单数
2.1.43ntbOrdersPercent品牌新买家订单占比string35.6Required品牌新买家订单占比,计算公式:ntbOrders / attributedOrders * 100%
2.1.44ntbRevenue品牌新买家销售额string6789.34Required品牌新买家销售额,首次购买该品牌的买家产生的销售额
2.1.45ntbRevenuePercent品牌新买家销售额占比string32.35Required品牌新买家销售额占比,计算公式:ntbRevenue / attributedSales * 100%
2.1.46ntbUnits品牌新买家销量string89Required品牌新买家销量,首次购买该品牌的买家购买数量
2.1.47ntbUnitsPercent品牌新买家销量占比string32.25Required品牌新买家销量占比,计算公式:ntbUnits / attributedUnits * 100%
2.1.48numAdsClicks广告点击量string3456Required广告点击量,广告被点击的总次数
2.1.49numAdsShown曝光次数string110789Required曝光次数,广告被展示的总次数
2.1.50otherSkuSales关联销售额string8530.87Required关联销售额,间接归因销售额
2.1.51otherSkuUnits关联销量string78Required关联销量,间接归因销量
2.1.52roas投入产出比(ROAS)string8.92Required投入产出比(ROAS),计算公式:广告销售额 / 广告花费
2.1.53targetingType投放类型stringmanualRequired投放类型,枚举值:manual-手动投放, auto-自动投放
2.1.54totalCompleteViewOrders完整观看订单总数--【仅SV视频广告】string0Required完整观看订单总数--【仅SV视频广告】
2.1.55totalCompleteViewUnits完整观看销量总数--【仅SV视频广告】string0Required完整观看销量总数--【仅SV视频广告】
2.1.56video5SecondViews视频5秒观看次数--【仅SV视频广告】string0Required视频5秒观看次数--【仅SV视频广告】
2.1.57videoCompleteViews视频完整观看次数--【仅SV视频广告】string0Required视频完整观看次数--【仅SV视频广告】
2.1.58videoFirstQuartileViews视频第一四分位观看次数--【仅SV视频广告】string0Required视频第一四分位观看次数--【仅SV视频广告】
2.1.59videoImpressions视频曝光量--【仅SV视频广告】string0Required视频曝光量--【仅SV视频广告】
2.1.60videoMidpointViews视频中点观看次数--【仅SV视频广告】string0Required视频中点观看次数--【仅SV视频广告】
2.1.61videoThirdQuartileViews视频第三四分位观看次数--【仅SV视频广告】string0Required视频第三四分位观看次数--【仅SV视频广告】
2.1.62videoUnmutes视频取消静音次数--【仅SV视频广告】string0Required视频取消静音次数--【仅SV视频广告】
2.1.63viewThroughOrders浏览订单数--【仅SV视频广告】string0Required浏览订单数--【仅SV视频广告】
2.1.64viewThroughSales浏览销售额--【仅SV视频广告】string0Required浏览销售额--【仅SV视频广告】
2.1.65viewThroughUnitsSold浏览销量--【仅SV视频广告】string0Required浏览销量--【仅SV视频广告】
2.1.66viewableImpressions可见曝光量--【仅SV视频广告】string0Required可见曝光量--【仅SV视频广告】
2.2total总记录数string5678Required总记录数,返回符合条件的数据总数
3error_details错误详情array<any>—Required错误详情
4message提示信息string—Required提示信息
5request_id请求idstring—Required请求id
6response_time响应时间string—Required响应时间
7total总记录数integer—Required总记录数

The 查询沃尔玛 - 广告 - SB广告 - 关键词 API (/basicOpen/multiplatform/ads/reportKeywordSbList) 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.

Need to integrate this API?

Qeasy ships with prebuilt adaptation for this API — contact us to start configuring data integration.