廣告活動績效報告

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

相關URL

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

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

參數

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

相關請求資訊

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

請求文件主體

屬性 是否必填？ 格式 描述
sellerId 是 String 您在新蛋商城的商家編號
countryCode 否 String 您的廣告活動所在的國家/地區。只接受國際標準3位國家代碼，如USA
searchKeywordType 否 Enum 有效值：

  • CAMPAIGN_NAME  廣告活動名稱
  • CAMPAIGN_NUM  廣告活動編號
keyword 否 String 如果searchKeywordType為CAMPAIGN_NUM，則返回廣告活動的識別字
如果searchKeywordType為CAMPAIGN_NAME，則返回包括使用模糊字串匹配的具有指定名稱的任何廣告活動
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 站外廣告
displayType 否 Integer 如sponsorType=3，有效值：

  • 2：Newegg平台投放
  • 3：非Newegg平台投放
activeStatus 否 Enum 返回值僅包含其中一個值的廣告活動
有效值：

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

示例：Json，Request

POST https://api.newegg.com/marketplace/sponsoredmgmt/campaign/search?sellerid={sellerid}
Content-Type: application/json
Accept: application/json
Authorization: 2d9da3949bdffd8594e9fa8a77764ce1
SecretKey: 55F55BC1-5E65-401B-BB1D-E29B0A19B734
 
 
{
  "sellerId": "A2GS",
  "countryCode": null,
  "searchKeywordType": "CAMPAIGN_NUM",
  "keyword": null,
  "type": null,
  "sponsorType": null ,
  "activeStatus": null,
  "fromDate": "2022-06-01",
  "toDate":"2022-07-01",
  "pageInfo": {
    "pageIndex": 1,
    "pageSize": 20,
    "sortField": "inDate",
    "sortType": "Desc"
  }
}

回覆文件主體

屬性 格式 描述
campaignNumber Integer 廣告活動標識編號
campaignName String 廣告活動名稱
countryCode String 廣告活動所在國家/地區的編碼
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  展示型推廣
userId String 創建廣告活動的用戶ID
userName String 創建廣告活動的用戶名稱
activeStatus String 廣告活動狀態：

  • Active  啟用：查詢處理中、正在投放、已超預算狀態的數據
  • Inactive  暫停：查詢暫停和已結束狀態的數據
status String 廣告活動狀態描述：

  • Pending  待審核
  • Delivering  正在投放
  • Processing  處理中
  • Out of budget  已超預算
  • Inactive  已暫停
  • Ended  已結束
startDate String 廣告活動的開始日期
endDate String 廣告活動的結束日期
budget Decimal 花費在此廣告活動的總金額
dailyBudget Decimal 每日花費在此廣告活動的金額
groupCount Integer 此廣告活動所在的廣告組數量
inDate String 廣告活動創建日期
inUser Integer 廣告活動創建用戶ID
displayType String 廣告活動展示類型
declineReason String 廣告活動被拒絕原因
costModel Decimal 有效值：

  • 0: CPM  每千次展示費用
  • 1: CPC  每次點擊費用
lastEditDate String 廣告活動的最後編輯日期

示例：Json，Request

{
    "header": [
        {
            "msg": "search campaigns success",
            "bizCode": "025"
        }
    ],
    "rows": [
        {
            "campaignNumber": 1171797,
            "campaignName": "Campaign-2022-05-28 02:18:16testUP",
            "countryCode": "USA",
            "type": 1,
            "userId": "31862132",
            "userName": "",
            "activeStatus": "Inactive",
            "status": "Inactive",
            "startDate": "2022-05-27 00:00:00",
            "endDate": null,
            "budget": null,
            "dailyBudget": 1,
            "groupCount": 1,
            "inDate": "Mon May 23 16:19:10 PDT 2022",
            "inUser": "28740045",
            "displayType": "0",
            "declineReason": null,
            "costModel": 0,
            "lastEditDate": "Fri May 27 18:24:44 PDT 2022"
        },
        {
            "campaignNumber": 1171315,
            "campaignName": "Campaign-2022-05-27 05:04:37视频测试",
            "countryCode": "USA",
            "type": 5,
            "userId": "28740045",
            "userName": "",
            "activeStatus": "Inactive",
            "status": "Pending",
            "startDate": "2022-05-27 00:00:00",
            "endDate": null,
            "budget": null,
            "dailyBudget": 100,
            "groupCount": 1,
            "inDate": "Fri May 20 19:21:01 PDT 2022",
            "inUser": "28740045",
            "displayType": null,
            "declineReason": null,
            "costModel": 0,
            "lastEditDate": "Tue Jun 14 15:20:48 PDT 2022"
        }
    ],
    "totalRows": 2
}

更新日期：10/03/2022