Skip to content

BoostPostRequest.md

Latest commit

 

History

History
56 lines (50 loc) · 4.5 KB

BoostPostRequest.md

File metadata and controls

56 lines (50 loc) · 4.5 KB
Raw

Zernio::BoostPostRequest

Properties

Name Type Description Notes
post_id String Zernio post ID (provide this or platformPostId) [optional]
platform_post_id String Platform post ID (alternative to postId) [optional]
account_id String Social account ID
ad_account_id String Platform ad account ID
name String
goal String Available goals vary by platform. Meta (Facebook/Instagram) and TikTok support all 7. LinkedIn supports all except app_promotion. Twitter/X supports engagement, traffic, awareness, video_views, app_promotion. Pinterest and Google Ads support only engagement, traffic, awareness, video_views.
budget BoostPostRequestBudget
currency String [optional]
schedule BoostPostRequestSchedule [optional]
targeting BoostPostRequestTargeting [optional]
bid_strategy BidStrategy Meta bid strategy applied to the ad set. On TikTok, mapped to `bid_type` / `bid_price` / `deep_bid_type` automatically. [optional]
bid_amount Float Bid cap in WHOLE currency units (USD: 5 = $5.00; JPY: 100 = ¥100). Required when `bidStrategy` is `LOWEST_COST_WITH_BID_CAP` or `COST_CAP`. Backward-compat: providing `bidAmount` without `bidStrategy` is treated as `LOWEST_COST_WITH_BID_CAP`. [optional]
roas_average_floor Float Minimum ROAS as a decimal multiplier (e.g. 2.0 = 2.0x ROAS). Required when `bidStrategy` is `LOWEST_COST_WITH_MIN_ROAS`. Sent to Meta as `bid_constraints.roas_average_floor` × 10000 (Meta uses fixed-point integers). [optional]
tracking BoostPostRequestTracking [optional]
special_ad_categories Array<String> Meta only. Required for housing, employment, credit, or political ads. [optional]
link_url String TikTok-only. Custom destination URL for the Spark Ad. Without this, TikTok Spark Ads have no clickable destination — required for traffic / conversion objectives. Maps to `landing_page_url` on the creative entry of /v2/ad/create/ (TikTok SDK `AdcreateCreatives.landing_page_url`). Ignored on Meta / LinkedIn / Pinterest / X / Google (those infer the destination from the boosted post). [optional]
call_to_action String TikTok-only. Call-to-action button label on the Spark Ad creative (e.g. `LEARN_MORE`, `SHOP_NOW`, `DOWNLOAD_NOW`, `SIGN_UP`, `WATCH_NOW`). Maps to `call_to_action` on the creative entry of /v2/ad/create/. Pass-through — the platform validates the value. See TikTok's &quot;Enumeration - Call-to-Action&quot; reference for the full list. [optional]
spark_auth_code String TikTok-only. Spark Code (creator's `auth_code`) authorizing cross-creator Spark Ads — the advertiser can boost a video owned by a DIFFERENT TikTok account. Without this, boosts are limited to videos owned by the same account running the ads (same-BC creators only). The creator generates the code in their TikTok app's Promote settings and shares it with the advertiser. Maps to `auth_code` on the creative entry of /v2/ad/create/. [optional]
dsa_beneficiary String Name of the legal entity benefiting from the ad. Required by Meta when targeting EU users (DSA Article 26). Not enforced at schema level; enforced server-side when targeting intersects EU member states. [optional]
dsa_payor String Name of the legal entity paying for the ad. Required by Meta when targeting EU users (DSA Article 26). Note Meta API spelling: dsa_payor (not dsa_payer). [optional]

Example

require 'zernio-sdk'

instance = Zernio::BoostPostRequest.new(
  post_id: null,
  platform_post_id: null,
  account_id: null,
  ad_account_id: null,
  name: null,
  goal: null,
  budget: null,
  currency: USD,
  schedule: null,
  targeting: null,
  bid_strategy: null,
  bid_amount: null,
  roas_average_floor: null,
  tracking: null,
  special_ad_categories: null,
  link_url: null,
  call_to_action: null,
  spark_auth_code: null,
  dsa_beneficiary: null,
  dsa_payor: null
)