API Reference
Buyer Cloud HomeGuidesAPI ReferenceChangelog

line_item

post
https://buzz-key.api.beeswax.com/rest/line_item
Body Params
int32
required

Must be a valid and active Campaign

int32
required

Must be active

int32
required

The type of the Line Item. 0=banner, 1=video, 2=native

int32

The ID of the associated Targeting Template, must be a valid and active Targeting Template.

string
required

Name of the Line Item, e.g. "Winter lead generation"

double
required

Maximum amount to spend on this Line Item

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.

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

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

int32

ID of the Delivery Modifier to associate with this Line Item

double

Maximum bid after taking into consideration any Bid Modifiers.

bidding
object
required

Bidding Strategy JSON.

string
Defaults to RANDOM

Either RANDOM or WEIGHTED

int32

When using Experiments the group to use for segregating users. The test_group_id must belong to the test_plan_id assigned to the Campaign. If a test_plan_id is set at the Campaign level, the test_group_id may not be null.

date
required

Start date of the Line Item.

date

End date of the Line Item.

frequency_cap
object

Frequency cap JSON.

int32
Defaults to 0

The method of frequency capping. 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. If set at the Campaign level, must match that value.

user_timezones
array of strings
Defaults to The account's timezone

When targeting by user_time_of_week, this field should include a list of timezones you expect the ad to serve within. If not set properly, pacing will be uneven.

user_timezones
string
Defaults to none

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

string
Defaults to none

Determines the type of audience extension to use. Valid options include none,1P,3P, and ALL.

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

List of vendors to use 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 Line Item. Must be enabled at the Campaign level to be enabled here.

string
Defaults to creative_line_item

Must be set if enable_skad_tracking is true. Valid options are creative_line_item and line_item. Cannot be changed once Line Item is active.

boolean
Defaults to false

Should the Line Item only target Apple SKAd-enabled inventory

boolean
Defaults to false

Indicates that the Line Item is Programmatic Guaranteed. When set to true the targeting, budgeting, pacing, and bidding parameters are restricted to ensure guaranteed delivery.

string

An alternative id to lookup the Line Item, if desired

string

Notes about the Line Item, up to 255 chars

boolean
required
Defaults to false

Is the Line Item active? Must be set to 0 on POST since no Creatives are yet assigned.

Response

Updated over 1 year ago

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