marketing APIv1.10.0

Campaign

This type defines the fields that describe an ad campaign.

Types that use Campaign

Calls that use Campaign

Fields

Field
Type
Description
campaignCriterion
The selection rules (criterion) used to select the listings for a campaign.
campaignId
A unique eBay-assigned ID for a campaign. This ID is generated when a campaign is created.
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
campaignStatus
Indicates the status of the campaign, such as RUNNING, PAUSED, and ENDED.
endDate
The date and time the campaign ends, in UTC format (yyyy-MM-ddThh:mm:ssZ). If this field is blank (code>null), it indicates a campaign that has no end date. For display purposes, convert this time into the local time of the seller.
fundingStrategy
This field specifies the funding model that defines how the Promoted Listing fee is calculated. The seller is assessed the fee if an item sells via a Promoted Listings action (such as buyer clicking on a Promoted Listings ad).

currently, the only funding model supported is COST_PER_SALE.

marketplaceId
The ID of the eBay marketplace where the campaign is hosted.
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.