广告组绩效报告

根据指定查询条件获取广告活动名称、活动状态、日期范围。

相关URL

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

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

参数

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

相关请求信息

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

请求文件主体

属性 是否必填？ 格式 描述
sellerId 是 String 您在新蛋商城的商家编号
countryCode 否 String 您的广告活动所在的国家/地区。只接受国际标准3位国家编码。
extUrl 是 String 绩效精确链接

有效值：group/searchGroupByCampaign
campaignNumber 否 Integer 广告活动标识编号
type 否 Integer 广告活动投放类型。有效值：

  • 0：manual targeting  手动投放
  • 1：auto targeting  自动投放
sponsorType 否 Integer 付费广告活动类型。有效值:

  • 0：Sponsored Products  产品推广
  • 1：Sponsored Headlines  头条推广
  • 2：Sponsored Video  视频推广
  • 3：Sponsor display  展示型推广
  • 4：Offsite Ads  站外广告
searchKeywordType 否 Enum 有效值：

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

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

示例：Json，Request

POST https://api.newegg.com/marketplace/sponsoredmgmt/campaign/group/performance?sellerid={sellerid}
Content-Type: application/json
Accept: application/json
Authorization: 2d9da3949bdffd8594e9fa8a77764ce1
SecretKey: 55F55BC1-5E65-401B-BB1D-E29B0A19B734
 
 {
  "sellerId": "AK9Y",
  "countryCode": "USA",
  "extUrl": "group/searchGroupByCampaign",
  "campaignNumber": "449001",
  "type": null,
  "sponsorType": null,
  "searchKeywordType": null,
  "keyword": null,
  "activeStatus": null,
  "fromDate": "1970-01-01",
  "toDate": "2022-09-09",
  "pageInfo": {
    "pageIndex": 1,
    "pageSize": 20,
    "sortField": "InDate",
    "sortType": "Desc"
  }
}

回复文件主体

属性 格式 描述
campaignNumber Integer 与广告组关联的广告活动标识编号
campaignName String 广告活动名称
groupNumber Integer 广告组标识编号
groupName String 广告组名称
countryCode String 国家/地区编码
defaultBid Decimal 广告组中无出价记录的关键词竞价金额
offSiteBid Decimal 站外广告竞价金额
type Integer 广告活动投放类型。有效值：

  • 0：manual targeting  手动投放
  • 1：auto-targeting  自动投放
  • 2：brand headlines manual  品牌头条手动投放
  • 3：brand headlines auto  品牌头条自动投放
  • 4：video manual   视频手动投放
  • 5：video auto  视频自动投放
  • 6：Sponsored Display – onsite   Newegg平台展示型推广
  • 7：Sponsored Display – offsite  非Newegg平台展示型推广
  • 8：Newegg Offsite Ads  站外广告
suggBid Decimal 建议出价
suggBidLowest Decimal 建议最低出价
suggBidMost Decimal 建议最高出价
keywordSize Integer 关键词数量
keywordList String 关键词文本
productSize Integer 商品数量
productList String 商品集合列表
sellerID String 您的商家编号
sellerName String 您的商家名称
activeStatus String 结果限制为指定范围内的状态。有效值：

  • Active  启用：查询处理中、正在投放、已超预算状态的数据
  • Inactive  暂停：查询暂停和已结束状态的数据
status String 广告组状态描述
有效值：

  • Pending  待审核
  • Delivering  正在投放
  • Processing  处理中
  • Out of budget  已超预算
  • Inactive  已暂停
  • Ended  已结束
inDate String 广告组创建日期
inUser Integer 广告组创建者
logo String 如广告活动类型为头条，值为Logo文件名称
headline String 如广告活动类型为头条，值为头条URL
title String 如广告活动类型为头条，值为界面展示的信息，位于商家Logo下方
landingPageType Integer 有效值：

  • 0：新蛋店铺
  • 1：卖家输入的新蛋导航页
landingPageUrl String 导航页URL
declineReason String 广告活动被拒绝原因
videoUrl String 如广告活动类型为视频，值为视频URL
costModel Integer 有效值：

  • 0: CPM  每千次展示费用
  • 1: CPC  每次点击费用
productTargetingList String 商品投放列表
liveStreamingProductList 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 groups success",
      "bizCode": "026"
    }
  ],
  "rows": [
    {
      "campaignNumber": 449001,
      "campaignName": "Cat6A plenum Bare Copper All",
      "groupNumber": 449002,
      "groupName": "Cat6a plenum Bare Copper",
      "countryCode": "USA",
      "defaultBid": null,
      "offSiteBid": null,
      "onSiteBid": null,
      "type": 1,
      "suggBid": null,
      "suggBidLowest": null,
      "suggBidMost": null,
      "keywordSize": 211,
      "keywordList": null,
      "productSize": 10,
      "productList": [
        "9SIAK9YDN88510",
        "9SIAK9YFA62671",
        "9SIAK9YFA62670",
        "9SIAK9YDRS1245",
        "9SIAK9YDRS1244",
        "9SIAK9YGRN6913",
        "9SIAK9YH889909",
        "9SIAK9YJFB3999",
        "9SIAK9YJFG6264",
        "9SIAK9YJFG6339"
      ],
      "sellerID": "AK9Y",
      "sellerName": "",
      "activeStatus": "Active",
      "status": "Delivering",
      "inDate": "Wed Feb 17 23:42:45 PST 2021",
      "inUser": "63722164",
      "logo": null,
      "headline": null,
      "title": null,
      "landingPageType": 0,
      "landingPageUrl": null,
      "declineReason": null,
      "videoUrl": null,
      "costModel": 0,
      "productTargetingList": null,
      "liveStreamingProductList": null,
      "spend": 932.24,
      "sales": 3616.87,
      "acos": 0.2577477210958647,
      "impressions": 27557,
      "clicks": 661,
      "ctr": 0.023986645861305656,
      "orders": 11,
      "cr": 0.01664145234493192,
      "cpc": 1.428174706649283
    }
  ],
  "totalRows": 1
}

更新日期：10/03/2022