TOOL API
tool_ vbo_ status_ check
Checks whether the specified campaign settings are eligible for Value-Based Optimization (VBO) and returns the available VBO bidding strategies for those settings. If you specify an allowlist-only VBO feature and the advertiser is not allowlisted, the settings are treated as ineligible and `vo_status` returns `NOT_SUPPORT`.
Call information
- Tool slug
- tiktok-ads.tool_vbo_status_check
- Provider
- TikTok for Business
- Average response
- 0 ms
- Calls in 7 days
- 0
Input parameters
advertiser_idrequiredAdvertiser ID.
app_idPromoted app ID. Not supported when `objective_type` is `PRODUCT_SALES` and `promotion_type` is `LIVE_SHOPPING` or `VIDEO_SHOPPING`, or when `app_promotion_type` is `MINIS`. Otherwise, pass either `pixel_id` or `app_id`.
app_promotion_typeRequired when `objective_type` is `APP_PROMOTION`. App promotion type: `APP_INSTALL` for acquiring new app installs, `APP_RETARGETING` for re-engaging existing users in your app, and `MINIS` for TikTok Minis. Only `APP_INSTALL` can be used in an iOS14 Dedicated Campaign.
bid_align_typeAttribution type for the Dedicated Campaign; determines whether ad-group target CPA or ROAS is based on SAN or SKAN. Valid only when all of the following are true: `objective_type` is `APP_PROMOTION`, `app_promotion_type` is `APP_INSTALL`, `campaign_type` is `IOS14_CAMPAIGN`, and `app_id` is an eligible iOS app ID. Check app eligibility with `/app/list/` and the returned `advanced_dedicated_campaign_allowed` field. Set this field as follows: when `is_advanced_dedicated_campaign` is `true` and you are not allowlisted for disabling SKAN attribution, use `SKAN`; when `is_advanced_dedicated_campaign` is `true`, you are allowlisted for disabling SKAN attribution, and `disable_skan_campaign` is `false`, use `SAN`; when `is_advanced_dedicated_campaign` is `true` and `disable_skan_campaign` is `true`, use `SAN`; when `is_advanced_dedicated_campaign` is `false` and `disable_skan_campaign` is `false`, use `SKAN`.
budget_optimize_onWhether to enable Campaign Budget Optimization (CBO).
campaign_app_profile_page_stateWhether to use App Profile Page at the campaign level to optimize delivery. Valid only when `objective_type` is `APP_PROMOTION` and the campaign is an iOS14 Dedicated Campaign (`ios14_quota_type` = `OCCUPIED`); otherwise an error occurs.
campaign_automation_typeCampaign automation type.
campaign_typeCampaign type. Do not pass `campaign_type` and `ios14_quota_type` together; if both are provided, `ios14_quota_type` is ignored. `IOS14_CAMPAIGN` is valid only when `objective_type` is `PRODUCT_SALES`, or when `objective_type` is `APP_PROMOTION` and `app_promotion_type` is `APP_INSTALL`.
disable_skan_campaignWhether to disable SKAN attribution for an iOS Dedicated Campaign. Valid only when all of the following are true: `objective_type` is `APP_PROMOTION`, `app_promotion_type` is `APP_INSTALL`, `campaign_type` is `IOS14_CAMPAIGN`, and `app_id` is an eligible iOS app ID. Check app eligibility with `/app/list/` and the returned `advanced_dedicated_campaign_allowed` field. If `true`, SKAN attribution is disabled, Dedicated Campaign quota limits do not apply, and SAN metrics are available, but SKAN reporting metrics are not. If the app is eligible for Advanced Dedicated Campaigns, you cannot disable both SKAN attribution and Advanced Dedicated Campaign at the same time. If `false`, SKAN attribution is enabled; quota limits apply and SKAN metrics are available. If `false` and `is_advanced_dedicated_campaign` is also `true`, both SAN and SKAN reporting metrics are available. Disabling SKAN attribution for Dedicated Campaigns is an allowlist-only feature. If you are allowlisted for this feature, you still cannot set ad-group-level `bid_type` to `BID_TYPE_CUSTOM` when campaign-level `is_advanced_dedicated_campaign` is `false`, campaign-level `disable_skan_campaign` is `false`, and ad-group-level `optimization_goal` is `INSTALL` or `IN_APP_EVENT`. Once set, this field cannot be updated.
is_advanced_dedicated_campaignWhether the campaign is an Advanced Dedicated Campaign. Default is `false`. Once set, this field cannot be updated.
objective_typerequiredAdvertising objective. Supported VBO objectives are `APP_PROMOTION`, `WEB_CONVERSIONS`, and `PRODUCT_SALES`; any other value causes `vo_status` to return `NOT_SUPPORT`. When `objective_type` is `PRODUCT_SALES` and `promotion_type` is `LIVE_SHOPPING` or `VIDEO_SHOPPING`, do not pass `pixel_id` or `app_id`; otherwise, pass either `pixel_id` or `app_id`.
optimization_eventConversion event for the ad group. Required when `pixel_id` is passed and ignored when `app_id` is passed.
pixel_idPixel ID. Not supported when `objective_type` is `PRODUCT_SALES` and `promotion_type` is `LIVE_SHOPPING` or `VIDEO_SHOPPING`, or when `app_promotion_type` is `MINIS`. Otherwise, pass either `pixel_id` or `app_id`. If you pass `pixel_id`, you must also pass `optimization_event`.
placementsrequiredApps where ads will be delivered. Supported values are `PLACEMENT_TIKTOK`, `PLACEMENT_PANGLE`, and `PLACEMENT_GLOBAL_APP_BUNDLE`. When `objective_type` is `PRODUCT_SALES`, only `PLACEMENT_TIKTOK` is supported.
promotion_typerequiredPromotion type that determines where products are promoted. When `objective_type` is `PRODUCT_SALES` and `promotion_type` is `LIVE_SHOPPING` or `VIDEO_SHOPPING`, do not pass `pixel_id` or `app_id`; otherwise, pass either `pixel_id` or `app_id`.
store_idTikTok Shop ID. Valid only when `objective_type` is `PRODUCT_SALES`.