广告活动绩效报告

根据指定查询条件获取广告活动名称、活动状态、日期范围。

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