openapi: 3.2.0 info: title: TikTok API for Business — Marketing Adgroup 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: Adgroup paths: /smart_plus/adgroup/create/: post: operationId: Smart_plus Adgroup Create 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: adgroup_name: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.name advertiser_id: description: '' 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 app_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 6 x-open-source: $.http.body.ad_ref_app_id attribution_event_count: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1807532923759682 enum_package_name: AttributionStatisticType enums: - description: '' is_valid: true key: EVERY value: '2' - description: '' is_valid: true key: ONCE 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-field-id: 41 x-open-source: $.http.body.attribution_statistic_type bid_price: description: '' format: double type: number x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 31 x-open-source: $.http.body.bid bid_type: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804193278233601 enum_package_name: SmartBidType enums: - description: 手动出价 is_valid: true key: BID_TYPE_CUSTOM value: '0' - description: '' is_valid: true key: BID_TYPE_MAX_CONVERSION value: '3' - description: 国际化no-bid出价 is_valid: true key: BID_TYPE_NO_BID value: '7' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 29 x-open-source: $.http.body.smart_bid_type billing_event: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1807532822255618 enum_package_name: PricingType enums: - description: '' is_valid: true key: CPA value: '7' - description: '' is_valid: true key: CPC value: '2' - description: '' is_valid: true key: CPM value: '1' - description: '' is_valid: true key: CPV value: '10' - description: '' is_valid: true key: GD value: '6' - description: '' is_valid: true key: OCPM value: '9' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 30 x-open-source: $.http.body.pricing budget: description: '' format: double type: number x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 14 x-open-source: $.http.body.budget budget_mode: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804191062647810 enum_package_name: BudgetMode enums: - description: '' is_valid: true key: BUDGET_MODE_DAY value: '0' - description: '' is_valid: true key: BUDGET_MODE_DYNAMIC_DAILY_BUDGET value: '3' - description: '' is_valid: true key: BUDGET_MODE_INFINITE value: '-1' - description: '' is_valid: true key: BUDGET_MODE_TOTAL value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 15 x-open-source: $.http.body.budget_mode campaign_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 3 x-open-source: $.http.body.campaign_id catalog_authorized_bc_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 34 x-open-source: $.http.body.catalog_authorized_bc catalog_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 33 x-open-source: $.http.body.product_platform_id click_attribution_window: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1807532889086018 enum_package_name: AttributionWindow enums: - description: '' is_valid: true key: FOURTEEN_DAYS value: '14' - description: '' is_valid: true key: 'OFF' value: '-1' - description: '' is_valid: true key: ONE_DAY value: '1' - description: '' is_valid: true key: SEVEN_DAYS value: '7' - description: '' is_valid: true key: TWENTY_EIGHT_DAYS value: '28' - description: '' is_valid: true key: UNSET value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 38 x-open-source: $.http.body.attribution_window_click comment_disabled: default: false description: '' type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int32(%s) x-open-field-id: 12 x-open-source: $.http.body.is_comment_disable conversion_bid_price: description: '' format: double type: number x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 32 x-open-source: $.http.body.cpa_bid custom_conversion_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 49 dayparting: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 19 x-open-source: $.http.body.dayparting deep_bid_type: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804193389572097 enum_package_name: DeepBidType enums: - description: AEO直投出价 is_valid: true key: AEO value: '101' - description: 标准出价 is_valid: true key: DEFAULT value: '0' - description: 自定义出价 is_valid: true key: MIN value: '1' - description: 动态出价 is_valid: true key: PACING value: '2' - description: 非中VO highest value is_valid: true key: VO_HIGHEST_VALUE value: '109' - description: ROI自动出价，非中含义为VO target CPA is_valid: true key: VO_MIN value: '7' - description: 非中VO minRoas is_valid: true key: VO_MIN_ROAS value: '108' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 26 x-open-source: $.http.body.deep_bid_type deep_cpabid: description: '' format: double type: number x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 27 x-open-source: $.http.body.deep_cpabid deep_funnel_event_source: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1829411592902721 enum_package_name: EventSourceIdType enums: - description: '' is_valid: true key: CRM value: '5' - description: '' is_valid: true key: OFFLINE value: '4' - description: '' is_valid: true key: PIXEL value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 45 x-open-source: $.http.body.deep_funnel_event_source deep_funnel_event_source_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 46 x-open-source: $.http.body.deep_funnel_event_source_id deep_funnel_optimization_event: description: '' 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_BILLING value: '266' - 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: application approval is_valid: true key: APPLICATION_APPROVAL value: '321' - 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: customize product is_valid: true key: CUSTOMIZE_PRODUCT value: '318' - 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_SESSION value: '319' - 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: find location is_valid: true key: FIND_LOCATION value: '316' - 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_CLUE value: '192' - 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: add to wishlist is_valid: true key: ON_WEB_ADD_TO_WISHLIST value: '269' - 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: search is_valid: true key: ON_WEB_SEARCH value: '268' - description: subscribe is_valid: true key: ON_WEB_SUBSCRIBE value: '270' - 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: 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: PURCHASE_ROI value: '160' - 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: schedule is_valid: true key: SCHEDULE value: '317' - 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: submit application is_valid: true key: SUBMIT_APPLICATION value: '320' - 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: 47 x-open-source: $.http.body.deep_funnel_optimization_event deep_funnel_optimization_status: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1829411517862913 enum_package_name: DeepFunnelToggle enums: - 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-field-id: 44 x-open-source: $.http.body.deep_funnel_toggle engaged_view_attribution_window: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1807532889086018 enum_package_name: AttributionWindow enums: - description: '' is_valid: true key: FOURTEEN_DAYS value: '14' - description: '' is_valid: true key: 'OFF' value: '-1' - description: '' is_valid: true key: ONE_DAY value: '1' - description: '' is_valid: true key: SEVEN_DAYS value: '7' - description: '' is_valid: true key: TWENTY_EIGHT_DAYS value: '28' - description: '' is_valid: true key: UNSET value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 39 x-open-source: $.http.body.attribution_window_engaged_view identity_authorized_bc_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 52 identity_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 50 identity_type: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800331041544193 enum_package_name: IdentityType enums: - description: '' is_valid: false key: AUTH_CODE value: '2' - description: '' is_valid: true key: BC_AUTH_TT value: '5' - description: '' is_valid: false key: BC_SELF_TT value: '4' - description: '' is_valid: false key: CUSTOMIZED_USER value: '1' - description: TTS 授权来源TT账号 is_valid: false key: TTS_TT value: '8' - description: '' is_valid: true key: TT_USER value: '3' - description: '' is_valid: false key: UNSET value: '0' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 51 message_event_set_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 57 x-open-source: $.http.body.ad_ref_message_event_set_id messaging_app_account_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 54 x-open-source: $.http.body.ima_account_id messaging_app_type: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1842138255512577 enum_package_name: ImaType enums: - description: '' is_valid: true key: IM_URL value: '0' - description: '' is_valid: true key: LINE value: '3' - description: '' is_valid: true key: MESSENGER value: '1' - description: '' is_valid: false key: TikTok value: '5' - description: '' is_valid: true key: WHATSAPP value: '2' - description: '' is_valid: true key: ZALO value: '4' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 53 x-open-source: $.http.body.ima_type min_budget: description: '' format: double type: number x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 13 movie_premiere_date: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - datetime_to_timestamp(%s, "date", "utc") x-open-field-id: 48 open_api_partner: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 22 x-open-source: $.http.body.open_api_partner operation_status: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804192764187649 enum_package_name: OptStatus enums: - description: 暂停 is_valid: true key: DISABLE value: '1' - description: 启用 is_valid: true key: ENABLE value: '0' - description: 终止,不能再次被启用 is_valid: false key: FROZEN value: '2' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 23 x-open-source: $.http.body.operation_status optimization_event: description: '' 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_BILLING value: '266' - 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: application approval is_valid: true key: APPLICATION_APPROVAL value: '321' - 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: customize product is_valid: true key: CUSTOMIZE_PRODUCT value: '318' - 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_SESSION value: '319' - 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: find location is_valid: true key: FIND_LOCATION value: '316' - 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_CLUE value: '192' - 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: add to wishlist is_valid: true key: ON_WEB_ADD_TO_WISHLIST value: '269' - 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: search is_valid: true key: ON_WEB_SEARCH value: '268' - description: subscribe is_valid: true key: ON_WEB_SUBSCRIBE value: '270' - 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: 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: PURCHASE_ROI value: '160' - 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: schedule is_valid: true key: SCHEDULE value: '317' - 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: submit application is_valid: true key: SUBMIT_APPLICATION value: '320' - 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: 25 x-open-source: $.http.body.external_action optimization_goal: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804193306612737 enum_package_name: OptimizeGoal enums: - description: '' is_valid: true key: ANCHOR_CLICK value: '112' - description: '' is_valid: true key: ANCHOR_CLICK_PURCHASE value: '117' - description: '' is_valid: true key: AUTOMATED_VALUE value: '125' - description: '' is_valid: true key: CLICK value: '101' - description: '' is_valid: true key: CONVERSATION value: '124' - description: '' is_valid: true key: CONVERSION_LEADS value: '121' - description: '' is_valid: true key: CONVERT value: '100' - description: '' is_valid: true key: DESTINATION_VISIT value: '123' - description: '' is_valid: true key: ENGAGED_VIEW value: '118' - description: '' is_valid: true key: ENGAGED_VIEW_FIFTEEM value: '120' - description: '' is_valid: true key: FOLLOWERS value: '108' - description: '' is_valid: true key: INSTALL value: '105' - description: '' is_valid: true key: IN_APP_EVENT value: '106' - description: '' is_valid: true key: LEAD_GENERATION value: '107' - description: '' is_valid: true key: MESSAGE value: '119' - description: '' is_valid: true key: MT_LIVE_FOLLOW value: '126' - description: '' is_valid: true key: MT_LIVE_ROOM value: '113' - description: '' is_valid: true key: MT_LIVE_SHOPPING value: '116' - description: '' is_valid: true key: PAGE_VISIT value: '122' - description: '' is_valid: true key: POST_ENGAGEMNT value: '110' - description: '' is_valid: true key: PREFERRED_LEAD value: '127' - description: '' is_valid: true key: PRODUCT_CLICK_IN_LIVE value: '114' - description: '' is_valid: true key: PROFILE_VIEWS value: '109' - description: '' is_valid: true key: REACH value: '103' - description: '' is_valid: true key: SHOW value: '102' - description: '' is_valid: true key: TRAFFIC_LANDING_PAGE_VIEW value: '115' - description: '' is_valid: true key: VALUE value: '111' - description: '' is_valid: true key: VIDEO_VIEW value: '104' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 24 x-open-source: $.http.body.optimize_goal phone_info: description: '' properties: phone_number: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 phone_region_calling_code: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 phone_region_code: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 56 pixel_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 8 x-open-source: $.http.body.ad_ref_pixel_id placement_type: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1807532513532929 enum_package_name: InventoryFlowType enums: - description: '' is_valid: true key: PLACEMENT_TYPE_AUTOMATIC value: '0' - description: '' is_valid: true key: PLACEMENT_TYPE_NORMAL value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 5 placements: description: '' 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-field-id: 4 product_source: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1807533400732674 enum_package_name: ProductSource enums: - description: '' is_valid: true key: CATALOG value: '1' - description: '' is_valid: true key: SHOWCASE value: '3' - description: '' is_valid: true key: STORE value: '2' - description: '' is_valid: true key: UNSET value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 35 x-open-source: $.http.body.product_source promotion_target_type: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800967779549186 enum_package_name: PromotionTargetType enums: - description: '' is_valid: true key: EXTERNAL_WEBSITE value: '2' - description: '' is_valid: true key: INSTANT_PAGE 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-field-id: 37 x-open-source: $.http.body.promotion_target_type promotion_type: description: '' 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: 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: false validate_only: false value_format: int32 x-open-field-id: 7 x-open-source: $.http.body.external_type promotion_website_type: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1807532535882754 enum_package_name: PromotionWebsiteType enums: - description: '' is_valid: true key: TIKTOK_NATIVE_PAGE 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-field-id: 21 x-open-source: $.http.body.promotion_website_type request_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 36 x-open-source: $.http.body.dedup_token roas_bid: description: '' format: double type: number x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 28 x-open-source: $.http.body.roas_bid schedule_end_time: description: '' format: datetime type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - datetime_to_timestamp(%s,"date-time","utc") x-open-field-id: 18 x-open-source: $.http.body.end_time_stamp schedule_start_time: description: '' format: datetime type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - datetime_to_timestamp(%s,"date-time","utc") x-open-field-id: 17 x-open-source: $.http.body.start_time_stamp schedule_type: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1807532710001665 enum_package_name: ScheduleType enums: - description: '' is_valid: true key: SCHEDULE_FROM_NOW value: '1' - description: '' is_valid: true key: SCHEDULE_START_END value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 16 x-open-source: $.http.body.schedule_type share_disabled: description: '' type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 42 x-open-source: $.http.body.is_share_disable suggestion_audience_enabled: description: '' type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 10 targeting_optimization_mode: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1838600430487746 enum_package_name: SpcTargetingSwitch enums: - description: '' is_valid: true key: AUTOMATIC value: '0' - description: '' is_valid: true key: MANUAL value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 9 targeting_spec: description: '' properties: actions: description: '' items: properties: action_category_ids: description: '' 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: 4 action_period: description: '' format: int64 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 action_scene: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800966577028098 enum_package_name: ActionScene enums: - description: '' is_valid: true key: CREATOR_RELATED value: '11' - description: '' is_valid: true key: HASHTAG_RELATED value: '13' - description: '' is_valid: true key: VIDEO_RELATED value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 1 video_user_actions: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804237663605761 enum_package_name: VideoAction enums: - description: '' is_valid: true key: COMMENTED value: '2' - description: '' is_valid: true key: FOLLOWING value: '4' - description: '' is_valid: true key: LIKED value: '1' - description: '' is_valid: true key: SHARED value: '3' - description: '' is_valid: true key: VIEW_HASHTAG value: '6' - description: '' is_valid: true key: VIEW_HOMEPAGE value: '5' - description: '' is_valid: true key: WATCHED_TO_END value: '0' 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 type: object 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: 15 age_groups: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804615806530625 enum_package_name: AgeType enums: - description: '' is_valid: true key: AGE_13_17 value: '30' - description: '' is_valid: true key: AGE_18_24 value: '42' - description: '' is_valid: true key: AGE_25_34 value: '59' - description: '' is_valid: true key: AGE_35_44 value: '79' - description: '' is_valid: true key: AGE_45_54 value: '99' - description: '' is_valid: true key: AGE_55_100 value: '155' 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: 4 x-open-source: $.http.body.audience.age_groups app_targeting_type: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1844135134496898 enum_package_name: DpaLocalAudience enums: - description: '' is_valid: true key: PROSPECT value: '0' - description: '' is_valid: true key: RETARGETING value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int64 x-open-field-id: 29 audience_ids: description: '' 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: 7 blocked_pangle_app_ids: description: '' 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: 28 carrier_ids: description: '' 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: 23 device_model_ids: description: '' 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: 26 device_price_ranges: description: '' items: format: int64 type: integer 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: 25 excluded_audience_ids: description: '' 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: 6 x-open-source: $.http.body.audience.retargeting_tags_exclude excluded_pangle_audience_package_ids: description: '' 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: 9 gender: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804229882527745 enum_package_name: AudienceGenderType enums: - description: '' is_valid: true key: GENDER_FEMALE value: '2' - description: '' is_valid: true key: GENDER_MALE value: '1' - description: '' is_valid: true key: GENDER_UNLIMITED 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.body.audience.gender household_income: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1810164011458562 enum_package_name: HHILabel enums: - description: 默认值，代表没有hhi标签，不会使用到 is_valid: false key: Default value: '0' - description: top10% is_valid: true key: TOP10 value: '2' - description: top10%~top25% is_valid: true key: TOP10_25 value: '3' - description: top25%~top50% is_valid: true key: TOP25_50 value: '4' - description: top5% is_valid: true key: TOP5 value: '1' 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-field-id: 19 included_pangle_audience_package_ids: description: '' 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: 8 interest_category_ids: description: '' 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: 12 interest_keyword_ids: description: '' 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: 13 isp_ids: description: '' 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: 24 languages: description: '' 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: 1 x-open-source: $.http.body.audience.language_list location_ids: description: '' 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: 10 x-open-source: $.http.body.audience.particle_locations min_android_version: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 20 min_ios_version: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 21 network_types: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1810160639116290 enum_package_name: AccessType enums: - description: '' is_valid: true key: 2G value: '2' - description: '' is_valid: true key: 3G value: '3' - description: '' is_valid: true key: 4G value: '4' - description: '' is_valid: true key: 5G value: '5' - description: '' is_valid: true key: WIFI 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-field-id: 22 operating_systems: description: '' items: 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 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 purchase_intention_keyword_ids: description: '' 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: 14 saved_audience_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 27 smart_audience_enabled: description: '' type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 17 smart_interest_behavior_enabled: description: '' type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 16 spc_audience_age: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1836070828374017 enum_package_name: ExcludeAgeUnder18Type enums: - description: '' is_valid: true key: OVER_EIGHTEEN value: '1' - description: '' is_valid: true key: OVER_TWENTY_FIVE value: '2' - description: '' is_valid: false key: UNSET value: '0' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 5 x-open-source: $.http.body.audience.exclude_age_under_eighteen spending_power: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1810164182046722 enum_package_name: SpendingPowerType enums: - description: '' is_valid: true key: ALL value: ALL - description: '' is_valid: true key: HIGH value: HIGH key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 18 zipcode_ids: description: '' 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: 11 x-open-source: $.http.body.audience.zipcode_ids type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 11 x-open-source: $.http.body.audience vbo_window: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1810159503625218 enum_package_name: VboDateType enums: - description: '' is_valid: true key: SEVEN_DAYS value: '0' - description: '' is_valid: true key: ZERO_DAY value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 43 x-open-source: $.http.body.vbo_date_type video_download_disabled: description: '' type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int32(%s) x-open-field-id: 20 x-open-source: $.http.body.ad_download_status view_attribution_window: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1807532889086018 enum_package_name: AttributionWindow enums: - description: '' is_valid: true key: FOURTEEN_DAYS value: '14' - description: '' is_valid: true key: 'OFF' value: '-1' - description: '' is_valid: true key: ONE_DAY value: '1' - description: '' is_valid: true key: SEVEN_DAYS value: '7' - description: '' is_valid: true key: TWENTY_EIGHT_DAYS value: '28' - description: '' is_valid: true key: UNSET value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 40 x-open-source: $.http.body.attribution_window_view zalo_id_type: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1842138458252290 enum_package_name: ImaIdType enums: - description: string is_valid: true key: ZALO_OFFICIAL_ACCOUNT value: '1' - description: phone number is_valid: true key: ZALO_PHONE_ACCOUNT value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 55 x-open-source: $.http.body.ima_id_type required: - advertiser_id - adgroup_name - campaign_id - promotion_type - targeting_spec - schedule_type - schedule_start_time - optimization_goal - billing_event - request_id 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: Create a new ad group [Smart Plus AdGroup Create] tags: - Adgroup 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: name required: true source: $.http.body.adgroup_name type: string - name: campaign_id required: true source: $.http.body.campaign_id type: number - name: ad_ref_app_id required: false source: $.http.body.app_id type: number - name: external_type required: false source: $.http.body.promotion_type type: number - name: ad_ref_pixel_id required: false source: $.http.body.pixel_id type: number - children: - children: - type: string is_expand: false name: language_list required: false source: $.http.body.targeting_spec.languages[] sub_type: string type: array - name: gender required: false source: $.http.body.targeting_spec.gender type: number - children: - type: number is_expand: false name: age_groups required: false source: $.http.body.targeting_spec.age_groups[] sub_type: number type: array - name: exclude_age_under_eighteen required: false source: $.http.body.targeting_spec.spc_audience_age type: number - children: - type: number is_expand: false name: retargeting_tags_exclude required: false source: $.http.body.targeting_spec.excluded_audience_ids[] sub_type: number type: array - children: - type: number is_expand: false name: particle_locations required: false source: $.http.body.targeting_spec.location_ids[] sub_type: number type: array - children: - type: number is_expand: false name: zipcode_ids required: false source: $.http.body.targeting_spec.zipcode_ids[] sub_type: number type: array - is_expand: false name: min_android_version required: false source: $.http.body.targeting_spec.min_android_version type: string - is_expand: false name: min_ios_version required: false source: $.http.body.targeting_spec.min_ios_version type: string - children: - is_expand: false source: undefined type: number is_expand: false name: ac required: false source: $.http.body.targeting_spec.network_types[] sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: false name: platform required: false source: $.http.body.targeting_spec.operating_systems[] sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: false name: launch_price required: false source: $.http.body.targeting_spec.device_price_ranges[] sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: false name: retargeting_tags required: false source: $.http.body.targeting_spec.audience_ids[] sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: false name: ad_tag_v2 required: false source: $.http.body.targeting_spec.interest_category_ids[] sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: false name: carriers required: false source: $.http.body.targeting_spec.carrier_ids[] sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: false name: household_income required: false source: $.http.body.targeting_spec.household_income[] sub_type: number type: array - children: - is_expand: false source: undefined type: string is_expand: false name: internet_service_providers required: false source: $.http.body.targeting_spec.isp_ids[] sub_type: string type: array - is_expand: false name: saved_audience_id required: false source: $.http.body.targeting_spec.saved_audience_id type: number - is_expand: false name: spending_power required: false source: $.http.body.targeting_spec.spending_power type: string - is_expand: false name: smart_interest_behavior_enabled required: false source: $.http.body.targeting_spec.smart_interest_behavior_enabled type: boolean - is_expand: false name: smart_audience_enabled required: false source: $.http.body.targeting_spec.smart_audience_enabled type: boolean - children: - is_expand: false source: undefined type: number is_expand: false name: exclude_app_package_id required: false source: $.http.body.targeting_spec.blocked_pangle_app_ids[] sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: true name: flow_package_include required: false source: $.http.body.targeting_spec.included_pangle_audience_package_ids[] sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: false name: flow_package_exclude required: false source: $.http.body.targeting_spec.excluded_pangle_audience_package_ids[] sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: false name: in_market_tags required: false source: $.http.body.targeting_spec.purchase_intention_keyword_ids[] sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: false name: interest_keywords_i18n required: false source: $.http.body.targeting_spec.interest_keyword_ids[] sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: false name: device_models required: false source: $.http.body.targeting_spec.device_model_ids[] sub_type: number type: array - children: - children: - is_expand: false name: action_scene required: false source: $.http.body.targeting_spec.actions[].action_scene type: number - is_expand: false name: action_period required: false source: $.http.body.targeting_spec.actions[].action_period type: number - children: - is_expand: false source: undefined type: number is_expand: false name: video_user_actions required: false source: $.http.body.targeting_spec.actions[].video_user_actions sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: false name: action_category_ids required: false source: $.http.body.targeting_spec.actions[].action_category_ids sub_type: number type: array is_expand: true source: undefined type: object is_expand: false name: action_v2 required: false source: $.http.body.targeting_spec.actions[] sub_type: object type: array - is_expand: false name: dpa_local_audience required: false source: $.http.body.targeting_spec.app_targeting_type type: number is_expand: true name: audience required: false type: object - name: is_comment_disable required: false source: $.http.body.comment_disabled type: number - name: budget required: false source: $.http.body.budget type: number - name: budget_mode required: false source: $.http.body.budget_mode type: number - name: schedule_type required: true source: $.http.body.schedule_type type: number - name: start_time_stamp required: true source: $.http.body.schedule_start_time type: number - name: end_time_stamp required: false source: $.http.body.schedule_end_time type: number - name: dayparting required: false source: $.http.body.dayparting type: string - name: ad_download_status required: false source: $.http.body.video_download_disabled type: number - name: promotion_website_type required: false source: $.http.body.promotion_website_type type: number - name: open_api_partner required: false source: $.http.body.open_api_partner type: string - name: operation_status required: false source: $.http.body.operation_status type: number - name: optimize_goal required: false source: $.http.body.optimization_goal type: number - name: external_action required: false source: $.http.body.optimization_event type: number - name: deep_bid_type required: false source: $.http.body.deep_bid_type type: number - name: deep_cpabid required: false source: $.http.body.deep_cpabid type: number - name: roas_bid required: false source: $.http.body.roas_bid type: number - name: smart_bid_type required: false source: $.http.body.bid_type type: number - name: pricing required: false source: $.http.body.billing_event type: number - name: bid required: false source: $.http.body.bid_price type: number - name: cpa_bid required: false source: $.http.body.conversion_bid_price type: number - name: product_platform_id required: false source: $.http.body.catalog_id type: number - name: catalog_authorized_bc required: false source: $.http.body.catalog_authorized_bc_id type: number - name: product_source required: false source: $.http.body.product_source type: number - name: dedup_token required: false source: $.http.body.request_id type: number - name: promotion_target_type required: false source: $.http.body.promotion_target_type type: number - name: attribution_window_click required: false source: $.http.body.click_attribution_window type: number - name: attribution_window_engaged_view required: false source: $.http.body.engaged_view_attribution_window type: number - name: attribution_window_view required: false source: $.http.body.view_attribution_window type: number - name: attribution_statistic_type required: false source: $.http.body.attribution_event_count type: number - name: is_share_disable required: false source: $.http.body.share_disabled type: number - name: vbo_date_type required: false source: $.http.body.vbo_window type: number - name: deep_funnel_toggle required: false source: $.http.body.deep_funnel_optimization_status type: number - name: deep_funnel_event_source required: false source: $.http.body.deep_funnel_event_source type: number - name: deep_funnel_event_source_id required: false source: $.http.body.deep_funnel_event_source_id type: string - name: deep_funnel_optimization_event required: false source: $.http.body.deep_funnel_optimization_event type: number - name: spc_targeting_switch required: false source: $.http.body.targeting_optimization_mode type: number - children: - type: number is_expand: false name: inventory_flow required: false source: $.http.body.placements[] sub_type: number type: array - name: inventory_flow_type required: false source: $.http.body.placement_type type: number - name: min_budget required: false source: $.http.body.min_budget type: number - name: suggestion_audience_enabled required: false source: $.http.body.suggestion_audience_enabled type: boolean - name: movie_premiere_date required: false source: $.http.body.movie_premiere_date type: number - name: custom_conversion_id required: false source: $.http.body.custom_conversion_id type: number - name: ima_type required: false source: $.http.body.messaging_app_type type: number - name: ima_account_id required: false source: $.http.body.messaging_app_account_id type: string - name: ima_id_type required: false source: $.http.body.zalo_id_type type: number - name: identity_id required: false source: $.http.body.identity_id type: string - name: identity_type required: false source: $.http.body.identity_type type: number - name: identity_bc_id required: false source: $.http.body.identity_authorized_bc_id type: number - name: phone_zip_code required: false source: $.http.body.phone_info.phone_region_calling_code type: string - name: phone_number required: false source: $.http.body.phone_info.phone_number type: string - name: phone_country_code required: false source: $.http.body.phone_info.phone_region_code type: string - name: ad_ref_message_event_set_id required: false source: $.http.body.message_event_set_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: ad_download_status: $.http.body.video_download_disabled ad_ref_app_id: $.http.body.app_id ad_ref_message_event_set_id: $.http.body.message_event_set_id ad_ref_pixel_id: $.http.body.pixel_id advertiser_id: $.http.body.advertiser_id attribution_statistic_type: $.http.body.attribution_event_count attribution_window_click: $.http.body.click_attribution_window attribution_window_engaged_view: $.http.body.engaged_view_attribution_window attribution_window_view: $.http.body.view_attribution_window audience: ac: $.http.body.targeting_spec.network_types[] action_v2: $.http.body.targeting_spec.actions[] ad_tag_v2: $.http.body.targeting_spec.interest_category_ids[] age_groups: $.http.body.targeting_spec.age_groups[] carriers: $.http.body.targeting_spec.carrier_ids[] device_models: $.http.body.targeting_spec.device_model_ids[] dpa_local_audience: $.http.body.targeting_spec.app_targeting_type exclude_age_under_eighteen: $.http.body.targeting_spec.spc_audience_age exclude_app_package_id: $.http.body.targeting_spec.blocked_pangle_app_ids[] flow_package_exclude: $.http.body.targeting_spec.excluded_pangle_audience_package_ids[] flow_package_include: $.http.body.targeting_spec.included_pangle_audience_package_ids[] gender: $.http.body.targeting_spec.gender household_income: $.http.body.targeting_spec.household_income[] in_market_tags: $.http.body.targeting_spec.purchase_intention_keyword_ids[] interest_keywords_i18n: $.http.body.targeting_spec.interest_keyword_ids[] internet_service_providers: $.http.body.targeting_spec.isp_ids[] language_list: $.http.body.targeting_spec.languages[] launch_price: $.http.body.targeting_spec.device_price_ranges[] min_android_version: $.http.body.targeting_spec.min_android_version min_ios_version: $.http.body.targeting_spec.min_ios_version particle_locations: $.http.body.targeting_spec.location_ids[] platform: $.http.body.targeting_spec.operating_systems[] retargeting_tags: $.http.body.targeting_spec.audience_ids[] retargeting_tags_exclude: $.http.body.targeting_spec.excluded_audience_ids[] saved_audience_id: $.http.body.targeting_spec.saved_audience_id smart_audience_enabled: $.http.body.targeting_spec.smart_audience_enabled smart_interest_behavior_enabled: $.http.body.targeting_spec.smart_interest_behavior_enabled spending_power: $.http.body.targeting_spec.spending_power zipcode_ids: $.http.body.targeting_spec.zipcode_ids[] bid: $.http.body.bid_price budget: $.http.body.budget budget_mode: $.http.body.budget_mode campaign_id: $.http.body.campaign_id catalog_authorized_bc: $.http.body.catalog_authorized_bc_id cpa_bid: $.http.body.conversion_bid_price custom_conversion_id: $.http.body.custom_conversion_id dayparting: $.http.body.dayparting dedup_token: $.http.body.request_id deep_bid_type: $.http.body.deep_bid_type deep_cpabid: $.http.body.deep_cpabid deep_funnel_event_source: $.http.body.deep_funnel_event_source deep_funnel_event_source_id: $.http.body.deep_funnel_event_source_id deep_funnel_optimization_event: $.http.body.deep_funnel_optimization_event deep_funnel_toggle: $.http.body.deep_funnel_optimization_status end_time_stamp: $.http.body.schedule_end_time external_action: $.http.body.optimization_event external_type: $.http.body.promotion_type identity_bc_id: $.http.body.identity_authorized_bc_id identity_id: $.http.body.identity_id identity_type: $.http.body.identity_type ima_account_id: $.http.body.messaging_app_account_id ima_id_type: $.http.body.zalo_id_type ima_type: $.http.body.messaging_app_type inventory_flow: $.http.body.placements[] inventory_flow_type: $.http.body.placement_type is_comment_disable: $.http.body.comment_disabled is_share_disable: $.http.body.share_disabled min_budget: $.http.body.min_budget movie_premiere_date: $.http.body.movie_premiere_date name: $.http.body.adgroup_name open_api_partner: $.http.body.open_api_partner operation_status: $.http.body.operation_status optimize_goal: $.http.body.optimization_goal phone_country_code: $.http.body.phone_info.phone_region_code phone_number: $.http.body.phone_info.phone_number phone_zip_code: $.http.body.phone_info.phone_region_calling_code pricing: $.http.body.billing_event product_platform_id: $.http.body.catalog_id product_source: $.http.body.product_source promotion_target_type: $.http.body.promotion_target_type promotion_website_type: $.http.body.promotion_website_type roas_bid: $.http.body.roas_bid schedule_type: $.http.body.schedule_type smart_bid_type: $.http.body.bid_type spc_targeting_switch: $.http.body.targeting_optimization_mode start_time_stamp: $.http.body.schedule_start_time suggestion_audience_enabled: $.http.body.suggestion_audience_enabled vbo_date_type: $.http.body.vbo_window response_cookie: [] response_header: [] response_rule: adgroup_id: $.rpc.output.adgroup_data.adgroup_id adgroup_name: $.rpc.output.adgroup_data.name advertiser_id: $.rpc.output.adgroup_data.advertiser_id app_id: $.rpc.output.adgroup_data.ad_ref_app_id attribution_event_count: $.rpc.output.adgroup_data.attribution_statistic_type bid_price: $.rpc.output.adgroup_data.bid bid_type: $.rpc.output.adgroup_data.smart_bid_type billing_event: $.rpc.output.adgroup_data.pricing budget: $.rpc.output.adgroup_data.budget budget_mode: $.rpc.output.adgroup_data.budget_mode campaign_id: $.rpc.output.adgroup_data.campaign_id campaign_name: $.rpc.output.adgroup_data.campaign_name catalog_authorized_bc_id: $.rpc.output.adgroup_data.catalog_authorized_bc catalog_id: $.rpc.output.adgroup_data.product_platform_id click_attribution_window: $.rpc.output.adgroup_data.attribution_window_click comment_disabled: $.rpc.output.adgroup_data.is_comment_disable conversion_bid_price: $.rpc.output.adgroup_data.cpa_bid create_time: $.rpc.output.adgroup_data.display_create_time custom_conversion_id: $.rpc.output.adgroup_data.custom_conversion_id dayparting: $.rpc.output.adgroup_data.dayparting deep_bid_type: $.rpc.output.adgroup_data.deep_bid_type deep_cpabid: $.rpc.output.adgroup_data.deep_cpabid deep_funnel_event_source: $.rpc.output.adgroup_data.deep_funnel_event_source deep_funnel_event_source_id: $.rpc.output.adgroup_data.deep_funnel_event_source_id deep_funnel_optimization_event: $.rpc.output.adgroup_data.deep_funnel_optimization_event deep_funnel_optimization_status: $.rpc.output.adgroup_data.deep_funnel_toggle engaged_view_attribution_window: $.rpc.output.adgroup_data.attribution_window_engaged_view identity_authorized_bc_id: $.rpc.output.adgroup_data.identity_bc_id identity_id: $.rpc.output.adgroup_data.identity_id identity_type: $.rpc.output.adgroup_data.identity_type incentive_offer_type: $.rpc.output.adgroup_data.compensation_activity message_event_set_id: $.rpc.output.adgroup_data.ad_ref_message_event_set_id messaging_app_account_id: $.rpc.output.adgroup_data.ima_account_id messaging_app_type: $.rpc.output.adgroup_data.ima_type min_budget: $.rpc.output.adgroup_data.min_budget modify_time: $.rpc.output.adgroup_data.display_modify_time movie_premiere_date: $.rpc.output.adgroup_data.movie_premiere_date operation_status: $.rpc.output.adgroup_data.operation_status optimization_event: $.rpc.output.adgroup_data.external_action optimization_goal: $.rpc.output.adgroup_data.optimize_goal pacing: $.rpc.output.adgroup_data.flow_control_mode phone_info: phone_number: $.rpc.output.adgroup_data.phone_number phone_region_calling_code: $.rpc.output.adgroup_data.phone_zip_code phone_region_code: $.rpc.output.adgroup_data.phone_country_code pixel_id: $.rpc.output.adgroup_data.ad_ref_pixel_id placement_type: $.rpc.output.adgroup_data.inventory_flow_type placements: $.rpc.output.adgroup_data.inventory_flow product_set_id: $.rpc.output.adgroup_data.product_set_id product_source: $.rpc.output.adgroup_data.product_source promotion_target_type: $.rpc.output.adgroup_data.promotion_target_type promotion_type: $.rpc.output.adgroup_data.external_type promotion_website_type: $.rpc.output.adgroup_data.promotion_website_type roas_bid: $.rpc.output.adgroup_data.roas_bid schedule_end_time: $.rpc.output.adgroup_data.end_time_stamp schedule_start_time: $.rpc.output.adgroup_data.start_time_stamp schedule_type: $.rpc.output.adgroup_data.schedule_type scheduled_budget: $.rpc.output.adgroup_data.scheduled_budget search_result_enabled: $.rpc.output.adgroup_data.search_result_enabled secondary_optimization_event: $.rpc.output.adgroup_data.deep_external_action secondary_status: $.rpc.output.adgroup_data.secondary_status share_disabled: $.rpc.output.adgroup_data.is_share_disable skip_learning_phase: $.rpc.output.adgroup_data.cpa_skip_first_phrase suggestion_audience_enabled: $.rpc.output.adgroup_data.suggestion_audience_enabled targeting_optimization_mode: $.rpc.output.adgroup_data.spc_targeting_switch targeting_spec: actions[][]: - action_category_ids: $.rpc.output.adgroup_data.audience.action_v2[].action_category_ids action_period: $.rpc.output.adgroup_data.audience.action_v2[].action_period action_scene: $.rpc.output.adgroup_data.audience.action_v2[].action_scene video_user_actions: $.rpc.output.adgroup_data.audience.action_v2[].video_user_actions age_groups: $.rpc.output.adgroup_data.audience.age_groups app_targeting_type: $.rpc.output.adgroup_data.audience.dpa_local_audience audience_ids: $.rpc.output.adgroup_data.audience.retargeting_tags blocked_pangle_app_ids: $.rpc.output.adgroup_data.audience.exclude_app_package_id brand_safety_type: $.rpc.output.adgroup_data.audience.brand_safety carrier_ids: $.rpc.output.adgroup_data.audience.carriers category_exclusion_ids: $.rpc.output.adgroup_data.audience.category_exclusion_ids device_model_ids: $.rpc.output.adgroup_data.audience.device_models device_price_ranges: $.rpc.output.adgroup_data.audience.launch_price excluded_audience_ids: $.rpc.output.adgroup_data.audience.retargeting_tags_exclude excluded_pangle_audience_package_ids: $.rpc.output.adgroup_data.audience.flow_package_exclude gender: $.rpc.output.adgroup_data.audience.gender household_income: $.rpc.output.adgroup_data.audience.household_income included_pangle_audience_package_ids: $.rpc.output.adgroup_data.audience.flow_package_include interest_category_ids: $.rpc.output.adgroup_data.audience.ad_tag_v2 interest_keyword_ids: $.rpc.output.adgroup_data.audience.interest_keywords_i18n isp_ids: $.rpc.output.adgroup_data.audience.internet_service_providers languages: $.rpc.output.adgroup_data.audience.language_list location_ids: $.rpc.output.adgroup_data.audience.particle_locations min_android_version: $.rpc.output.adgroup_data.audience.min_android_version min_ios_version: $.rpc.output.adgroup_data.audience.min_ios_version network_types: $.rpc.output.adgroup_data.audience.ac operating_systems: $.rpc.output.adgroup_data.audience.platform purchase_intention_keyword_ids: $.rpc.output.adgroup_data.audience.in_market_tags saved_audience_id: $.rpc.output.adgroup_data.audience.saved_audience_id smart_audience_enabled: $.rpc.output.adgroup_data.audience.smart_audience_enabled smart_interest_behavior_enabled: $.rpc.output.adgroup_data.audience.smart_interest_behavior_enabled spc_audience_age: $.rpc.output.adgroup_data.audience.exclude_age_under_eighteen spending_power: $.rpc.output.adgroup_data.audience.spending_power zipcode_ids: $.rpc.output.adgroup_data.audience.zipcode_ids vbo_window: $.rpc.output.adgroup_data.vbo_date_type video_download_disabled: $.rpc.output.adgroup_data.ad_download_status view_attribution_window: $.rpc.output.adgroup_data.attribution_window_view zalo_id_type: $.rpc.output.adgroup_data.ima_id_type x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /smart_plus/adgroup/get/: get: operationId: Smart_plus Adgroup Get parameters: - description: '' 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: adgroup_ids: description: '' 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: 1 x-open-source: $.http.query.filtering.adgroup_ids adgroup_name: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.query.filtering.adgroup_name campaign_ids: description: '' 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: 2 x-open-source: $.http.query.filtering.campaign_ids creation_filter_end_time: description: '' format: datetime type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 8 x-open-source: $.http.query.filtering.creation_filter_end_time creation_filter_start_time: description: '' format: datetime type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 x-open-source: $.http.query.filtering.creation_filter_start_time objective_type: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1799789194562626 enum_package_name: CampaignObjectiveType enums: - description: '' is_valid: false key: APP_INSTALL value: '2' - description: '' is_valid: true key: APP_PROMOTION value: '16' - description: '' is_valid: false key: BRAND_AD value: '50' - description: '' is_valid: false key: CATALOG_SALES value: '6' - description: '' is_valid: false key: CONVERSIONS value: '3' - description: '' is_valid: false 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: false key: PRODUCT_SALES value: '15' - description: '' is_valid: false 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: false 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: SHOP value: '14' - description: '' is_valid: false key: SS_HTC_AD value: '52' - description: '' is_valid: false key: TOPVIEW_REACH value: '50' - description: '' is_valid: false key: TRAFFIC value: '1' - description: '' is_valid: false key: VIDEO_VIEWS value: '4' - description: '' is_valid: true key: WEB_CONVERSIONS value: '1003' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 3 x-open-source: $.http.query.filtering.objective_type optimization_goal: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804192692022273 enum_package_name: OptimizeGoalFilter enums: - description: '' is_valid: true key: ANCHOR_CLICK_PURCHASE value: '17' - description: '' is_valid: true key: CLICK value: '2' - description: '' is_valid: true key: CONVERSATION value: '28' - description: '' is_valid: true key: CONVERSION_LEADS value: '25' - description: '' is_valid: true key: CONVERT value: '1' - description: '' is_valid: true key: DESTINATION_VISIT value: '27' - description: '' is_valid: true key: ENGAGED_VIEW value: '18' - description: '' is_valid: true key: ENGAGED_VIEW_FIFTEEN value: '20' - description: '' is_valid: true key: FOLLOWERS value: '9' - description: '' is_valid: true key: GMV value: '22' - description: '' is_valid: true key: INITIATE_CHECKOUTS value: '24' - description: '' is_valid: true key: INSTALL value: '6' - description: '' is_valid: true key: IN_APP_EVENT value: '7' - description: '' is_valid: true key: LEAD_GENERATION value: '8' - description: '' is_valid: true key: MESSAGE value: '19' - description: '' is_valid: true key: MT_LIVE_ROOM value: '13' - description: '' is_valid: true key: MT_LIVE_SHOPPING value: '16' - description: '' is_valid: true key: PAGE_VISIT value: '26' - description: '' is_valid: true key: POST_ENGAGEMENT value: '11' - description: '' is_valid: true key: PRODUCT_CLICK_IN_LIVE value: '14' - description: '' is_valid: true key: PROFILE_VIEWS value: '10' - description: '' is_valid: true key: PURCHASES value: '23' - description: '' is_valid: true key: REACH value: '4' - description: '' is_valid: true key: SHOW value: '3' - description: '' is_valid: true key: TRAFFIC_LANDING_PAGE_VIEW value: '15' - description: '' is_valid: true key: VALUE value: '12' - description: '' is_valid: true key: VIDEO_VIEW value: '5' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 10 x-open-source: $.http.query.filtering.optimization_goal primary_status: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1827747639725058 enum_package_name: AdgPrimaryStatus enums: - description: '' is_valid: true key: STATUS_ALL value: None - description: '' is_valid: true key: STATUS_DELETE value: delete - description: '' is_valid: true key: STATUS_DELIVERY_OK value: delivery_ok - description: '' is_valid: true key: STATUS_DISABLE value: disable - description: '' is_valid: true key: STATUS_FROZEN value: frozen - description: '' is_valid: true key: STATUS_NOT_DELETE value: no_delete - description: '' is_valid: true key: STATUS_NOT_DELIVERY value: not_delivery - description: '' is_valid: true key: STATUS_RF_CLOSED value: rf_closed - description: '' is_valid: true key: STATUS_TIME_DONE value: time_done key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 5 x-open-source: $.http.query.filtering.primary_status promotion_type: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1827830268475394 enum_package_name: PromotionTypeFilter enums: - description: '' is_valid: true key: APP value: '1' - description: '' is_valid: true key: INSTANT_FORM value: '5' - description: '' is_valid: true key: LEAD_GEN_CLICK_TO_CALL value: '8' - description: '' is_valid: true key: LEAD_GEN_CLICK_TO_SOCIAL_MEDIA_APP_MESSAGE value: '7' - description: '' is_valid: true key: LEAD_GEN_CLICK_TO_TT_DIRECT_MESSAGE value: '6' - description: '' is_valid: false key: LIVE value: '4' - description: '' is_valid: true key: OTHERS value: '11' - description: '' is_valid: false key: SHORT_VIDEO value: '3' - description: '' is_valid: true key: WEBSITE value: '2' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 9 x-open-source: $.http.query.filtering.promotion_type secondary_status: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1836707190790321 enum_package_name: AdgroupSecondaryStatus enums: - description: '' is_valid: false key: ADGROUP_STATUS_ADGROUP_PRE_ONLINE value: ad_pre_online - description: '' is_valid: false key: ADGROUP_STATUS_ADGROUP_QUOTA_LIMIT value: ad_quota_limit - description: '' is_valid: true key: ADGROUP_STATUS_ADVERTISER_AUDIT value: advertiser_audit - description: '' is_valid: true key: ADGROUP_STATUS_ADVERTISER_AUDIT_DENY value: advertiser_offline_audit - description: '' is_valid: true key: ADGROUP_STATUS_ALL value: None - description: '' is_valid: false key: ADGROUP_STATUS_ASSET_AUTHORIZATION_LOST value: ad_asset_authorization_lost - description: '' is_valid: true key: ADGROUP_STATUS_AUDIT value: ad_audit - description: '' is_valid: true key: ADGROUP_STATUS_AUDIT_DENY value: ad_offline_audit - description: '' is_valid: true key: ADGROUP_STATUS_BALANCE_EXCEED value: ad_offline_balance - description: '' is_valid: true key: ADGROUP_STATUS_BUDGET_EXCEED value: ad_offline_budget - description: '' is_valid: true key: ADGROUP_STATUS_CAMPAIGN_DELETE value: campaign_delete - description: '' is_valid: true key: ADGROUP_STATUS_CAMPAIGN_DISABLE value: campaign_disable - description: '' is_valid: true key: ADGROUP_STATUS_CAMPAIGN_EXCEED value: campaign_offline_budget - description: '' is_valid: false key: ADGROUP_STATUS_CLOSED value: rf_closed_others - description: '' is_valid: true key: ADGROUP_STATUS_CREATE value: ad_create - description: '' is_valid: true key: ADGROUP_STATUS_DELETE value: ad_delete - description: '' is_valid: true key: ADGROUP_STATUS_DELIVERY_OK value: ad_delivery_ok - description: '' is_valid: true key: ADGROUP_STATUS_DISABLE value: ad_disable - description: '' is_valid: true key: ADGROUP_STATUS_FROZEN value: ad_frozen - description: '' is_valid: true key: ADGROUP_STATUS_IDENTITY_USED_BY_GMV_MAX_AD value: roi2_mutex_enable - description: '' is_valid: true key: ADGROUP_STATUS_INDUSTRY_QUALIFICATION_DENY value: ad_industry_qualification_rejected - description: '' is_valid: true key: ADGROUP_STATUS_INDUSTRY_QUALIFICATION_EXPIRED value: ad_industry_qualification_expired - description: '' is_valid: true key: ADGROUP_STATUS_INDUSTRY_QUALIFICATION_MISSING value: ad_industry_qualification_missing - description: '' is_valid: true key: ADGROUP_STATUS_LIVE_NOT_START value: ad_live_not_start - description: '' is_valid: false key: ADGROUP_STATUS_LIVE_OFFLINE value: live_offline - description: '' is_valid: true key: ADGROUP_STATUS_NOT_DELETE value: no_delete - description: '' is_valid: true key: ADGROUP_STATUS_NOT_START value: ad_time_no_reach - description: '' is_valid: true key: ADGROUP_STATUS_PARTIAL_AUDIT_DELIVERY_OK value: ad_partial_audit_and_delivery_ok - description: '' is_valid: true key: ADGROUP_STATUS_PARTIAL_AUDIT_NO_DELIVERY value: ad_partial_audit_but_no_delivery - description: '' is_valid: true key: ADGROUP_STATUS_PIXEL_UNBIND value: ad_pixel_unbind - description: '' is_valid: true key: ADGROUP_STATUS_PROMOTE_AD_NOT_APPROVED value: promote_creative_not_approved - description: '' is_valid: true key: ADGROUP_STATUS_PROMOTE_WITHDRAW_ORDER value: promote_withdraw_order - description: '' is_valid: true key: ADGROUP_STATUS_REAUDIT value: ad_reaudit - description: '' is_valid: false key: ADGROUP_STATUS_REVIEW_PARTIALLY_APPROVED value: ads_review_partially_approved - description: '' is_valid: true key: ADGROUP_STATUS_RF_ADGROUP_INVALID value: rf_no_ad_group - description: '' is_valid: true key: ADGROUP_STATUS_RF_AD_AUDIT_DENY value: rf_creative_not_approved - description: '' is_valid: true key: ADGROUP_STATUS_RF_BOOKING value: rf_booking - description: '' is_valid: true key: ADGROUP_STATUS_RF_CLOSED_OTHERS value: rf_closed_others - description: '' is_valid: true key: ADGROUP_STATUS_RF_DEDUCTION_FAILED value: rf_deduction_failed - description: '' is_valid: true key: ADGROUP_STATUS_RF_NO_DELIVERY_CREATIVE value: rf_no_delivery_creative - description: '' is_valid: true key: ADGROUP_STATUS_RF_NO_VALID_CREATIVE value: rf_no_valid_creative - description: '' is_valid: true key: ADGROUP_STATUS_RF_SCHEDULE value: rf_schedule - description: '' is_valid: true key: ADGROUP_STATUS_RF_SHORT_BALANCE value: rf_short_balance - description: '' is_valid: true key: ADGROUP_STATUS_RF_TERMINATE value: rf_terminate - description: '' is_valid: true key: ADGROUP_STATUS_RF_TIME_DONE value: ad_rf_completed - description: '' is_valid: true key: ADGROUP_STATUS_RF_WITHDRAW_ORDER value: rf_withdraw_order - description: '' is_valid: true key: ADGROUP_STATUS_SEARCH_KEYWORDS_IN_REVIEW value: keyword_in_review - description: '' is_valid: true key: ADGROUP_STATUS_SEARCH_KEYWORDS_NOT_AVAILABLE value: keyword_not_available - description: '' is_valid: true key: ADGROUP_STATUS_SEARCH_KEYWORDS_PARTIAL_APPROVED value: keyword_partial_approved - description: '' is_valid: true key: ADGROUP_STATUS_SHADOW_ADGROUP_REAUDIT value: shadow_ad_reaudit - description: '' is_valid: true key: ADGROUP_STATUS_TIME_DONE value: ad_time_done - description: '' is_valid: false key: ADGROUP_STATUS_TRANSCODING_FAIL value: ad_transcoding_fail - description: '' is_valid: true key: ADVERTISER_ACCOUNT_INVALID value: rf_account_invalid - description: '' is_valid: true key: ADVERTISER_ACCOUNT_PUNISH value: advertiser_punish - description: '' is_valid: true key: ADVERTISER_CONTRACT_PENDING value: advertiser_contract_pending - description: '' is_valid: true key: STATUS_DELETE value: delete - description: '' is_valid: true key: STATUS_DELIVERY_OK value: delivery_ok - description: '' is_valid: true key: STATUS_DISABLE value: disable - description: '' is_valid: true key: STATUS_FROZEN value: frozen - description: '' is_valid: true key: STATUS_NOT_DELIVERY value: not_delivery - description: '' is_valid: true key: STATUS_RF_CLOSED value: rf_closed - description: '' is_valid: true key: STATUS_TIME_DONE value: time_done key_format: string strict: true use_part: true validate_only: false value_format: string x-open-field-id: 4 x-open-source: $.http.query.filtering.secondary_status type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.filtering description: '' in: query name: filtering required: false x-open-field-id: 2 - description: '' in: query name: page required: false schema: default: 1 format: int64 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page x-open-field-id: 3 - description: '' in: query name: page_size required: false schema: default: 10 format: int64 maximum: 1000 minimum: 1 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page_size x-open-field-id: 4 - 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.fields description: '' in: query name: fields required: false 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: Retrieve ad group details [Smart Plus AdGroup Get] tags: - Adgroup 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: - children: - type: number is_expand: false name: adgroup_ids required: false source: $.http.query.filtering.adgroup_ids sub_type: number type: array - children: - type: number is_expand: false name: campaign_ids required: false source: $.http.query.filtering.campaign_ids sub_type: number type: array - name: objective_type required: false source: $.http.query.filtering.objective_type type: number - name: secondary_status required: false source: $.http.query.filtering.secondary_status type: string - name: primary_status required: false source: $.http.query.filtering.primary_status type: string - name: adgroup_name required: false source: $.http.query.filtering.adgroup_name type: string - name: creation_filter_start_time required: false source: $.http.query.filtering.creation_filter_start_time type: string - name: creation_filter_end_time required: false source: $.http.query.filtering.creation_filter_end_time type: string - name: promotion_type required: false source: $.http.query.filtering.promotion_type type: number - name: optimization_goal required: false source: $.http.query.filtering.optimization_goal type: number is_expand: false name: filtering required: false source: $.http.query.filtering type: object - name: page required: true source: $.http.query.page type: number - name: page_size required: true source: $.http.query.page_size type: number - children: - type: string is_expand: true name: fields required: false source: $.http.query.fields sub_type: string type: array plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id fields: $.http.query.fields filtering: $.http.query.filtering page: $.http.query.page page_size: $.http.query.page_size response_cookie: [] response_header: [] response_rule: list[][]: - adgroup_id: $.rpc.output.adgroup_list[].adgroup_id adgroup_name: $.rpc.output.adgroup_list[].name advertiser_id: $.rpc.output.adgroup_list[].advertiser_id app_id: $.rpc.output.adgroup_list[].ad_ref_app_id attribution_event_count: $.rpc.output.adgroup_list[].attribution_statistic_type bid_price: $.rpc.output.adgroup_list[].bid bid_type: $.rpc.output.adgroup_list[].smart_bid_type billing_event: $.rpc.output.adgroup_list[].pricing budget: $.rpc.output.adgroup_list[].budget budget_mode: $.rpc.output.adgroup_list[].budget_mode campaign_id: $.rpc.output.adgroup_list[].campaign_id campaign_name: $.rpc.output.adgroup_list[].campaign_name catalog_authorized_bc_id: $.rpc.output.adgroup_list[].catalog_authorized_bc catalog_id: $.rpc.output.adgroup_list[].product_platform_id click_attribution_window: $.rpc.output.adgroup_list[].attribution_window_click comment_disabled: $.rpc.output.adgroup_list[].is_comment_disable conversion_bid_price: $.rpc.output.adgroup_list[].cpa_bid create_time: $.rpc.output.adgroup_list[].display_create_time custom_conversion_id: $.rpc.output.adgroup_list[].custom_conversion_id dayparting: $.rpc.output.adgroup_list[].dayparting deep_bid_type: $.rpc.output.adgroup_list[].deep_bid_type deep_cpabid: $.rpc.output.adgroup_list[].deep_cpabid deep_funnel_event_source: $.rpc.output.adgroup_list[].deep_funnel_event_source deep_funnel_event_source_id: $.rpc.output.adgroup_list[].deep_funnel_event_source_id deep_funnel_optimization_event: $.rpc.output.adgroup_list[].deep_funnel_optimization_event deep_funnel_toggle: $.rpc.output.adgroup_list[].deep_funnel_toggle engaged_view_attribution_window: $.rpc.output.adgroup_list[].attribution_window_engaged_view identity_authorized_bc_id: $.rpc.output.adgroup_list[].identity_bc_id identity_id: $.rpc.output.adgroup_list[].identity_id identity_type: $.rpc.output.adgroup_list[].identity_type incentive_offer_type: $.rpc.output.adgroup_list[].compensation_activity message_event_set_id: $.rpc.output.adgroup_list[].ad_ref_message_event_set_id messaging_app_account_id: $.rpc.output.adgroup_list[].ima_account_id messaging_app_type: $.rpc.output.adgroup_list[].ima_type min_budget: $.rpc.output.adgroup_list[].min_budget modify_time: $.rpc.output.adgroup_list[].display_modify_time movie_premiere_date: $.rpc.output.adgroup_list[].movie_premiere_date operation_status: $.rpc.output.adgroup_list[].operation_status optimization_event: $.rpc.output.adgroup_list[].external_action optimization_goal: $.rpc.output.adgroup_list[].optimize_goal pacing: $.rpc.output.adgroup_list[].flow_control_mode phone_info[]: - phone_number: $.rpc.output.adgroup_list[].phone_number phone_region_calling_code: $.rpc.output.adgroup_list[].phone_zip_code phone_region_code: $.rpc.output.adgroup_list[].phone_country_code pixel_id: $.rpc.output.adgroup_list[].ad_ref_pixel_id placement_type: $.rpc.output.adgroup_list[].inventory_flow_type placements: $.rpc.output.adgroup_list[].inventory_flow product_set_id: $.rpc.output.adgroup_list[].product_set_id product_source: $.rpc.output.adgroup_list[].product_source promotion_target_type: $.rpc.output.adgroup_list[].promotion_target_type promotion_type: $.rpc.output.adgroup_list[].external_type promotion_website_type: $.rpc.output.adgroup_list[].promotion_website_type roas_bid: $.rpc.output.adgroup_list[].roas_bid schedule_end_time: $.rpc.output.adgroup_list[].end_time_stamp schedule_start_time: $.rpc.output.adgroup_list[].start_time_stamp schedule_type: $.rpc.output.adgroup_list[].schedule_type scheduled_budget: $.rpc.output.adgroup_list[].scheduled_budget search_result_enabled: $.rpc.output.adgroup_list[].search_result_enabled secondary_optimization_event: $.rpc.output.adgroup_list[].deep_external_action secondary_status: $.rpc.output.adgroup_list[].secondary_status share_disabled: $.rpc.output.adgroup_list[].is_share_disable skip_learning_phase: $.rpc.output.adgroup_list[].cpa_skip_first_phrase suggestion_audience_enabled: $.rpc.output.adgroup_list[].suggestion_audience_enabled targeting_optimization_mode: $.rpc.output.adgroup_list[].spc_targeting_switch targeting_spec[]: - actions[][]: - action_category_ids: $.rpc.output.adgroup_list[].audience.action_v2[].action_category_ids action_period: $.rpc.output.adgroup_list[].audience.action_v2[].action_period action_scene: $.rpc.output.adgroup_list[].audience.action_v2[].action_scene video_user_actions: $.rpc.output.adgroup_list[].audience.action_v2[].video_user_actions age_groups: $.rpc.output.adgroup_list[].audience.age_groups app_targeting_type: $.rpc.output.adgroup_list[].audience.dpa_local_audience audience_ids: $.rpc.output.adgroup_list[].audience.retargeting_tags blocked_pangle_app_ids: $.rpc.output.adgroup_list[].audience.exclude_app_package_id brand_safety_type: $.rpc.output.adgroup_list[].audience.brand_safety carrier_ids: $.rpc.output.adgroup_list[].audience.carriers category_exclusion_ids: $.rpc.output.adgroup_list[].audience.category_exclusion_ids contextual_tags: $.rpc.output.adgroup_list[].audience.contextual_tags device_model_ids: $.rpc.output.adgroup_list[].audience.device_models device_price_ranges: $.rpc.output.adgroup_list[].audience.launch_price excluded_audience_ids: $.rpc.output.adgroup_list[].audience.retargeting_tags_exclude excluded_pangle_audience_package_ids: $.rpc.output.adgroup_list[].audience.flow_package_exclude gender: $.rpc.output.adgroup_list[].audience.gender household_income: $.rpc.output.adgroup_list[].audience.household_income included_pangle_audience_package_ids: $.rpc.output.adgroup_list[].audience.flow_package_include interest_category_ids: $.rpc.output.adgroup_list[].audience.ad_tag_v2 interest_keyword_ids: $.rpc.output.adgroup_list[].audience.interest_keywords_i18n isp_ids: $.rpc.output.adgroup_list[].audience.internet_service_providers languages: $.rpc.output.adgroup_list[].audience.language_list location_ids: $.rpc.output.adgroup_list[].audience.particle_locations min_android_version: $.rpc.output.adgroup_list[].audience.min_android_version min_ios_version: $.rpc.output.adgroup_list[].audience.min_ios_version network_types: $.rpc.output.adgroup_list[].audience.ac operating_systems: $.rpc.output.adgroup_list[].audience.platform purchase_intention_keyword_ids: $.rpc.output.adgroup_list[].audience.in_market_tags saved_audience_id: $.rpc.output.adgroup_list[].audience.saved_audience_id smart_audience_enabled: $.rpc.output.adgroup_list[].audience.smart_audience_enabled smart_interest_behavior_enabled: $.rpc.output.adgroup_list[].audience.smart_interest_behavior_enabled spc_audience_age: $.rpc.output.adgroup_list[].audience.exclude_age_under_eighteen spending_power: $.rpc.output.adgroup_list[].audience.spending_power zipcode_ids: $.rpc.output.adgroup_list[].audience.zipcode_ids vbo_window: $.rpc.output.adgroup_list[].vbo_date_type video_download_disabled: $.rpc.output.adgroup_list[].ad_download_status view_attribution_window: $.rpc.output.adgroup_list[].attribution_window_view zalo_id_type: $.rpc.output.adgroup_list[].ima_id_type page_info: $.rpc.output.page_info x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /smart_plus/adgroup/status/update/: post: operationId: Smart_plus Adgroup Status Update 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: adgroup_ids: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) maxItems: 20 minItems: 1 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.adgroup_ids advertiser_id: description: '' 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 operation_status: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1811076987051010 enum_package_name: StatusOptType enums: - description: 清除 is_valid: true key: DELETE value: '3' - description: 暂停 is_valid: true key: DISABLE value: '2' - description: 启用 is_valid: true key: ENABLE value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 3 x-open-source: $.http.body.operation_status required: - advertiser_id - adgroup_ids - operation_status 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: Update ad group status [Smart Plus AdGroup Status Update] tags: - Adgroup 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: false name: adgroup_ids required: true source: $.http.body.adgroup_ids sub_type: number type: array - name: operation_status required: true source: $.http.body.operation_status type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: adgroup_ids: $.http.body.adgroup_ids advertiser_id: $.http.body.advertiser_id operation_status: $.http.body.operation_status response_cookie: [] response_header: [] response_rule: adgroup_list[][]: - adgroup_id: $.rpc.output.adgroup_list[].obj_id status: $.rpc.output.adgroup_list[].status error_list[][]: - adgroup_id: $.rpc.output.error_list[].obj_id error_message: $.rpc.output.error_list[].error_message x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /smart_plus/adgroup/update/: post: operationId: Smart_plus Adgroup Update 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: adgroup_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 2 x-open-source: $.http.body.adgroup_id adgroup_name: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.name advertiser_id: description: '' 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 bid_price: description: '' format: double type: number x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 10 x-open-source: $.http.body.bid budget: description: '' format: double type: number x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.body.budget comment_disabled: description: '' type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int32(%s) x-open-field-id: 4 x-open-source: $.http.body.is_comment_disable conversion_bid_price: description: '' format: double type: number x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 13 dayparting: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 9 x-open-source: $.http.body.dayparting min_budget: description: '' format: double type: number x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 11 pacing: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1810156218235905 enum_package_name: FlowControlMode enums: - description: 尽快投放 is_valid: true key: PACING_MODE_FAST value: '0' - description: 平均投放 is_valid: true key: PACING_MODE_SMOOTH value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 12 roas_bid: description: '' format: double type: number x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 14 x-open-source: $.http.body.roas_bid schedule_end_time: description: '' format: datetime type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - datetime_to_timestamp(%s,"date-time","utc") x-open-field-id: 8 x-open-source: $.http.body.end_time_stamp schedule_start_time: description: '' format: datetime type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - datetime_to_timestamp(%s,"date-time","utc") x-open-field-id: 7 x-open-source: $.http.body.start_time_stamp schedule_type: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1807532710001665 enum_package_name: ScheduleType enums: - description: '' is_valid: true key: SCHEDULE_FROM_NOW value: '1' - description: '' is_valid: true key: SCHEDULE_START_END 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.schedule_type share_disabled: description: '' type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int32(%s) x-open-field-id: 15 x-open-source: $.http.body.is_share_disable suggestion_audience_enabled: description: '' type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 16 targeting_optimization_mode: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1838600430487746 enum_package_name: SpcTargetingSwitch enums: - description: '' is_valid: true key: AUTOMATIC value: '0' - description: '' is_valid: true key: MANUAL value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 17 targeting_spec: description: '' properties: actions: description: '' items: properties: action_category_ids: description: '' 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: 4 action_period: description: '' format: int64 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 action_scene: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800966577028098 enum_package_name: ActionScene enums: - description: '' is_valid: true key: CREATOR_RELATED value: '11' - description: '' is_valid: true key: HASHTAG_RELATED value: '13' - description: '' is_valid: true key: VIDEO_RELATED value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 1 video_user_actions: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804237663605761 enum_package_name: VideoAction enums: - description: '' is_valid: true key: COMMENTED value: '2' - description: '' is_valid: true key: FOLLOWING value: '4' - description: '' is_valid: true key: LIKED value: '1' - description: '' is_valid: true key: SHARED value: '3' - description: '' is_valid: true key: VIEW_HASHTAG value: '6' - description: '' is_valid: true key: VIEW_HOMEPAGE value: '5' - description: '' is_valid: true key: WATCHED_TO_END value: '0' 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 type: object 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: 15 age_groups: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804615806530625 enum_package_name: AgeType enums: - description: '' is_valid: true key: AGE_13_17 value: '30' - description: '' is_valid: true key: AGE_18_24 value: '42' - description: '' is_valid: true key: AGE_25_34 value: '59' - description: '' is_valid: true key: AGE_35_44 value: '79' - description: '' is_valid: true key: AGE_45_54 value: '99' - description: '' is_valid: true key: AGE_55_100 value: '155' 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: 4 x-open-source: $.http.body.audience.age_groups audience_ids: description: '' 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: 7 blocked_pangle_app_ids: description: '' 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: 28 carrier_ids: description: '' 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: 23 device_model_ids: description: '' 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: 26 device_price_ranges: description: '' items: format: int64 type: integer 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: 25 excluded_audience_ids: description: '' 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: 6 x-open-source: $.http.body.audience.retargeting_tags_exclude excluded_pangle_audience_package_ids: description: '' 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: 9 gender: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804229882527745 enum_package_name: AudienceGenderType enums: - description: '' is_valid: true key: GENDER_FEMALE value: '2' - description: '' is_valid: true key: GENDER_MALE value: '1' - description: '' is_valid: true key: GENDER_UNLIMITED 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.body.audience.gender household_income: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1810164011458562 enum_package_name: HHILabel enums: - description: 默认值，代表没有hhi标签，不会使用到 is_valid: false key: Default value: '0' - description: top10% is_valid: true key: TOP10 value: '2' - description: top10%~top25% is_valid: true key: TOP10_25 value: '3' - description: top25%~top50% is_valid: true key: TOP25_50 value: '4' - description: top5% is_valid: true key: TOP5 value: '1' 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-field-id: 19 included_pangle_audience_package_ids: description: '' 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: 8 interest_category_ids: description: '' 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: 12 interest_keyword_ids: description: '' 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: 13 isp_ids: description: '' 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: 24 languages: description: '' 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: 1 x-open-source: $.http.body.audience.language_list location_ids: description: '' 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: 10 x-open-source: $.http.body.audience.particle_locations min_android_version: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 20 min_ios_version: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 21 network_types: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1810160639116290 enum_package_name: AccessType enums: - description: '' is_valid: true key: 2G value: '2' - description: '' is_valid: true key: 3G value: '3' - description: '' is_valid: true key: 4G value: '4' - description: '' is_valid: true key: 5G value: '5' - description: '' is_valid: true key: WIFI 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-field-id: 22 operating_systems: description: '' items: 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 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 purchase_intention_keyword_ids: description: '' 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: 14 saved_audience_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 27 smart_audience_enabled: description: '' type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 17 smart_interest_behavior_enabled: description: '' type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 16 spc_audience_age: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1836070828374017 enum_package_name: ExcludeAgeUnder18Type enums: - description: '' is_valid: true key: OVER_EIGHTEEN value: '1' - description: '' is_valid: true key: OVER_TWENTY_FIVE value: '2' - description: '' is_valid: false key: UNSET value: '0' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 5 x-open-source: $.http.body.audience.exclude_age_under_eighteen spending_power: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1810164182046722 enum_package_name: SpendingPowerType enums: - description: '' is_valid: true key: ALL value: ALL - description: '' is_valid: true key: HIGH value: HIGH key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 18 zipcode_ids: description: '' 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: 11 x-open-source: $.http.body.audience.zipcode_ids type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 18 x-open-source: $.http.body.audience required: - advertiser_id - adgroup_id 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: Update an ad group [Smart Plus AdGroup Update] tags: - Adgroup 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: adgroup_id required: true source: $.http.body.adgroup_id type: number - name: name required: false source: $.http.body.adgroup_name type: string - name: is_comment_disable required: false source: $.http.body.comment_disabled type: number - name: budget required: false source: $.http.body.budget type: number - name: schedule_type required: false source: $.http.body.schedule_type type: number - name: start_time_stamp required: false source: $.http.body.schedule_start_time type: number - name: end_time_stamp required: false source: $.http.body.schedule_end_time type: number - name: dayparting required: false source: $.http.body.dayparting type: string - name: bid required: false source: $.http.body.bid_price type: number - name: roas_bid required: false source: $.http.body.roas_bid type: number - children: - children: - type: string is_expand: false name: language_list required: false source: $.http.body.targeting_spec.languages[] sub_type: string type: array - name: gender required: false source: $.http.body.targeting_spec.gender type: number - children: - type: number is_expand: false name: age_groups required: false source: $.http.body.targeting_spec.age_groups[] sub_type: number type: array - name: exclude_age_under_eighteen required: false source: $.http.body.targeting_spec.spc_audience_age type: number - children: - type: number is_expand: false name: retargeting_tags_exclude required: false source: $.http.body.targeting_spec.excluded_audience_ids[] sub_type: number type: array - children: - type: number is_expand: false name: particle_locations required: false source: $.http.body.targeting_spec.location_ids[] sub_type: number type: array - children: - type: number is_expand: false name: zipcode_ids required: false source: $.http.body.targeting_spec.zipcode_ids[] sub_type: number type: array - is_expand: false name: smart_interest_behavior_enabled required: false source: $.http.body.targeting_spec.smart_interest_behavior_enabled type: boolean - is_expand: false name: smart_audience_enabled required: false source: $.http.body.targeting_spec.smart_audience_enabled type: boolean - children: - is_expand: false source: undefined type: number is_expand: false name: retargeting_tags required: false source: $.http.body.targeting_spec.audience_ids[] sub_type: number type: array - children: - is_expand: false source: undefined type: string is_expand: false name: internet_service_providers required: false source: $.http.body.targeting_spec.isp_ids[] sub_type: string type: array - is_expand: false name: saved_audience_id required: false source: $.http.body.targeting_spec.saved_audience_id type: number - children: - is_expand: false source: undefined type: number is_expand: false name: household_income required: false source: $.http.body.targeting_spec.household_income[] sub_type: number type: array - is_expand: false name: spending_power required: false source: $.http.body.targeting_spec.spending_power type: string - children: - is_expand: false source: undefined type: number is_expand: false name: in_market_tags required: false source: $.http.body.targeting_spec.purchase_intention_keyword_ids[] sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: false name: interest_keywords_i18n required: false source: $.http.body.targeting_spec.interest_keyword_ids sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: false name: ad_tag_v2 required: false source: $.http.body.targeting_spec.interest_category_ids[] sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: false name: carriers required: false source: $.http.body.targeting_spec.carrier_ids[] sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: false name: device_models required: false source: $.http.body.targeting_spec.device_model_ids[] sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: false name: flow_package_include required: false source: $.http.body.targeting_spec.included_pangle_audience_package_ids[] sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: false name: flow_package_exclude required: false source: $.http.body.targeting_spec.excluded_pangle_audience_package_ids[] sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: false name: exclude_app_package_id required: false source: $.http.body.targeting_spec.blocked_pangle_app_ids[] sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: false name: platform required: false source: $.http.body.targeting_spec.operating_systems[] sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: false name: ac required: false source: $.http.body.targeting_spec.network_types[] sub_type: number type: array - is_expand: false name: min_android_version required: false source: $.http.body.targeting_spec.min_android_version type: string - is_expand: false name: min_ios_version required: false source: $.http.body.targeting_spec.min_ios_version type: string - children: - children: - is_expand: false name: action_scene required: false source: $.http.body.targeting_spec.actions[].action_scene type: number - is_expand: false name: action_period required: false source: $.http.body.targeting_spec.actions[].action_period type: number - children: - is_expand: false source: undefined type: number is_expand: false name: video_user_actions required: false source: $.http.body.targeting_spec.actions[].video_user_actions sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: false name: action_category_ids required: false source: $.http.body.targeting_spec.actions[].action_category_ids sub_type: number type: array is_expand: true source: undefined type: object is_expand: false name: action_v2 required: false source: $.http.body.targeting_spec.actions[] sub_type: object type: array - children: - is_expand: false source: undefined type: number is_expand: false name: launch_price required: false source: $.http.body.targeting_spec.device_price_ranges[] sub_type: number type: array is_expand: true name: audience required: false type: object - name: is_share_disable required: false source: $.http.body.share_disabled type: number - name: cpa_bid required: false source: $.http.body.conversion_bid_price type: number - name: suggestion_audience_enabled required: false source: $.http.body.suggestion_audience_enabled type: boolean - name: flow_control_mode required: false source: $.http.body.pacing type: number - name: spc_targeting_switch required: false source: $.http.body.targeting_optimization_mode type: number - name: min_budget required: false source: $.http.body.min_budget type: number - name: movie_premiere_date required: false source: $.http.body.movie_premiere_date type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: adgroup_id: $.http.body.adgroup_id advertiser_id: $.http.body.advertiser_id audience: ac: $.http.body.targeting_spec.network_types[] action_v2: $.http.body.targeting_spec.actions[] ad_tag_v2: $.http.body.targeting_spec.interest_category_ids[] age_groups: $.http.body.targeting_spec.age_groups[] carriers: $.http.body.targeting_spec.carrier_ids[] device_models: $.http.body.targeting_spec.device_model_ids[] exclude_age_under_eighteen: $.http.body.targeting_spec.spc_audience_age exclude_app_package_id: $.http.body.targeting_spec.blocked_pangle_app_ids[] flow_package_exclude: $.http.body.targeting_spec.excluded_pangle_audience_package_ids[] flow_package_include: $.http.body.targeting_spec.included_pangle_audience_package_ids[] gender: $.http.body.targeting_spec.gender household_income: $.http.body.targeting_spec.household_income[] in_market_tags: $.http.body.targeting_spec.purchase_intention_keyword_ids[] interest_keywords_i18n: $.http.body.targeting_spec.interest_keyword_ids internet_service_providers: $.http.body.targeting_spec.isp_ids[] language_list: $.http.body.targeting_spec.languages[] launch_price: $.http.body.targeting_spec.device_price_ranges[] min_android_version: $.http.body.targeting_spec.min_android_version min_ios_version: $.http.body.targeting_spec.min_ios_version particle_locations: $.http.body.targeting_spec.location_ids[] platform: $.http.body.targeting_spec.operating_systems[] retargeting_tags: $.http.body.targeting_spec.audience_ids[] retargeting_tags_exclude: $.http.body.targeting_spec.excluded_audience_ids[] saved_audience_id: $.http.body.targeting_spec.saved_audience_id smart_audience_enabled: $.http.body.targeting_spec.smart_audience_enabled smart_interest_behavior_enabled: $.http.body.targeting_spec.smart_interest_behavior_enabled spending_power: $.http.body.targeting_spec.spending_power zipcode_ids: $.http.body.targeting_spec.zipcode_ids[] bid: $.http.body.bid_price budget: $.http.body.budget cpa_bid: $.http.body.conversion_bid_price dayparting: $.http.body.dayparting end_time_stamp: $.http.body.schedule_end_time flow_control_mode: $.http.body.pacing is_comment_disable: $.http.body.comment_disabled is_share_disable: $.http.body.share_disabled min_budget: $.http.body.min_budget movie_premiere_date: $.http.body.movie_premiere_date name: $.http.body.adgroup_name roas_bid: $.http.body.roas_bid schedule_type: $.http.body.schedule_type spc_targeting_switch: $.http.body.targeting_optimization_mode start_time_stamp: $.http.body.schedule_start_time suggestion_audience_enabled: $.http.body.suggestion_audience_enabled response_cookie: [] response_header: [] response_rule: adgroup_id: $.rpc.output.adgroup_data.adgroup_id adgroup_name: $.rpc.output.adgroup_data.name advertiser_id: $.rpc.output.adgroup_data.advertiser_id app_id: $.rpc.output.adgroup_data.ad_ref_app_id attribution_event_count: $.rpc.output.adgroup_data.attribution_statistic_type bid_price: $.rpc.output.adgroup_data.bid bid_type: $.rpc.output.adgroup_data.smart_bid_type billing_event: $.rpc.output.adgroup_data.pricing budget: $.rpc.output.adgroup_data.budget budget_mode: $.rpc.output.adgroup_data.budget_mode campaign_id: $.rpc.output.adgroup_data.campaign_id campaign_name: $.rpc.output.adgroup_data.campaign_name catalog_authorized_bc_id: $.rpc.output.adgroup_data.catalog_authorized_bc catalog_id: $.rpc.output.adgroup_data.product_platform_id click_attribution_window: $.rpc.output.adgroup_data.attribution_window_click comment_disabled: $.rpc.output.adgroup_data.is_comment_disable conversion_bid_price: $.rpc.output.adgroup_data.cpa_bid create_time: $.rpc.output.adgroup_data.display_create_time custom_conversion_id: $.rpc.output.adgroup_data.custom_conversion_id dayparting: $.rpc.output.adgroup_data.dayparting deep_bid_type: $.rpc.output.adgroup_data.deep_bid_type deep_cpabid: $.rpc.output.adgroup_data.deep_cpabid deep_funnel_event_source: $.rpc.output.adgroup_data.deep_funnel_event_source deep_funnel_event_source_id: $.rpc.output.adgroup_data.deep_funnel_event_source_id deep_funnel_optimization_event: $.rpc.output.adgroup_data.deep_funnel_optimization_event deep_funnel_optimization_status: $.rpc.output.adgroup_data.deep_funnel_toggle engaged_view_attribution_window: $.rpc.output.adgroup_data.attribution_window_engaged_view identity_authorized_bc_id: $.rpc.output.adgroup_data.identity_bc_id identity_id: $.rpc.output.adgroup_data.identity_id identity_type: $.rpc.output.adgroup_data.identity_type incentive_offer_type: $.rpc.output.adgroup_data.compensation_activity message_event_set_id: $.rpc.output.adgroup_data.ad_ref_message_event_set_id messaging_app_account_id: $.rpc.output.adgroup_data.ima_account_id messaging_app_type: $.rpc.output.adgroup_data.ima_type min_budget: $.rpc.output.adgroup_data.min_budget modify_time: $.rpc.output.adgroup_data.display_modify_time movie_premiere_date: $.rpc.output.adgroup_data.movie_premiere_date operation_status: $.rpc.output.adgroup_data.operation_status optimization_event: $.rpc.output.adgroup_data.external_action optimization_goal: $.rpc.output.adgroup_data.optimize_goal pacing: $.rpc.output.adgroup_data.flow_control_mode phone_info: phone_number: $.rpc.output.adgroup_data.phone_number phone_region_calling_code: $.rpc.output.adgroup_data.phone_zip_code phone_region_code: $.rpc.output.adgroup_data.phone_country_code pixel_id: $.rpc.output.adgroup_data.ad_ref_pixel_id placement_type: $.rpc.output.adgroup_data.inventory_flow_type placements: $.rpc.output.adgroup_data.inventory_flow product_set_id: $.rpc.output.adgroup_data.product_set_id product_source: $.rpc.output.adgroup_data.product_source promotion_target_type: $.rpc.output.adgroup_data.promotion_target_type promotion_type: $.rpc.output.adgroup_data.external_type promotion_website_type: $.rpc.output.adgroup_data.promotion_website_type roas_bid: $.rpc.output.adgroup_data.roas_bid schedule_end_time: $.rpc.output.adgroup_data.end_time_stamp schedule_start_time: $.rpc.output.adgroup_data.start_time_stamp schedule_type: $.rpc.output.adgroup_data.schedule_type scheduled_budget: $.rpc.output.adgroup_data.scheduled_budget search_result_enabled: $.rpc.output.adgroup_data.search_result_enabled secondary_optimization_event: $.rpc.output.adgroup_data.deep_external_action secondary_status: $.rpc.output.adgroup_data.secondary_status share_disabled: $.rpc.output.adgroup_data.is_share_disable skip_learning_phase: $.rpc.output.adgroup_data.cpa_skip_first_phrase suggestion_audience_enabled: $.rpc.output.adgroup_data.suggestion_audience_enabled targeting_optimization_mode: $.rpc.output.adgroup_data.spc_targeting_switch targeting_spec: actions[][]: - action_category_ids: $.rpc.output.adgroup_data.audience.action_v2[].action_category_ids action_period: $.rpc.output.adgroup_data.audience.action_v2[].action_period action_scene: $.rpc.output.adgroup_data.audience.action_v2[].action_scene video_user_actions: $.rpc.output.adgroup_data.audience.action_v2[].video_user_actions age_groups: $.rpc.output.adgroup_data.audience.age_groups app_targeting_type: $.rpc.output.adgroup_data.audience.dpa_local_audience audience_ids: $.rpc.output.adgroup_data.audience.retargeting_tags blocked_pangle_app_ids: $.rpc.output.adgroup_data.audience.exclude_app_package_id brand_safety_type: $.rpc.output.adgroup_data.audience.brand_safety carrier_ids: $.rpc.output.adgroup_data.audience.carriers category_exclusion_ids: $.rpc.output.adgroup_data.audience.category_exclusion_ids device_model_ids: $.rpc.output.adgroup_data.audience.device_models device_price_ranges: $.rpc.output.adgroup_data.audience.launch_price excluded_audience_ids: $.rpc.output.adgroup_data.audience.retargeting_tags_exclude excluded_pangle_audience_package_ids: $.rpc.output.adgroup_data.audience.flow_package_exclude gender: $.rpc.output.adgroup_data.audience.gender household_income: $.rpc.output.adgroup_data.audience.household_income included_pangle_audience_package_ids: $.rpc.output.adgroup_data.audience.flow_package_include interest_category_ids: $.rpc.output.adgroup_data.audience.ad_tag_v2 interest_keyword_ids: $.rpc.output.adgroup_data.audience.interest_keywords_i18n isp_ids: $.rpc.output.adgroup_data.audience.internet_service_providers languages: $.rpc.output.adgroup_data.audience.language_list location_ids: $.rpc.output.adgroup_data.audience.particle_locations min_android_version: $.rpc.output.adgroup_data.audience.min_android_version min_ios_version: $.rpc.output.adgroup_data.audience.min_ios_version network_types: $.rpc.output.adgroup_data.audience.ac operating_systems: $.rpc.output.adgroup_data.audience.platform purchase_intention_keyword_ids: $.rpc.output.adgroup_data.audience.in_market_tags saved_audience_id: $.rpc.output.adgroup_data.audience.saved_audience_id smart_audience_enabled: $.rpc.output.adgroup_data.audience.smart_audience_enabled smart_interest_behavior_enabled: $.rpc.output.adgroup_data.audience.smart_interest_behavior_enabled spc_audience_age: $.rpc.output.adgroup_data.audience.exclude_age_under_eighteen spending_power: $.rpc.output.adgroup_data.audience.spending_power zipcode_ids: $.rpc.output.adgroup_data.audience.zipcode_ids vbo_window: $.rpc.output.adgroup_data.vbo_date_type video_download_disabled: $.rpc.output.adgroup_data.ad_download_status view_attribution_window: $.rpc.output.adgroup_data.attribution_window_view zalo_id_type: $.rpc.output.adgroup_data.ima_id_type x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true 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