/basicOpen/multiplatform/ads/queryCampaignSpList{
"operation": {
"method": "POST",
"path": "/basicOpen/multiplatform/ads/queryCampaignSpList"
},
"protocol": "HTTPS",
"host": "https://openapi.lingxing.com",
"rateLimit": {
"tokenBucketCapacity": 1,
"text": ""
},
"requestExample": "curl --location 'https://openapi.lingxing.com/basicOpen/multiplatform/ads/queryCampaignSpList?access_token=value×tamp=value&sign=value&app_key=value' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"advertiserIds\": [\"123456789012345\"],\n \"campaignType\": [\"sponsoredProducts-manual\",\"sponsoredProducts-auto\"],\n \"day\": 14,\n \"endDate\": \"2024-11-12\",\n \"operationSourceType\": \"gateway\",\n \"pageNum\": 1,\n \"pageSize\": 20,\n \"paging\": \"1\",\n \"startDate\": \"2024-11-01\",\n \"campaignIds\": [123456789,987654321],\n \"orderField\": \"adSpend\",\n \"orderType\": \"DESC\",\n \"searchText\": \"测试广告活动\",\n \"status\": [\"enabled\",\"live\"]\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
}
}| 序号 | 字段 | 名称 | 类型 | 默认值 | 必填 | 描述 |
|---|---|---|---|---|---|---|
| 1 | advertiserIds | 广告账号ID列表 | array<any> | — | 可选 | 广告账号ID列表,BigInteger数组,必须至少选择一个店铺 |
| 2 | campaignType | 广告活动类型列表 | array<any> | — | 可选 | 广告活动类型列表,String数组,枚举值:sponsoredProducts-manual(SP手动), sponsoredProducts-auto(SP自动), sba(SB品牌广告), video(SV视频广告)。注意:1.查询sp广告报告必须且只能携带sponsoredProducts-manual和sponsoredProducts-auto;2.查询sb广告报告必须且只能携带sba;3.查询sv广告报告必须且只能携带video |
| 3 | day | 归因天数 | integer | — | 可选 | 归因天数,数据归因天数,枚举值:3, 14, 30 |
| 4 | endDate | 结束日期 | string | — | 可选 | 结束日期,必填,格式:yyyy-MM-dd,且 startDate 和 endDate 间隔不能超过31天 |
| 5 | operationSourceType | 操作来源 | string | — | 可选 | 操作来源,openapi调用必传gateway,前端传web |
| 6 | pageNum | 页码 | integer | — | 可选 | 页码,分页时的页码,从1开始 |
| 7 | pageSize | 每页大小 | integer | — | 可选 | 每页大小,分页时每页显示的记录数,openapi必传且小于2000 |
| 8 | paging | 是否分页 | boolean | — | 可选 | 是否分页,openapi必填true |
| 9 | startDate | 开始日期 | string | — | 可选 | 开始日期,必填,格式:yyyy-MM-dd,且 startDate 和 endDate 间隔不能超过31天 |
| 10 | campaignIds | 广告活动ID列表 | array<any> | — | 可选 | 广告活动ID列表,Long数组,指定查询的广告活动ID,支持批量查询 |
| 11 | orderField | 排序字段 | string | — | 可选 | 排序字段,支持对查询结果中的任意字段进行排序(驼峰命名)。包括但不限于:基础指标(numAdsShown/numAdsClicks/adSpend)、销售指标(attributedSales/attributedOrders/attributedUnits/advertisedSkuSales/advertisedSkuUnits)、关联指标(otherSkuSales/otherSkuUnits)、品牌新买家指标(ntbOrders/ntbRevenue/ntbUnits)、计算指标(cpc/ctr/cvr/acos/roas/aov/cpa)、时间字段(startDate/endDate/entityCreateAt)等所有返回的报表字段。不传时默认按广告花费倒序 |
| 12 | orderType | 排序类型 | string | — | 可选 | 排序类型,枚举值:ASC-升序, DESC-降序。不传时默认ASC |
| 13 | searchText | 搜索文本 | string | — | 可选 | 搜索文本,模糊搜索广告活动名称 |
| 14 | status | 广告活动状态列表 | array<any> | — | 可选 | 广告活动状态列表,String数组,枚举值:enabled-启用, paused-暂停, scheduled-已安排, rescheduled-重新安排, live-运行中, proposal-提议, completed-已完成 |
| 序号 | 字段 | 名称 | 类型 | 默认值 | 必填 | 描述 |
|---|---|---|---|---|---|---|
| 1 | code | 响应码 | integer | — | 必填 | 响应码 |
| 2 | data | 返回数据 | object | — | 必填 | 返回数据 |
| 2.1 | list | 列表数据 | array<object> | — | 必填 | 列表数据 |
| 2.1.1 | acos | 广告成本占比ACOS | number | 25 | 可选 | 广告成本占比ACOS,计算公式:广告花费 / 广告销售额 * 100% |
| 2.1.2 | adSpend | 广告花费 | number | 1250.5 | 可选 | 广告花费 |
| 2.1.3 | advertisedSkuSales | 直接销售额 | number | 3500 | 可选 | 直接销售额,广告直接点击归因销售额 |
| 2.1.4 | advertisedSkuUnits | 直接销量 | integer | 70 | 可选 | 直接销量,广告直接点击归因销量 |
| 2.1.5 | advertiserId | 广告账号ID | integer | 123456789012345 | 可选 | 广告账号ID |
| 2.1.6 | aov | 平均订单值AOV | number | 50 | 可选 | 平均订单值AOV,计算公式:广告销售额 / 广告订单 |
| 2.1.7 | appliedTemplate | 应用的分时策略模板信息 | array<any> | — | 可选 | 应用的分时策略模板信息,AppliedTemplate对象数组 |
| 2.1.8 | attributedOrders | 广告订单数 | integer | 100 | 可选 | 广告订单数,归因总订单数 |
| 2.1.9 | attributedSales | 广告销售额 | number | 5000 | 可选 | 广告销售额,归因总销售额 |
| 2.1.10 | attributedUnits | 广告销量 | integer | 150 | 可选 | 广告销量,归因总销量 |
| 2.1.11 | benchmarkVal | 基准值 | number | 1.5 | 可选 | 基准值,分时策略的基准值 |
| 2.1.12 | biddingStrategy | 竞价策略 | object | {"type":"auto"} | 必填 | 竞价策略,JSON格式字符串 |
| 2.1.12.1 | biddingStrategyStatus | 竞价策略状态 | string | active | 必填 | 竞价策略状态,strategy为TROAS时返回 |
| 2.1.12.2 | strategy | 竞价策略 | string | TROAS | 必填 | 竞价策略,枚举值:DYNAMIC - 动态竞价,FIXED - 固定竞价, TROAS - 目标竞价 |
| 2.1.12.3 | troas | 支出回报率 | string | 5 | 必填 | 支出回报率,strategy为TROAS时返回 |
| 2.1.13 | budgetType | 预算类型 | string | daily | 可选 | 预算类型,枚举值:daily-每日预算, total-总预算, both-两者都有 |
| 2.1.14 | campaignId | 广告活动ID | integer | 987654321 | 可选 | 广告活动ID |
| 2.1.15 | campaignName | 广告活动名称 | string | 双十一促销活动 | 可选 | 广告活动名称 |
| 2.1.16 | campaignStatus | 广告活动状态 | string | live | 可选 | 广告活动状态,枚举值:enabled-启用, paused-暂停, scheduled-已安排, rescheduled-重新安排, live-运行中, proposal-提议, completed-已完成 |
| 2.1.17 | campaignType | 广告活动类型 | string | sponsoredProducts | 可选 | 广告活动类型,枚举值:sponsoredProducts-SP广告, sba-SB品牌广告, video-SV视频广告 |
| 2.1.18 | completeViewRevenue | 完整观看收入 | number | 300 | 可选 | 完整观看收入,仅SV视频广告 |
| 2.1.19 | cpa | 平均订单成本CPA | number | 12.51 | 可选 | 平均订单成本CPA,计算公式:广告花费 / 广告订单 |
| 2.1.20 | cpc | 点击成本CPC | number | 5 | 可选 | 点击成本CPC,计算公式:广告花费 / 点击量 |
| 2.1.21 | ctr | 点击率CTR | number | 5 | 可选 | 点击率CTR,计算公式:点击量 / 曝光量 * 100% |
| 2.1.22 | cvr | 转化率CVR | number | 40 | 可选 | 转化率CVR,计算公式:广告订单 / 点击量 * 100% |
| 2.1.23 | dailyBudget | 广告活动每日预算 | number | 500 | 可选 | 广告活动每日预算 |
| 2.1.24 | endDate | 广告活动结束日期 | string | 2024-11-30 | 可选 | 广告活动结束日期 |
| 2.1.25 | entityCreateAt | 创建时间 | string | 2024-11-01 10:00:00 | 可选 | 创建时间,实体创建时间 |
| 2.1.26 | haloCompleteViewRevenue | 光晕完整观看收入 | number | 100 | 可选 | 光晕完整观看收入,仅SV视频广告 |
| 2.1.27 | isApplyTime | 是否应用分时策略 | boolean | 1 | 可选 | 是否应用分时策略 |
| 2.1.28 | key | 唯一键 | integer | 123456789 | 可选 | 唯一键,用于前端列表展示 |
| 2.1.29 | mpAdvertiserName | 广告账号名称 | string | 测试广告账号 | 可选 | 广告账号名称 |
| 2.1.30 | mpSellerName | 店铺名称 | string | 测试店铺 | 可选 | 店铺名称 |
| 2.1.31 | ntbOrderRate | 品牌新买家订单转化率 | number | 12 | 可选 | 品牌新买家订单转化率,计算公式:ntbOrders / numAdsClicks * 100% |
| 2.1.32 | ntbOrders | 品牌新买家订单数 | integer | 30 | 可选 | 品牌新买家订单数 |
| 2.1.33 | ntbOrdersPercent | 品牌新买家订单占比 | number | 30 | 可选 | 品牌新买家订单占比,计算公式:ntbOrders / attributedOrders * 100% |
| 2.1.34 | ntbRevenue | 品牌新买家销售额 | number | 1500 | 可选 | 品牌新买家销售额 |
| 2.1.35 | ntbRevenuePercent | 品牌新买家销售额占比 | number | 30 | 可选 | 品牌新买家销售额占比,计算公式:ntbRevenue / attributedSales * 100% |
| 2.1.36 | ntbUnits | 品牌新买家销量 | integer | 45 | 可选 | 品牌新买家销量 |
| 2.1.37 | ntbUnitsPercent | 品牌新买家销量占比 | number | 30 | 可选 | 品牌新买家销量占比,计算公式:ntbUnits / attributedUnits * 100% |
| 2.1.38 | numAdsClicks | 广告点击量 | integer | 250 | 可选 | 广告点击量 |
| 2.1.39 | numAdsShown | 曝光次数 | integer | 5000 | 可选 | 曝光次数 |
| 2.1.40 | otherSkuSales | 关联销售额 | number | 1500 | 可选 | 关联销售额,间接归因销售额 |
| 2.1.41 | otherSkuUnits | 关联销量 | integer | 80 | 可选 | 关联销量,间接归因销量 |
| 2.1.42 | reportTag | 报表标签 | string | REALTIME | 可选 | 报表标签,枚举值:REALTIME-实时数据标识 |
| 2.1.43 | roas | 投入产出比ROAS | number | 4 | 可选 | 投入产出比ROAS,计算公式:广告销售额 / 广告花费 |
| 2.1.44 | rollover | 是否结转 | boolean | 1 | 可选 | 是否结转,前一天未用的每日预算是否应结转到第二天的每日预算 |
| 2.1.45 | startDate | 广告活动开始日期 | string | 2024-11-01 | 可选 | 广告活动开始日期 |
| 2.1.46 | targetingType | 投放类型 | string | manual | 可选 | 投放类型,枚举值:manual-手动投放, auto-自动投放 |
| 2.1.47 | totalBudget | 广告活动总预算 | number | 10000 | 可选 | 广告活动总预算 |
| 2.1.48 | totalCompleteViewOrders | 完整观看订单总数 | integer | 5 | 可选 | 完整观看订单总数,仅SV视频广告 |
| 2.1.49 | totalCompleteViewUnits | 完整观看销量总数 | integer | 15 | 可选 | 完整观看销量总数,仅SV视频广告 |
| 2.1.50 | video5SecondViews | 视频5秒观看次数 | integer | 200 | 可选 | 视频5秒观看次数,仅SV视频广告 |
| 2.1.51 | videoCompleteViews | 视频完整观看次数 | integer | 50 | 可选 | 视频完整观看次数,仅SV视频广告 |
| 2.1.52 | videoFirstQuartileViews | 视频第一四分位观看次数 | integer | 100 | 可选 | 视频第一四分位观看次数,仅SV视频广告 |
| 2.1.53 | videoImpressions | 视频曝光量 | integer | 1000 | 可选 | 视频曝光量,仅SV视频广告 |
| 2.1.54 | videoMidpointViews | 视频中点观看次数 | integer | 80 | 可选 | 视频中点观看次数,仅SV视频广告 |
| 2.1.55 | videoThirdQuartileViews | 视频第三四分位观看次数 | integer | 60 | 可选 | 视频第三四分位观看次数,仅SV视频广告 |
| 2.1.56 | videoUnmutes | 视频取消静音次数 | integer | 30 | 可选 | 视频取消静音次数,仅SV视频广告 |
| 2.1.57 | viewThroughOrders | 浏览订单数 | integer | 10 | 可选 | 浏览订单数,仅SV视频广告 |
| 2.1.58 | viewThroughSales | 浏览销售额 | number | 500 | 可选 | 浏览销售额,仅SV视频广告 |
| 2.1.59 | viewThroughUnitsSold | 浏览销量 | integer | 20 | 可选 | 浏览销量,仅SV视频广告 |
| 2.1.60 | viewableImpressions | 可见曝光量 | integer | 800 | 可选 | 可见曝光量,仅SV视频广告 |
| 2.2 | total | 总记录数 | integer | 100 | 必填 | 总记录数 |
| 3 | error_details | 错误详情 | array<any> | — | 必填 | 错误详情 |
| 4 | message | 提示信息 | string | — | 必填 | 提示信息 |
| 5 | request_id | 请求id | string | — | 必填 | 请求id |
| 6 | response_time | 响应时间 | string | — | 必填 | 响应时间 |
| 7 | total | 总记录数 | integer | — | 必填 | 总记录数 |
领星ERP的接口:查询沃尔玛 - 广告 - SP广告 - 广告活动(/basicOpen/multiplatform/ads/queryCampaignSpList),由轻易云数据集成平台 API 资产管理模块整理收纳,并随领星ERP版本更新同步更新。