/basicOpen/multiplatform/ads/reportKeywordSpList{
"operation": {
"method": "POST",
"path": "/basicOpen/multiplatform/ads/reportKeywordSpList"
},
"protocol": "HTTPS",
"host": "https://openapi.lingxing.com",
"rateLimit": {
"tokenBucketCapacity": 1,
"text": ""
},
"requestExample": "curl --location 'https://openapi.lingxing.com/basicOpen/multiplatform/ads/reportKeywordSpList?access_token=value×tamp=value&sign=value&app_key=value' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"advertiserIds\": [123456789012345,987654321098765],\n \"campaignType\": [\"sponsoredProducts-manual\",\"sponsoredProducts-auto\"],\n \"endDate\": \"2024-12-31\",\n \"startDate\": \"2024-01-01\",\n \"adGroupIds\": [123456,789012],\n \"campaignIds\": [123456789,987654321],\n \"day\": 14,\n \"orderField\": \"adSpend\",\n \"orderType\": \"DESC\",\n \"pageNum\": 1,\n \"pageSize\": 20,\n \"paging\": \"1\",\n \"searchText\": \"women shoes\",\n \"status\": [\"enabled\",\"paused\"]\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视频广告)。注意:查询SP广告报告必须且只能携带sponsoredProducts-manual和sponsoredProducts-auto |
| 3 | endDate | 结束日期 | string | — | 可选 | 结束日期,必填,格式:yyyy-MM-dd,且 startDate 和 endDate 间隔不能超过31天 |
| 4 | startDate | 开始日期 | string | — | 可选 | 开始日期,必填,格式:yyyy-MM-dd,且 startDate 和 endDate 间隔不能超过31天 |
| 5 | adGroupIds | 广告组ID列表 | array<any> | — | 可选 | 广告组ID列表,Integer数组,按广告组ID筛选 |
| 6 | campaignIds | 广告活动ID列表 | array<any> | — | 可选 | 广告活动ID列表,Long数组,按广告活动ID筛选 |
| 7 | day | 归因天数 | integer | — | 可选 | 归因天数,数据归因天数,枚举值:3, 14, 30,默认14天 |
| 8 | 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)等所有返回的报表字段。不传时默认按广告花费倒序 |
| 9 | orderType | 排序类型 | string | — | 可选 | 排序类型,枚举值:ASC-升序, DESC-降序,不传时默认ASC |
| 10 | pageNum | 页码 | integer | — | 可选 | 页码,分页时的页码,从1开始 |
| 11 | pageSize | 每页大小 | integer | — | 可选 | 每页大小,分页时每页显示的记录数,最大200 |
| 12 | paging | 是否分页 | boolean | — | 可选 | 是否分页,默认为true |
| 13 | searchText | 搜索文本 | string | — | 可选 | 搜索文本,模糊搜索关键词文本(keyword_text) |
| 14 | status | 关键词状态列表 | array<any> | — | 可选 | 关键词状态列表,String数组,枚举值:enabled-启用, paused-暂停 |
| 序号 | 字段 | 名称 | 类型 | 默认值 | 必填 | 描述 |
|---|---|---|---|---|---|---|
| 1 | code | 响应码 | integer | — | 必填 | 响应码 |
| 2 | data | 返回数据 | object | — | 必填 | 返回数据 |
| 2.1 | list | 列表数据 | array<object> | — | 必填 | 列表数据,关键词报表详细数据列表 |
| 2.1.1 | acos | 广告成本占比(ACoS) | string | 19.1 | 必填 | 广告成本占比(ACoS),计算公式:广告花费 / 广告销售额 * 100% |
| 2.1.2 | adGroupId | 广告组ID | string | 789123456 | 必填 | 广告组ID |
| 2.1.3 | adGroupName | 广告组名称 | string | 高转化关键词组 | 必填 | 广告组名称 |
| 2.1.4 | adGroupStatus | 广告组状态 | string | enabled | 必填 | 广告组状态,枚举值:enabled-启用, disabled-禁用,delete-归档 |
| 2.1.5 | adSpend | 广告花费 | string | 310.89 | 必填 | 广告花费,广告投放的总花费金额 |
| 2.1.6 | advertisedSkuSales | 直接销售额 | string | 1234.56 | 必填 | 直接销售额,广告直接点击归因销售额 |
| 2.1.7 | advertisedSkuUnits | 直接销量 | string | 34 | 必填 | 直接销量,广告直接点击归因销量 |
| 2.1.8 | advertiserId | 广告账号ID | string | 987654321098765 | 必填 | 广告账号ID |
| 2.1.9 | aov | 平均订单值(AOV) | string | 52.34 | 必填 | 平均订单值(AOV),计算公式:广告销售额 / 广告订单 |
| 2.1.10 | appliedTemplate | 应用的分时策略模板信息 | array<object> | — | 必填 | 应用的分时策略模板信息,AppliedTemplate对象数组 |
| 2.1.10.1 | benchmarkFixedVal | 基准固定值 | string | 1.5 | 必填 | 基准固定值,分时策略的固定基准值 |
| 2.1.10.2 | benchmarkType | 基准类型 | string | 1 | 必填 | 基准类型,枚举值:1-固定值, 2-动态值 |
| 2.1.10.3 | curBenchmarkVal | 当前基准值 | string | 1.8 | 必填 | 当前基准值,当前实际使用的基准值 |
| 2.1.10.4 | effectiveTime | 生效时间范围 | object | — | 必填 | 生效时间范围,EffectiveTime对象 |
| 2.1.10.4.1 | begin | 开始时间 | string | 2024-01-01 00:00:00 | 必填 | 开始时间,格式:yyyy-MM-dd HH:mm:ss |
| 2.1.10.4.2 | end | 结束时间 | string | 2024-12-31 23:59:59 | 必填 | 结束时间,格式:yyyy-MM-dd HH:mm:ss |
| 2.1.10.5 | id | 模板ID | string | 100234 | 必填 | 模板ID,分时策略模板的唯一标识 |
| 2.1.10.6 | taskName | 任务名称 | string | 晚高峰竞价提升策略 | 必填 | 任务名称,分时策略任务名称 |
| 2.1.10.7 | taskStatus | 任务状态 | string | 1 | 必填 | 任务状态,枚举值:0-未启用, 1-已启用, 2-已暂停 |
| 2.1.10.8 | taskType | 任务类型 | string | BID_ADJUSTMENT | 必填 | 任务类型,枚举值:BID_ADJUSTMENT-竞价调整, STATUS_CONTROL-状态控制, BUDGET_ADJUSTMENT-预算调整 |
| 2.1.10.9 | timezone | 时区 | string | America/Los_Angeles | 必填 | 时区,如:America/Los_Angeles |
| 2.1.11 | attributedOrders | 广告订单数 | string | 45 | 必填 | 广告订单数,归因总订单数 |
| 2.1.12 | attributedSales | 广告销售额 | string | 2345.67 | 必填 | 广告销售额,归因总销售额 |
| 2.1.13 | attributedUnits | 广告销量 | string | 67 | 必填 | 广告销量,归因总销量 |
| 2.1.14 | benchmarkVal | 基准值 | string | 0.8 | 必填 | 基准值,分时策略的基准值 |
| 2.1.15 | campaignId | 广告活动ID | string | 123456789 | 必填 | 广告活动ID |
| 2.1.16 | campaignName | 广告活动名称 | string | 双十一大促活动 | 必填 | 广告活动名称 |
| 2.1.17 | campaignStatus | 广告活动状态 | string | live | 必填 | 广告活动状态,枚举值:enabled-启用, paused-暂停, scheduled-已安排, rescheduled-重新安排, live-运行中, proposal-提议, completed-已完成 |
| 2.1.18 | campaignType | 广告活动类型 | string | sponsoredProducts | 必填 | 广告活动类型,枚举值:sponsoredProducts-SP广告, sba-SB品牌广告, video-SV视频广告 |
| 2.1.19 | completeViewRevenue | 完整观看收入 | string | 0 | 必填 | 完整观看收入,【仅SV视频广告】 |
| 2.1.20 | cpa | 平均订单成本(CPA) | string | 5.67 | 必填 | 平均订单成本(CPA),计算公式:广告花费 / 广告订单 |
| 2.1.21 | cpc | 点击成本(CPC) | string | 0.68 | 必填 | 点击成本(CPC),计算公式:广告花费 / 点击量 |
| 2.1.22 | ctr | 点击率(CTR) | string | 1.45 | 必填 | 点击率(CTR),计算公式:点击量 / 曝光量 * 100% |
| 2.1.23 | cvr | 转化率(CVR) | string | 9.87 | 必填 | 转化率(CVR),计算公式:广告订单 / 点击量 * 100% |
| 2.1.24 | entityCreateAt | 创建时间 | string | 2024-11-12 10:30:00 | 必填 | 创建时间,实体创建时间 |
| 2.1.25 | haloCompleteViewRevenue | 光晕完整观看收入 | string | 0 | 必填 | 光晕完整观看收入,【仅SV视频广告】 |
| 2.1.26 | inStoreAdvertisedSales | 实体店广告销售额(未使用) | string | 0 | 必填 | 实体店广告销售额(未使用) |
| 2.1.27 | inStoreAttributedSales | 实体店销售额 | string | 234.56 | 必填 | 实体店销售额,实体店归因总销售额 |
| 2.1.28 | inStoreOrders | 实体店订单数 | string | 23 | 必填 | 实体店订单数,实体店归因订单数 |
| 2.1.29 | inStoreOtherSales | 实体店关联销售额 | string | 123.45 | 必填 | 实体店关联销售额,实体店间接归因销售额 |
| 2.1.30 | inStoreUnitsSold | 实体店销量 | string | 45 | 必填 | 实体店销量,实体店归因销量 |
| 2.1.31 | isApplyTime | 是否应用分时策略 | string | 1 | 必填 | 是否应用分时策略 |
| 2.1.32 | key | 唯一键 | string | 456789123 | 必填 | 唯一键,用于前端列表展示,取值为keywordId |
| 2.1.33 | keywordBid | 关键词竞价 | string | 0.75 | 必填 | 关键词竞价,当前出价金额 |
| 2.1.34 | keywordId | 关键词ID | string | 456789123 | 必填 | 关键词ID |
| 2.1.35 | keywordName | 关键词文本 | string | women shoes | 必填 | 关键词文本 |
| 2.1.36 | keywordState | 关键词状态(旧字段) | string | enabled | 必填 | 关键词状态(旧字段) |
| 2.1.37 | keywordStatus | 关键词状态 | string | enabled | 必填 | 关键词状态,枚举值:enabled-启用, paused-暂停, deleted-已删除 |
| 2.1.38 | matchType | 匹配类型 | string | exact | 必填 | 匹配类型,枚举值:exact-精确匹配, phrase-短语匹配, broad-广泛匹配 |
| 2.1.39 | mpAdvertiserName | 广告账号名称 | string | Walmart广告账号A | 必填 | 广告账号名称 |
| 2.1.40 | mpSellerName | 店铺名称 | string | Walmart官方旗舰店 | 必填 | 店铺名称 |
| 2.1.41 | ntbOrderRate | 品牌新买家订单转化率 | string | 2.63 | 必填 | 品牌新买家订单转化率,计算公式:ntbOrders / numAdsClicks * 100% |
| 2.1.42 | ntbOrders | 品牌新买家订单数 | string | 12 | 必填 | 品牌新买家订单数,首次购买该品牌的买家产生的订单数 |
| 2.1.43 | ntbOrdersPercent | 品牌新买家订单占比 | string | 26.5 | 必填 | 品牌新买家订单占比,计算公式:ntbOrders / attributedOrders * 100% |
| 2.1.44 | ntbRevenue | 品牌新买家销售额 | string | 567.89 | 必填 | 品牌新买家销售额,首次购买该品牌的买家产生的销售额 |
| 2.1.45 | ntbRevenuePercent | 品牌新买家销售额占比 | string | 24.2 | 必填 | 品牌新买家销售额占比,计算公式:ntbRevenue / attributedSales * 100% |
| 2.1.46 | ntbUnits | 品牌新买家销量 | string | 18 | 必填 | 品牌新买家销量,首次购买该品牌的买家购买数量 |
| 2.1.47 | ntbUnitsPercent | 品牌新买家销量占比 | string | 26.9 | 必填 | 品牌新买家销量占比,计算公式:ntbUnits / attributedUnits * 100% |
| 2.1.48 | numAdsClicks | 广告点击量 | string | 456 | 必填 | 广告点击量,广告被点击的总次数 |
| 2.1.49 | numAdsShown | 曝光次数 | string | 31456 | 必填 | 曝光次数,广告被展示的总次数 |
| 2.1.50 | otherSkuSales | 关联销售额 | string | 1111.11 | 必填 | 关联销售额,间接归因销售额 |
| 2.1.51 | otherSkuUnits | 关联销量 | string | 33 | 必填 | 关联销量,间接归因销量 |
| 2.1.52 | roas | 投入产出比(ROAS) | string | 5.23 | 必填 | 投入产出比(ROAS),计算公式:广告销售额 / 广告花费 |
| 2.1.53 | targetingType | 投放类型 | string | manual | 必填 | 投放类型,枚举值:manual-手动投放, auto-自动投放 |
| 2.1.54 | totalCompleteViewOrders | 完整观看订单总数 | string | 0 | 必填 | 完整观看订单总数,【仅SV视频广告】 |
| 2.1.55 | totalCompleteViewUnits | 完整观看销量总数 | string | 0 | 必填 | 完整观看销量总数,【仅SV视频广告】 |
| 2.1.56 | video5SecondViews | 视频5秒观看次数 | string | 0 | 必填 | 视频5秒观看次数,【仅SV视频广告】 |
| 2.1.57 | videoCompleteViews | 视频完整观看次数 | string | 0 | 必填 | 视频完整观看次数,【仅SV视频广告】 |
| 2.1.58 | videoFirstQuartileViews | 视频第一四分位观看次数 | string | 0 | 必填 | 视频第一四分位观看次数,【仅SV视频广告】 |
| 2.1.59 | videoImpressions | 视频曝光量 | string | 0 | 必填 | 视频曝光量,【仅SV视频广告】 |
| 2.1.60 | videoMidpointViews | 视频中点观看次数 | string | 0 | 必填 | 视频中点观看次数,【仅SV视频广告】 |
| 2.1.61 | videoThirdQuartileViews | 视频第三四分位观看次数 | string | 0 | 必填 | 视频第三四分位观看次数,【仅SV视频广告】 |
| 2.1.62 | videoUnmutes | 视频取消静音次数 | string | 0 | 必填 | 视频取消静音次数,【仅SV视频广告】 |
| 2.1.63 | viewThroughOrders | 浏览订单数 | string | 0 | 必填 | 浏览订单数,【仅SV视频广告】 |
| 2.1.64 | viewThroughSales | 浏览销售额 | string | 0 | 必填 | 浏览销售额,【仅SV视频广告】 |
| 2.1.65 | viewThroughUnitsSold | 浏览销量 | string | 0 | 必填 | 浏览销量,【仅SV视频广告】 |
| 2.1.66 | viewableImpressions | 可见曝光量 | string | 0 | 必填 | 可见曝光量,【仅SV视频广告】 |
| 2.2 | total | 总记录数 | string | 3456 | 必填 | 总记录数,返回符合条件的数据总数 |
| 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/reportKeywordSpList),由轻易云数据集成平台 API 资产管理模块整理收纳,并随领星ERP版本更新同步更新。