campaign

put https://asx-api.bidtheatre.com/v2.0/api/{network_id}/campaign/{id}

Path Params

network_id

string

required

string

required

Body Params

integer

A unique id for this campaign

advertiser

integer

required

The advertiser this campaign belongs to

name

string

required

This campaign's name

targetURL

string | null

Where to send user on click

clickThroughURL

string | null

Landing page at advertiser

campaignManager

string | null

required

The campaign manager receives important campaign mails

salesManager

string | null

The sales manager receives important campaign mails regarding the campaigns finance

utmSource

string | null

The utm_source parameter used for tracking traffic in Google Analytics

utmMedium

string | null

The utm_medium parameter used for tracking traffic in Google Analytics

utmContent

string | null

The utm_content parameter used for tracking traffic in Google Analytics

utmCampaign

string | null

The utm_campaign parameter used for tracking traffic in Google Analytics

defaultLineItem

integer | null

Sets revenue model. Choose 'At cost' if uncertain

conversion

integer | null

Only used for campaigns with the Cost Per Conversion KPI selected. Identifies the conversion tracker to be optimized against

takeScreenshots

boolean | null

Indicates if screenshots should be taken automatically

reportTemplate

integer | null

If set, a campaign report is automatically sent to the CM on campaign end

frontloadFactor

number | null

The frontload factor is the extra percentages that you'd like the campaign to be delivered at 50 % of the campaign time.

deliveryPriority

string | null

The delivery priority. Only updatable on PATCH.

frequencyCapping

integer | null

Frequency capping limit. Only updatable on PATCH.

frequencyCappingTimeout

integer | null

Time until counter reset after capping limit reached (hours). Only updatable on PATCH.

allowWideTargeting

boolean | null

Indicates if wide targeting should be allowed. Only updatable on PATCH.

renderOBA

boolean | null

Indicates whether the online behavioral advertising (OBA) information should be displayed alongside the ad creatives. Only updatable on PATCH.

orderId

string | null

Optional order id for cross reference against other systems. Only updatable on PATCH.

defaultGeoTarget

integer | null

Default geo target to use on this campaign. Only updatable on PATCH.

defaultAudience

integer | null

Default audience to use on this campaign. Only updatable on PATCH.

defaultFilterTarget

integer | null

Default filter target to use on this campaign. Only updatable on PATCH.

defaultOptimizationStrategy

integer | null

Default optimization strategy to use on this campaign. Only updatable on PATCH.

campaignKPI

integer | null

The desired campaign KPI for this campaign. Only updatable on PATCH.

defaultMaxCPM

number | null

The default max CPM value. Only updatable on PATCH.

version

integer

Version 1 indicates a campaign created following the old standards. Version 2 indicates a campaign created following the new standards using default objects and isn't visible in our old GUI. Not updatable.

defaultMaxCPC

number | null

The default max CPC value. Only updatable on PATCH.

skipCycleRecovery

boolean | null

Governs how under delivered cycles are handled. If set unspent targets isn't used for later cycles. Not updatable.

hideTerminated

boolean

Filter campaigns based on whether they are terminated or not

filterGeoTarget

integer

Filter campaigns based on assigned geo target

filterFilterTarget

integer

Filter campaigns based on assigned filter target

filterAudience

integer

Filter campaigns based on assigned audience

hasAlerts

boolean

Indicates if this campaign have active alerts

hideBundleCampaigns

boolean

Filter campaigns based on whether they originates in a bundle or not

filterLabels

string

Filter campaigns based on assigned labels

campaign

integer

Used for filtering when path filter can't be used

Responses

Response body

object

integer

A unique id for this campaign

advertiser

integer

required

The advertiser this campaign belongs to

name

string

required

This campaign's name

targetURL

string | null

Where to send user on click

clickThroughURL

string | null

Landing page at advertiser

campaignManager

string | null

required

The campaign manager receives important campaign mails

salesManager

string | null

The sales manager receives important campaign mails regarding the campaigns finance

utmSource

string | null

The utm_source parameter used for tracking traffic in Google Analytics

utmMedium

string | null

The utm_medium parameter used for tracking traffic in Google Analytics

utmContent

string | null

The utm_content parameter used for tracking traffic in Google Analytics

utmCampaign

string | null

The utm_campaign parameter used for tracking traffic in Google Analytics

defaultLineItem

integer | null

Sets revenue model. Choose 'At cost' if uncertain

conversion

integer | null

Only used for campaigns with the Cost Per Conversion KPI selected. Identifies the conversion tracker to be optimized against

creationDate

string

200Get operation completed successfully.