| 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 |
\Zernio\Model\BoostPostRequestBudget |
|
|
| currency |
string |
|
[optional] |
| schedule |
\Zernio\Model\BoostPostRequestSchedule |
|
[optional] |
| targeting |
\Zernio\Model\BoostPostRequestTargeting |
|
[optional] |
| raw_targeting |
array<string,mixed> |
Meta only. A verbatim Meta-native targeting spec (e.g. `{ "geo_locations": { "cities": [{ "key": "...", "radius": 15, "distance_unit": "kilometer" }] } }`), forwarded unchanged. Mutually exclusive with `targeting` (sending both is a 400). Use for advanced fields the structured object does not expose (flexible_spec, excluded audiences, business places). |
[optional] |
| bid_strategy |
\Zernio\Model\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] |
| platform_specific_data |
\Zernio\Model\LinkedInAdsPlatformData |
|
[optional] |
| tracking |
\Zernio\Model\BoostPostRequestTracking |
|
[optional] |
| special_ad_categories |
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 "Enumeration - Call-to-Action" 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 |
Legal entity that benefits from the ad. Required when targeting EU users (EU DSA, Article 26). Optional if the ad account has a default beneficiary: set it once via `PATCH /v1/ads/accounts` or in Meta Ads Manager, and Meta fills it in whenever the field is omitted. |
[optional] |
| dsa_payor |
string |
Legal entity that pays for the ad. Can differ from `dsaBeneficiary` (for example, an agency paying for a client's ads). Same rules as `dsaBeneficiary`: required for EU targeting unless the ad account has a default payor. |
[optional] |