Lingxing
切换旧版

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

POST/basicOpen/multiplatform/ads/queryGroupSpList

接口信息

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

请求参数

advertiserIdsarray<any>
广告账号ID列表，必填，BigInteger数组，必须至少选择一个店铺
campaignTypearray<any>
广告活动类型列表，必填，String数组，枚举值：sponsoredProducts-manual-SP手动, sponsoredProducts-auto-SP自动, sba-SB品牌广告, video-SV视频广告。注意：1.查询sp广告报告必须且只能携带sponsoredProducts-manual和sponsoredProducts-auto；2.查询sb广告报告必须且只能携带sba；3.查询sv广告报告必须且只能携带video
dayinteger
归因天数，必填，数据归因天数，枚举值：3, 14, 30
endDatestring
结束日期，必填，格式：yyyy-MM-dd，且 startDate 和 endDate 间隔不能超过31天
operationSourceTypestring
操作来源，必填，openapi调用必传gateway，前端传web
pageNuminteger
页码，必填，分页时的页码，从1开始
pageSizeinteger
每页大小，必填，分页时每页显示的记录数，openapi必传且小于2000
pagingboolean
是否分页，必填，openapi必填true
startDatestring
开始日期，必填，格式：yyyy-MM-dd，且 startDate 和 endDate 间隔不能超过31天
campaignIdsarray<any>
广告活动ID列表，Long数组，按广告活动ID筛选广告组
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
searchTextstring
搜索文本，模糊搜索广告组名称（ad_group_name）
statusarray<any>
广告组状态列表，String数组，枚举值：enabled-启用, disabled-禁用, delete-归档

请求cURL示例

curl --location 'https://openapi.lingxing.com/basicOpen/multiplatform/ads/queryGroupSpList?access_token=value&timestamp=value&sign=value&app_key=value' \
--header 'Content-Type: application/json' \
--data '{
    "advertiserIds": ["123456789012345"],
    "campaignType": ["sponsoredProducts-manual","sponsoredProducts-auto"],
    "day": 14,
    "endDate": "2024-11-12",
    "operationSourceType": "gateway",
    "pageNum": 1,
    "pageSize": 20,
    "paging": "1",
    "startDate": "2024-11-01",
    "campaignIds": [123456789,987654321],
    "orderField": "adSpend",
    "orderType": "DESC",
    "searchText": "测试广告组",
    "status": ["enabled","disabled"]
}'

返回结果

Json Object

codeinteger必填
响应码
dataobject必填
返回数据
隐藏子属性
listarray<object>必填
广告组列表数据
隐藏子属性
acosnumber
广告成本占比ACOS，计算公式: 广告花费 / 广告销售额 * 100%
示例 12.5
adGroupIdinteger
广告组ID
示例 987654321
adGroupNamestring
广告组名称
示例 测试广告组
adGroupStatusstring
广告组状态，枚举值：enabled-启用, disabled-禁用, delete-归档
示例 enabled
adSpendnumber
广告花费
示例 1500.5
advertisedSkuSalesnumber
直接销售额，广告直接点击归因销售额
示例 8500
advertisedSkuUnitsnumber
直接销量，广告直接点击归因销量
示例 100
advertiserIdinteger
广告账号ID
示例 123456789012345
aovnumber
平均订单值AOV，计算公式: 广告销售额 / 广告订单
示例 80
attributedOrdersinteger
广告订单数，归因总订单数
示例 150
attributedSalesnumber
广告销售额，归因总销售额
示例 12000
attributedUnitsinteger
广告销量，归因总销量
示例 200
campaignIdinteger
广告活动ID
示例 123456789
campaignNamestring
广告活动名称
示例 测试广告活动
campaignStatusstring
广告活动状态，枚举值：enabled-启用, paused-暂停, scheduled-已安排, rescheduled-重新安排, live-运行中, proposal-提议, completed-已完成
示例 enabled
campaignTypestring
广告活动类型，枚举值：sponsoredProducts-SP广告, sba-SB品牌广告, video-SV视频广告
示例 sponsoredProducts
cpanumber
平均订单成本CPA，计算公式: 广告花费 / 广告订单
示例 10
cpcnumber
点击成本CPC，计算公式: 广告花费 / 点击量
示例 3
ctrnumber
点击率CTR，计算公式: 点击量 / 曝光量 * 100%
示例 5
cvrnumber
转化率CVR，计算公式: 广告订单 / 点击量 * 100%
示例 30
entityCreateAtstring
创建时间，实体创建时间
示例 2024-11-01T10:00:00
keyinteger
唯一键，用于前端列表展示
示例 987654321
mpAdvertiserNamestring
广告账号名称
示例 主账号
mpSellerNamestring
店铺名称
示例 Walmart旗舰店
ntbOrderRatenumber
品牌新买家订单转化率，计算公式: ntbOrders / numAdsClicks * 100%
示例 6
ntbOrdersinteger
品牌新买家订单数
示例 30
ntbOrdersPercentnumber
品牌新买家订单占比，计算公式: ntbOrders / attributedOrders * 100%
示例 20
ntbRevenuenumber
品牌新买家销售额
示例 2500
ntbRevenuePercentnumber
品牌新买家销售额占比，计算公式: ntbRevenue / attributedSales * 100%
示例 20.83
ntbUnitsinteger
品牌新买家销量
示例 40
ntbUnitsPercentnumber
品牌新买家销量占比，计算公式: ntbUnits / attributedUnits * 100%
示例 20
numAdsClicksinteger
广告点击量
示例 500
numAdsShowninteger
曝光次数
示例 10000
otherSkuSalesnumber
关联销售额，间接归因销售额
示例 3500
otherSkuUnitsnumber
关联销量，间接归因销量
示例 50
roasnumber
投入产出比ROAS，计算公式: 广告销售额 / 广告花费
示例 8
targetingTypestring
投放类型，枚举值：manual-手动投放, auto-自动投放
示例 manual
totalinteger必填
总记录数
示例 100
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
}