API Reference
Buyer Cloud HomeGuidesAPI ReferenceChangelog

creative

put
https://buzz-key.api.beeswax.com/rest/creative
Body Params
int32
required

Unique ID of the Creative

int32

Must belong to the same account as the Advertiser and be active

string

Name of the Creative, e.g. "Blue Banner Ad"

int32

Width in pixels. Use the creative_sizes view to see all acceptable width and height combinations.

int32

Height in pixels. Use the creative_sizes view to see all acceptable width and height combinations.

boolean
Defaults to false

Is the creative sizeless, meaning it can match any size placement that is an interstitial.

boolean
Defaults to false

Is the creative intended to serve in a secure (HTTPS) environment.

string
Defaults to 0

URL the ad should click or tap to, must be a valid URL. This field is required when using a Creative Template that is not a tag (e.g. an image or video)

creative_assets
array of int32s

DEPRECATED, use primary_asset and secondary_asset fields instead.

creative_assets
int32

ID of the creative_asset to use in the Creative, for example the ID of an Image or Video.

int32

ID of a secondary creative_asset to use in the Creative. Most commonly used for the companion asset within a Video Creative.

int32

For Native creatives, the NativeOffer to be used for the Creative content

string

For tag creatives the tag can be placed in this field and on save the creative_rule_key will be applied to insert relevant macros. This is recommended vs completing the creative_content field directly.

int32

The ID of the Creative Template to use for this creative. Must be a valid and active Creative Template that either belongs to this Account, OR is marked as "global".

int32

DEPRECATED

string
Defaults to none

Thy key corresponding to the creative_rule to apply to the creative_content_tag field. The rule will insert click and timestamp macros. You can use auto_detect for easiest implementation.

attributes
object

Creative Attributes JSON.

pixels
array of strings

List of URLs to be added to the Creative as pixels

pixels
scripts
array of strings

List of URLs to be added to the Creative as scripts

scripts
events
object

List of video event objects

progess_events
object

List of objects to track VAST video progress

creative_addons
array of int32s

List of CreativeAddOn IDs to add to the Creativ

creative_addons
string

URL to an image thumbnail for the creative. This field will be automatically set if you associate the creative with a Creative Asset that has a valid thumbnail but must be updated manually when using a tag-based Creative. Thumbnail is required by some exchanges to serve.

date

Start date of the creative, optional

date

End date of the creative, optional

string

An alternative id to lookup the creative, if desired

string

Notes about the Creative, up to 255 chars

boolean
Defaults to false

Is the Creative 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