TOOL API

app_optimization_event_get

Gets app optimization/conversion event information for an app via `/v1.3/app/optimization_event/`. This endpoint returns the available app conversion events based on the advertiser, app, objective, optimization goal, placement settings, and SKAN usage. By using Events API endpoints, you agree to the TikTok Business Products (Data) Terms (https://ads.tiktok.com/i18n/official/policy/business-products-terms) and must not share sensitive data with TikTok. This page also notes the v1.2 to v1.3 migration: the path changed from `/v1.2/app/external_action/` to `/v1.3/app/optimization_event/`, `is_dedicated` became `is_skan`, `optimize_goal` became `optimization_goal`, and `advertiser_id` and `app_id` changed from number to string.

ecommerceOAuth1 credits

Call information

Tool slug
tiktok-ads.app_optimization_event_get
Provider
TikTok for Business
Average response
0 ms
Calls in 7 days
0

Input parameters

advertiser_idrequired

Advertiser ID.

app_idrequired

Your App ID, obtained after successfully creating your app.

app_promotion_type

App promotion type. Required when `objective` is `APP_PROMOTION`. `APP_INSTALL` can be used in an iOS14 Dedicated Campaign, while `APP_RETARGETING` cannot be used.

available_only

Whether to return only available conversion events. Defaults to `true`, which returns only available conversion events.

is_skan

Whether the app is using SKAN features.

objectiverequired

Advertising objective. Required with `app_promotion_type` when `objective` is `APP_PROMOTION`.

optimization_goalrequired

Optimization goal.

placement

Apps where you want to deliver ads. Required when `placement_type` is `PLACEMENT_TYPE_NORMAL`, and ignored when `placement_type` is `PLACEMENT_TYPE_AUTOMATIC`. Currently supported values include `PLACEMENT_TIKTOK`, `PLACEMENT_PANGLE`, and `PLACEMENT_GLOBAL_APP_BUNDLE`. Do not use `PLACEMENT_TOPBUZZ` or `PLACEMENT_HELO`, because they are deprecated. For Product Sales campaigns (`objective_type` = `PRODUCT_SALES`), only `PLACEMENT_TIKTOK` is supported.

placement_type

Placement strategy that decides where ads are shown. `PLACEMENT_TYPE_AUTOMATIC` means automatic placement. `PLACEMENT_TYPE_NORMAL` means select placement manually and requires `placement`. Defaults to `PLACEMENT_TYPE_NORMAL`.