getCampaign

This array contains alert messages for the campaign.

Occurrence: Conditional

The type of alert message. For example, an invalid bid percentage.

Occurrence: Conditional

A description of the alert including dimensions and aspects.

Occurrence: Conditional

The dimension information of the alert including keys and values.

Occurrence: Conditional

The key field of the applied dimension. For example, the marketplace Id.

Occurrence: Conditional

The value field of the applied dimension. For example, if the key is a MARKETPLACE_ID, the value would be from MarketplaceIdEnum.

Occurrence: Conditional

The aspect information of the alert including keys and values.

Occurrence: Conditional

The type of the aspect. For example, MINIMUM_REQUIRED.

Occurrence: Conditional

The value of the aspect. For example, if the aspect is a percentage, a value of '2.0' would equal 2%.

Occurrence: Conditional

The allocated budget for the Cost Per Click (CPC) Promoted Listings campaign.Note: This field will only be returned for campaigns using the CPC funding model; it does not apply to the Cost Per Sale (CPS) funding model.

Occurrence: Conditional

The daily budget limit for the Cost Per Click (CPC) Promoted Listings campaign.

Required if the campaign's funding model is CPC.

This will be a dollar value. All clicks using the keywords defined for the campaign will go towards expending the daily budget. Once the daily budget is exceeded for the campaign, all Promoted Listings under the campaign will be turned off until the next day.

When running an offsite campaign, eBay may spend more or less than the seller's daily budget to capitalize on interested buyers, but will not exceed 2x the daily budget. The average over the course of the campaign will not exceed the provided daily budget. This value is used to calculate a total monthly budget by multiplying 30.4 by the provided daily budget. Over the course of the campaign, eBay will not charge more than this total budget per month.

If a campaign ends prematurely, however, the seller may be charged up to 2x their daily budget on a daily basis, as the campaign may have not had the chance to average the budget out over time.

Valid Values:

• 50.00
• 100.00

Occurrence: Conditional

The allocated budget amount for a CPC Promoted Listings campaign.

Occurrence: Conditional

The base currency applied to the value field to establish a monetary amount.

The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD

Occurrence: Conditional

The monetary amount in the specified currency.

Required in the amount type.

Occurrence: Conditional

The budget status for a CPC Promoted Listings campaign.

Occurrence: Conditional

The selection rules (criterion) used to select the listings for a 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.Note: This container is only returned for rules-based campaigns using the Cost Per Sale (CPS) funding model.

Occurrence: Conditional

A field used to indicate whether listings shall be automatically added to, or removed from, a Promoted Listings campaign based on the rules that have been configured for the campaign.

If set to true, eBay adds all listings matching the campaign criterion to the campaign, including any new listings created from the items in a seller's inventory.

Default: false

Occurrence: Conditional

This enum defines the criterion (selection rule) types. Currently, the only criterion type supported is INVENTORY_PARTITION, and you must specify this value if you manage your items with the Inventory API and you want to include items based on their inventory reference IDs.

Do not include this field if you manage your listings with Trading API/legacy model.

Occurrence: Conditional

This container shows all of the rules/inclusion filters used to add listings to the campaign. For information on using the contained fields, see Promoted Listing campaigns.

Occurrence: Conditional

An array of product brands. For more details, see Using the selectionRules container.

Occurrence: Conditional

This field contains an array of the associated category ID(s).

For Item discounts, a single-item array containing the category ID associated with the discounts. Required when used in an Item discount and either specifying a selectionRules container or when inventoryCriterionType is set to INVENTORY_BY_RULE.

For Promoted Listing campaigns, an array of category ID(s) associated with the campaign.

For information on how to get category IDs, see eBay Marketplace category IDs and Seller store category IDs

Occurrence: Conditional

This enumerated value indicates if the category ID for the item is an identifier for eBay categories or for a seller's eBay store categories.

For Promoted Listing campaigns, this field includes the type of the category ID for the item(s) to be included in the campaign.

For Item discounts, this field identifies the scope for the corresponding array as eBay categories or for a seller's eBay store categories. Required when used in an Item discount and inventoryCriterionType is set to INVENTORY_BY_RULE.

Occurrence: Conditional

A comma-separated list of unique identifiers for the conditions of listings to be included

For Promoted Listing campaigns, refer to Add items to the campaign. Up to four IDs can be specified.

For Item discounts, refer to Item condition ID and name values.

Occurrence: Conditional

This container sets the maximum price threshold. For more details, see Using the selectionRules container.

Occurrence: Conditional

The base currency applied to the value field to establish a monetary amount.

The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD

Occurrence: Conditional

The monetary amount in the specified currency.

Required in the amount type.

Occurrence: Conditional

