關鍵字績效報告

根據指定關鍵字查詢廣告活動資訊。

相關URL

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

註:請確保您的請求URL全都是小寫(除Seller ID)並且不能包含任何空格或者分行符號。

參數

名稱 是否必填? 描述
sellerid 您在新蛋商城的商家編號

相關請求資訊

HTTP方式 是否需要認證? 請求格式 回覆格式 頻率限制
POST 需要 Json Json 1000 請求/小時

請求文件主體

屬性 是否必填? 格式 描述
sellerId String 您的商家編號
extUrl String 績效精確連結

有效值:keyword/searchKeywordList

countryCode String 國家/地區的國際標準3位國家代碼
campaignNumber Integer 與關鍵字相關聯的廣告活動標識編號
groupNumber Integer 與關鍵字相關聯的廣告組標識編號
searchKeywordType Enum 關鍵字,模糊匹配
與關鍵字配合使用,同時返回值或不返回值
如果不通過,表示該條件未被過濾
keyword String 結果限制為與指定文本精准匹配的關鍵字
activeStatus Enum 有效值:

  • Active 啟用:查詢處理中、正在投放、已超預算狀態的數據
  • Inactive 暫停:查詢暫停和已結束狀態的數據
fromDate String 廣告活動的開始日期
toDate String 廣告活動的結束日期
pageInfo pageIndex Integer 當前頁索引,預設為 1
pageSize Integer 單頁中的記錄數(預設為20,最大值為每頁999999 條)
sortField String 排序欄位名稱,默認為InDate
sortType String 預設Desc,支援Desc、Asc兩種方式

示例:Json,Request

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

回覆文件主體

屬性 格式 描述
ACoS Decimal 投入產出比:商品花費 / 銷售額
activeStatus Enum 有效值:

  • Active 啟用:查詢處理中、正在投放、已超預算狀態的數據
  • Inactive 暫停:查詢暫停和已結束狀態的數據
bid Decimal 與關鍵字相關聯的出價
campaignName String 與關鍵字相關聯的廣告活動名稱
campaignNumber Integer 與關鍵字相關聯的廣告活動標識編號
clicks Integer 關鍵字獲得的點擊次數
competition Enum 競爭類型。有效值:

  • Low  低
  • Medium  中
  • High  高
cpc Decimal 每次點擊費用
cr Decimal 轉化率
ctr Decimal 點擊率:商品的點擊次數 / 廣告活動曝光量
declineReason String 廣告活動被拒絕原因
groupNumber Integer 關鍵字相關聯的廣告組標識編號
groupName String 關鍵字相關聯的廣告組名稱
impressions Integer 關鍵字被展示次數
inDate String 關鍵字創建日期
inUser String 關鍵字創建使用者ID
keyword String 與搜索查詢匹配的文本
keywordUrl String 在新蛋網站上的關鍵字URL
matchType Integer 匹配類型。有效值:

  • 0:Exact  精確
  • 1:Broad  廣泛
  • 6:Phrase  短語
normalizedKeyword String 標準化關鍵字
orders Integer 關鍵字訂單數量
sales Decimal 關鍵字銷售額
searchVolume String 關鍵字搜索量
spend Decimal 關鍵字花費金額
status String 廣告活動狀態描述
有效值:

  • Pending  待審核
  • Delivering  正在投放
  • Processing  處理中
  • Out of budget  已超預算
  • Inactive  已暫停
  • Ended  已結束
suggBid Decimal 建議出價
suggBidLowest Decimal 建議最高出價
suggBidMost Decimal 建議最低出價
totalRows Integer 記錄總數

示例:Json,Request

{
  "header": [
    {
      "msg": "query keywords success!",
      "bizCode": "200"
    }
  ],
  "rows": [
    {
      "campaignNumber": 0,
      "campaignName": null,
      "groupNumber": 0,
      "groupName": null,
      "keyword": "test manufacturer",
      "matchType": 1,
      "normalizedKeyword": "manufacture|test",
      "keywordUrl": "https://www.newegg.com/p/pl?d=test manufacturer",
      "suggBid": 0.4,
      "suggBidLowest": 0.4,
      "suggBidMost": 0.5,
      "searchVolume": "NA",
      "competition": "Low",
      "bid": 0.1,
      "userId": null,
      "userName": null,
      "activeStatus": "Active",
      "status": "Delivering",
      "declineReason": null,
      "inDate": "Tue Feb 08 14:17:38 PST 2022",
      "inUser": "28740045",
      "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