openapi: 3.2.0 info: title: TikTok API for Business — Marketing Tool API description: TikTok API for Business (Marketing API) v1.3. This document is a mechanical union of the 202 per-operation OpenAPI 3.0.1 documents TikTok publishes in yml_files/ of its own SDK repository (https://github.com/tiktok/tiktok-business-api-sdk), which are the swagger-codegen inputs for TikTok's first-party Java/Python/JavaScript SDKs. Operation content (paths, parameters, responses, tags and the x-open-* extensions) is preserved verbatim; only info, servers and components.securitySchemes were written by API Evangelist, because the per-operation fragments carry placeholder info blocks and no servers block. The servers values are the production and sandbox base URLs TikTok documents at https://business-api.tiktok.com/portal/docs?id=1738855331457026 . version: v1.3 contact: name: TikTok API for Business support url: https://business-api.tiktok.com/portal/docs?id=1795190020378625 termsOfService: https://business-api.tiktok.com/portal/docs?id=1737191804348417 x-source: https://github.com/tiktok/tiktok-business-api-sdk/tree/main/yml_files x-harvested-by: API Evangelist enrichment pipeline x-harvested: '2026-08-13' servers: - url: https://business-api.tiktok.com/open_api/v1.3 description: Production - url: https://sandbox-ads.tiktok.com/open_api/v1.3 description: Sandbox security: - AccessToken: [] tags: - name: Tool paths: /search/region/: get: operationId: Search Region parameters: - description: Advertiser ID. in: query name: advertiser_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 - description: 'The language you want the returned region name to be translated into. Default value: en Currently, we only support zh, fr, es, ko, vi, en, hi, it, tr, ru, ja, id, de, ms, ar, and th Note: If you do not pass in one of the supported values above, it will return as the default en.' in: query name: language required: false schema: default: en type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get available locations by advertiser ID [Search Region](https://ads.tiktok.com/marketing_api/docs?id=1773644763581441) tags: - Tool x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - name: language required: false source: $.http.query.language type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id language: $.http.query.language response_cookie: [] response_header: [] response_rule: region_list[][]: - area_type: $.rpc.output.region_list[].area_type country_code: $.rpc.output.region_list[].country_code parent_id: $.rpc.output.region_list[].parent_id region_id: $.rpc.output.region_list[].region_id region_level: $.rpc.output.region_list[].region_level region_name: $.rpc.output.region_list[].region_name support_below_18: $.rpc.output.region_list[].support_below_18 x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /tool/action_category/: get: operationId: Tool Action_category parameters: - description: Advertiser ID. in: query name: advertiser_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.advertiser_id x-open-field-id: 1 - content: application/json: schema: items: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800966552221698 enum_package_name: IndustryType enums: - description: '' is_valid: true key: CREDIT value: '3' - description: '' is_valid: true key: EMPLOYMENT value: '2' - description: '' is_valid: true key: HOUSING value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.special_industries description: 'Special ad categories. Enum values: HOUSING: Ads for real estate listings, homeowners insurance, mortgage loans or other related opportunities. EMPLOYMENT: Ads for job offers, internship, professional certification programs or other related opportunities. CREDIT: Ads for credit card offers, auto loans, long-term financing or other related opportunities. Note: This field is generally available to advertisers registered in America or Canada. Advertisers who are not registered in America or Canada but want to target these countries with special ad categories need to apply for an additional allowlist.' in: query name: special_industries required: false x-open-field-id: 2 - description: 'Category name language in repsonse. Default value: en. Supported languages: en, zh, ja, de, es, fr, id, it, ko, ru, th, tr, vi, ar, pt, ms. For details, see Enumeration - Language Code.' in: query name: language required: false schema: default: en type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.language x-open-field-id: 3 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get action categories. [Tool Action Category](https://business-api.tiktok.com/portal/docs?id=1737166752522241) tags: - Tool x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - children: - type: number name: special_industries required: false source: $.http.query.special_industries sub_type: number type: array - name: language required: false source: $.http.query.language type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id language: $.http.query.language special_industries: $.http.query.special_industries response_cookie: [] response_header: [] response_rule: action_categories[][]: - action_category_id: $.rpc.output.action_categories[].action_category_id action_scene: $.rpc.output.action_categories[].scene description: $.rpc.output.action_categories[].description level: $.rpc.output.action_categories[].level name: $.rpc.output.action_categories[].action_category_name special_industries: $.rpc.output.action_categories[].special_industries sub_category_ids: $.rpc.output.action_categories[].sub_category_ids x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /tool/bid/recommend/: post: operationId: Tool Bid Recommend parameters: - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string requestBody: content: application/json: schema: properties: advertiser_id: description: Advertiser ID. type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 campaign_id: default: '"0"' description: Campaign ID. type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 2 external_action: description: Conversion event for the ad group. type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1799795326256129 enum_package_name: ExternalAction enums: - description: '' is_valid: true key: ACTIVE value: '8' - description: '' is_valid: true key: ACTIVE_PAY value: '14' - description: '' is_valid: true key: ACTIVE_REGISTER value: '13' - description: '' is_valid: true key: ADD_BOOKSHELF value: '116' - description: '' is_valid: true key: ADD_PAYMENT_INFO value: '127' - description: '' is_valid: true key: ADD_TO_WISHLIST value: '128' - description: '' is_valid: true key: ANCHOR_CLICK value: '308' - description: '' is_valid: true key: APPLET_DEAL value: '126' - description: '' is_valid: true key: APPOINTMENT_DOWNLOAD_BUTTON value: '173' - description: '' is_valid: true key: ASCRIPTION_PHONE value: '161' - description: '' is_valid: true key: AUTHORIZATION value: '121' - description: '' is_valid: true key: BANKCARD_INFORMATION value: '107' - description: '' is_valid: true key: BOOST value: '124' - description: '' is_valid: true key: BUTTON value: '5' - description: '' is_valid: true key: CERTIFICATION_INFORMATION value: '109' - description: '' is_valid: true key: CLICK_CALL_DY value: '69' - description: '' is_valid: true key: CLICK_DOWNLOAD value: '68' - description: '' is_valid: true key: CLICK_LANDING_PAGE value: '66' - description: '' is_valid: true key: CLICK_SHOPWINDow value: '67' - description: '' is_valid: true key: CLICK_WEBSITE value: '70' - description: '' is_valid: true key: CLUE_CONFIRM value: '194' - description: '' is_valid: true key: CLUE_HIGH_INTENTION value: '196' - description: '' is_valid: true key: CLUE_INTERFLOW value: '195' - description: '' is_valid: true key: CLUE_PAY_SUCCEED value: '218' - description: '' is_valid: true key: COMMENT_ACTION value: '47' - description: '' is_valid: true key: COMMODITY_CLICK value: '122' - description: '' is_valid: true key: COMPLETE_TUTORIAL value: '131' - description: '' is_valid: true key: CONSULT value: '97' - description: '' is_valid: true key: CONSULT_CLUE value: '123' - description: '' is_valid: true key: CONSULT_EFFECTIVE value: '19' - description: '' is_valid: true key: CONVERSION_LEADS value: '313' - description: '' is_valid: true key: COUPON value: '28' - description: '' is_valid: true key: CREATE_GAMEROLE value: '38' - description: '' is_valid: true key: CUSTOMER_EFFECTIVE value: '26' - description: '' is_valid: true key: DEEP_PURCHASE value: '52' - description: '' is_valid: true key: DESTINATION_VISIT value: '272' - description: '' is_valid: true key: DIALBACK value: '33' - description: '' is_valid: true key: DIALBACK_CONFIRM value: '34' - description: '' is_valid: true key: DIALBACK_CONNECT value: '35' - description: '' is_valid: true key: DOWNLOAD_BUTTON value: '155' - description: '' is_valid: true key: DOWNLOAD_DETAIL value: '154' - description: '' is_valid: true key: DOWNLOAD_FINISH value: '4' - description: '' is_valid: true key: DOWNLOAD_START value: '9' - description: '' is_valid: true key: EC_CLICK_BUY value: '175' - description: '' is_valid: true key: EC_CLICK_PRODUCT value: '179' - description: '' is_valid: true key: EC_CONFRIM_DEAL value: '214' - description: '' is_valid: true key: EC_LIVE_CART value: '210' - description: '' is_valid: true key: EC_LIVE_CLICK_PRODUCT_ACTION value: '208' - description: '' is_valid: true key: EC_LIVE_COMMENT_ACTION value: '205' - description: '' is_valid: true key: EC_LIVE_ENTER_ACTION value: '202' - description: '' is_valid: true key: EC_LIVE_FOLLOW_ACTION value: '204' - description: '' is_valid: true key: EC_LIVE_GIFT_ACTION value: '206' - description: '' is_valid: true key: EC_LIVE_NATIVE_ACTION value: '203' - description: '' is_valid: true key: EC_LIVE_ORDER value: '211' - description: '' is_valid: true key: EC_LIVE_REDIRECT_TO_STORE_ACTION value: '209' - description: '' is_valid: true key: EC_LIVE_SLIDECART_CLICK_ACTION value: '207' - description: '' is_valid: true key: EC_SUBMIT_ORDER value: '176' - description: '' is_valid: true key: EFFECTIVE_COPY value: '27' - description: '' is_valid: true key: ENGAGED_VIEW value: '309' - description: '' is_valid: true key: ENGAGED_VIEW_FIFTEEN value: '311' - description: '' is_valid: true key: ENTER_HOMEPAGE value: '181' - description: '' is_valid: true key: FEED_LIVE_HOMEPAGE value: '120' - description: '' is_valid: true key: FOLLOW_ACTION value: '46' - description: '' is_valid: true key: FOLLOW_LIVE_ENTER value: '250' - description: '' is_valid: true key: FOLLOW_VIDEO_PLAY_FINISH value: '252' - description: '' is_valid: true key: FORM value: '2' - description: '' is_valid: true key: FORM_ANSWER value: '32' - description: '' is_valid: true key: FORM_BUTTON value: '151' - description: '' is_valid: true key: FORM_CONNECT value: '31' - description: '' is_valid: true key: FORM_DEEP value: '36' - description: '' is_valid: true key: FORM_DETAIL value: '150' - description: '' is_valid: true key: GAME_ADDICTION value: '25' - description: '' is_valid: true key: HIGHVALUE_CLUE value: '42' - description: '' is_valid: true key: IDCARD_INFORMATION value: '106' - description: '' is_valid: true key: IMPRESSION_LEVEL_AD_REVENUE value: '312' - description: '' is_valid: true key: INITIATE_ORDER value: '267' - description: '' is_valid: true key: INSTALL_FINISH value: '15' - description: '' is_valid: true key: INTENTION_CLUE value: '41' - description: '' is_valid: true key: INVALID_CLUE value: '40' - description: '' is_valid: true key: IN_APP_AD_CLICK value: '132' - description: '' is_valid: true key: IN_APP_AD_IMPR value: '133' - description: '' is_valid: true key: IN_APP_CART value: '22' - description: '' is_valid: true key: IN_APP_DETAIL_UV value: '29' - description: '' is_valid: true key: IN_APP_ORDER value: '20' - description: '' is_valid: true key: IN_APP_PAY value: '23' - description: '' is_valid: true key: IN_APP_UV value: '21' - description: '' is_valid: true key: LANDING_PAGE_VIEW value: '271' - description: '' is_valid: true key: LAUNCH_APP value: '129' - description: '' is_valid: true key: LIKE_ACTION value: '45' - description: '' is_valid: true key: LINK_ACTION value: '51' - description: '' is_valid: true key: LIVE_APPOINTMENT value: '249' - description: '' is_valid: true key: LIVE_CARD_CLICK value: '215' - description: '' is_valid: true key: LIVE_CLICK_PRODUCT_ACTION value: '167' - description: '' is_valid: true key: LIVE_COMMENT_ACTION value: '164' - description: '' is_valid: true key: LIVE_ENTER_ACTION value: '171' - description: '' is_valid: true key: LIVE_FOLLOW_ACTION value: '163' - description: '' is_valid: true key: LIVE_GIFT_ACTION value: '165' - description: '' is_valid: true key: LIVE_HOMEPAGE value: '111' - description: '' is_valid: true key: LIVE_JOIN_GROUP value: '248' - description: '' is_valid: true key: LIVE_NATIVE_ACTION value: '162' - description: '' is_valid: true key: LIVE_REDIRECT_TO_STORE_ACTION value: '168' - description: '' is_valid: true key: LIVE_ROOM_ACTION value: '254' - description: '' is_valid: true key: LIVE_SLIDECART_CLICK_ACTION value: '166' - description: '' is_valid: true key: LIVE_STAY_TIME value: '186' - description: '' is_valid: true key: LIVE_SUCCESSORDER_ACTION value: '172' - description: '' is_valid: true key: LIVE_SUCESSORDER_PAY value: '169' - description: '' is_valid: true key: LOAN value: '119' - description: '' is_valid: true key: LOAN_APPLY value: '118' - description: '' is_valid: true key: LOAN_COMPLETION value: '103' - description: '' is_valid: true key: LOAN_CREDIT value: '105' - description: '' is_valid: true key: LOCATION_ACTION value: '48' - description: '' is_valid: true key: LOGIN value: '114' - description: '' is_valid: true key: LOGIN_ACTION value: '136' - description: '' is_valid: true key: LONGTERM_CUSTOMER value: '130' - description: '' is_valid: true key: LOTTERY value: '11' - description: '' is_valid: true key: LT_ROI value: '110' - description: '' is_valid: true key: MAP_SEARCH value: '3' - description: '' is_valid: true key: MESSAGE value: '94' - description: '' is_valid: true key: MESSAGE_ACTION value: '63' - description: '' is_valid: true key: MESSAGE_CLICK value: '177' - description: '' is_valid: true key: MESSAGE_JOIN_GROUP value: '247' - description: '' is_valid: true key: MESSAGE_SELF_SERVICE value: '188' - description: '' is_valid: true key: MESSAGE_SEND value: '310' - description: '' is_valid: true key: MULTIPLE value: '100' - description: '' is_valid: true key: MULTI_NATIVE_ACTION value: '102' - description: '' is_valid: true key: NATIVE_ACTION value: '44' - description: '' is_valid: true key: NAV_BAR value: '149' - description: '' is_valid: true key: NEW_FOLLOW_ACTION value: '187' - description: '' is_valid: true key: NEXT_DAY_OPEN value: '39' - description: '' is_valid: true key: NOVEL_CHAPTER value: '115' - description: '' is_valid: true key: ON_WEB_CART value: '147' - description: '' is_valid: true key: ON_WEB_DETAIL value: '146' - description: '' is_valid: true key: ON_WEB_ORDER value: '148' - description: '' is_valid: true key: ON_WEB_REGISTER value: '145' - description: '' is_valid: true key: OTHER value: '99' - description: '' is_valid: true key: OTO_PAY value: '229' - description: '' is_valid: true key: OTO_STAY_TIME value: '228' - description: '' is_valid: true key: PAGE_VIEW value: '93' - description: '' is_valid: true key: PAGE_VISIT value: '314' - description: '' is_valid: true key: PAID_CLUE value: '43' - description: '' is_valid: true key: PAY_ACTION value: '137' - description: '' is_valid: true key: PAY_ROI value: '160' - description: '' is_valid: true key: PERSONAL_INFORMATION value: '108' - description: '' is_valid: true key: PHONE value: '1' - description: '' is_valid: true key: PHONE_BUTTON value: '153' - description: '' is_valid: true key: PHONE_CONFIRM value: '16' - description: '' is_valid: true key: PHONE_CONNECT value: '17' - description: '' is_valid: true key: PHONE_DETAIL value: '152' - description: '' is_valid: true key: PHONE_EFFECTIVE value: '18' - description: '' is_valid: true key: PREFERRED_LEAD value: '315' - description: '' is_valid: true key: PREMIUM_PAYMENT value: '174' - description: '' is_valid: true key: PRE_LOAN_CREDIT value: '104' - description: '' is_valid: true key: PURCHASE_OF_GOODS value: '156' - description: '' is_valid: true key: QQ value: '10' - description: '' is_valid: true key: RATE value: '138' - description: '' is_valid: true key: READING_TIME value: '117' - description: '' is_valid: true key: REDIRECT value: '95' - description: '' is_valid: true key: REDIRECT_TO_SHOP value: '50' - description: '' is_valid: true key: REDIRECT_TO_STORE value: '113' - description: '' is_valid: true key: REGISTER_ACTION value: '139' - description: '' is_valid: true key: RESERVATION value: '62' - description: '' is_valid: true key: RSS value: '30' - description: '' is_valid: true key: SALES_LEAD value: '24' - description: '' is_valid: true key: SEARCH value: '140' - description: '' is_valid: true key: SEVEN_DAY_OPEN value: '227' - description: '' is_valid: true key: SHARE_ACTION value: '65' - description: '' is_valid: true key: SHOPPING value: '96' - description: '' is_valid: true key: SHOPPING_ACTION value: '49' - description: '' is_valid: true key: SHOPPING_CART value: '182' - description: '' is_valid: true key: START_TRIAL value: '142' - description: '' is_valid: true key: STAY_TIME value: '125' - description: '' is_valid: true key: SUBSCRIBE value: '143' - description: '' is_valid: true key: SUCCESSORDER_ACTION value: '53' - description: '' is_valid: true key: SUCCESSORDER_PAY value: '112' - description: '' is_valid: true key: UG_EFFECTIVE_ACTION value: '245' - description: '' is_valid: true key: UG_EFFECTIVE_DEAL value: '244' - description: '' is_valid: true key: UG_EFFECTIVE_SHARE value: '246' - description: '' is_valid: true key: UG_EFFECTIVE_SPEECH value: '243' - description: '' is_valid: true key: UG_ROI value: '178' - description: '' is_valid: true key: UNLOCK_ACHIEVEMENT value: '144' - description: '' is_valid: true key: UPDATE_LEVEL value: '37' - description: '' is_valid: true key: VIEW value: '7' - description: '' is_valid: true key: VOTE value: '12' - description: '' is_valid: true key: XPATH value: '6' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 4 location_ids: description: IDs of the locations that you want to target. items: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 objective_type: description: 'Campaign objective. The current API endpoint only supports Traffic and Website conversions objectives. For enum values and descriptions, see Objectives. Note: This API is being revamped to support larger function scope and more accurate result. Please stay tuned for updates.' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1815013888391169 enum_package_name: ToolCampaignObjectiveType enums: - description: '' is_valid: false key: APP_INSTALL value: '2' - description: '' is_valid: true key: APP_PROMOTION value: '16' - description: '' is_valid: false key: CATALOG_SALES value: '6' - description: '' is_valid: false key: CONVERSIONS value: '3' - description: '' is_valid: true key: ENGAGEMENT value: '9' - description: '' is_valid: false key: EST_AD value: '51' - description: '' is_valid: true key: LEAD_GENERATION value: '8' - description: '' is_valid: false key: NONE_TYPE value: '0' - description: '' is_valid: true key: PRODUCT_SALES value: '15' - description: '' is_valid: true key: REACH value: '5' - description: '' is_valid: false key: RF_APP_INSTALL value: '13' - description: '' is_valid: false key: RF_ENGAGEMENT value: '12' - description: '' is_valid: true key: RF_REACH value: '7' - description: '' is_valid: false key: RF_TRAFFIC value: '11' - description: '' is_valid: false key: RF_VIDEO_VIEW value: '10' - description: '' is_valid: false key: SS_HTC_AD value: '52' - description: '' is_valid: false key: TOPVIEW_REACH value: '50' - description: '' is_valid: true key: TRAFFIC value: '1' - description: '' is_valid: true key: VIDEO_VIEWS value: '4' - description: '' is_valid: true key: WEB_CONVERSIONS value: '3' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 5 required: - advertiser_id - location_ids - objective_type type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get a suggested bid [Tool Bid Recommend](https://ads.tiktok.com/marketing_api/docs?id=1737107845597186) tags: - Tool x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.body.advertiser_id type: number - name: campaign_id required: false source: $.http.body.campaign_id type: number - children: - type: number is_expand: true name: location_ids required: false source: $.http.body.location_ids[] sub_type: number type: array - name: external_action required: false source: $.http.body.external_action type: number - name: objective_type required: true source: $.http.body.objective_type type: number - children: - name: app_id required: false source: $.context.app_id type: number - name: core_user_id required: false source: $.context.core_user_id type: number - name: developer_id required: false source: $.context.developer_id type: number is_expand: true name: context_info required: false type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id campaign_id: $.http.body.campaign_id context_info: app_id: $.context.app_id core_user_id: $.context.core_user_id developer_id: $.context.developer_id external_action: $.http.body.external_action location_ids: $.http.body.location_ids[] objective_type: $.http.body.objective_type response_cookie: [] response_header: [] response_rule: bid: $.rpc.output.bid x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /tool/brand_safety/partner/authorize/status/: get: operationId: Tool Brand_safety Partner Authorize Status parameters: - description: 'Brand Safety post bid measurement partner. Enum values: Zefr.' in: query name: partner required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: null enum_package_name: null enums: - description: '' is_valid: true key: Zefr value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.Partner x-open-field-id: 1 - description: Advertiser ID in: query name: advertiser_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.AdvertiserId x-open-field-id: 2 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get the authorization status of a Brand Safety partner [Tool Brand_safety Partner Authorize Status](https://ads.tiktok.com/marketing_api/docs?id=1738456743621634) tags: - Tool x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: Partner required: false source: $.http.query.partner type: number - name: AdvertiserId required: false source: $.http.query.advertiser_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: AdvertiserId: $.http.query.advertiser_id Partner: $.http.query.partner response_cookie: [] response_header: [] response_rule: status: $.rpc.output.Status x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /tool/carrier/: get: operationId: Tool Carrier parameters: - description: Advertiser ID in: query name: advertiser_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.advertiser_id x-open-field-id: 1 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get carriers. [Tool Carrier](https://business-api.tiktok.com/portal/docs?id=1737168013095938) tags: - Tool x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id response_cookie: [] response_header: [] response_rule: countries[][]: - carriers[][]: - carrier_id: $.rpc.output.countries[].carriers[].carrier_id in_use: $.rpc.output.countries[].carriers[].in_use name: $.rpc.output.countries[].carriers[].name value[][]: - hni_id: $.rpc.output.countries[].carriers[].value[].hni_id in_use: $.rpc.output.countries[].carriers[].value[].in_use country_code: $.rpc.output.countries[].country_code x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /tool/contextual_tag/get/: get: operationId: Tool Contextual_tag Get parameters: - description: Advertiser ID. in: query name: advertiser_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.advertiser_id x-open-field-id: 1 - description: Advertising objective. Only supports REACH, VIDEO_VIEWS, RF_REACH. in: query name: objective_type required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: null enum_package_name: null enums: - description: '' is_valid: true key: REACH value: '5' - description: '' is_valid: true key: VIDEO_VIEWS value: '4' - description: '' is_valid: true key: RF_REACH value: '7' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.objective_type x-open-field-id: 2 - content: application/json: schema: items: type: string x-open-allow-strlist: false x-open-allow-strnum: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.region_codes description: Country or region codes. in: query name: region_codes required: false x-open-field-id: 3 - description: 'Brand safety type. Default value: STANDARD_INVENTORY. Enum values: EXPANDED_INVENTORY: Use TikTok''s brand safety solution. Expanded inventory means that your ads will appear next to content where most inappropriate content has been removed, and may contain some mature themes. In the next API version, EXPANDED_INVENTORY will replace NO_BRAND_SAFETY and will be the default brand safety option. STANDARD_INVENTORY: Use TikTok''s brand safety solution. Standard inventory means that ads will appear next to content that is appropriate for most brands. LIMITED_INVENTORY: Use TikTok''s brand safety solution. Limited inventory means that your ads will not appear next to content that contains mature themes. Note: Pre-bid first-party Brand Safety solutions for APP_PROMOTION, WEB_CONVERSIONS, TRAFFIC, LEAD_GENERATION objectives in Auction ads, and pre-bid third-party brand safety solutions are currently allowlist-only features. If you would like to access them, please contact your TikTok representative. See Brand safety to learn about the supported advertising objectives for pre-bid Brand Safety filtering.' in: query name: brand_safety_type required: false schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1799789799590914 enum_package_name: brand_safety_type enums: - description: '' is_valid: true key: EXPANDED_INVENTORY value: '7' - description: '' is_valid: true key: LIMITED_INVENTORY value: '6' - description: '' is_valid: true key: NO_BRAND_SAFETY value: '1' - description: '' is_valid: true key: STANDARD_INVENTORY value: '5' - description: '' is_valid: true key: THIRD_PARTY value: '4' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.brand_safety_type x-open-field-id: 4 - description: 'Note: When objective_type is specified as RF_REACH, use this field to set the campaign as a TikTok Pulse campaign, then you can get available premium contextual tags. Do not pass in this field when objective_type is not specified as RF_REACH. Enum values: STANDARD (Reach & Frequency campaign), PULSE（TikTok Pulse campaign）' in: query name: rf_campaign_type required: false schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1799789905918978 enum_package_name: rf_campaign_type enums: - description: '' is_valid: true key: PULSE value: '1' - description: '' is_valid: true key: STANDARD value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.rf_campaign_type x-open-field-id: 5 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get available contextual tags [Tool Contextual_tag Get](https://ads.tiktok.com/marketing_api/docs?id=1747747118654465) tags: - Tool x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - name: objective_type required: true source: $.http.query.objective_type type: number - children: - type: string is_expand: true name: region_codes required: false source: $.http.query.region_codes[] sub_type: string type: array - name: brand_safety_type required: false source: $.http.query.brand_safety_type type: number - name: rf_campaign_type required: false source: $.http.query.rf_campaign_type type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id brand_safety_type: $.http.query.brand_safety_type objective_type: $.http.query.objective_type region_codes: $.http.query.region_codes[] rf_campaign_type: $.http.query.rf_campaign_type response_cookie: [] response_header: [] response_rule: contextual_tag_list[][]: - content_lineup_type: $.rpc.output.contextual_tag_list[].content_lineup_type contextual_tag_id: $.rpc.output.contextual_tag_list[].contextual_tag_id description: $.rpc.output.contextual_tag_list[].description name: $.rpc.output.contextual_tag_list[].name objective_types: $.rpc.output.contextual_tag_list[].objective_types region_codes: $.rpc.output.contextual_tag_list[].region_codes status: $.rpc.output.contextual_tag_list[].status type: $.rpc.output.contextual_tag_list[].type x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /tool/contextual_tag/info/: get: operationId: Tool Contextual_tag Info parameters: - description: Advertiser ID. in: query name: advertiser_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.advertiser_id x-open-field-id: 1 - content: application/json: schema: items: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.contextual_tag_ids description: Contextual tag IDs. in: query name: contextual_tag_ids required: true x-open-field-id: 2 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get details of contextual tags [Tool Contextual_tag Info](https://ads.tiktok.com/marketing_api/docs?id=1747747180830722) tags: - Tool x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - children: - type: number is_expand: true name: contextual_tag_ids required: true source: $.http.query.contextual_tag_ids[] sub_type: number type: array plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id contextual_tag_ids: $.http.query.contextual_tag_ids[] response_cookie: [] response_header: [] response_rule: contextual_tag_list[][]: - content_lineup_type: $.rpc.output.contextual_tag_list[].content_lineup_type contextual_tag_id: $.rpc.output.contextual_tag_list[].contextual_tag_id description: $.rpc.output.contextual_tag_list[].description name: $.rpc.output.contextual_tag_list[].name objective_types: $.rpc.output.contextual_tag_list[].objective_types region_codes: $.rpc.output.contextual_tag_list[].region_codes status: $.rpc.output.contextual_tag_list[].status type: $.rpc.output.contextual_tag_list[].type x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /tool/hashtag/get/: get: operationId: Tool Hashtag Get parameters: - description: Advertiser ID in: query name: advertiser_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 - content: application/json: schema: items: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) type: array x-open-allow-strlist: false x-open-allow-strnum: false description: List of keyword IDs in: query name: keyword_ids required: true x-open-field-id: 2 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get targeting hashtags by ID [Tool Hashtag Get](https://ads.tiktok.com/marketing_api/docs?id=1736280889167874) tags: - Tool x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - children: - type: number is_expand: true name: keyword_ids required: false source: $.http.query.keyword_ids[] sub_type: number type: array plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id keyword_ids: $.http.query.keyword_ids[] response_cookie: [] response_header: [] response_rule: keywords_status[][]: - keyword: $.rpc.output.keywords_status[].keyword keyword_id: $.rpc.output.keywords_status[].keyword_id keyword_status: $.rpc.output.keywords_status[].status x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /tool/hashtag/recommend/: get: operationId: Tool Hashtag Recommend parameters: - description: Advertiser ID. in: query name: advertiser_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.advertiser_id x-open-field-id: 1 - content: application/json: schema: items: type: string x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 10 minItems: 1 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.keywords description: 'Keywords that you want to get recommended hashtags for. If you specify multiple unrelated keywords and set operator to AND, it is possible that no recommended hashtags are returned. Max size: 10.' in: query name: keywords required: true x-open-field-id: 2 - description: 'The operator to be used between the keywords. Enum values: AND: Recommended hashtags will be generated based on all the keywords specified in keywords. OR: Recommended hashtags will be generated separately for each individual keyword in keywords. Default value: AND.' in: query name: operator required: false schema: default: AND type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.operator x-open-validate: - error_msg: 'Operator: Must be one of: AND, OR.' expr: '%s in ["AND", "OR"]' x-open-field-id: 3 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Search for targeting hashtags [Tool Hashtag Recommend](https://ads.tiktok.com/marketing_api/docs?id=1736271339521025) tags: - Tool x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - children: - type: string is_expand: true name: keywords required: true source: $.http.query.keywords[] sub_type: string type: array - name: operator required: false source: $.http.query.operator type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id keywords: $.http.query.keywords[] operator: $.http.query.operator response_cookie: [] response_header: [] response_rule: recommend_keywords[][]: - input_keyword: $.rpc.output.recommend_keywords[].input_keyword keyword: $.rpc.output.recommend_keywords[].keyword keyword_id: $.rpc.output.recommend_keywords[].keyword_id keyword_status: $.rpc.output.recommend_keywords[].keyword_status x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /tool/interest_keyword/get/: get: operationId: Tool Interest_keyword Get parameters: - description: Advertiser ID. in: query name: advertiser_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.advertiser_id x-open-field-id: 1 - content: application/json: schema: properties: audience_type: default: GENERAL_INTEREST description: 'The audience type that you want to filter by. Enum values: GENERAL_INTEREST: General interest. The audiences have a general, long-term interest in a video category. PURCHASE_INTENTION: Purchase intent. The audiences'' recent behavior suggests they may buy something related to a content category. Default value: GENERAL_INTEREST.' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1802435246858242 enum_package_name: KeywordScene enums: - description: '' is_valid: true key: GENERAL_INTEREST value: '12' - description: '' is_valid: false key: HASHTAG_TARGETING value: '13' - description: '' is_valid: true key: PURCHASE_INTENTION value: '14' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 1 x-open-source: $.http.query.filtering.audience_type type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.filtering description: Filtering conditions. in: query name: filtering required: false x-open-field-id: 2 - content: application/json: schema: items: properties: keyword_id: description: Additional interest category ID. type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 x-open-source: $.http.query.keyword_query[].keyword_id language: default: en description: 'Additional interest category language. Default value: en. Supported languages: fr, id, it, ja, ms, ar, vi, en, ru, es, th, tr, hi, zh, de, ko.' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1802434494012417 enum_package_name: Language enums: - description: '' is_valid: true key: ar value: '15' - description: '' is_valid: true key: de value: '3' - description: '' is_valid: true key: en value: '1' - description: '' is_valid: true key: es value: '4' - description: '' is_valid: true key: fr value: '5' - description: '' is_valid: true key: hi value: '6' - description: '' is_valid: true key: id value: '7' - description: '' is_valid: true key: it value: '8' - description: '' is_valid: true key: ja value: '2' - description: '' is_valid: true key: ko value: '9' - description: '' is_valid: true key: ms value: '10' - description: '' is_valid: true key: ru value: '11' - description: '' is_valid: true key: th value: '12' - description: '' is_valid: true key: tr value: '13' - description: '' is_valid: true key: vi value: '14' - description: '' is_valid: true key: zh value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 2 x-open-source: $.http.query.keyword_query[].language required: - keyword_id type: object x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 50 minItems: 1 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.keyword_query description: Information of the additional interest category you want to get. Max size = 50. in: query name: keyword_query required: false x-open-field-id: 3 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get additional interest categories by ID [Tool Interest_keyword Get](https://ads.tiktok.com/marketing_api/docs?id=1763590894544897) tags: - Tool x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - children: - name: audience_type required: false source: $.http.query.filtering.audience_type type: number is_expand: true name: filtering required: false type: object - children: - children: - name: keyword_id required: true source: $.http.query.keyword_query[].keyword_id type: number - name: language required: false source: $.http.query.keyword_query[].language type: number is_expand: true type: object is_expand: true name: keyword_query required: false sub_type: object type: array plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id filtering: audience_type: $.http.query.filtering.audience_type keyword_query[][]: - keyword_id: $.http.query.keyword_query[].keyword_id language: $.http.query.keyword_query[].language response_cookie: [] response_header: [] response_rule: keywords[][]: - keyword: $.rpc.output.keywords[].keyword keyword_id: $.rpc.output.keywords[].keyword_id status: $.rpc.output.keywords[].status x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /tool/open_url/: get: operationId: Tool Open_url parameters: - description: Advertiser ID in: query name: advertiser_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.advertiser_id x-open-field-id: 1 - description: Open URL that you want to get the internal link for. in: query name: url required: true schema: format: url type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.url x-open-field-id: 2 - description: 'Type of the open TikTok URL. Enum: USER_PROFILE VIDEO: Video detail page HASHTAG_CHALLENGE: Hashtag challenge page MUSIC: Music page STICKER: Sticker (special effect) page STICKER_SHOOTER: Shoot a video with a sticker (special effect).' in: query name: url_type required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.url_type x-open-field-id: 3 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get a TikTok in-app link [Tool Open_url](https://ads.tiktok.com/marketing_api/docs?id=1738457335681026) tags: - Tool x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - name: url required: true source: $.http.query.url type: string - name: url_type required: true source: $.http.query.url_type type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id url: $.http.query.url url_type: $.http.query.url_type response_cookie: [] response_header: [] response_rule: open_url: $.rpc.output.open_url supported_regions: $.rpc.output.supported_regions x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /tool/os_version/: get: operationId: Tool Os_version parameters: - description: Advertiser ID. in: query name: advertiser_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 - description: 'OS type. Enum values: ANDROID,IOS.' in: query name: os_type required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1802236567813122 enum_package_name: OsVersionType enums: - description: '' is_valid: true key: ANDROID value: '1' - description: '' is_valid: true key: IOS value: '2' - description: '' is_valid: false key: IOS14_MINUS value: '4' - description: '' is_valid: false key: IOS14_PLUS value: '3' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 2 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get OS versions [Tool Os_version](https://ads.tiktok.com/marketing_api/docs?id=1738308662898689) tags: - Tool x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - name: os_type required: true source: $.http.query.os_type type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id os_type: $.http.query.os_type response_cookie: [] response_header: [] response_rule: os_versions[][]: - name: $.rpc.output.os_versions[].name os_id: $.rpc.output.os_versions[].os_id os_type: $.rpc.output.os_versions[].os_type version: $.rpc.output.os_versions[].version x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /tool/phone_region_code/: get: operationId: Tool Phone_region_code parameters: - description: Advertiser ID. in: query name: advertiser_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get region calling codes and region codes for phone numbers [Tool Phone_region_code](https://ads.tiktok.com/marketing_api/docs?id=1774488637039618) tags: - Tool x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: [] plugins: after_response: [] before_request: [] request_query_rule: null request_rule: null response_cookie: [] response_header: [] response_rule: phone_region_code_infos[][]: - phone_region_calling_code: $.rpc.output.phone_area_code_info[].area phone_region_code: $.rpc.output.phone_area_code_info[].short_name phone_region_name: $.rpc.output.phone_area_code_info[].name x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /tool/targeting/info/: post: operationId: Tool Targeting Info parameters: - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string requestBody: content: application/json: schema: properties: advertiser_id: description: Advertiser ID. type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 x-open-source: $.http.body.advertiser_id brand_safety_partner: description: 'Required only when brand_safety_type is THIRD_PARTY. Brand safety partner. Enum values: IAS, OPEN_SLATE(The partner is named DoubleVerify on TikTok Ads Manager because the partner has been acquired by DoubleVerify). Note: Pre-bid third-party brand safety solutions are currently allowlist-only features. If you would like to access them, please contact your TikTok representative.' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800967691601922 enum_package_name: BrandSafetyPartnerType enums: - description: '' is_valid: true key: IAS value: '2' - description: '' is_valid: true key: OPEN_SLATE value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 8 x-open-source: $.http.body.brand_safety_partner brand_safety_type: description: 'Brand safety type. Valid only when scene is set as GEO and placements is set as PLACEMENT_TIKTOK. Default value: NO_BRAND_SAFETY. Enum values: NO_BRAND_SAFETY: To not use any brand safety solution. Full inventory, which means your ads may appear next to some content featuring mature themes. EXPANDED_INVENTORY: Use TikTok''s brand safety solution. Expanded inventory means that your ads will appear next to content where most inappropriate content has been removed, and that does not contain mature themes. In the next API version, EXPANDED_INVENTORY will replace NO_BRAND_SAFETY and will be the default brand safety option. STANDARD_INVENTORY: Use TikTok''s brand safety solution. Standard inventory means that ads will appear next to content that is appropriate for most brands. LIMITED_INVENTORY: Use TikTok''s brand safety solution. Limited inventory means that your ads will not appear next to content that contains mature themes. THIRD_PARTY: Use a third-party brand safety solution. You also need to pass in a value to the brand_safety_partner field. To get the countries and regions that your ads can be deployed to based on your brand safety settings, use the /tool/region/ endpoint. Note: Pre-bid first-party Brand Safety solutions for APP_PROMOTION, WEB_CONVERSIONS, TRAFFIC, LEAD_GENERATION objectives in Auction ads, and pre-bid third-party brand safety solutions are currently allowlist-only features. If you would like to access them, please contact your TikTok representative. See Brand safety to learn about the supported advertising objectives for pre-bid Brand Safety filtering.' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800967668879361 enum_package_name: BrandSafetyType enums: - description: '' is_valid: true key: EXPANDED_INVENTORY value: '7' - description: '' is_valid: true key: LIMITED_INVENTORY value: '6' - description: '' is_valid: true key: NO_BRAND_SAFETY value: '1' - description: '' is_valid: true key: STANDARD_INVENTORY value: '5' - description: '' is_valid: true key: THIRD_PARTY value: '4' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 7 x-open-source: $.http.body.brand_safety_type objective_type: description: 'Required when scene is set as GEO. Campaign objective. The allowed enum values: REACH, TRAFFIC, VIDEO_VIEWS, LEAD_GENERATION, ENGAGEMENT, APP_PROMOTION, WEB_CONVERSIONS, PRODUCT_SALES. For descriptions of the objectives, see Objectives.' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: null enum_package_name: CampaignObjectiveType enums: - description: '' is_valid: true key: NONE_TYPE value: '0' - description: '' is_valid: true key: REACH value: '5' - description: '' is_valid: true key: TRAFFIC value: '1' - description: '' is_valid: true key: APP_INSTALL value: '2' - description: '' is_valid: true key: VIDEO_VIEWS value: '4' - description: '' is_valid: true key: CONVERSIONS value: '3' - description: '' is_valid: true key: CATALOG_SALES value: '6' - description: '' is_valid: true key: LEAD_GENERATION value: '8' - description: '' is_valid: true key: ENGAGEMENT value: '9' - description: '' is_valid: true key: RF_VIDEO_VIEW value: '10' - description: '' is_valid: true key: RF_TRAFFIC value: '11' - description: '' is_valid: true key: RF_ENGAGEMENT value: '12' - description: '' is_valid: true key: RF_APP_INSTALL value: '13' - description: '' is_valid: true key: PRODUCT_SALES value: '15' - description: '' is_valid: true key: APP_PROMOTION value: '16' - description: '' is_valid: true key: WEB_CONVERSIONS value: '3' - description: '' is_valid: true key: TOPVIEW_REACH value: '50' - description: '' is_valid: true key: EST_AD value: '51' - description: '' is_valid: true key: SS_HTC_AD value: '52' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 4 x-open-source: $.http.body.objective_type operating_system: description: 'Valid only when scene is set as GEO. Device operating system that you want to target. Enum values: ANDROID, IOS.' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800967646681090 enum_package_name: PlatformType enums: - description: '' is_valid: true key: ANDROID value: '1' - description: '' is_valid: true key: IOS value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 6 x-open-source: $.http.body.operating_system placements: description: 'Required when scene is set as GEO. The apps where you want to deliver your ads. For enum values, see Enumeration - Placement. Note: If you want to get information about zip code IDs to be used for zip code targeting in the US or postal code IDs to be used for postal code targeting in Canada, the value of this field needs to include PLACEMENT_TIKTOK.' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800966528747521 enum_package_name: InventoryFlow enums: - description: '' is_valid: true key: PLACEMENT_GLOBAL_APP_BUNDLE value: '1000' - description: '' is_valid: true key: PLACEMENT_HELO value: '4000' - description: '' is_valid: true key: PLACEMENT_PANGLE value: '9000' - description: '' is_valid: true key: PLACEMENT_TIKTOK value: '3000' - description: '' is_valid: true key: PLACEMENT_VIGO value: '2000' key_format: string strict: true use_part: false validate_only: false value_format: int32 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.placements promotion_type: description: Required when scene is set as GEO and objective_type is NOT set as REACH, VIDEO_VIEWS, or ENGAGEMENT. Promotion type and you can decide where you'd like to promote your products using this field. For enum values, see Enumeration - Promotion Type. type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1799795775493121 enum_package_name: ExternalType enums: - description: '' is_valid: true key: AEO_APK value: '204' - description: '' is_valid: true key: APP_ANDROID value: '201' - description: '' is_valid: true key: APP_IOS value: '202' - description: '' is_valid: true key: LEAD_GENERATION value: '601' - description: '' is_valid: true key: LIVE_SHOPPING value: '305' - description: '' is_valid: true key: PRODUCT_SHOPPING value: '307' - description: '' is_valid: true key: TIKTOK_SHOP value: '11' - description: '' is_valid: true key: VIDEO_SHOPPING value: '304' - description: '' is_valid: true key: WEBSITE value: '102' - description: '' is_valid: true key: WEBSITE_OR_DISPLAY value: '602' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 9 x-open-source: $.http.body.promotion_type scene: default: GEO description: 'The targeting type that the specified targeting_ids is used for. Enum values: GEO: Geographical targeting, which consists of administrative region targeting and zip code targeting (or postal code targeting). ISP : Internet Service Provider targeting. Default value: GEO.' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800965588712449 enum_package_name: ListScene enums: - description: '' is_valid: true key: GEO value: '2' - description: '' is_valid: true key: ISP value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 5 x-open-source: $.http.body.scene targeting_ids: description: 'Targeting tag IDs. You can pass in location IDs, zip code IDs or postal code IDs, a combination of location IDs, zip code IDs or postal code IDs, or ISP IDs. Max size: 1,000. You can get location IDs, zip code IDs, or postal code IDs via geo_id returned from /tool/targeting/search/, or get location IDs via location_id returned from /tool/region/. You can get ISP IDs via isp_id returned from /tool/targeting/list/.' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 1000 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.targeting_ids required: - advertiser_id - targeting_ids type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Obtain details about location targeting tags by ID [Tool Targeting Info](https://ads.tiktok.com/marketing_api/docs?id=1761237001980929) tags: - Tool x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.body.advertiser_id type: number - children: - type: number is_expand: true name: placements required: false source: $.http.body.placements[] sub_type: number type: array - name: objective_type required: false source: $.http.body.objective_type type: number - name: scene required: false source: $.http.body.scene type: number - name: operating_system required: false source: $.http.body.operating_system type: number - name: brand_safety_type required: false source: $.http.body.brand_safety_type type: number - name: brand_safety_partner required: false source: $.http.body.brand_safety_partner type: number - name: promotion_type required: false source: $.http.body.promotion_type type: number - children: - type: string is_expand: true name: targeting_ids required: true source: $.http.body.targeting_ids[] sub_type: string type: array plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id brand_safety_partner: $.http.body.brand_safety_partner brand_safety_type: $.http.body.brand_safety_type objective_type: $.http.body.objective_type operating_system: $.http.body.operating_system placements: $.http.body.placements[] promotion_type: $.http.body.promotion_type scene: $.http.body.scene targeting_ids: $.http.body.targeting_ids[] response_cookie: [] response_header: [] response_rule: parent_tags[][]: - geo[]: - description: $.rpc.output.parent_tags[].geo.description geo_id: $.rpc.output.parent_tags[].geo.id geo_type: $.rpc.output.parent_tags[].geo.type parent_id: $.rpc.output.parent_tags[].geo.parent_id region_code: $.rpc.output.parent_tags[].geo.country_code isp[]: - isp_id: $.rpc.output.parent_tags[].isp.isp_id location_id: $.rpc.output.parent_tags[].isp.location_id region_code: $.rpc.output.parent_tags[].isp.region_code name: $.rpc.output.parent_tags[].name status_info[]: - reason: $.rpc.output.parent_tags[].status_info.reason status: $.rpc.output.parent_tags[].status_info.status targeting_type: $.rpc.output.parent_tags[].format_type targeting_tag_list[][]: - geo[]: - description: $.rpc.output.targeting_tag_list[].geo.description geo_id: $.rpc.output.targeting_tag_list[].geo.id geo_type: $.rpc.output.targeting_tag_list[].geo.type parent_id: $.rpc.output.targeting_tag_list[].geo.parent_id region_code: $.rpc.output.targeting_tag_list[].geo.country_code isp[]: - isp_id: $.rpc.output.targeting_tag_list[].isp.isp_id location_id: $.rpc.output.targeting_tag_list[].isp.location_id region_code: $.rpc.output.targeting_tag_list[].isp.region_code name: $.rpc.output.targeting_tag_list[].name status_info[]: - reason: $.rpc.output.targeting_tag_list[].status_info.reason status: $.rpc.output.targeting_tag_list[].status_info.status targeting_type: $.rpc.output.targeting_tag_list[].format_type x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /tool/targeting/list/: get: operationId: Tool Targeting List parameters: - description: Advertiser ID. in: query name: advertiser_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.advertiser_id x-open-field-id: 1 - content: application/json: schema: items: type: string x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 1000 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.location_ids description: 'IDs of the locations that you want to get the supported ISP IDs for. Max size: 1000. To find out the list of location IDs, see Location IDs. Note: You need to pass location IDs at the country or region level. To get the available locations and corresponding IDs based on your placement and objective, use the /tool/region/ and the returned level for location IDs at the country or region level will be COUNTRY.' in: query name: location_ids required: true x-open-field-id: 2 - description: 'The targeting type that the targeting tags are used for. The allowed enum values: ISP ( Internet Service Provider targeting).' in: query name: scene required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800965588712449 enum_package_name: ListScene enums: - description: '' is_valid: false key: GEO value: '2' - description: '' is_valid: true key: ISP value: '1' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-source: $.http.query.scene x-open-field-id: 3 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get internet service providers [Tool Targeting List](https://ads.tiktok.com/marketing_api/docs?id=1762962378261506) tags: - Tool x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - name: scene required: true source: $.http.query.scene type: number - children: - type: string is_expand: true name: location_ids required: true source: $.http.query.location_ids[] sub_type: string type: array plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id location_ids: $.http.query.location_ids[] scene: $.http.query.scene response_cookie: [] response_header: [] response_rule: parent_tags[][]: - format_type: $.rpc.output.parent_tags[].format_type geo[]: - country_code: $.rpc.output.parent_tags[].geo.country_code description: $.rpc.output.parent_tags[].geo.description id: $.rpc.output.parent_tags[].geo.id parent_id: $.rpc.output.parent_tags[].geo.parent_id type: $.rpc.output.parent_tags[].geo.type isp[]: - isp_id: $.rpc.output.parent_tags[].isp.isp_id location_id: $.rpc.output.parent_tags[].isp.location_id region_code: $.rpc.output.parent_tags[].isp.region_code name: $.rpc.output.parent_tags[].name status_info[]: - reason: $.rpc.output.parent_tags[].status_info.reason status: $.rpc.output.parent_tags[].status_info.status targeting_tag_list[][]: - geo[]: - country_code: $.rpc.output.targeting_tag_list[].geo.country_code description: $.rpc.output.targeting_tag_list[].geo.description id: $.rpc.output.targeting_tag_list[].geo.id parent_id: $.rpc.output.targeting_tag_list[].geo.parent_id type: $.rpc.output.targeting_tag_list[].geo.type isp[]: - isp_id: $.rpc.output.targeting_tag_list[].isp.isp_id location_id: $.rpc.output.targeting_tag_list[].isp.location_id region_code: $.rpc.output.targeting_tag_list[].isp.region_code name: $.rpc.output.targeting_tag_list[].name status_info[]: - reason: $.rpc.output.targeting_tag_list[].status_info.reason status: $.rpc.output.targeting_tag_list[].status_info.status targeting_type: $.rpc.output.targeting_tag_list[].format_type x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /tool/targeting/search/: post: operationId: Tool Targeting Search parameters: - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string requestBody: content: application/json: schema: properties: advertiser_id: description: Advertiser ID. type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 x-open-source: $.http.body.advertiser_id brand_safety_partner: description: 'Required only when brand_safety_type is THIRD_PARTY. Brand safety partner. Enum values: IAS, OPEN_SLATE(The partner is named DoubleVerify on TikTok Ads Manager because the partner has been acquired by DoubleVerify). Note: Pre-bid third-party brand safety solutions are currently allowlist-only features. If you would like to access them, please contact your TikTok representative.' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800967691601922 enum_package_name: BrandSafetyPartnerType enums: - description: '' is_valid: true key: IAS value: '2' - description: '' is_valid: true key: OPEN_SLATE value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 8 x-open-source: $.http.body.brand_safety_partner brand_safety_type: description: 'Brand safety type. Valid only when placements is set as PLACEMENT_TIKTOK. Default value: NO_BRAND_SAFETY. Enum values: NO_BRAND_SAFETY: To not use any brand safety solution. Full inventory, which means your ads may appear next to some content featuring mature themes. EXPANDED_INVENTORY: Use TikTok''s brand safety solution. Expanded inventory means that your ads will appear next to content where most inappropriate content has been removed, and that does not contain mature themes. In the next API version, EXPANDED_INVENTORY will replace NO_BRAND_SAFETY and will be the default brand safety option. STANDARD_INVENTORY: Use TikTok''s brand safety solution. Standard inventory means that ads will appear next to content that is appropriate for most brands. LIMITED_INVENTORY: Use TikTok''s brand safety solution. Limited inventory means that your ads will not appear next to content that contains mature themes. THIRD_PARTY: Use a third-party brand safety solution. You also need to pass in a value to the brand_safety_partner field. To get the countries and regions that your ads can be deployed to based on your brand safety settings, use the /tool/region/ endpoint. Note: Pre-bid first-party Brand Safety solutions for APP_PROMOTION, WEB_CONVERSIONS, TRAFFIC, LEAD_GENERATION objectives in Auction ads, and pre-bid third-party brand safety solutions are currently allowlist-only features. If you would like to access them, please contact your TikTok representative. See Brand safety to learn about the supported advertising objectives for pre-bid Brand Safety filtering.' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800967668879361 enum_package_name: BrandSafetyType enums: - description: '' is_valid: true key: EXPANDED_INVENTORY value: '7' - description: '' is_valid: true key: LIMITED_INVENTORY value: '6' - description: '' is_valid: true key: NO_BRAND_SAFETY value: '1' - description: '' is_valid: true key: STANDARD_INVENTORY value: '5' - description: '' is_valid: true key: THIRD_PARTY value: '4' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 7 x-open-source: $.http.body.brand_safety_type geo_types: description: 'The types of locations that you want to filter the results by. Enum values: COUNTRY (country or region), PROVINCE (province), CITY (city or county), DISTRICT (district or city), DMA (DMA), ZIP_CODE (zip code or postal code). When you specify search_type as FUZZY_SEARCH, the allowed enum values for this field are ZIP_CODE, COUNTRY, PROVINCE, CITY, DISTRICT, and DMA. When you specify search_type as BATCH_ZIPCODE_SEARCH, the allowed enum value for this field is ZIP_CODE. When you specify search_type as BATCH_REGION_SEARCH, the allowed enum values for this field are COUNTRY, PROVINCE, CITY, DISTRICT, and DMA.' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800965724901378 enum_package_name: GeoType enums: - description: '' is_valid: true key: CITY value: '3' - description: '' is_valid: true key: COUNTRY value: '1' - description: '' is_valid: true key: DISTRICT value: '4' - description: '' is_valid: true key: DMA value: '5' - description: '' is_valid: true key: POST_TOWN value: '8' - description: '' is_valid: true key: PROVINCE value: '2' - description: '' is_valid: true key: TOWN value: '7' - description: '' is_valid: true key: ZIP_CODE value: '6' key_format: string strict: true use_part: false validate_only: false value_format: int32 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 10 x-open-source: $.http.body.geo_types keywords: description: 'The keywords that you use to search for targeting tags. Length limit: 1 when search_type is FUZZY_SEARCH. 1,000 when search_type is BATCH_REGION_SEARCH or BATCH_ZIPCODE_SEARCH. If you set search_type as BATCH_ZIPCODE_SEARCH, you need to pass zip codes or postal codes as keywords because this search type only supports exact search. For US zip code targeting, provide the five-digit US zip codes as keywords. Example: ["10001","10002"]. For Canadian postal code targeting, provide the three-character Forward Sortation Area (FSA) portions of Canadian postal codes as keywords. Example: ["A0A","A0B"].' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 1000 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.keywords objective_type: description: 'Campaign objective. The allowed enum values: REACH, TRAFFIC, VIDEO_VIEWS, LEAD_GENERATION, ENGAGEMENT, APP_PROMOTION, WEB_CONVERSIONS, PRODUCT_SALES. For descriptions of the objectives, see Objectives.' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1815013888391169 enum_package_name: ToolCampaignObjectiveType enums: - description: '' is_valid: true key: APP_INSTALL value: '2' - description: '' is_valid: true key: APP_PROMOTION value: '16' - description: '' is_valid: true key: CATALOG_SALES value: '6' - description: '' is_valid: true key: CONVERSIONS value: '3' - description: '' is_valid: true key: ENGAGEMENT value: '9' - description: '' is_valid: true key: EST_AD value: '51' - description: '' is_valid: true key: LEAD_GENERATION value: '8' - description: '' is_valid: true key: NONE_TYPE value: '0' - description: '' is_valid: true key: PRODUCT_SALES value: '15' - description: '' is_valid: true key: REACH value: '5' - description: '' is_valid: true key: RF_APP_INSTALL value: '13' - description: '' is_valid: true key: RF_ENGAGEMENT value: '12' - description: '' is_valid: true key: RF_REACH value: '7' - description: '' is_valid: true key: RF_TRAFFIC value: '11' - description: '' is_valid: true key: RF_VIDEO_VIEW value: '10' - description: '' is_valid: true key: SS_HTC_AD value: '52' - description: '' is_valid: true key: TOPVIEW_REACH value: '50' - description: '' is_valid: true key: TRAFFIC value: '1' - description: '' is_valid: true key: VIDEO_VIEWS value: '4' - description: '' is_valid: true key: WEB_CONVERSIONS value: '3' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 3 x-open-source: $.http.body.objective_type operating_system: description: 'Device operating system that you want to target. Enum values: ANDROID, IOS.' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800967646681090 enum_package_name: PlatformType enums: - description: '' is_valid: true key: ANDROID value: '1' - description: '' is_valid: true key: IOS value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 6 x-open-source: $.http.body.operating_system placements: description: 'The apps where you want to deliver your ads. For enum values, see Enumeration - Placement. Note: If you want to fuzzy search for a zip code ID to be used for zip code targeting in the US or a postal code ID to be used for postal code targeting in Canada, the value of this field needs to include PLACEMENT_TIKTOK.' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: null enum_package_name: InventoryFlow enums: - description: '' is_valid: true key: PLACEMENT_VIGO value: '2000' - description: '' is_valid: true key: PLACEMENT_TIKTOK value: '3000' - description: '' is_valid: true key: PLACEMENT_HELO value: '4000' - description: '' is_valid: true key: PLACEMENT_PANGLE value: '9000' - description: '' is_valid: true key: PLACEMENT_GLOBAL_APP_BUNDLE value: '1000' key_format: string strict: true use_part: false validate_only: false value_format: int32 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.placements promotion_type: description: Promotion type and you can decide where you'd like to promote your products using this field. You need to specify the field when advertising objective (objective_type) for your campaign is NOT set as REACH, VIDEO_VIEWS, or ENGAGEMENT. For enum values, see Enumeration - Promotion Type. type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1815569817057282 enum_package_name: ToolExternalType enums: - description: '' is_valid: false key: AEO_APK value: '204' - description: '' is_valid: true key: APP_ANDROID value: '201' - description: '' is_valid: true key: APP_IOS value: '202' - description: '' is_valid: true key: GAME value: '700' - description: '' is_valid: true key: LEAD_GENERATION value: '601' - description: '' is_valid: true key: LEAD_GEN_CLICK_TO_CALL value: '603' - description: '' is_valid: true key: LEAD_GEN_CLICK_TO_SOCIAL_MEDIA_APP_MESSAGE value: '605' - description: '' is_valid: true key: LEAD_GEN_CLICK_TO_TT_DIRECT_MESSAGE value: '604' - description: '' is_valid: true key: LIVE_SHOPPING value: '305' - description: '' is_valid: true key: PRODUCT_SHOPPING value: '307' - description: '' is_valid: true key: TIKTOK_SHOP value: '11' - description: '' is_valid: true key: VIDEO_SHOPPING value: '304' - description: '' is_valid: true key: WEBSITE value: '102' - description: '' is_valid: true key: WEBSITE_OR_DISPLAY value: '602' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 11 x-open-source: $.http.body.promotion_type region_codes: description: The codes of targeted countries or regions that you want to filter the results by. When you specify search_type as BATCH_ZIPCODE_SEARCH or BATCH_REGION_SEARCH, this field is required and needs to be set as US (the US) or CA (Canada). When you specify search_type as FUZZY_SEARCH, this field is optional and you can pass any supported country or region code to this field. To find out the complete list of country or region codes, see Location code. items: type: string x-open-allow-strlist: false x-open-allow-strnum: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 9 x-open-source: $.http.body.region_codes search_type: description: 'The type of search you want to perform. Enum values: FUZZY_SEARCH: To fuzzy search for a single location ID, a zip code ID, or a postal code ID. For this search type, you can only pass one keyword to keywords and a maximum of 100 results will be returned. BATCH_REGION_SEARCH: To search for location IDs in batch. Fuzzy search is supported. For this search type, you can pass up to 1,000 keywords to keywords, and for each keyword a maximum of 5 results ordered by relevance will be returned. BATCH_ZIPCODE_SEARCH: To search for zip code IDs or postal code IDs in batch. Exact search is supported. For this search type, you can pass up to 1,000 keywords to keywords, and for each keyword one result or no result will be returned. Note: The enum values BATCH_ZIPCODE_SEARCH and BATCH_REGION_SEARCH can only be used to search for IDs of zip codes (or postal codes) or locations in the US or Canada. In contrast, you can use FUZZY_SEARCH to search for a single ID of a zip code (or postal code) or location in the US or Canada or in another country.' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800967623122946 enum_package_name: LocationSearchType enums: - description: '' is_valid: true key: BATCH_REGION_SEARCH value: '2' - description: '' is_valid: true key: BATCH_ZIPCODE_SEARCH value: '3' - description: '' is_valid: true key: FUZZY_SEARCH value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 5 x-open-source: $.http.body.search_type required: - advertiser_id - placements - objective_type - keywords - search_type type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Search for location targeting tags [Tool Targeting Search](https://ads.tiktok.com/marketing_api/docs?id=1761236883355649) tags: - Tool x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.body.advertiser_id type: number - children: - type: number is_expand: true name: placements required: true source: $.http.body.placements[] sub_type: number type: array - name: objective_type required: true source: $.http.body.objective_type type: number - children: - type: string is_expand: true name: keywords required: true source: $.http.body.keywords[] sub_type: string type: array - name: search_type required: true source: $.http.body.search_type type: number - name: operating_system required: false source: $.http.body.operating_system type: number - name: brand_safety_type required: false source: $.http.body.brand_safety_type type: number - name: brand_safety_partner required: false source: $.http.body.brand_safety_partner type: number - children: - type: string is_expand: true name: region_codes required: false source: $.http.body.region_codes[] sub_type: string type: array - children: - type: number is_expand: true name: geo_types required: false source: $.http.body.geo_types[] sub_type: number type: array - name: promotion_type required: false source: $.http.body.promotion_type type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id brand_safety_partner: $.http.body.brand_safety_partner brand_safety_type: $.http.body.brand_safety_type geo_types: $.http.body.geo_types[] keywords: $.http.body.keywords[] objective_type: $.http.body.objective_type operating_system: $.http.body.operating_system placements: $.http.body.placements[] promotion_type: $.http.body.promotion_type region_codes: $.http.body.region_codes[] search_type: $.http.body.search_type response_cookie: [] response_header: [] response_rule: parent_tags[][]: - geo[]: - description: $.rpc.output.parent_tags[].geo.description geo_id: $.rpc.output.parent_tags[].geo.id geo_type: $.rpc.output.parent_tags[].geo.type parent_id: $.rpc.output.parent_tags[].geo.parent_id region_code: $.rpc.output.parent_tags[].geo.country_code isp[]: - isp_id: $.rpc.output.parent_tags[].isp.isp_id location_id: $.rpc.output.parent_tags[].isp.location_id region_code: $.rpc.output.parent_tags[].isp.region_code name: $.rpc.output.parent_tags[].name status_info[]: - reason: $.rpc.output.parent_tags[].status_info.reason status: $.rpc.output.parent_tags[].status_info.status targeting_type: $.rpc.output.parent_tags[].format_type targeting_tag_list[][]: - geo[]: - description: $.rpc.output.targeting_tag_list[].geo.description geo_id: $.rpc.output.targeting_tag_list[].geo.id geo_type: $.rpc.output.targeting_tag_list[].geo.type parent_id: $.rpc.output.targeting_tag_list[].geo.parent_id region_code: $.rpc.output.targeting_tag_list[].geo.country_code isp[]: - isp_id: $.rpc.output.targeting_tag_list[].isp.isp_id location_id: $.rpc.output.targeting_tag_list[].isp.location_id region_code: $.rpc.output.targeting_tag_list[].isp.region_code keyword: $.rpc.output.targeting_tag_list[].keyword name: $.rpc.output.targeting_tag_list[].name status_info[]: - reason: $.rpc.output.targeting_tag_list[].status_info.reason status: $.rpc.output.targeting_tag_list[].status_info.status targeting_type: $.rpc.output.targeting_tag_list[].format_type x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /tool/timezone/: get: operationId: Tool Timezone parameters: - description: Advertiser ID in: query name: advertiser_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get time zones [Tool Timezone](https://ads.tiktok.com/marketing_api/docs?id=1738455961470977) tags: - Tool x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: [] plugins: after_response: [] before_request: [] request_query_rule: null request_rule: null response_cookie: [] response_header: [] response_rule: timezones[][]: - gmt_offset: $.rpc.output.time_zone_list[].gmt_offset timezone: $.rpc.output.time_zone_list[].timezone x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /tool/url_validate/: get: operationId: Tool Url_validate parameters: - description: Advertiser ID. in: query name: advertiser_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 - description: The URL that you want to get verification results for. in: query name: url required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.URL x-open-field-id: 2 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get the verification results of a URL [Tool Url_validate](https://ads.tiktok.com/marketing_api/docs?id=1774487686007810) tags: - Tool x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: URL required: false source: $.http.query.url type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: URL: $.http.query.url response_cookie: [] response_header: [] response_rule: url_info: validate_info: is_scheme_link: $.rpc.output.IsSchemeLink is_valid_scheme: $.rpc.output.IsValidScheme is_valid_url: $.rpc.output.IsValidURL x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /tool/vbo_status/: get: operationId: Tool Vbo_status parameters: - description: Advertiser ID. in: query name: advertiser_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.advertiser_id x-open-field-id: 1 - description: 'Advertising objective. Set this field to APP_PROMOTION, WEB_CONVERSIONS, or PRODUCT_SALES. When you set this field to any other objective, vo_status will be NOT_SUPPORT because these objectives are not supported for VBO. For enum values and descriptions, see Objectives. Note: When objective_type is set to PRODUCT_SALES and promotion_type is set to LIVE_SHOPPING or VIDEO_SHOPPING, do not pass in pixel_id or app_id. Otherwise, pass in either pixel_id or app_id.' in: query name: objective_type required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: null enum_package_name: CampaignObjectiveType enums: - description: '' is_valid: true key: NONE_TYPE value: '0' - description: '' is_valid: true key: REACH value: '5' - description: '' is_valid: true key: TRAFFIC value: '1' - description: '' is_valid: true key: APP_INSTALL value: '2' - description: '' is_valid: true key: VIDEO_VIEWS value: '4' - description: '' is_valid: true key: CONVERSIONS value: '3' - description: '' is_valid: true key: CATALOG_SALES value: '6' - description: '' is_valid: true key: LEAD_GENERATION value: '8' - description: '' is_valid: true key: ENGAGEMENT value: '9' - description: '' is_valid: true key: RF_REACH value: '7' - description: '' is_valid: true key: RF_VIDEO_VIEW value: '10' - description: '' is_valid: true key: RF_TRAFFIC value: '11' - description: '' is_valid: true key: RF_ENGAGEMENT value: '12' - description: '' is_valid: true key: RF_APP_INSTALL value: '13' - description: '' is_valid: true key: PRODUCT_SALES value: '15' - description: '' is_valid: true key: APP_PROMOTION value: '16' - description: '' is_valid: true key: WEB_CONVERSIONS value: '3' - description: '' is_valid: true key: TOPVIEW_REACH value: '50' - description: '' is_valid: true key: EST_AD value: '51' - description: '' is_valid: true key: SS_HTC_AD value: '52' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.objective_type x-open-field-id: 2 - description: 'Promotion type and you can decide where you''d like to promote your products using this field. For enum values, see Enumeration - Promotion Type. Note: When objective_type is set to PRODUCT_SALES and promotion_type is set to LIVE_SHOPPING or VIDEO_SHOPPING, do not pass in pixel_id or app_id. Otherwise, pass in either pixel_id or app_id.' in: query name: promotion_type required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1815569817057282 enum_package_name: ToolExternalType enums: - description: '' is_valid: false key: AEO_APK value: '204' - description: '' is_valid: true key: APP_ANDROID value: '201' - description: '' is_valid: true key: APP_IOS value: '202' - description: '' is_valid: true key: GAME value: '700' - description: '' is_valid: true key: LEAD_GENERATION value: '601' - description: '' is_valid: true key: LEAD_GEN_CLICK_TO_CALL value: '603' - description: '' is_valid: true key: LEAD_GEN_CLICK_TO_SOCIAL_MEDIA_APP_MESSAGE value: '605' - description: '' is_valid: true key: LEAD_GEN_CLICK_TO_TT_DIRECT_MESSAGE value: '604' - description: '' is_valid: true key: LIVE_SHOPPING value: '305' - description: '' is_valid: true key: MINI_APP value: '701' - description: '' is_valid: true key: PRODUCT_SHOPPING value: '307' - description: '' is_valid: true key: TIKTOK_SHOP value: '11' - description: '' is_valid: true key: VIDEO_SHOPPING value: '304' - description: '' is_valid: true key: WEBSITE value: '102' - description: '' is_valid: true key: WEBSITE_OR_DISPLAY value: '602' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-source: $.http.query.promotion_type x-open-field-id: 3 - content: application/json: schema: items: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800966528747521 enum_package_name: InventoryFlow enums: - description: '' is_valid: true key: PLACEMENT_GLOBAL_APP_BUNDLE value: '1000' - description: '' is_valid: false key: PLACEMENT_HELO value: '4000' - description: '' is_valid: true key: PLACEMENT_PANGLE value: '9000' - description: '' is_valid: true key: PLACEMENT_TIKTOK value: '3000' - description: '' is_valid: false key: PLACEMENT_VIGO value: '2000' key_format: string strict: true use_part: true validate_only: false value_format: int32 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.placements description: 'The apps where you want to deliver your ads. Note: Currently, we support PLACEMENT_TIKTOK, PLACEMENT_PANGLE and PLACEMENT_GLOBAL_APP_BUNDLE. For Product Sales campaigns (objective_type = PRODUCT_SALES), only TikTok placement (PLACEMENT_TIKTOK) is supported.' in: query name: placements required: true x-open-field-id: 4 - description: Not supported when objective_type is set to PRODUCT_SALES and promotion_type is set to LIVE_SHOPPING or VIDEO_SHOPPING. Otherwise, pass in either pixel_id or app_id. Pixel ID. When you pass in this field, you need to specify optimization_event at the same time. To get Pixel IDs, use the /pixel/list/ endpoint. in: query name: pixel_id required: false schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.pixel_id x-open-field-id: 5 - description: Not supported when objective_type is set to PRODUCT_SALES and promotion_type is set to LIVE_SHOPPING or VIDEO_SHOPPING. Otherwise, pass in either pixel_id or app_id. The Application ID of the promoted app. To get App IDs, use the /app/list/ endpoint. in: query name: app_id required: false schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.app_id x-open-field-id: 6 - description: Required when pixel_id is passed. Ignored when app_id is passed. Conversion event for the ad group. See Conversion events for more. in: query name: optimization_event required: false schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1799795326256129 enum_package_name: ExternalAction enums: - description: '' is_valid: true key: ACTIVE value: '8' - description: '' is_valid: true key: ACTIVE_PAY value: '14' - description: '' is_valid: true key: ACTIVE_REGISTER value: '13' - description: '' is_valid: true key: ADD_BOOKSHELF value: '116' - description: '' is_valid: true key: ADD_PAYMENT_INFO value: '127' - description: '' is_valid: true key: ADD_TO_WISHLIST value: '128' - description: '' is_valid: true key: ANCHOR_CLICK value: '308' - description: '' is_valid: true key: APPLET_DEAL value: '126' - description: '' is_valid: true key: APPOINTMENT_DOWNLOAD_BUTTON value: '173' - description: '' is_valid: true key: ASCRIPTION_PHONE value: '161' - description: '' is_valid: true key: AUTHORIZATION value: '121' - description: '' is_valid: true key: BANKCARD_INFORMATION value: '107' - description: '' is_valid: true key: BOOST value: '124' - description: '' is_valid: true key: BUTTON value: '5' - description: '' is_valid: true key: CERTIFICATION_INFORMATION value: '109' - description: '' is_valid: true key: CLICK_CALL_DY value: '69' - description: '' is_valid: true key: CLICK_DOWNLOAD value: '68' - description: '' is_valid: true key: CLICK_LANDING_PAGE value: '66' - description: '' is_valid: true key: CLICK_SHOPWINDow value: '67' - description: '' is_valid: true key: CLICK_WEBSITE value: '70' - description: '' is_valid: true key: CLUE_CONFIRM value: '194' - description: '' is_valid: true key: CLUE_HIGH_INTENTION value: '196' - description: '' is_valid: true key: CLUE_INTERFLOW value: '195' - description: '' is_valid: true key: CLUE_PAY_SUCCEED value: '218' - description: '' is_valid: true key: COMMENT_ACTION value: '47' - description: '' is_valid: true key: COMMODITY_CLICK value: '122' - description: '' is_valid: true key: COMPLETE_TUTORIAL value: '131' - description: '' is_valid: true key: CONSULT value: '97' - description: '' is_valid: true key: CONSULT_CLUE value: '123' - description: '' is_valid: true key: CONSULT_EFFECTIVE value: '19' - description: '' is_valid: true key: CONVERSION_LEADS value: '313' - description: '' is_valid: true key: COUPON value: '28' - description: '' is_valid: true key: CREATE_GAMEROLE value: '38' - description: '' is_valid: true key: CUSTOMER_EFFECTIVE value: '26' - description: '' is_valid: true key: DEEP_PURCHASE value: '52' - description: '' is_valid: true key: DESTINATION_VISIT value: '272' - description: '' is_valid: true key: DIALBACK value: '33' - description: '' is_valid: true key: DIALBACK_CONFIRM value: '34' - description: '' is_valid: true key: DIALBACK_CONNECT value: '35' - description: '' is_valid: true key: DOWNLOAD_BUTTON value: '155' - description: '' is_valid: true key: DOWNLOAD_DETAIL value: '154' - description: '' is_valid: true key: DOWNLOAD_FINISH value: '4' - description: '' is_valid: true key: DOWNLOAD_START value: '9' - description: '' is_valid: true key: EC_CLICK_BUY value: '175' - description: '' is_valid: true key: EC_CLICK_PRODUCT value: '179' - description: '' is_valid: true key: EC_CONFRIM_DEAL value: '214' - description: '' is_valid: true key: EC_LIVE_CART value: '210' - description: '' is_valid: true key: EC_LIVE_CLICK_PRODUCT_ACTION value: '208' - description: '' is_valid: true key: EC_LIVE_COMMENT_ACTION value: '205' - description: '' is_valid: true key: EC_LIVE_ENTER_ACTION value: '202' - description: '' is_valid: true key: EC_LIVE_FOLLOW_ACTION value: '204' - description: '' is_valid: true key: EC_LIVE_GIFT_ACTION value: '206' - description: '' is_valid: true key: EC_LIVE_NATIVE_ACTION value: '203' - description: '' is_valid: true key: EC_LIVE_ORDER value: '211' - description: '' is_valid: true key: EC_LIVE_REDIRECT_TO_STORE_ACTION value: '209' - description: '' is_valid: true key: EC_LIVE_SLIDECART_CLICK_ACTION value: '207' - description: '' is_valid: true key: EC_SUBMIT_ORDER value: '176' - description: '' is_valid: true key: EFFECTIVE_COPY value: '27' - description: '' is_valid: true key: ENGAGED_VIEW value: '309' - description: '' is_valid: true key: ENGAGED_VIEW_FIFTEEN value: '311' - description: '' is_valid: true key: ENTER_HOMEPAGE value: '181' - description: '' is_valid: true key: FEED_LIVE_HOMEPAGE value: '120' - description: '' is_valid: true key: FOLLOW_ACTION value: '46' - description: '' is_valid: true key: FOLLOW_LIVE_ENTER value: '250' - description: '' is_valid: true key: FOLLOW_VIDEO_PLAY_FINISH value: '252' - description: '' is_valid: true key: FORM value: '2' - description: '' is_valid: true key: FORM_ANSWER value: '32' - description: '' is_valid: true key: FORM_BUTTON value: '151' - description: '' is_valid: true key: FORM_CONNECT value: '31' - description: '' is_valid: true key: FORM_DEEP value: '36' - description: '' is_valid: true key: FORM_DETAIL value: '150' - description: '' is_valid: true key: GAME_ADDICTION value: '25' - description: '' is_valid: true key: HIGHVALUE_CLUE value: '42' - description: '' is_valid: true key: IDCARD_INFORMATION value: '106' - description: '' is_valid: true key: IMPRESSION_LEVEL_AD_REVENUE value: '312' - description: '' is_valid: true key: INITIATE_ORDER value: '267' - description: '' is_valid: true key: INSTALL_FINISH value: '15' - description: '' is_valid: true key: INTENTION_CLUE value: '41' - description: '' is_valid: true key: INVALID_CLUE value: '40' - description: '' is_valid: true key: IN_APP_AD_CLICK value: '132' - description: '' is_valid: true key: IN_APP_AD_IMPR value: '133' - description: '' is_valid: true key: IN_APP_CART value: '22' - description: '' is_valid: true key: IN_APP_DETAIL_UV value: '29' - description: '' is_valid: true key: IN_APP_ORDER value: '20' - description: '' is_valid: true key: IN_APP_PAY value: '23' - description: '' is_valid: true key: IN_APP_UV value: '21' - description: '' is_valid: true key: LANDING_PAGE_VIEW value: '271' - description: '' is_valid: true key: LAUNCH_APP value: '129' - description: '' is_valid: true key: LIKE_ACTION value: '45' - description: '' is_valid: true key: LINK_ACTION value: '51' - description: '' is_valid: true key: LIVE_APPOINTMENT value: '249' - description: '' is_valid: true key: LIVE_CARD_CLICK value: '215' - description: '' is_valid: true key: LIVE_CLICK_PRODUCT_ACTION value: '167' - description: '' is_valid: true key: LIVE_COMMENT_ACTION value: '164' - description: '' is_valid: true key: LIVE_ENTER_ACTION value: '171' - description: '' is_valid: true key: LIVE_FOLLOW_ACTION value: '163' - description: '' is_valid: true key: LIVE_GIFT_ACTION value: '165' - description: '' is_valid: true key: LIVE_HOMEPAGE value: '111' - description: '' is_valid: true key: LIVE_JOIN_GROUP value: '248' - description: '' is_valid: true key: LIVE_NATIVE_ACTION value: '162' - description: '' is_valid: true key: LIVE_REDIRECT_TO_STORE_ACTION value: '168' - description: '' is_valid: true key: LIVE_ROOM_ACTION value: '254' - description: '' is_valid: true key: LIVE_SLIDECART_CLICK_ACTION value: '166' - description: '' is_valid: true key: LIVE_STAY_TIME value: '186' - description: '' is_valid: true key: LIVE_SUCCESSORDER_ACTION value: '172' - description: '' is_valid: true key: LIVE_SUCESSORDER_PAY value: '169' - description: '' is_valid: true key: LOAN value: '119' - description: '' is_valid: true key: LOAN_APPLY value: '118' - description: '' is_valid: true key: LOAN_COMPLETION value: '103' - description: '' is_valid: true key: LOAN_CREDIT value: '105' - description: '' is_valid: true key: LOCATION_ACTION value: '48' - description: '' is_valid: true key: LOGIN value: '114' - description: '' is_valid: true key: LOGIN_ACTION value: '136' - description: '' is_valid: true key: LONGTERM_CUSTOMER value: '130' - description: '' is_valid: true key: LOTTERY value: '11' - description: '' is_valid: true key: LT_ROI value: '110' - description: '' is_valid: true key: MAP_SEARCH value: '3' - description: '' is_valid: true key: MESSAGE value: '94' - description: '' is_valid: true key: MESSAGE_ACTION value: '63' - description: '' is_valid: true key: MESSAGE_CLICK value: '177' - description: '' is_valid: true key: MESSAGE_JOIN_GROUP value: '247' - description: '' is_valid: true key: MESSAGE_SELF_SERVICE value: '188' - description: '' is_valid: true key: MESSAGE_SEND value: '310' - description: '' is_valid: true key: MULTIPLE value: '100' - description: '' is_valid: true key: MULTI_NATIVE_ACTION value: '102' - description: '' is_valid: true key: NATIVE_ACTION value: '44' - description: '' is_valid: true key: NAV_BAR value: '149' - description: '' is_valid: true key: NEW_FOLLOW_ACTION value: '187' - description: '' is_valid: true key: NEXT_DAY_OPEN value: '39' - description: '' is_valid: true key: NOVEL_CHAPTER value: '115' - description: '' is_valid: true key: ON_WEB_CART value: '147' - description: '' is_valid: true key: ON_WEB_DETAIL value: '146' - description: '' is_valid: true key: ON_WEB_ORDER value: '148' - description: '' is_valid: true key: ON_WEB_REGISTER value: '145' - description: '' is_valid: true key: OTHER value: '99' - description: '' is_valid: true key: OTO_PAY value: '229' - description: '' is_valid: true key: OTO_STAY_TIME value: '228' - description: '' is_valid: true key: PAGE_VIEW value: '93' - description: '' is_valid: true key: PAGE_VISIT value: '314' - description: '' is_valid: true key: PAID_CLUE value: '43' - description: '' is_valid: true key: PAY_ACTION value: '137' - description: '' is_valid: true key: PAY_ROI value: '160' - description: '' is_valid: true key: PERSONAL_INFORMATION value: '108' - description: '' is_valid: true key: PHONE value: '1' - description: '' is_valid: true key: PHONE_BUTTON value: '153' - description: '' is_valid: true key: PHONE_CONFIRM value: '16' - description: '' is_valid: true key: PHONE_CONNECT value: '17' - description: '' is_valid: true key: PHONE_DETAIL value: '152' - description: '' is_valid: true key: PHONE_EFFECTIVE value: '18' - description: '' is_valid: true key: PREFERRED_LEAD value: '315' - description: '' is_valid: true key: PREMIUM_PAYMENT value: '174' - description: '' is_valid: true key: PRE_LOAN_CREDIT value: '104' - description: '' is_valid: true key: PURCHASE_OF_GOODS value: '156' - description: '' is_valid: true key: QQ value: '10' - description: '' is_valid: true key: RATE value: '138' - description: '' is_valid: true key: READING_TIME value: '117' - description: '' is_valid: true key: REDIRECT value: '95' - description: '' is_valid: true key: REDIRECT_TO_SHOP value: '50' - description: '' is_valid: true key: REDIRECT_TO_STORE value: '113' - description: '' is_valid: true key: REGISTER_ACTION value: '139' - description: '' is_valid: true key: RESERVATION value: '62' - description: '' is_valid: true key: RSS value: '30' - description: '' is_valid: true key: SALES_LEAD value: '24' - description: '' is_valid: true key: SEARCH value: '140' - description: '' is_valid: true key: SEVEN_DAY_OPEN value: '227' - description: '' is_valid: true key: SHARE_ACTION value: '65' - description: '' is_valid: true key: SHOPPING value: '96' - description: '' is_valid: true key: SHOPPING_ACTION value: '49' - description: '' is_valid: true key: SHOPPING_CART value: '182' - description: '' is_valid: true key: START_TRIAL value: '142' - description: '' is_valid: true key: STAY_TIME value: '125' - description: '' is_valid: true key: SUBSCRIBE value: '143' - description: '' is_valid: true key: SUCCESSORDER_ACTION value: '53' - description: '' is_valid: true key: SUCCESSORDER_PAY value: '112' - description: '' is_valid: true key: UG_EFFECTIVE_ACTION value: '245' - description: '' is_valid: true key: UG_EFFECTIVE_DEAL value: '244' - description: '' is_valid: true key: UG_EFFECTIVE_SHARE value: '246' - description: '' is_valid: true key: UG_EFFECTIVE_SPEECH value: '243' - description: '' is_valid: true key: UG_ROI value: '178' - description: '' is_valid: true key: UNLOCK_ACHIEVEMENT value: '144' - description: '' is_valid: true key: UPDATE_LEVEL value: '37' - description: '' is_valid: true key: VIEW value: '7' - description: '' is_valid: true key: VOTE value: '12' - description: '' is_valid: true key: XPATH value: '6' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.optimization_event x-open-field-id: 7 - description: 'Do not pass campaign_type and ios14_quota_type at the same time. If both fields are passed, ios14_quota_type will be ignored. We recommend using campaign_type alone when you specify an iOS 14 Dedicated Campaign. campaign_type as REGULAR_CAMPAIGN or ios14_quota_type as UNOCCUPIED both indicate a non-iOS 14 Dedicated Campaign. campaign_type as IOS14_CAMPAIGN or ios14_quota_type as OCCUPIED both indicate an iOS 14 Dedicated Campaign. Whether the campaign will be counted towards the iOS 14 Dedicated Campaign quota. Enum values: OCCUPIED: The campaign is an iOS 14 Dedicated Campaign. UNOCCUPIED: The campaign is not an iOS 14 Dedicated Campaign.' in: query name: ios14_quota_type required: false schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1799795370044418 enum_package_name: IOS14QuotaType enums: - description: '' is_valid: true key: OCCUPIED value: '2' - description: '' is_valid: true key: UNOCCUPIED value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.ios14_quota_type x-open-field-id: 8 - description: 'Required when objective_type is APP_PROMOTION. App promotion type. Enum values: APP_INSTALL: Get new users to install your app. APP_RETARGETING: Re-engage existing users to take action in your app. Note: Only the enum value APP_INSTALL can be used in an iOS14 Dedicated Campaign.' in: query name: app_promotion_type required: false schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1799795397435394 enum_package_name: AppCampaignType enums: - description: '' is_valid: true key: APP_INSTALL value: '1' - description: '' is_valid: true key: APP_PREREGISTRATION value: '3' - description: '' is_valid: true key: APP_RETARGETING value: '2' - description: '' is_valid: true key: PAID_CONTENT value: '4' - description: '' is_valid: true key: UNSET value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.app_promotion_type x-open-field-id: 9 - description: 'Valid only when objective_type is PRODUCT_SALES. ID of the TikTok Shop. Note: To get the TikTok Shop ID, you can use /bc/asset/get/: When in the response asset_type is TIKTOK_SHOP, the returned asset_id is the TikTok Shop ID.' in: query name: store_id required: false schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.store_id x-open-field-id: 10 - description: 'Whether to use App Profile Page at the campaign level to optimize delivery. Enum values: ON, OFF. You can use the field only when objective_type is APP_PROMOTION and your campaign is an iOS14 Dedicated Campaign (ios14_quota_type =OCCUPIED). Otherwise, an error will occur.' in: query name: campaign_app_profile_page_state required: false schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1799795483636802 enum_package_name: AppProfilePageType enums: - description: '' is_valid: true key: INVALID value: '-1' - description: '' is_valid: true key: 'OFF' value: '2' - description: '' is_valid: true key: 'ON' value: '1' - description: '' is_valid: true key: UNSET value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.campaign_app_profile_page_state x-open-field-id: 11 - description: 'Whether the campaign is a Smart+ Campaign or not. Enum values: true, false.' in: query name: is_smart_performance_campaign required: false schema: type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.is_smart_performance_campaign x-open-field-id: 12 - description: 'Whether to enable Campaign Budget Optimization (CBO). Enum values: true, false. For details about CBO, see Campaign Budget Optimization.' in: query name: budget_optimize_on required: false schema: default: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.budget_optimize_on x-open-field-id: 13 - description: 'Do not pass campaign_type and ios14_quota_type at the same time. If both fields are passed, ios14_quota_type will be ignored. Campaign type. Enums values: REGULAR_CAMPAIGN: non-iOS 14 Dedicated Campaign. IOS14_CAMPAIGN: iOS 14 Dedicated Campaign. The value IOS14_CAMPAIGN can only be used when: objective_type is PRODUCT_SALES. objective_type is APP_PROMOTION and app_promotion_type is APP_INSTALL.' in: query name: campaign_type required: false schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1799795511033857 enum_package_name: IOSCampaignType enums: - description: '' is_valid: true key: IOS14_CAMPAIGN value: '2' - description: '' is_valid: true key: REGULAR_CAMPAIGN value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.campaign_type x-open-field-id: 14 - description: '' in: query name: is_advanced_dedicated_campaign required: false schema: type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.is_advanced_dedicated_campaign x-open-field-id: 15 - description: '' in: query name: disable_skan_campaign required: false schema: type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.disable_skan_campaign x-open-field-id: 16 - description: '' in: query name: bid_align_type required: false schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1828789430630402 enum_package_name: ToolBidAlignType enums: - description: '' is_valid: true key: SAN value: '1' - description: '' is_valid: true key: SKAN value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.bid_align_type x-open-field-id: 17 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Check Value-Based Optimization eligibility [Tool Vbo_status](https://ads.tiktok.com/marketing_api/docs?id=1770016073586753) tags: - Tool x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - name: core_user_id required: true source: $.http.query.context_info.core_user_id type: number - name: objective_type required: true source: $.http.query.objective_type type: number - name: promotion_type required: true source: $.http.query.promotion_type type: number - children: - type: number is_expand: true name: placements required: true source: $.http.query.placements sub_type: number type: array - name: pixel_id required: false source: $.http.query.pixel_id type: number - name: app_id required: false source: $.http.query.app_id type: number - name: optimization_event required: false source: $.http.query.optimization_event type: number - name: ios14_quota_type required: false source: $.http.query.ios14_quota_type type: number - name: app_promotion_type required: false source: $.http.query.app_promotion_type type: number - name: store_id required: false source: $.http.query.store_id type: number - name: campaign_app_profile_page_state required: false source: $.http.query.campaign_app_profile_page_state type: number - name: is_smart_performance_campaign required: false source: $.http.query.is_smart_performance_campaign type: boolean - name: budget_optimize_on required: false source: $.http.query.budget_optimize_on type: boolean - name: campaign_type required: false source: $.http.query.campaign_type type: number - children: - name: app_id required: false source: $.context.app_id type: number - name: core_user_id required: false source: $.context.core_user_id type: number is_expand: true name: context_info required: false type: object - name: is_advanced_dedicated_campaign required: false source: $.http.query.is_advanced_dedicated_campaign type: boolean - name: disable_skan_campaign required: false source: $.http.query.disable_skan_campaign type: boolean - name: bid_align_type required: false source: $.http.query.bid_align_type type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id app_id: $.http.query.app_id app_promotion_type: $.http.query.app_promotion_type bid_align_type: $.http.query.bid_align_type budget_optimize_on: $.http.query.budget_optimize_on campaign_app_profile_page_state: $.http.query.campaign_app_profile_page_state campaign_type: $.http.query.campaign_type context_info: app_id: $.context.app_id core_user_id: $.context.core_user_id core_user_id: $.http.query.context_info.core_user_id disable_skan_campaign: $.http.query.disable_skan_campaign ios14_quota_type: $.http.query.ios14_quota_type is_advanced_dedicated_campaign: $.http.query.is_advanced_dedicated_campaign is_smart_performance_campaign: $.http.query.is_smart_performance_campaign objective_type: $.http.query.objective_type optimization_event: $.http.query.optimization_event pixel_id: $.http.query.pixel_id placements: $.http.query.placements promotion_type: $.http.query.promotion_type store_id: $.http.query.store_id response_cookie: [] response_header: [] response_rule: highest_value_status_day0: $.rpc.output.highest_value_status_day0 highest_value_status_day7: $.rpc.output.roas_status_day7 roas_status_day0: $.rpc.output.roas_status_day0 roas_status_day7: $.rpc.output.roas_status_day7 vo_highest_value: $.rpc.output.vo_highest_value vo_iaa_highest_value: $.rpc.output.vo_iaa_highest_value vo_iaa_highest_value_zero_day: $.rpc.output.vo_iaa_highest_value_zero_day vo_iaa_min_roas: $.rpc.output.vo_iaa_min_roas vo_iaa_min_roas_zero_day: $.rpc.output.vo_iaa_min_roas_zero_day vo_min: $.rpc.output.vo_min vo_min_roas: $.rpc.output.vo_min_roas vo_status: $.rpc.output.vo_status x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false components: securitySchemes: AccessToken: type: apiKey in: header name: Access-Token description: Long-term access token issued by POST /oauth2/access_token/ after advertiser authorization. See https://business-api.tiktok.com/portal/docs?id=1738373164380162