campaign target bid strategy

patch https://asx-api.bidtheatre.com/v2.0/api/{network_id}/campaign-target/{campaign_id}/bid-strategy/{id}

Path Params

network_id

string

required

string

required

campaign_id

string

required

Body Params

string

A unique id for this bid strategy

rtbSitelist

integer

required

The RTB sitelist to use

adgroup

integer

required

The adgroup to use

audience

integer | null

The audience target to apply

maxCPM

number

The max CPM used for this bid strategy

targetShare

integer | null

The desired share of the campaigns total target

paused

boolean | null

Indicates whether this bid strategy is paused or not

optimizationStrategy

integer | null

The optimization strategy to apply

geoTarget

integer | null

The geo target to apply [only updatable via patch]

filterTarget

integer | null

The filter target to apply [only updatable via patch]

name

string | null

An optional name for this bid strategy [only updatable via patch]

ampRec

integer | null

If set, indicates from which recomennded Bid Strategy it was created

Responses

Response body

object

string

A unique id for this bid strategy

rtbSitelist

integer

required

The RTB sitelist to use

adgroup

integer

required

The adgroup to use

audience

integer | null

The audience target to apply

maxCPM

number

The max CPM used for this bid strategy

targetShare

integer | null

The desired share of the campaigns total target

paused

boolean | null

Indicates whether this bid strategy is paused or not

optimizationStrategy

integer | null

The optimization strategy to apply

nrImps

integer | null

The number of impression delivered [read-only]

nrClicks

integer | null

The number of clicks delivered [read-only]

ctr

number | null

The current click through-rate [read-only]

nrConversions

integer | null

The number of conversions delivered [read-only]

number | null

The current conversion-rate [read-only]

spend

number | null

The total spend for this bid strategy [read-only]

bidRate

number | null

The number of available request that is processed (%) [read-only]

winRate

number | null

The number of impressions won in relationship to the number of bids placed (%) [read-only]

avgCPM

number | null

Actual average CPM cost [read-only]

avgCPC

number | null

Actual average CPC cost [read-only]

number | null

The actual share of the campaigns total target [read-only]

geoTarget

integer | null

The geo target to apply [only updatable via patch]

filterTarget

integer | null

The filter target to apply [only updatable via patch]

nrIConversions

integer | null

The number of view through conversions delivered [read-only]

name

string | null

An optional name for this bid strategy [only updatable via patch]

validations

array of objects

The validation on individual exchanges

validations

object

exchange

integer

validationId

integer

validationMsg

string

nrUniques

integer | null

The number of unique users on this bid strategy [read-only]

nrBids

integer | null

The number of bids placed for this bid strategy [read-only]

rtbSitelistName

string

The RTB sitelist name

nrXactsTotal

integer

nrXactsInvalid

integer

defaultName

string

audienceName

string

The audience target name if applicable

viewableRate

number | null

The viewable rate for this bid strategy

ampRec

integer | null

If set, indicates from which recomennded Bid Strategy it was created

400

Bad input parameter. Error message should indicate which one and why.

401

Bad or expired token. Re-authenticate to resolve.

403

Invalid auth or the request attempts to access an unavailable resource. Could be followed by an application error code that specifies the problem.

404

Object not found.

429

Too many requests. Your request have been throttled.

500

Unhandled server side problem.

503

Service Unavailable. A needed sub-service is temporarily down.

Language


xxxxxxxxxx
1
curl --request PATCH \
2
     --url https://asx-api.bidtheatre.com/v2.0/api/network_id/campaign-target/campaign_id/bid-strategy/id \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Get operation completed successfully.