Auto Targeting Match Type List

Search auto targeting match type list according to the specified query conditions.

Resource URL

Newegg.com: https://api.newegg.com/marketplace/sponsoredmgmt/campaign/autotargeting/matchtypesearch?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

Attitude	Required？	Format	Description
sellerID	Yes	String	Your seller ID on Newegg Marketplace
campaignNumber	Yes	Integer	The identifier of an existing campaign
groupNumber	Yes	Integer	The identifier of an existing ad group

Example: Json, Request

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

{
  "sellerID": "AP08",
  "campaignNumber": 1003234,
  "groupNumber": 1003235
}

Response Body

Attribute	Format	Description
msg	String	Return message
bizCode	String	Available values: 200: query match type success!
matchType	Integer	The type of match. Available values: 2: Close match 3: Loose match 4: Substitute 5: Complements
matchTypeName	String	The name of match type. Available values: Close match: if matchType vaule = 2 Loose match: if matchType vaule = 3 Substitutes: if matchType vaule = 4 Complements: if matchType vaule = 5
suggBid	Decimal	The bid recommendation
suggBidLowest	Decimal	The lower bound bid recommendation
suggBidMost	Decimal	The upper bound bid recommendation
bid	Decimal	Bid associated with this match type. Applicable to biddable match types only
activeStatus	Enum	The campaigns status Active: Query the data of Processing, Delivering, Out of budget status Inactive: Query the data of Inactive and Ended states
status	Enum	The Campaign Status Description Pending Delivering Processing Out of budget Inactive Ended
declineReason	String	The campaign declined reason
totalRows	Integer	Total number of the result

Example: Json, Response

{
  "header": [
    {
      "msg": "query match type success!",
      "bizCode": "200"
    }
  ],
  "rows": [
    {
      "matchType": 2,
      "matchTypeName": "Close match",
      "suggBid": 0.55,
      "suggBidLowest": 0.32,
      "suggBidMost": 0.77,
      "bid": 0.76,
      "activeStatus": "Active",
      "status": "Delivering",
      "declineReason": null
    },
    {
      "matchType": 3,
      "matchTypeName": "Loose match",
      "suggBid": 0.36,
      "suggBidLowest": 0.32,
      "suggBidMost": 0.4,
      "bid": 0.64,
      "activeStatus": "Active",
      "status": "Delivering",
      "declineReason": null
    },
    {
      "matchType": 4,
      "matchTypeName": "Substitutes",
      "suggBid": 0.13,
      "suggBidLowest": 0.1,
      "suggBidMost": 0.16,
      "bid": 0.42,
      "activeStatus": "Active",
      "status": "Delivering",
      "declineReason": null
    },
    {
      "matchType": 5,
      "matchTypeName": "Complements",
      "suggBid": 0.16,
      "suggBidLowest": 0.12,
      "suggBidMost": 0.2,
      "bid": 0.56,
      "activeStatus": "Active",
      "status": "Delivering",
      "declineReason": null
    }
  ],
  "totalRows": 4
}

Last updated: June 29, 2022