廣告組績效報告

根據指定查詢條件獲取廣告活動名稱、活動狀態、日期範圍。

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