商品績效報告

根據指定的商品標題、活動狀態、日期範圍獲取績效報告。

相關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