This container sets the minimum price threshold. For more details, see Using the selectionRules container.

Occurrence: Conditional

The base currency applied to the value field to establish a monetary amount.

The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD

Occurrence: Conditional

The monetary amount in the specified currency.

Required in the amount type.

Occurrence: Conditional

A unique eBay-assigned ID for a campaign. This ID is generated when a campaign is created.

Occurrence: Always

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.

Occurrence: Always

Indicates the status of the campaign, such as RUNNING, PAUSED, and ENDED.

Occurrence: Always

The targeting type of the campaign. This value indicates whether the campaign is a manual targeting or smart targeting ad campaign.

Occurrence: Conditional

The channel for the campaign. This value indicates whether the campaign is an Onsite or Offsite advertising campaign.

Valid Values:

• ON_SITE
• OFF_SITE

Occurrence: Conditional

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.

Occurrence: Always

This container includes parameters that define an ad campaign funding strategy. The set of seller-configurable parameters depends on the selected fundingModel value.

Currently, the supported funding models are COST_PER_SALE (CPS) and COST_PER_CLICK (CPC). For onsite ads, the CPC model supports two bidding strategies: FIXED and DYNAMIC.

Occurrence: Always

This field is used to set the ad rate strategy for a Cost Per Sale (CPS) campaign.

The default value for this field is FIXED. If this field is omitted, the default value will be used.

Note: This field is not applicable for Cost Per Click (CPC) or offsite campaigns.

Occurrence: Conditional

Indicates the bidding strategy for an onsite Cost Per Click (CPC) campaign that uses manual targeting.

Note: This field is not applicable for smart targeting campaigns.
Valid values are:

• FIXED
  
  When using a fixed bidding strategy, sellers manually assign and adjust keyword bids for the CPC campaign.
• DYNAMIC
  
  When using a dynamic bidding strategy, eBay manages the campaign's keyword bids and automatically updates them daily to the suggested bid.
  
  Note: For a CPC campaign using dynamic bidding, sellers can continue to manually add keywords for the campaign, but they are no longer able to manually adjust their associated bid values. In order to manually adjust bid values, sellers must use the FIXED bidding strategy.

Occurrence: Conditional

The user-defined bid percentage (also known as the ad rate) sets the level that eBay increases the visibility in search results for the associated listing. The higher the bidPercentage value, the more eBay promotes the listing.

The value specified here is also used to calculate the Promoted Listings fee. This percentage value is multiplied by the final sales price to determine the fee.

The Promoted Listings fee is determined at the time the transaction completes and the seller is assessed the fee only when an item sells through a Promoted Listings ad campaign.

The bidPercentage is a single precision value that is guided by the following rules:

• These values are valid:
     4.1,    5.0,    5.5, ...
• These values are not valid:
     0.01,    10.75,    99.99,
     and so on.

Occurrence: Conditional

This container indicates the bidding preferences of the campaign, such as the maximum CPC amount.

Note: This container is only applicable for smart targeting campaigns.
This container is required if the user wants to create a Smart Targeting campaign.

Occurrence: Conditional

The maximum amount for which the eBay suggested bid can be adjusted. This value represents the most a seller is willing to pay for each click on their ad. The adjusted bid will never exceed this amount.

This field is required for smart targeting campaigns.

Note: The maximum cost-per-click has a minimum value of 0.02 and a maximum value of 100.

Occurrence: Conditional

The allocated maximum CPC amount for a smart targeting campaign.

Both the currency and amount must be specified when allocating the Max CPC.

Occurrence: Conditional

The base currency applied to the value field to establish a monetary amount.

The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD

Occurrence: Conditional

The monetary amount in the specified currency.

Required in the amount type.

Occurrence: Conditional

A field that indicates whether a single, user-defined bid percentage (also known as the ad rate) should be used, or whether eBay should automatically adjust listings to maintain the daily suggested bid percentage.

Note: Dynamic adjustment is only applicable when the adRateStrategy is set to DYNAMIC This field is not applicable for offsite campaigns.
Default: FIXED

Occurrence: Conditional

The percentage above or below (-) the eBay suggested ad rate that a seller is willing to pay.

This specifies the maximum and minimum values to which an ad rate can be dynamically adjusted.

Occurrence: Conditional

The maximum value (specified as a percentage) to which the eBay suggested ad rate can be adjusted. The adjusted ad rate will never exceed this percentage.

Occurrence: Conditional

Indicates the model that eBay uses to calculate the Promoted Listings fee.

For a description of the funding model types, refer to FundingModelTypeEnum.

Occurrence: Always

The ID of the eBay marketplace where the campaign is hosted.

Occurrence: Always

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.

Occurrence: Always