Ad

adGroupId

A unique eBay-assigned ID for an ad group in a campaign that uses the Cost Per Click (CPC) funding model. This ID is created after a successful createAdGroup call, and all ad groups must be associated with a CPC campaign.

adId

A unique eBay-assigned ID that is generated when the ad is created.

adStatus

The current status of the CPC ad.

Valid Values:

• ACTIVE
• PAUSED
• ARCHIVED

Note: This type only applies to the Cost Per Click (CPC) funding model; it does not apply to the Cost Per Sale (CPS) funding model.

alerts

array of Alert

An array containing alert messages for the ad.

bidPercentage

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.

This is default bid percentage for the campaigns using the Cost Per Sale (CPS) funding model, and this value will be overridden by any ads in the campaign that have their own set bid percentages.

If a bid percentage is not provided for an ad, eBay uses the default bid percentage of the associated campaign.

Note:This field will always be returned for campaigns that use the Cost Per Sale (CPS) funding model. It will not be returned for campaigns that use the Cost Per Click (CPC) funding model.
Minimum value: 2.0
Maximum value: 100.0

inventoryReferenceId

An ID that identifies a single-item listing or multiple-variation listing that is managed with the Inventory API.

The inventory reference ID is a seller-defined value that can be either an SKU for a single-item listing or an inventoryItemGroupKey for a multiple-value listing.

An inventoryItemGroupKey is a value that the seller defines to indicate a listing that's the parent of an inventory item group (a multiple-variation listing, such as a listing for a shirt that's available in multiple sizes and colors).

This field is only returned if the ad is associated with a SKU or an inventory item group value.

inventoryReferenceType

The enumeration value returned here indicates the type of listing the inventoryReferenceId references. The value returned here will be INVENTORY_ITEM for a single-variation listing, or INVENTORY_ITEM_GROUP for a multiple-variation listing.

This field is only returned if the ad is associated with a SKU or an inventory item group value.

listingId

A unique eBay-assigned ID that is generated when a listing is created.