Skip to main content

This type defines the fields needed to create a campaign. To create a campaign, you need to specify a name, start and end dates, funding, marketplace, and optionally the criterion (selection rules).

Types that use CreateCampaignRequest

Not used by any types.

Call that uses CreateCampaignRequest

Fields

Field
Type
Description
budget
The allocated daily budget for the Cost Per Click (CPC) Promoted Listings campaign.

Required if the campaign funding model is CPC.
campaignCriterion
This container is used if the seller wishes to create one or more rules for a rules-based campaign. If you populate the campaignCriterion object in your createCampaign request, ads for the campaign are created by rule for the listings that meet the criteria you specify, and these ads are associated with the campaign to be created.

Note: Rules-based listing selection is only applicable for general strategy campaigns using the Cost-Per-Sale (CPS) funding model.
campaignName
A seller-defined name for the campaign. This value must be unique for the seller.

You can use any alphanumeric characters in the name, except the less than (<) or greater than (>) characters.

Max length: 80 characters
campaignTargetingType
The targeting type of the campaign. This value indicates whether the campaign is a manual targeting or smart targeting campaign.

If not value is specified, this field will default to MANUAL.

Note: This feature is only supported for on-site campaigns that use the Cost Per Click (CPC) funding model.
Valid Values:
  • MANUAL
  • SMART
This field is required and must be set to SMART for a Smart Targeting campaign.
channels
array of ChannelEnum
The channel for the campaign. This value indicates whether the advertising campaign is an Onsite or Offsite.

If no value is entered, this field will default to ON_SITE. Multiple channels are not supported.

Note: Channels is only applicable for campaigns that use the Cost Per Click (CPC) funding model.
Valid Values:
  • ON_SITE
  • OFF_SITE
This field is required and must be set to OFF_SITE for a promote offsite campaign.
endDate
The date and time the campaign ends, in UTC format (yyyy-MM-ddThh:mm:ssZ). If this field is omitted, the campaign will have no defined end date, and will not end until the seller makes a decision to end the campaign with an endCampaign call, or if they update the campaign at a later time with an end date.
fundingStrategy
This container includes parameters that define an ad campaign funding strategy. The set of seller-configurable parameters depends on the selected fundingModel value.
marketplaceId
The ID of the eBay marketplace where the campaign is hosted. See the MarketplaceIdEnum type to get the appropriate enumeration value for the listing marketplace.
startDate
The date and time the campaign starts, in UTC format (yyyy-MM-ddThh:mm:ssZ). For display purposes, convert this time into the local time of the seller.

On the date specified, the service derives the keywords for each listing in the campaign, creates an ad for each listing, and associates each new ad with the campaign. The campaign starts after this process is completed. The amount of time it takes the service to start the campaign depends on the number of listings in the campaign. Call getCampaign to check the status of the campaign.