Lingxing
切换旧版

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

POST/basicOpen/multiplatform/ads/queryAdGroupSvList

接口信息

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

请求参数

advertiserIdsarray<any>
广告账号ID列表,BigInteger数组,必须至少选择一个店铺
campaignTypearray<any>
广告活动类型列表,String数组,枚举值:sponsoredProducts-manual(SP手动), sponsoredProducts-auto(SP自动), sba(SB品牌广告), video(SV视频广告)。不传时默认查询所有类型
dateKeystring
天数据聚合维度,枚举值:day-按天, week-按周, month-按月。【仅天维度接口使用】
endDatestring
结束日期,格式: yyyy-MM-dd,且 startDate 和 endDate 间隔不能超过31天
startDatestring
开始日期,格式: yyyy-MM-dd,且 startDate 和 endDate 间隔不能超过31天
campaignIdsarray<any>
广告活动ID列表,Long数组,按广告活动ID筛选广告组
companyIdinteger
公司ID
dayinteger
归因天数,数据归因天数,枚举值:3, 14, 30。默认14天
operationSourceTypestring
操作来源,默认网页操作
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
每页大小,分页时每页显示的记录数
pagingboolean
是否分页,默认为true
searchTextstring
搜索文本,模糊搜索广告组名称(ad_group_name)
searchTypestring
搜索类型,目前不用传
statusarray<any>
广告组状态列表,String数组,枚举值:enabled-启用, disabled-禁用, delete-归档

请求cURL示例

curl --location 'https://openapi.lingxing.com/basicOpen/multiplatform/ads/queryAdGroupSvList?access_token=value&timestamp=value&sign=value&app_key=value' \
--header 'Content-Type: application/json' \
--data '{
    "advertiserIds": ["123456789","987654321"],
    "campaignType": ["video"],
    "dateKey": "day",
    "endDate": "2024-12-31",
    "startDate": "2024-01-01",
    "campaignIds": ["100001","100002"],
    "companyId": 10001,
    "day": 14,
    "operationSourceType": "web",
    "orderField": "adSpend",
    "orderType": "DESC",
    "pageNum": 1,
    "pageSize": 50,
    "paging": "1",
    "searchText": "测试广告组",
    "searchType": "value",
    "status": ["enabled","disabled"]
}'

返回结果

Json Object

codeinteger必填
响应码
dataobject必填
返回数据
隐藏子属性
listarray<object>必填
广告组列表数据
隐藏子属性
acosstring必填
广告成本销售比(ACOS),计算公式:adSpend / attributedSales
示例 23.5
adGroupIdstring必填
广告组ID
示例 8765432109
adGroupNamestring必填
广告组名称
示例 冬季促销广告组
adGroupStatusstring必填
广告组状态,枚举值:enabled-启用, disabled-禁用, delete-归档
示例 enabled
adSpendstring必填
广告花费
示例 1058.75
advertisedSkuSalesstring必填
广告SKU销售额
示例 3250.75
advertisedSkuUnitsstring必填
广告SKU销售单元数
示例 156
advertiserIdstring必填
广告账号ID
示例 123456789012345
aovstring必填
平均订单价值(AOV),计算公式:attributedSales / attributedOrders
示例 35.5
attributedOrdersstring必填
归因订单数,广告带来的总订单数
示例 125
attributedSalesstring必填
归因销售额,广告带来的总销售额
示例 4500.25
attributedUnitsstring必填
归因销售单元数,广告带来的总销售单元数
示例 194
campaignIdstring必填
广告活动ID
示例 9876543210
campaignNamestring必填
广告活动名称
示例 2024春季促销活动
campaignStatusstring必填
广告活动状态,枚举值:enabled-启用, disabled-禁用, delete-归档
示例 enabled
campaignTypestring必填
广告活动类型,枚举值:sponsoredProducts-manual(SP手动), sponsoredProducts-auto(SP自动), sba(SB品牌广告), video(SV视频广告)
示例 video
cpastring必填
单次转化成本(CPA),计算公式:adSpend / attributedOrders
示例 8.5
cpcstring必填
单次点击成本(CPC),计算公式:adSpend / numAdsClicks
示例 0.45
ctrstring必填
点击率(CTR),计算公式:numAdsClicks / numAdsShown
示例 2.15
cvrstring必填
转化率(CVR),计算公式:attributedOrders / numAdsClicks
示例 5.32
entityCreateAtstring必填
实体创建时间
示例 2024-01-15 10:30:00
keystring必填
唯一标识键
示例 adGroup_8765432109
mpAdvertiserNamestring必填
广告账号名称
示例 沃尔玛广告账号A
mpSellerNamestring必填
店铺名称
示例 我的沃尔玛店铺
ntbOrderRatestring必填
品牌新买家订单率
示例 33.6
ntbOrdersstring必填
品牌新买家订单数
示例 42
ntbOrdersPercentstring必填
品牌新买家订单占比百分比
示例 35.5
ntbRevenuestring必填
品牌新买家销售额
示例 1850.5
ntbRevenuePercentstring必填
品牌新买家销售额占比百分比
示例 38.2
ntbUnitsstring必填
品牌新买家购买单元数
示例 45
ntbUnitsPercentstring必填
品牌新买家购买单元占比百分比
示例 32.8
numAdsClicksstring必填
广告点击次数
示例 2350
numAdsShownstring必填
广告展示次数
示例 109250
otherSkuSalesstring必填
其他SKU销售额,关联销售额
示例 850.25
otherSkuUnitsstring必填
其他SKU销售单元数,关联销售单元数
示例 38
roasstring必填
广告投入产出比(ROAS),计算公式:attributedSales / adSpend
示例 4.25
targetingTypestring必填
定向类型
示例 auto
totalstring必填
总记录数
示例 1500
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
}