API Reference
Buyer Cloud HomeGuidesAPI ReferenceChangelog

campaign

put
https://buzz-key.api.beeswax.com/rest/campaign

Note, the test_plan_id field used for the Experiments feature cannot be changed using a PUT, it must be set using the campaign_experiment_assignment endpoint.

Body Params
int32
required

Unique ID of the campaign

string

Name of the campaign, e.g. "Winter lead generation"

double

Maximum amount to spend on this Campaign

double

Maximum amount to spend or deliver in a day, Cannot exceed campaign_budget or be so low as to prevent campaign_budget from being reached over the length of the campaign. Cannot be lower than the daily_budget for any Line Items associated with this Campaign.

int32
Defaults to 0

Type of budget, 0=spend, 1=impressions, 2=spend with vendor fees

string

Supported revenue types: CPM, CPC, CPCV, CPI, CPA

double

If a revenue_type is set, this is field is the basis of calculation. For example, if revenue_type is CPM and revenue_amount is 5.12, revenue will be calculated as a $5.12 CPM.

int32
Defaults to 0

This field is deprecated. Pacing is available at the Line Item level.

int32

ID of a Bid Modifier object to associate with the Campaign. If set, max_bid must also be set.

int32

ID of the Delivery Modifier to associate with Line Items under this Campaign

double

Maximum bid after taking into consideration any Bid Modifiers.

date

Start date of the Campaign. No Line Items associated with the Campaign can have start dates prior to this date.

date

End date of the Campaign. No Line Items associated with the Campaign can have end dates after this date.

frequency_cap
object

Frequency cap JSON.

int32

The method of frequency capping. All Line Items must match Campaign-level if set. For definitions, see the Frequency Cap guide.

string

Extends frequency cap using a device graph (fees may apply). Valid values may be TAPAD or LIVERAMP depending on what has been enabled

continents
array of strings

Continents in which the Campaign is eligible to serve. Inherited from the Advertiser object if left blank.

continents
string
Defaults to none

Determines the type of audience extension to use at the Line Item level. Valid values are none,person,household,person_extend_only, and household_extend_only.

string
Defaults to none

Determines the type of audience extension to be used at the Line Item level. Valid options include none,1P,3P, and ALL.

segment_extension_vendors_default
array of strings
Defaults to `["TAPAD"]`

Lists of vendors to use at the Line Item level for audience extension. Valid values are TAPAD and LIVERAMP.

segment_extension_vendors_default
boolean
Defaults to false

Should Apple's SKAdNetwork tracking be enabled for this Campaign. Must be enabled at the Advertiser level to be enabled here.

string

An alternative id to lookup the campaign, if desired

string

Notes up to 255 chars

boolean

Is it active?

Response

Updated about 6 years ago

Language
Request
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 6 years ago