商品绩效报告

根据指定的商品标题、活动状态、日期范围获取绩效报告。

相关URL

Newegg.com: https://api.newegg.com/marketplace/sponsoredmgmt/campaign/product/performance?sellerid={sellerid}

注:请确保您的请求URL全都是小写(除Seller ID)并且不能包含任何空格或者换行符。

参数

名称 是否必填? 描述
sellerid 您在新蛋商城的商家编号

相关请求信息

HTTP方式 是否需要认证? 请求格式 回复格式 频率限制
POST 需要 Json Json 1000 请求/小时

请求文件主体

属性 是否必填? 格式 描述
sellerId String 您在新蛋商城的商家编号
extUrl String 绩效精确链接

有效值:product/searchItems

countryCode String 国家/地区的国际标准3位国家编码
campaignNumber Integer 广告活动标识编号
groupNumber Integer 广告组标识编号
searchKeywordType Enum 有效值:

  • GROUP_NAME 模糊匹配,只支持单个关键词
  • GROUP_NUM 精准匹配,关键词输入组号用逗号分隔,支持批量查询
keyword String 结果限制为具有指定名称的广告活动
activeStatus Enum 结果限制为指定范围内的状态
有效值:

  • Active 启用:查询处理中、正在投放、已超预算状态的数据
  • Inactive 暂停:查询暂停和已结束状态的数据
fromDate String 广告活动的开始日期
toDate String 广告活动的结束日期
pageInfo pageIndex Integer 当前页索引,默认为 1
pageSize Integer 一页中的记录数(最大值为每页999999 条)
sortField String 排序字段名称,默认为InDate
sortType String 默认Desc,支持Desc、Asc两种方式

示例:Json,Request

POST https://api.newegg.com/marketplace/sponsoredmgmt/campaign/product/performance?sellerid={sellerid}
Content-Type: application/json
Accept: application/json
Authorization: 2d9da3949bdffd8594e9fa8a77764ce1
SecretKey: 55F55BC1-5E65-401B-BB1D-E29B0A19B734  
 
{
  "sellerId": "A2GS",
  "extUrl": "product/searchItems",
  "countryCode": "USA"
  "campaignNumber": "1295077",
  "groupNumber": "1295078",
  "searchKeywordType": null,
  "keyword": null,
  "activeStatus": null,
  "fromDate": "2022-09-09",
  "toDate": "2022-09-09",
  "pageInfo": {
    "pageIndex": 1,
    "pageSize": 9999999,
    "sortField": "InDate",
    "sortType": "Desc"
  }
}

回复文件主体

属性 格式 描述
campaignNumber Integer 广告活动标识编号
campaignName String 广告活动名称
groupNumber Integer 广告组标识编号
groupName String 广告组名称
itemNumber String 新蛋商品编号
itemTitle String 商品网页标题
countryCode String 国家/地区的国际标准3位国家编码
sellingPrice Decimal 商品实际售价
primaryImgUrl String 商品主图URL
itemStatus Enum 有效值:

  • Enable 激活状态
itemLink String 商品PDP页面链接
sellerPartNumber String 商家商品编号
sellerName String 商家名称
activeStatus String 有效值:

  • Active  上架
  • Inactive  下架
status String 商品状态描述
有效值:

  • Pending  待审核
  • Delivering  正在投放
  • Processing  处理中
  • Out of budget  已超预算
  • Inactive  已暂停
  • Ended  已结束
declineReason String 广告活动被拒绝原因
userId String 创建广告活动的用户ID
userName String 创建广告活动的用户名称
inDate String 关键词创建日期
inUser String 关键词创建用户ID
liveStreamingPrice Decimal 直播间售价
liveStreamingNote String 直播备注
spend Decimal 商品花费
sales Decimal 商品销售额
ACoS Decimal 投入产出比:商品花费 / 销售额
impressions Integer 商品被展示次数
clicks Integer 商品被点击的次数
ctr Decimal 点击率:商品的点击次数 / 曝光量
orders Integer 商品订单数量
cr Decimal 转化率
cpc Decimal 每次点击费用
totalRows Integer 返回结果总数量

示例:Json,Request

{
  "header": [
    {
      "msg": "search item success",
      "bizCode": "031"
    }
  ],
  "rows": [
    {
      "campaignNumber": 1295077,
      "campaignName": "SellerAPITest",
      "groupNumber": 1295078,
      "groupName": "1",
      "itemNumber": "9SIA2GSCXT9656",
      "itemTitle": "testXML",
      "countryCode": "USA",
      "sellingPrice": null,
      "primaryImgUrl": null,
      "itemStatus": "ENABLED",
      "itemLink": null,
      "sellerPartNumber": null,
      "sellerID": null,
      "sellerName": null,
      "activeStatus": "Active",
      "status": "Delivering",
      "declineReason": null,
      "userId": "A2GS",
      "userName": null,
      "inDate": "2022-07-19 02:47:08.920-0700",
      "inUser": "A2GS",
      "liveStreamingPrice": null,
      "liveStreamingNote": null,
      "costModel": null,
      "spend": 0,
      "sales": 0,
      "acos": 0,
      "impressions": 0,
      "clicks": 0,
      "ctr": 0,
      "orders": 0,
      "cr": 0,
      "cpc": 0
    }
  ],
  "totalRows": 1
}

更新日期:10/03/2022