Skip to content

Latest commit

 

History

History
27 lines (24 loc) · 4.1 KB

File metadata and controls

27 lines (24 loc) · 4.1 KB

# BoostPostRequestPlatformSpecificData

Properties

Name Type Description Notes
cost_type string Campaign cost model (billing event). Defaults to `CPM`. Required when `unitCost` is set so the manual bid applies to an explicit cost model. [optional]
unit_cost float Manual bid in WHOLE account-currency units (e.g. 2.5 = $2.50). Requires `costType`. Omit for LinkedIn's automated (max delivery) bidding. LinkedIn enforces its own per-audience min/max bid bounds. [optional]
optimization_target_type string Campaign `optimizationTargetType` (e.g. `MAX_CLICK`, `TARGET_COST_PER_CLICK`, `MAX_IMPRESSION`). Forwarded verbatim, LinkedIn validates compatibility with the objective and `costType`. Omit for the objective-derived default: `awareness` gets `MAX_IMPRESSION`, `video_views` gets `MAX_VIDEO_VIEW`, and every other goal gets `MAX_CLICK`. `lead_generation` and `conversions` also get `MAX_CLICK`, because `MAX_LEAD` and `MAX_CONVERSION` need a lead gen form or a conversion rule that neither creation flow attaches. The default applies only to `SPONSORED_UPDATES` campaigns (every boost, and the image, video and carousel standalone ads), never to the `TEXT_AD`, `DYNAMIC` and `SPONSORED_INMAILS` campaigns the other creative formats produce. It is also skipped when `unitCost` or a non-`CPM` `costType` is set, since those select manual bidding and the bid is then yours to choose. [optional]
creative_selection string How LinkedIn rotates creatives within the campaign. Defaults to `OPTIMIZED`. [optional]
audience_expansion_enabled bool Enable LinkedIn audience expansion. Defaults to false. [optional]
offsite_delivery_enabled bool Deliver on the LinkedIn Audience Network. Defaults to false. [optional]
connected_television_only bool Restrict delivery to Connected TV inventory. [optional]
carousel \Zernio\Model\LinkedInAdsPlatformDataCarousel [optional]
document \Zernio\Model\LinkedInAdsPlatformDataDocument [optional]
spotlight \Zernio\Model\LinkedInAdsPlatformDataSpotlight [optional]
follower \Zernio\Model\LinkedInAdsPlatformDataFollower [optional]
jobs \Zernio\Model\LinkedInAdsPlatformDataJobs [optional]
text_ad \Zernio\Model\LinkedInAdsPlatformDataTextAd [optional]
conversation \Zernio\Model\LinkedInAdsPlatformDataConversation [optional]
event \Zernio\Model\LinkedInAdsPlatformDataEvent [optional]
thought_leader \Zernio\Model\LinkedInAdsPlatformDataThoughtLeader [optional]
bid_strategy \Zernio\Model\BidStrategy [optional]
bid_amount float Whole currency units (USD: 5 = $5.00). Required when bidStrategy is LOWEST_COST_WITH_BID_CAP or COST_CAP. May also be sent alone, WITHOUT bidStrategy, to set the cap on an ad set joining a COST_CAP / LOWEST_COST_WITH_BID_CAP campaign (the strategy is inherited from the campaign). On POST /v1/ads/create that shape requires existingCampaignId and is a 400 otherwise; on POST /v1/ads/boost it is promoted to LOWEST_COST_WITH_BID_CAP. [optional]
roas_average_floor float Decimal ROAS multiplier (2.0 = 2.0x). Required when bidStrategy is LOWEST_COST_WITH_MIN_ROAS; sending it without bidStrategy is a 400. [optional]

[Back to Model list] [Back to API list] [Back to README]