Add Group to Campaign

Add a group to an existing campaign.

Resource URL

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

Note: Please make sure your request URL is all in lower case (except for Seller ID) and cannot contain any blank spaces or line breaks.

Parameters

Name Required? Description
sellerid Yes Your seller ID on Newegg Marketplace

Resource Information

HTTP Method Authentication? Request Formats Response Formats Rate Limited?
POST Required Json Json 1000 request per hour

Request Body

Attribute Required? Format Description
countryCode Yes String countryCode
currencyCode Yes String currencyCode
campaignNumber Yes Integer An existing campaign with which the ad group is associated
groupName Yes String A name for the ad group
products Yes String The Item# collection is associated with the product. Defined for seller accounts only.

The minimum value is 1, and the maximum value is 10000. The items under the same group cannot be repeated
keywords keyword Yes String The keyword text. The minimum value is 1, and the maximum value is 1000

The keywords under the same group cannot be repeated
normalizedKeyword Yes String Normalized Keyword
bid Yes Decimal Bid associated with this keyword. Applicable to biddable match types only
matchType Yes Integer The type of match. Available values:

  • 0:  Exact
  • 1:  Broad
  • 6:  Phrase
negativeKeywords keyword Yes String The text of the expression to match against a search query
keywordType Yes Enum The type of match. Available values:

  • 0:  exact match
  • 6:  phrase match
status Yes Integer The Status of the negative keyword. Available values:

  • 0: Deactive
  • 1: Active
matchTypes matchType Yes Integer The type of match. Available values:

  • 2:  Near match
  • 3:  Loose match
  • 4:  Substitute
  • 5:  Complements
activeStatus Yes Enum The type of match. Available values:

  • Active
  • Inactive
bid No Decimal A bid value for use when no bid is specified for keywords in the ad group
relevantProducts type Yes Integer The type of relevant. Available values:

  • 0: product
  • 1: category
relevantCode Yes String If type of relevant = 0 (product), this element value for Newegg Item#

If type of relevant = 1 (category), this element value is Newegg Item#s categoryCode
currentBid No Decimal If type of relevant = 0 (product), this element value is offer a price for product

If type of relevant = 1 (category), this element value is null
status No Integer The status of relevant. Available values:

  • 1 – PAUSED
  • 2 – ENABLED
  • 3 – DELETE
  • 4 – ARREARS
categoryRefine No Refine category data

If Type = 0 (product) , this element value is null

If Type = 1 (category) , this element value 
categoryRefine brand_id No String Product’s brand
low_price No Decimal price_range
high_price No Decimal price_range
review_low_ratings No Integer review egg ratings default is 0
review_high_ratings No Integer review egg ratings default is 5
status No Integer The Status of category Refine. Available values:

  • 1:  PAUSED
  • 2:  ENABLED
  • 3:  DELETE
  • 4:  ARREARS
offSiteBid No Decimal off-site bid amount
displayMatchType No Integer

Example: Json, Request

POST https://api.newegg.com/marketplace/sponsoredmgmt/campaign/group/add?sellerid={sellerid}
Authorization: 720ddc067f4d115bd544aff46bc75634
SecretKey: 21EC2020-3AEA-1069-A2DD-08002B30309D
Content-Type: application/json
Accept: application/json

{
  "countryCode": "USA",
  "currencyCode": "USD",
  "campaignNumber": 1153302,
  "groupName": "Z-11-3-Grey Black- Red switch",
   "products": [
    "9SIAWEJHGK6318"
  ],
  "keywords": [],
  "negativeKeywords": [],
  "defaultBid": 1.09,
  "matchTypes": [
    {
      "matchType": 2,
      "activeStatus": "Active",
      "bid": 0.45
    },
    {
      "matchType": 3,
      "activeStatus": "Active",
      "bid": 0.41
    },
    {
      "matchType": 4,
      "activeStatus": "Active",
      "bid": 0.215
    },
    {
      "matchType": 5,
      "activeStatus": "Active",
      "bid": 0.265
    }
  ],
  "relevantProducts": null,
  "offSiteBid": null,
  "displayMatchType": null
}

Response Body

Attribute
Format
Description
msg String Return Message
biz code Integer Available values:

  • 012:    add group to campaign success
  • 013： add group name repetitio
  • 014： add group products repetitio

Example: Json, Response

{
  "header": [
    {
      "msg": "add group to campaign success",
      "bizCode": "012"
    }
  ]
}

Last updated: June 29, 2022