PATCH
/
public
/
v1
/
campaign-service
/
campaigns
/
{campaign-id}
/
bids
/
{bid-id}

Path Parameters

campaign-id
string
required

The ID of the campaign.

bid-id
string
required

The ID of the bid.

Body

application/json

The Bid update request body.

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
isActive
boolean

Whether to activate or deactivate the bid.

Response

200 - application/json

Represents an auction bid for a specific entity and a specific maximum amount.

bidId
string
required

The ID of the bid

campaignId
string
required

The ID of the campaign.

isActive
boolean
required

Whether the bid is active.

state
enum<string>
required

The activity state of the bid.

Available options:
active,
deactivated_manually,
inactive_entity,
deleted_entity,
legacy_inactive
target
object
required

The type of entity this bid will be targeting.

triggers
object[]
required

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

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
bidsBehaviorData
string
deprecated

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

formatProperties
object
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
trigger
object
deprecated

When should this bid participate in an auction.

Delete Campaign Bid By Id[BETA] Get estimated clicks of a future campaign for a given vendor