Lingxing
切换旧版

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

POST/basicOpen/multiplatform/ads/reportKeywordSpList

接口信息

API Path请求协议请求方式令牌桶容量
/basicOpen/multiplatform/ads/reportKeywordSpListHTTPSPOST1

请求参数

advertiserIdsarray<any>
广告账号ID列表,BigInteger数组,必填,必须至少选择一个店铺
campaignTypearray<any>
广告活动类型列表,String数组,必填,枚举值:sponsoredProducts-manual(SP手动), sponsoredProducts-auto(SP自动), sba(SB品牌广告), video(SV视频广告)。注意:查询SP广告报告必须且只能携带sponsoredProducts-manual和sponsoredProducts-auto
endDatestring
结束日期,必填,格式:yyyy-MM-dd,且 startDate 和 endDate 间隔不能超过31天
startDatestring
开始日期,必填,格式:yyyy-MM-dd,且 startDate 和 endDate 间隔不能超过31天
adGroupIdsarray<any>
广告组ID列表,Integer数组,按广告组ID筛选
campaignIdsarray<any>
广告活动ID列表,Long数组,按广告活动ID筛选
dayinteger
归因天数,数据归因天数,枚举值:3, 14, 30,默认14天
orderFieldstring
排序字段,支持对查询结果中的任意字段进行排序(驼峰命名)。包括:基础指标(numAdsShown/numAdsClicks/adSpend)、销售指标(attributedSales/attributedOrders/attributedUnits/advertisedSkuSales/advertisedSkuUnits)、关联指标(otherSkuSales/otherSkuUnits)、品牌新买家指标(ntbOrders/ntbRevenue/ntbUnits)、计算指标(cpc/ctr/cvr/acos/roas/aov/cpa)、时间字段(startDate/endDate/entityCreateAt)等所有返回的报表字段。不传时默认按广告花费倒序
orderTypestring
排序类型,枚举值:ASC-升序, DESC-降序,不传时默认ASC
pageNuminteger
页码,分页时的页码,从1开始
pageSizeinteger
每页大小,分页时每页显示的记录数,最大200
pagingboolean
是否分页,默认为true
searchTextstring
搜索文本,模糊搜索关键词文本(keyword_text)
statusarray<any>
关键词状态列表,String数组,枚举值:enabled-启用, paused-暂停

请求cURL示例

curl --location 'https://openapi.lingxing.com/basicOpen/multiplatform/ads/reportKeywordSpList?access_token=value&timestamp=value&sign=value&app_key=value' \
--header 'Content-Type: application/json' \
--data '{
    "advertiserIds": [123456789012345,987654321098765],
    "campaignType": ["sponsoredProducts-manual","sponsoredProducts-auto"],
    "endDate": "2024-12-31",
    "startDate": "2024-01-01",
    "adGroupIds": [123456,789012],
    "campaignIds": [123456789,987654321],
    "day": 14,
    "orderField": "adSpend",
    "orderType": "DESC",
    "pageNum": 1,
    "pageSize": 20,
    "paging": "1",
    "searchText": "women shoes",
    "status": ["enabled","paused"]
}'

返回结果

Json Object

