关键词列表

搜索指定关键词,查询广告活动信息。

相关URL

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

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

参数

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

相关请求信息

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

请求文件主体

属性 是否必填? 格式 描述
sellerId String 您在新蛋商城的商家编号
campaignNumber Integer 关键词相关联的广告活动标识编号
searchKeywordType Enum 关键词,模糊匹配
与关键词配合使用,同时返回值或不返回值
如果不通过,表示该条件未被过滤
keyword String 结果限制为与指定文本完全匹配的关键词
activeStatus Enum 有效值:

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

示例:Json,Request

POST https://api.newegg.com/marketplace/sponsoredmgmt/campaign/keyword/search?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json

{
  "sellerId": "ANWT",
  "campaignNumber": 1171910,
  "groupNumber": 1171911,
  "searchKeywordType": null,
  "keyword": null,
  "activeStatus": null,
  "pageInfo": {
    "pageIndex": 1,
    "pageSize": 9999999,
    "sortField": null,
    "sortType": null
  }
}

回复文件主体

属性 格式 描述
campaignNumber Integer 与关键词相关联的广告活动标识编号
campaignName String 与关键词相关联的广告活动名称
groupNumber Integer 与关键词相关联的广告组标识编号
groupName String 与关键词相关联的广告组名称
keyword String 与搜索查询匹配的文本
matchType Integer 匹配类型。有效值:

  • 0:Exact 精确
  • 1:Broad 广泛
  • 6:Phrase 短语
normalizedKeyword String 标准化关键词
keywordUrl String 在新蛋网站上的关键词URL
suggBid Decimal 建议出价
suggBidLowest Decimal 建议最低出价
suggBidMost Decimal 建议最高出价
searchVolume String 关键词搜索量
competition Enum 竞争类型。有效值:

  • Low 低
  • Medium 中
  • High 高
bid Decimal 与关键词相关联的竞价
activeStatus Enum 有效值:

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

  • Pending 待审核
  • Delivering 正在投放
  • Processing 处理中
  • Out of budget 已超预算
  • Inactive 已暂停
  • Ended 已结束
declineReason String 广告活动被拒绝原因
totalRows Integer 记录总数

示例:Json,Request

{
  "rows": [
    {
      "campaignNumber": 0,
      "campaignName": null,
      "groupNumber": 0,
      "groupName": null,
      "keyword": "drill",
      "matchType": 3,
      "normalizedKeyword": "drill",
      "keywordUrl": "https://www.newegg.com/p/pl?d=drill",
      "suggBid": null,
      "suggBidLowest": null,
      "suggBidMost": null,
      "searchVolume": null,
      "competition": null,
      "bid": 0.35,
      "activeStatus": "Active",
      "status": "Delivering",
      "declineReason": null
    }
],
totalRows: 1
}

更新日期:06/29/2022