/basicOpen/multiplatform/ads/queryAdGroupSvList{
"operation": {
"method": "POST",
"path": "/basicOpen/multiplatform/ads/queryAdGroupSvList"
},
"protocol": "HTTPS",
"host": "https://openapi.lingxing.com",
"rateLimit": {
"tokenBucketCapacity": 1,
"text": ""
},
"requestExample": "curl --location 'https://openapi.lingxing.com/basicOpen/multiplatform/ads/queryAdGroupSvList?access_token=value×tamp=value&sign=value&app_key=value' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"advertiserIds\": [\"123456789\",\"987654321\"],\n \"campaignType\": [\"video\"],\n \"dateKey\": \"day\",\n \"endDate\": \"2024-12-31\",\n \"startDate\": \"2024-01-01\",\n \"campaignIds\": [\"100001\",\"100002\"],\n \"companyId\": 10001,\n \"day\": 14,\n \"operationSourceType\": \"web\",\n \"orderField\": \"adSpend\",\n \"orderType\": \"DESC\",\n \"pageNum\": 1,\n \"pageSize\": 50,\n \"paging\": \"1\",\n \"searchText\": \"测试广告组\",\n \"searchType\": \"value\",\n \"status\": [\"enabled\",\"disabled\"]\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
}
}| No. | Field | Name | Type | Default | Required | Description |
|---|---|---|---|---|---|---|
| 1 | advertiserIds | 广告账号ID列表 | array<any> | — | Optional | 广告账号ID列表,BigInteger数组,必须至少选择一个店铺 |
| 2 | campaignType | 广告活动类型列表 | array<any> | — | Optional | 广告活动类型列表,String数组,枚举值:sponsoredProducts-manual(SP手动), sponsoredProducts-auto(SP自动), sba(SB品牌广告), video(SV视频广告)。不传时默认查询所有类型 |
| 3 | dateKey | 天数据聚合维度 | string | — | Optional | 天数据聚合维度,枚举值:day-按天, week-按周, month-按月。【仅天维度接口使用】 |
| 4 | endDate | 结束日期 | string | — | Optional | 结束日期,格式: yyyy-MM-dd,且 startDate 和 endDate 间隔不能超过31天 |
| 5 | startDate | 开始日期 | string | — | Optional | 开始日期,格式: yyyy-MM-dd,且 startDate 和 endDate 间隔不能超过31天 |
| 6 | campaignIds | 广告活动ID列表 | array<any> | — | Optional | 广告活动ID列表,Long数组,按广告活动ID筛选广告组 |
| 7 | companyId | 公司ID | integer | — | Optional | 公司ID |
| 8 | day | 归因天数 | integer | — | Optional | 归因天数,数据归因天数,枚举值:3, 14, 30。默认14天 |
| 9 | operationSourceType | 操作来源 | string | — | Optional | 操作来源,默认网页操作 |
| 10 | orderField | 排序字段 | 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)等所有返回的报表字段。不传时默认按广告花费倒序 |
| 11 | orderType | 排序类型 | string | — | Optional | 排序类型,枚举值:ASC-升序, DESC-降序。不传时默认ASC |
| 12 | pageNum | 页码 | integer | — | Optional | 页码,分页时的页码,从1开始 |
| 13 | pageSize | 每页大小 | integer | — | Optional | 每页大小,分页时每页显示的记录数 |
| 14 | paging | 是否分页 | boolean | — | Optional | 是否分页,默认为true |
| 15 | searchText | 搜索文本 | string | — | Optional | 搜索文本,模糊搜索广告组名称(ad_group_name) |
| 16 | searchType | 搜索类型 | string | — | Optional | 搜索类型,目前不用传 |
| 17 | status | 广告组状态列表 | array<any> | — | Optional | 广告组状态列表,String数组,枚举值:enabled-启用, disabled-禁用, delete-归档 |
| No. | Field | Name | Type | Default | Required | Description |
|---|---|---|---|---|---|---|
| 1 | code | 响应码 | integer | — | Required | 响应码 |
| 2 | data | 返回数据 | object | — | Required | 返回数据 |
| 2.1 | list | 广告组列表数据 | array<object> | — | Required | 广告组列表数据 |
| 2.1.1 | acos | 广告成本销售比(ACOS) | string | 23.5 | Required | 广告成本销售比(ACOS),计算公式:adSpend / attributedSales |
| 2.1.2 | adGroupId | 广告组ID | string | 8765432109 | Required | 广告组ID |
| 2.1.3 | adGroupName | 广告组名称 | string | 冬季促销广告组 | Required | 广告组名称 |
| 2.1.4 | adGroupStatus | 广告组状态 | string | enabled | Required | 广告组状态,枚举值:enabled-启用, disabled-禁用, delete-归档 |
| 2.1.5 | adSpend | 广告花费 | string | 1058.75 | Required | 广告花费 |
| 2.1.6 | advertisedSkuSales | 广告SKU销售额 | string | 3250.75 | Required | 广告SKU销售额 |
| 2.1.7 | advertisedSkuUnits | 广告SKU销售单元数 | string | 156 | Required | 广告SKU销售单元数 |
| 2.1.8 | advertiserId | 广告账号ID | string | 123456789012345 | Required | 广告账号ID |
| 2.1.9 | aov | 平均订单价值(AOV) | string | 35.5 | Required | 平均订单价值(AOV),计算公式:attributedSales / attributedOrders |
| 2.1.10 | attributedOrders | 归因订单数 | string | 125 | Required | 归因订单数,广告带来的总订单数 |
| 2.1.11 | attributedSales | 归因销售额 | string | 4500.25 | Required | 归因销售额,广告带来的总销售额 |
| 2.1.12 | attributedUnits | 归因销售单元数 | string | 194 | Required | 归因销售单元数,广告带来的总销售单元数 |
| 2.1.13 | campaignId | 广告活动ID | string | 9876543210 | Required | 广告活动ID |
| 2.1.14 | campaignName | 广告活动名称 | string | 2024春季促销活动 | Required | 广告活动名称 |
| 2.1.15 | campaignStatus | 广告活动状态 | string | enabled | Required | 广告活动状态,枚举值:enabled-启用, disabled-禁用, delete-归档 |
| 2.1.16 | campaignType | 广告活动类型 | string | video | Required | 广告活动类型,枚举值:sponsoredProducts-manual(SP手动), sponsoredProducts-auto(SP自动), sba(SB品牌广告), video(SV视频广告) |
| 2.1.17 | cpa | 单次转化成本(CPA) | string | 8.5 | Required | 单次转化成本(CPA),计算公式:adSpend / attributedOrders |
| 2.1.18 | cpc | 单次点击成本(CPC) | string | 0.45 | Required | 单次点击成本(CPC),计算公式:adSpend / numAdsClicks |
| 2.1.19 | ctr | 点击率(CTR) | string | 2.15 | Required | 点击率(CTR),计算公式:numAdsClicks / numAdsShown |
| 2.1.20 | cvr | 转化率(CVR) | string | 5.32 | Required | 转化率(CVR),计算公式:attributedOrders / numAdsClicks |
| 2.1.21 | entityCreateAt | 实体创建时间 | string | 2024-01-15 10:30:00 | Required | 实体创建时间 |
| 2.1.22 | key | 唯一标识键 | string | adGroup_8765432109 | Required | 唯一标识键 |
| 2.1.23 | mpAdvertiserName | 广告账号名称 | string | 沃尔玛广告账号A | Required | 广告账号名称 |
| 2.1.24 | mpSellerName | 店铺名称 | string | 我的沃尔玛店铺 | Required | 店铺名称 |
| 2.1.25 | ntbOrderRate | 品牌新买家订单率 | string | 33.6 | Required | 品牌新买家订单率 |
| 2.1.26 | ntbOrders | 品牌新买家订单数 | string | 42 | Required | 品牌新买家订单数 |
| 2.1.27 | ntbOrdersPercent | 品牌新买家订单占比百分比 | string | 35.5 | Required | 品牌新买家订单占比百分比 |
| 2.1.28 | ntbRevenue | 品牌新买家销售额 | string | 1850.5 | Required | 品牌新买家销售额 |
| 2.1.29 | ntbRevenuePercent | 品牌新买家销售额占比百分比 | string | 38.2 | Required | 品牌新买家销售额占比百分比 |
| 2.1.30 | ntbUnits | 品牌新买家购买单元数 | string | 45 | Required | 品牌新买家购买单元数 |
| 2.1.31 | ntbUnitsPercent | 品牌新买家购买单元占比百分比 | string | 32.8 | Required | 品牌新买家购买单元占比百分比 |
| 2.1.32 | numAdsClicks | 广告点击次数 | string | 2350 | Required | 广告点击次数 |
| 2.1.33 | numAdsShown | 广告展示次数 | string | 109250 | Required | 广告展示次数 |
| 2.1.34 | otherSkuSales | 其他SKU销售额 | string | 850.25 | Required | 其他SKU销售额,关联销售额 |
| 2.1.35 | otherSkuUnits | 其他SKU销售单元数 | string | 38 | Required | 其他SKU销售单元数,关联销售单元数 |
| 2.1.36 | roas | 广告投入产出比(ROAS) | string | 4.25 | Required | 广告投入产出比(ROAS),计算公式:attributedSales / adSpend |
| 2.1.37 | targetingType | 定向类型 | string | auto | Required | 定向类型 |
| 2.2 | total | 总记录数 | string | 1500 | Required | 总记录数 |
| 3 | error_details | 错误详情 | array<any> | — | Required | 错误详情 |
| 4 | message | 提示信息 | string | — | Required | 提示信息 |
| 5 | request_id | 请求id | string | — | Required | 请求id |
| 6 | response_time | 响应时间 | string | — | Required | 响应时间 |
| 7 | total | 总记录数 | integer | — | Required | 总记录数 |
The 查询沃尔玛 - 广告 - SV广告 - 广告组 API (/basicOpen/multiplatform/ads/queryAdGroupSvList) 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.
Qeasy ships with prebuilt adaptation for this API — contact us to start configuring data integration.