codeinteger必填
响应码
dataobject必填
返回数据
隐藏子属性
listarray<object>必填
列表数据,关键词报表详细数据列表
隐藏子属性
acosstring必填
广告成本占比(ACoS),计算公式:广告花费 / 广告销售额 * 100%
示例 19.1
adGroupIdstring必填
广告组ID
示例 789123456
adGroupNamestring必填
广告组名称
示例 高转化关键词组
adGroupStatusstring必填
广告组状态,枚举值:enabled-启用, disabled-禁用,delete-归档
示例 enabled
adSpendstring必填
广告花费,广告投放的总花费金额
示例 310.89
advertisedSkuSalesstring必填
直接销售额,广告直接点击归因销售额
示例 1234.56
advertisedSkuUnitsstring必填
直接销量,广告直接点击归因销量
示例 34
advertiserIdstring必填
广告账号ID
示例 987654321098765
aovstring必填
平均订单值(AOV),计算公式:广告销售额 / 广告订单
示例 52.34
appliedTemplatearray<object>必填
应用的分时策略模板信息,AppliedTemplate对象数组
隐藏子属性
benchmarkFixedValstring必填
基准固定值,分时策略的固定基准值
示例 1.5
benchmarkTypestring必填
基准类型,枚举值:1-固定值, 2-动态值
示例 1
curBenchmarkValstring必填
当前基准值,当前实际使用的基准值
示例 1.8
effectiveTimeobject必填
生效时间范围,EffectiveTime对象
隐藏子属性
beginstring必填
开始时间,格式:yyyy-MM-dd HH:mm:ss
示例 2024-01-01 00:00:00
endstring必填
结束时间,格式:yyyy-MM-dd HH:mm:ss
示例 2024-12-31 23:59:59
idstring必填
模板ID,分时策略模板的唯一标识
示例 100234
taskNamestring必填
任务名称,分时策略任务名称
示例 晚高峰竞价提升策略
taskStatusstring必填
任务状态,枚举值:0-未启用, 1-已启用, 2-已暂停
示例 1
taskTypestring必填
任务类型,枚举值:BID_ADJUSTMENT-竞价调整, STATUS_CONTROL-状态控制, BUDGET_ADJUSTMENT-预算调整
示例 BID_ADJUSTMENT
timezonestring必填
时区,如:America/Los_Angeles
示例 America/Los_Angeles
attributedOrdersstring必填
广告订单数,归因总订单数
示例 45
attributedSalesstring必填
广告销售额,归因总销售额
示例 2345.67
attributedUnitsstring必填
广告销量,归因总销量
示例 67
benchmarkValstring必填
基准值,分时策略的基准值
示例 0.8
campaignIdstring必填
广告活动ID
示例 123456789
campaignNamestring必填
广告活动名称
示例 双十一大促活动
campaignStatusstring必填
广告活动状态,枚举值:enabled-启用, paused-暂停, scheduled-已安排, rescheduled-重新安排, live-运行中, proposal-提议, completed-已完成
示例 live
campaignTypestring必填
广告活动类型,枚举值:sponsoredProducts-SP广告, sba-SB品牌广告, video-SV视频广告
示例 sponsoredProducts
completeViewRevenuestring必填
完整观看收入,【仅SV视频广告】
示例 0
cpastring必填
平均订单成本(CPA),计算公式:广告花费 / 广告订单
示例 5.67
cpcstring必填
点击成本(CPC),计算公式:广告花费 / 点击量
示例 0.68
ctrstring必填
点击率(CTR),计算公式:点击量 / 曝光量 * 100%
示例 1.45
cvrstring必填
转化率(CVR),计算公式:广告订单 / 点击量 * 100%
示例 9.87
entityCreateAtstring必填
创建时间,实体创建时间
示例 2024-11-12 10:30:00
haloCompleteViewRevenuestring必填
光晕完整观看收入,【仅SV视频广告】
示例 0
inStoreAdvertisedSalesstring必填
实体店广告销售额(未使用)
示例 0
inStoreAttributedSalesstring必填
实体店销售额,实体店归因总销售额
示例 234.56
inStoreOrdersstring必填
实体店订单数,实体店归因订单数
示例 23
inStoreOtherSalesstring必填
实体店关联销售额,实体店间接归因销售额
示例 123.45
inStoreUnitsSoldstring必填
实体店销量,实体店归因销量
示例 45
isApplyTimestring必填
是否应用分时策略
示例 1
keystring必填
唯一键,用于前端列表展示,取值为keywordId
示例 456789123
keywordBidstring必填
关键词竞价,当前出价金额
示例 0.75
keywordIdstring必填
关键词ID
示例 456789123
keywordNamestring必填
关键词文本
示例 women shoes
keywordStatestring必填
关键词状态(旧字段)
示例 enabled
keywordStatusstring必填
关键词状态,枚举值:enabled-启用, paused-暂停, deleted-已删除
示例 enabled
matchTypestring必填
匹配类型,枚举值:exact-精确匹配, phrase-短语匹配, broad-广泛匹配
示例 exact
mpAdvertiserNamestring必填
广告账号名称
示例 Walmart广告账号A
mpSellerNamestring必填
店铺名称
示例 Walmart官方旗舰店
ntbOrderRatestring必填
品牌新买家订单转化率,计算公式:ntbOrders / numAdsClicks * 100%
示例 2.63
ntbOrdersstring必填
品牌新买家订单数,首次购买该品牌的买家产生的订单数
示例 12
ntbOrdersPercentstring必填
品牌新买家订单占比,计算公式:ntbOrders / attributedOrders * 100%
示例 26.5
ntbRevenuestring必填
品牌新买家销售额,首次购买该品牌的买家产生的销售额
示例 567.89
ntbRevenuePercentstring必填
品牌新买家销售额占比,计算公式:ntbRevenue / attributedSales * 100%
示例 24.2
ntbUnitsstring必填
品牌新买家销量,首次购买该品牌的买家购买数量
示例 18
ntbUnitsPercentstring必填
品牌新买家销量占比,计算公式:ntbUnits / attributedUnits * 100%
示例 26.9
numAdsClicksstring必填
广告点击量,广告被点击的总次数
示例 456
numAdsShownstring必填
曝光次数,广告被展示的总次数
示例 31456
otherSkuSalesstring必填
关联销售额,间接归因销售额
示例 1111.11
otherSkuUnitsstring必填
关联销量,间接归因销量
示例 33
roasstring必填
投入产出比(ROAS),计算公式:广告销售额 / 广告花费
示例 5.23
targetingTypestring必填
投放类型,枚举值:manual-手动投放, auto-自动投放
示例 manual
totalCompleteViewOrdersstring必填
完整观看订单总数,【仅SV视频广告】
示例 0
totalCompleteViewUnitsstring必填
完整观看销量总数,【仅SV视频广告】
示例 0
video5SecondViewsstring必填
视频5秒观看次数,【仅SV视频广告】
示例 0
videoCompleteViewsstring必填
视频完整观看次数,【仅SV视频广告】
示例 0
videoFirstQuartileViewsstring必填
视频第一四分位观看次数,【仅SV视频广告】
示例 0
videoImpressionsstring必填
视频曝光量,【仅SV视频广告】
示例 0
videoMidpointViewsstring必填
视频中点观看次数,【仅SV视频广告】
示例 0
videoThirdQuartileViewsstring必填
视频第三四分位观看次数,【仅SV视频广告】
示例 0
videoUnmutesstring必填
视频取消静音次数,【仅SV视频广告】
示例 0
viewThroughOrdersstring必填
浏览订单数,【仅SV视频广告】
示例 0
viewThroughSalesstring必填
浏览销售额,【仅SV视频广告】
示例 0
viewThroughUnitsSoldstring必填
浏览销量,【仅SV视频广告】
示例 0
viewableImpressionsstring必填
可见曝光量,【仅SV视频广告】
示例 0
totalstring必填
总记录数,返回符合条件的数据总数
示例 3456
error_detailsarray<any>必填
错误详情
messagestring必填
提示信息
request_idstring必填
请求id
response_timestring必填
响应时间
totalinteger必填
总记录数

返回成功示例

{
    "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
}