Create Campaign Bids

Endpoint to create a bid for a campaign.

Path Parameters

campaign-id

string

required

The ID of the campaign.

Query Parameters

skip_existing_bids

boolean

default:

false

Skip creating bids that already exist. Existing bids will not be updated and will not be returned in the response.

Body

application/json

bids

object[]

required

An array of bids to be created.

Show child attributes

bids.target

object

required

Represents a promotable entity that will be returned upon a winning auction.

Show child attributes

bids.target.id

string

required

The unique ID of the entity.

Required string length: 1 - 256

bids.target.type

enum<string>

required

The type of the entity to be advertised.

Available options:

product,

brand,

vendor,

url

bids.amount

integer

Maximum amount of money willing to offer for a sponsored slot in minor units of currency according to ISO 4217.

Required range: x > 0

bids.formatProperties

object

The format properties of the bid. This field is required for banner ads. Should be not set for listing ads.

Show child attributes

bids.formatProperties.adFormat

enum<string>

required

Available options:

banner

bids.formatProperties.bannerAssets

object[]

required

The assets for the banner campaign, if adFormat is banner.

Show child attributes

bids.formatProperties.bannerAssets.dimensions

object

required

The width and height of an asset.

Show child attributes

bids.formatProperties.bannerAssets.dimensions.height

integer

required

The height of the image.

Required range: x > 0

bids.formatProperties.bannerAssets.dimensions.width

integer

required

The width of the image.

Required range: x > 0

bids.formatProperties.bannerAssets.assetId

string

Asset id, if created using the asset API.

Maximum length: 33

bids.formatProperties.bannerAssets.contentType

string

The mime type of the asset. If asset_id is provided, this field will be ignored.

Minimum length: 1

bids.formatProperties.bannerAssets.size

integer

The file size of the asset, in bytes. If asset_id is provided, this field will be ignored.

bids.formatProperties.bannerAssets.url

string

The url where the asset is located. If asset_id is provided, this field will be ignored.

Required string length: 1 - 2083

bids.formatProperties.slotId

string

required

The external slot id provided by the marketplace.

Minimum length: 1

bids.formatProperties.deviceType

enum<string>

default:

desktop

The targeted device for this campaign, if adFormat is banner.

Available options:

mobile,

desktop

bids.location

string

By using this option you will be able to target this campaign to a specific group.You must define the same location as a parameter on the auction request. Products on a specific campaign will have specific conversion rates, considering the context of location, so it will not interfere with the conversion rates for the same product in other campaigns.

Minimum length: 1

bids.trigger

object

deprecated

When should this bid participate in an auction.

• Trigger
• Trigger
• Trigger
• Trigger
• Trigger

Show child attributes

bids.trigger.type

enum<string>

required

Available options:

keyword

bids.trigger.value

object

required

Show child attributes

bids.trigger.value.matchType

enum<string>

required

Available options:

exact

bids.trigger.value.words

string[]

required

The list of keywords.

bids.triggers

object[]

A list of objects that trigger the appearance of this bid on an auction.

• KeywordTrigger
• CategoryTrigger
• CategoriesTrigger
• ProductTrigger
• NoContextTrigger

Show child attributes

bids.triggers.type

enum<string>

required

Available options:

keyword

bids.triggers.value

object

required

Show child attributes

bids.triggers.value.matchType

enum<string>

required

Available options:

exact

bids.triggers.value.words

string[]

required

The list of keywords.

Response

200 - application/json

The public response body of the bids endpoints.

bids

object[]

required

An array of bids.

Show child attributes

bids.bidId

string

required

The ID of the bid

bids.campaignId

string

required

The ID of the campaign.

bids.isActive

boolean

required

Whether the bid is active.

bids.state

enum<string>

required

The activity state of the bid.

Available options:

active,

deactivated_manually,

inactive_entity,

deleted_entity,

legacy_inactive

bids.target

object

required

The type of entity this bid will be targeting.

Show child attributes

bids.target.id

string

required

The unique ID of the entity.

Required string length: 1 - 256

bids.target.type

enum<string>

required

The type of the entity to be advertised.

Available options:

product,

brand,

vendor,

url

bids.triggers

object[]

required

A list of objects that trigger the appearance of this bid on an auction.

• KeywordTrigger
• CategoryTrigger
• CategoriesTrigger
• ProductTrigger
• NoContextTrigger

Show child attributes

bids.triggers.type

enum<string>

required

Available options:

keyword

bids.triggers.value

object

required

Show child attributes

bids.triggers.value.matchType

enum<string>

required

Available options:

exact

bids.triggers.value.words

string[]

required

The list of keywords.

bids.amount

integer

Maximum amount of money willing to offer for a sponsored slot in minor units of currency according to ISO 4217.

Required range: x > 0

bids.bidsBehaviorData

string

deprecated

Deprecated. This field is always null. For behavioral data use reporting service.

bids.formatProperties

object

Show child attributes

bids.formatProperties.adFormat

enum<string>

required

Available options:

banner

bids.formatProperties.bannerAssets

object[]

required

The assets for the banner campaign, if adFormat is banner.

Show child attributes

bids.formatProperties.bannerAssets.dimensions

object

required

The width and height of an asset.

Show child attributes

bids.formatProperties.bannerAssets.dimensions.height

integer

required

The height of the image.

Required range: x > 0

bids.formatProperties.bannerAssets.dimensions.width

integer

required

The width of the image.

Required range: x > 0

bids.formatProperties.bannerAssets.assetId

string

Asset id, if created using the asset API.

Maximum length: 33

bids.formatProperties.bannerAssets.contentType

string

The mime type of the asset. If asset_id is provided, this field will be ignored.

Minimum length: 1

bids.formatProperties.bannerAssets.size

integer

The file size of the asset, in bytes. If asset_id is provided, this field will be ignored.

bids.formatProperties.bannerAssets.url

string

The url where the asset is located. If asset_id is provided, this field will be ignored.

Required string length: 1 - 2083

bids.formatProperties.slotId

string

required

The external slot id provided by the marketplace.

Minimum length: 1

bids.formatProperties.deviceType

enum<string>

default:

desktop

The targeted device for this campaign, if adFormat is banner.

Available options:

mobile,

desktop

bids.location

string

By using this option you will be able to target this campaign to a specific group.You must define the same location as a parameter on the auction request. Products on a specific campaign will have specific conversion rates, considering the context of location, so it will not interfere with the conversion rates for the same product in other campaigns.

Minimum length: 1

bids.trigger

object

deprecated

When should this bid participate in an auction.

• Trigger
• Trigger
• Trigger
• Trigger
• Trigger

Show child attributes

bids.trigger.type

enum<string>

required

Available options:

keyword

bids.trigger.value

object

required

Show child attributes

bids.trigger.value.matchType

enum<string>

required

Available options:

exact

bids.trigger.value.words

string[]

required

The list of keywords.

hasMore

boolean

required

Whether this is the last page of results or not.

next

object

The parameters that should be used to fetch the next page.

Show child attributes

next.limit

integer

required

How many items to return.

next.offset

integer

required

How many items to skip from the beginning of the list.