openapi: 3.2.0 info: title: TikTok API for Business — Marketing Campaign Creation 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: Campaign Creation paths: /campaign/gmv_max/create/: post: operationId: Campaign Gmv_max 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: 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.gmv_max_data.advertiser_id affiliate_posts_enabled: description: '' type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int32(%s) x-open-field-id: 19 auto_budget_enabled: description: '' type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 22 budget: description: '' format: double type: number x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 12 x-open-source: $.http.body.gmv_max_data.budget campaign_name: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.gmv_max_data.campaign_name custom_anchor_video_list: description: '' items: properties: identity_info: description: '' properties: 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: 3 identity_authorized_shop_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 5 identity_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 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: true 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: true 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: 2 store_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 4 required: - identity_id - identity_type type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 item_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 spu_id_list: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 1 minItems: 1 type: array 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 maxItems: 2000 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 20 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: false key: AEO value: '101' - description: 标准出价 is_valid: false key: DEFAULT value: '0' - description: 自定义出价 is_valid: false key: MIN value: '1' - description: 动态出价 is_valid: false key: PACING value: '2' - description: 非中VO highest value is_valid: false key: VO_HIGHEST_VALUE value: '109' - description: ROI自动出价，非中含义为VO target CPA is_valid: false key: VO_MIN value: '7' - description: 非中VO minRoas is_valid: true key: VO_MIN_ROAS value: '108' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 10 x-open-source: $.http.body.gmv_max_data.deep_bid_type identity_list: description: '' items: properties: 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: 3 x-open-source: $.http.body.gmv_max_data.identity_list[].identity_authorized_bc_id identity_authorized_shop_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 5 x-open-source: $.http.body.gmv_max_data.identity_list[].identity_authorized_shop_id identity_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.gmv_max_data.identity_list[].identity_id 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: true 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: true 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: 2 x-open-source: $.http.body.gmv_max_data.identity_list[].identity_type store_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 4 x-open-source: $.http.body.gmv_max_data.identity_list[].store_id required: - identity_id - identity_type 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: 6 x-open-source: $.http.body.gmv_max_data.identity_list item_group_ids: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 50 minItems: 1 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 9 x-open-source: $.http.body.gmv_max_data.spu_list item_list: description: '' items: properties: identity_info: description: '' properties: 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: 3 x-open-source: $.http.body.gmv_max_data.shop_item_list[].identity_info.identity_authorized_bc_id identity_authorized_shop_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 5 identity_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.gmv_max_data.shop_item_list[].identity_info.identity_id 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: true 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: true 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: 2 x-open-source: $.http.body.gmv_max_data.shop_item_list[].identity_info.identity_type store_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 4 x-open-source: $.http.body.gmv_max_data.shop_item_list[].identity_info.store_id required: - identity_id - identity_type type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.gmv_max_data.shop_item_list[].identity_info item_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.gmv_max_data.shop_item_list[].item_id spu_id_list: 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: 3 x-open-source: $.http.body.gmv_max_data.shop_item_list[].spu_id_list video_info: description: '' properties: video_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.gmv_max_data.shop_item_list[].video_info.video_id required: - video_id type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.gmv_max_data.shop_item_list[].video_info 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: 17 x-open-source: $.http.body.gmv_max_data.shop_item_list 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: false key: ANCHOR_CLICK value: '112' - description: '' is_valid: false key: ANCHOR_CLICK_PURCHASE value: '117' - description: '' is_valid: false key: AUTOMATED_VALUE value: '125' - description: '' is_valid: false key: CLICK value: '101' - description: '' is_valid: false key: CONVERSATION value: '124' - description: '' is_valid: false key: CONVERSION_LEADS value: '121' - description: '' is_valid: false key: CONVERT value: '100' - description: '' is_valid: false key: DESTINATION_VISIT value: '123' - description: '' is_valid: false key: ENGAGED_VIEW value: '118' - description: '' is_valid: false key: ENGAGED_VIEW_FIFTEEM value: '120' - description: '' is_valid: false key: FOLLOWERS value: '108' - description: '' is_valid: false key: INSTALL value: '105' - description: '' is_valid: false key: IN_APP_EVENT value: '106' - description: '' is_valid: false key: LEAD_GENERATION value: '107' - description: '' is_valid: false key: MESSAGE value: '119' - description: '' is_valid: false key: MT_LIVE_FOLLOW value: '126' - description: '' is_valid: false key: MT_LIVE_ROOM value: '113' - description: '' is_valid: false key: MT_LIVE_SHOPPING value: '116' - description: '' is_valid: false key: PAGE_VISIT value: '122' - description: '' is_valid: false key: POST_ENGAGEMNT value: '110' - description: '' is_valid: false key: PREFERRED_LEAD value: '127' - description: '' is_valid: false key: PRODUCT_CLICK_IN_LIVE value: '114' - description: '' is_valid: false key: PROFILE_VIEWS value: '109' - description: '' is_valid: false key: REACH value: '103' - description: '' is_valid: false key: SHOW value: '102' - description: '' is_valid: false key: TRAFFIC_LANDING_PAGE_VIEW value: '115' - description: '' is_valid: true key: VALUE value: '111' - description: '' is_valid: false key: VIDEO_VIEW value: '104' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 7 x-open-source: $.http.body.gmv_max_data.optimize_goal product_specific_type: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1807533365234690 enum_package_name: ProductSpecificType enums: - description: '' is_valid: true key: ALL value: '1' - description: '' is_valid: true key: CUSTOMIZED_PRODUCTS value: '3' - description: '' is_valid: false key: PRODUCT_SET 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: 8 x-open-source: $.http.body.gmv_max_data.product_specific_type product_video_specific_type: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1817317969806337 enum_package_name: ProductVideoSelectionType enums: - description: video auto selected by automation is_valid: true key: AUTO_SELECTION value: '1' - description: video mannual selected in seller center is_valid: true key: CUSTOM_SELECTION 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: 16 x-open-source: $.http.body.gmv_max_data.product_video_selection_type promotion_days: description: '' properties: auto_schedule_enabled: default: true description: '' type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 custom_schedule_list: description: '' items: properties: end_date: description: '' format: date type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - 'convert_time_format(%s, "yyyy-MM-dd", "yyyy-MM-dd 00:00:00", "local") ' x-open-field-id: 2 schedule_type: default: STARTEND description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: null enum_package_name: null enums: - description: '' is_valid: true key: FROMTIME value: '1' - description: '' is_valid: true key: STARTEND value: '2' - description: '' is_valid: true key: DAYS value: '3' - description: '' is_valid: true key: WEEKLY value: '4' - description: '' is_valid: true key: STARTDURATION value: '5' - description: '' is_valid: true key: FROMTIME_DAILY_DURATION value: '6' - description: '' is_valid: true key: STARTEND_DAILY_DURATION value: '7' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 3 start_date: description: '' format: date type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - 'convert_time_format(%s, "yyyy-MM-dd", "yyyy-MM-dd 00:00:00", "local") ' x-open-field-id: 1 required: - start_date - end_date 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: 3 is_enabled: default: true description: '' type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 roas_bid_multiplier: default: 90 description: '' format: int32 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 21 request_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 18 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: 11 x-open-source: $.http.body.gmv_max_data.roas_bid schedule_end_time: description: '' 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: 15 x-open-source: $.http.body.gmv_max_data.end_time_stamp schedule_start_time: description: '' 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: 14 x-open-source: $.http.body.gmv_max_data.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: 13 x-open-source: $.http.body.gmv_max_data.schedule_type shopping_ads_type: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1810159239577601 enum_package_name: PromotionFlowType enums: - description: '' is_valid: false key: CATALOG_LISTING_ADS value: '3' - description: '' is_valid: true key: LIVE value: '2' - description: 推商品广告（VIDEO + PSA） is_valid: true key: PRODUCT value: '5' - description: '' is_valid: false key: PRODUCT_SHOPPING_ADS value: '4' - description: '' is_valid: false key: UNSET value: '0' - description: '' is_valid: false key: VIDEO value: '1' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 5 x-open-source: $.http.body.gmv_max_data.promotion_flow_type store_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: 4 x-open-source: $.http.body.gmv_max_data.store_authorized_bc_id store_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.gmv_max_data.store_id required: - advertiser_id - campaign_name - store_id - store_authorized_bc_id - shopping_ads_type - optimization_goal - deep_bid_type - schedule_type - schedule_start_time - 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 GMV Max campaign [Smart Plus GMV Max Campaign Create](https://business-api.tiktok.com/portal/docs?id=1822000988713089) tags: - Campaign Creation x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - children: - name: advertiser_id required: true source: $.http.body.advertiser_id type: number - name: campaign_name required: true source: $.http.body.campaign_name type: string - name: store_id required: true source: $.http.body.store_id type: number - name: store_authorized_bc_id required: true source: $.http.body.store_authorized_bc_id type: number - name: promotion_flow_type required: true source: $.http.body.shopping_ads_type type: number - children: - children: - name: identity_id required: true source: $.http.body.identity_list[].identity_id type: string - name: identity_type required: true source: $.http.body.identity_list[].identity_type type: number - name: identity_authorized_bc_id required: false source: $.http.body.identity_list[].identity_authorized_bc_id type: number - name: store_id required: false source: $.http.body.identity_list[].store_id type: number - name: avatar_url required: false source: $.http.body.identity_list[].avatar_url type: string - name: name required: false source: $.http.body.identity_list[].name type: string - name: identity_authorized_shop_id required: false source: $.http.body.identity_list[].identity_authorized_shop_id type: number - name: has_roi1_ads required: false source: $.http.body.identity_list[].has_roi1_ads type: boolean - name: available_for_product required: false source: $.http.body.identity_list[].available_for_product type: boolean - name: available_for_live required: false source: $.http.body.identity_list[].available_for_live type: boolean - name: unavailable_reason_for_live required: false source: $.http.body.identity_list[].unavailable_reason_for_live type: number - name: user_name required: false source: $.http.body.identity_list[].user_name type: string is_expand: true type: object is_expand: false name: identity_list required: false source: $.http.body.identity_list sub_type: object type: array - name: optimize_goal required: true source: $.http.body.optimization_goal type: number - name: product_specific_type required: false source: $.http.body.product_specific_type type: number - children: - type: string is_expand: false name: spu_list required: false source: $.http.body.item_group_ids[] sub_type: string type: array - name: deep_bid_type required: true source: $.http.body.deep_bid_type type: number - name: roas_bid required: false source: $.http.body.roas_bid type: number - name: budget required: false source: $.http.body.budget 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: product_video_selection_type required: false source: $.http.body.product_video_specific_type type: number - children: - children: - name: item_id required: false source: $.http.body.item_list[].item_id type: number - children: - name: identity_id required: true source: $.http.body.item_list[].identity_info.identity_id type: string - name: identity_type required: true source: $.http.body.item_list[].identity_info.identity_type type: number - name: identity_authorized_bc_id required: false source: $.http.body.item_list[].identity_info.identity_authorized_bc_id type: number - name: store_id required: false source: $.http.body.item_list[].identity_info.store_id type: number - name: identity_authorized_shop_id required: false source: $.http.body.item_list[].identity_info.identity_authorized_shop_id type: number is_expand: true name: identity_info required: false type: object - children: - type: string is_expand: false name: spu_id_list required: false source: $.http.body.item_list[].spu_id_list[] sub_type: string type: array - children: - name: video_id required: true source: $.http.body.item_list[].video_info.video_id type: string is_expand: false name: video_info required: false type: object is_expand: true type: object is_expand: true name: shop_item_list required: false source: $.http.body.item_list[] sub_type: object type: array - name: shop_aca_mode required: false source: $.http.body.affiliate_posts_enabled type: number - children: - children: - name: item_id required: false source: $.http.body.custom_anchor_video_list[].item_id type: number - children: - name: identity_id required: true source: $.http.body.custom_anchor_video_list[].identity_info.identity_id type: string - name: identity_type required: true source: $.http.body.custom_anchor_video_list[].identity_info.identity_type type: number - name: identity_authorized_bc_id required: false source: $.http.body.custom_anchor_video_list[].identity_info.identity_authorized_bc_id type: number - name: store_id required: false source: $.http.body.custom_anchor_video_list[].identity_info.store_id type: number - name: identity_authorized_shop_id required: false source: $.http.body.custom_anchor_video_list[].identity_info.identity_authorized_shop_id type: number is_expand: true name: identity_info required: false source: $.http.body.custom_anchor_video_list[].identity_info type: object - children: - source: undefined type: string is_expand: true name: spu_id_list required: false source: $.http.body.custom_anchor_video_list[].spu_id_list sub_type: string type: array is_expand: true source: undefined type: object is_expand: true name: custom_anchor_video_list required: false source: $.http.body.custom_anchor_video_list sub_type: object type: array - children: - is_expand: false name: is_enabled required: false source: $.http.body.promotion_days.is_enabled type: boolean - is_expand: false name: auto_schedule_enabled required: false source: $.http.body.promotion_days.auto_schedule_enabled type: boolean - children: - children: - is_expand: false name: start_date required: false source: $.http.body.promotion_days.custom_schedule_list[].start_date type: string - is_expand: false name: end_date required: false source: $.http.body.promotion_days.custom_schedule_list[].end_date type: string - is_expand: false name: schedule_type required: false source: $.http.body.promotion_days.custom_schedule_list[].schedule_type type: number is_expand: true source: undefined type: object is_expand: true name: custom_schedule_list required: false source: $.http.body.promotion_days.custom_schedule_list sub_type: object type: array - is_expand: false name: roas_bid_multiplier required: false source: $.http.body.promotion_days.roas_bid_multiplier type: number is_expand: true name: promotion_days required: false source: $.http.body.promotion_days type: object - is_expand: false name: auto_budget_enabled required: false source: $.http.body.auto_budget_enabled type: boolean is_expand: true name: gmv_max_data required: true type: object - name: dedup_token required: true source: $.http.body.request_id type: number - children: - name: app_id required: false source: $.http.body.context_info.app_id type: number - name: core_user_id required: false source: $.http.body.context_info.core_user_id type: number - name: developer_id required: false source: $.http.body.context_info.developer_id type: number - name: x_forwarded_for required: false source: $.http.body.context_info.x_forwarded_for type: string - name: x_real_ip required: false source: $.http.body.context_info.x_real_ip type: string - name: user_agent required: false source: $.http.body.context_info.user_agent type: string - name: referer required: false source: $.http.body.context_info.referer type: string is_expand: false name: context_info required: false source: $.http.body.context_info type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: context_info: $.http.body.context_info dedup_token: $.http.body.request_id gmv_max_data: advertiser_id: $.http.body.advertiser_id auto_budget_enabled: $.http.body.auto_budget_enabled budget: $.http.body.budget campaign_name: $.http.body.campaign_name custom_anchor_video_list: $.http.body.custom_anchor_video_list deep_bid_type: $.http.body.deep_bid_type end_time_stamp: $.http.body.schedule_end_time identity_list: $.http.body.identity_list optimize_goal: $.http.body.optimization_goal product_specific_type: $.http.body.product_specific_type product_video_selection_type: $.http.body.product_video_specific_type promotion_days: $.http.body.promotion_days promotion_flow_type: $.http.body.shopping_ads_type roas_bid: $.http.body.roas_bid schedule_type: $.http.body.schedule_type shop_aca_mode: $.http.body.affiliate_posts_enabled shop_item_list: $.http.body.item_list[] spu_list: $.http.body.item_group_ids[] start_time_stamp: $.http.body.schedule_start_time store_authorized_bc_id: $.http.body.store_authorized_bc_id store_id: $.http.body.store_id response_cookie: [] response_header: [] response_rule: advertiser_id: $.rpc.output.gmv_max_data.advertiser_id affiliate_posts_enabled: $.rpc.output.gmv_max_data.shop_aca_mode age_groups: $.rpc.output.gmv_max_data.age auto_budget_enabled: $.rpc.output.gmv_max_data.auto_budget_enabled budget: $.rpc.output.gmv_max_data.budget campaign_custom_anchor_video_id: $.rpc.output.gmv_max_data.custom_anchor_video_ref_id campaign_id: $.rpc.output.gmv_max_data.campaign_id campaign_name: $.rpc.output.gmv_max_data.campaign_name custom_anchor_video_list[][]: - identity_info[]: - identity_authorized_bc_id: $.rpc.output.gmv_max_data.custom_anchor_video_list[].identity_info.identity_authorized_bc_id identity_authorized_shop_id: $.rpc.output.gmv_max_data.custom_anchor_video_list[].identity_info.identity_authorized_shop_id identity_id: $.rpc.output.gmv_max_data.custom_anchor_video_list[].identity_info.identity_id identity_type: $.rpc.output.gmv_max_data.custom_anchor_video_list[].identity_info.identity_type store_id: $.rpc.output.gmv_max_data.custom_anchor_video_list[].identity_info.store_id item_id: $.rpc.output.gmv_max_data.custom_anchor_video_list[].item_id spu_id_list: $.rpc.output.gmv_max_data.custom_anchor_video_list[].spu_id_list deep_bid_type: $.rpc.output.gmv_max_data.deep_bid_type identity_list: $.rpc.output.gmv_max_data.identity_list item_group_ids: $.rpc.output.gmv_max_data.spu_list item_list[][]: - identity_info[]: - identity_authorized_bc_id: $.rpc.output.gmv_max_data.shop_item_list[].identity_info.identity_authorized_bc_id identity_authorized_shop_id: $.rpc.output.gmv_max_data.shop_item_list[].identity_info.identity_authorized_shop_id identity_id: $.rpc.output.gmv_max_data.shop_item_list[].identity_info.identity_id identity_type: $.rpc.output.gmv_max_data.shop_item_list[].identity_info.identity_type name: $.rpc.output.gmv_max_data.shop_item_list[].identity_info.name profile_image: $.rpc.output.gmv_max_data.shop_item_list[].identity_info.avatar_url store_id: $.rpc.output.gmv_max_data.shop_item_list[].identity_info.store_id user_name: $.rpc.output.gmv_max_data.shop_item_list[].identity_info.user_name item_id: $.rpc.output.gmv_max_data.shop_item_list[].item_id spu_id_list: $.rpc.output.gmv_max_data.shop_item_list[].spu_id_list text: $.rpc.output.gmv_max_data.shop_item_list[].title video_info[]: - bit_rate: $.rpc.output.gmv_max_data.shop_item_list[].video_info.bitrate definition: $.rpc.output.gmv_max_data.shop_item_list[].video_info.definition duration: $.rpc.output.gmv_max_data.shop_item_list[].video_info.duration format: $.rpc.output.gmv_max_data.shop_item_list[].video_info.format fps: $.rpc.output.gmv_max_data.shop_item_list[].video_info.fps height: $.rpc.output.gmv_max_data.shop_item_list[].video_info.height preview_url: $.rpc.output.gmv_max_data.shop_item_list[].video_info.play_url signature: $.rpc.output.gmv_max_data.shop_item_list[].video_info.file_md5 size: $.rpc.output.gmv_max_data.shop_item_list[].video_info.file_size video_cover_url: $.rpc.output.gmv_max_data.shop_item_list[].video_info.cover_url video_id: $.rpc.output.gmv_max_data.shop_item_list[].video_info.video_id width: $.rpc.output.gmv_max_data.shop_item_list[].video_info.width location_ids: $.rpc.output.gmv_max_data.particle_locations operation_status: $.rpc.output.gmv_max_data.opt_status optimization_goal: $.rpc.output.gmv_max_data.optimize_goal placements: $.rpc.output.gmv_max_data.inventory_flow product_specific_type: $.rpc.output.gmv_max_data.product_specific_type product_video_specific_type: $.rpc.output.gmv_max_data.product_video_selection_type promotion_days: adjusted_roas_bid: $.rpc.output.gmv_max_data.promotion_days.adjusted_roas_bid auto_schedule_enabled: $.rpc.output.gmv_max_data.promotion_days.auto_schedule_enabled current_budget: $.rpc.output.gmv_max_data.promotion_days.current_budget custom_schedule_list[][]: - end_date: $.rpc.output.gmv_max_data.promotion_days.custom_schedule_list[].end_date start_date: $.rpc.output.gmv_max_data.promotion_days.custom_schedule_list[].start_date estimated_gross_revenue_increase: $.rpc.output.gmv_max_data.promotion_days.estimated_gross_revenue_increase is_enabled: $.rpc.output.gmv_max_data.promotion_days.is_enabled maximum_budget: $.rpc.output.gmv_max_data.promotion_days.maximum_budget next_increase: $.rpc.output.gmv_max_data.promotion_days.next_increase roas_bid_multiplier: $.rpc.output.gmv_max_data.promotion_days.roas_bid_multiplier roas_bid: $.rpc.output.gmv_max_data.roas_bid roi_protection_enabled: $.rpc.output.gmv_max_data.roi_protection_enabled schedule_end_time: $.rpc.output.gmv_max_data.end_time_stamp schedule_start_time: $.rpc.output.gmv_max_data.start_time_stamp schedule_type: $.rpc.output.gmv_max_data.schedule_type shopping_ads_type: $.rpc.output.gmv_max_data.promotion_flow_type store_authorized_bc_id: $.rpc.output.gmv_max_data.store_authorized_bc_id store_id: $.rpc.output.gmv_max_data.store_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /campaign/gmv_max/info/: get: operationId: Campaign Gmv_max Info 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 - description: '' in: query name: campaign_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.campaign_id x-open-field-id: 2 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get GMV Max campaign info [Smart Plus GMV Max Campaign Info](https://business-api.tiktok.com/portal/docs?id=1822000968821762) tags: - Campaign Creation x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - name: campaign_id required: true source: $.http.query.campaign_id type: number - children: - name: app_id required: false source: $.http.query.context_info.app_id type: number - name: core_user_id required: false source: $.http.query.context_info.core_user_id type: number - name: developer_id required: false source: $.http.query.context_info.developer_id type: number - name: x_forwarded_for required: false source: $.http.query.context_info.x_forwarded_for type: string - name: x_real_ip required: false source: $.http.query.context_info.x_real_ip type: string - name: user_agent required: false source: $.http.query.context_info.user_agent type: string - name: referer required: false source: $.http.query.context_info.referer type: string is_expand: false name: context_info required: false source: $.http.query.context_info type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id campaign_id: $.http.query.campaign_id context_info: $.http.query.context_info response_cookie: [] response_header: [] response_rule: advertiser_id: $.rpc.output.gmv_max_data.advertiser_id affiliate_posts_enabled: $.rpc.output.gmv_max_data.shop_aca_mode age_groups: $.rpc.output.gmv_max_data.age auto_budget_enabled: $.rpc.output.gmv_max_data.auto_budget_enabled budget: $.rpc.output.gmv_max_data.budget campaign_custom_anchor_video_id: $.rpc.output.gmv_max_data.custom_anchor_video_ref_id campaign_id: $.rpc.output.gmv_max_data.campaign_id campaign_name: $.rpc.output.gmv_max_data.campaign_name custom_anchor_video_list[][]: - identity_info[]: - identity_authorized_bc_id: $.rpc.output.gmv_max_data.custom_anchor_video_list[].identity_info.identity_authorized_bc_id identity_authorized_shop_id: $.rpc.output.gmv_max_data.custom_anchor_video_list[].identity_info.identity_authorized_shop_id identity_id: $.rpc.output.gmv_max_data.custom_anchor_video_list[].identity_info.identity_id identity_type: $.rpc.output.gmv_max_data.custom_anchor_video_list[].identity_info.identity_type store_id: $.rpc.output.gmv_max_data.custom_anchor_video_list[].identity_info.store_id item_id: $.rpc.output.gmv_max_data.custom_anchor_video_list[].item_id spu_id_list: $.rpc.output.gmv_max_data.custom_anchor_video_list[].spu_id_list deep_bid_type: $.rpc.output.gmv_max_data.deep_bid_type identity_list: $.rpc.output.gmv_max_data.identity_list item_group_ids: $.rpc.output.gmv_max_data.spu_list item_list[][]: - identity_info[]: - identity_authorized_bc_id: $.rpc.output.gmv_max_data.shop_item_list[].identity_info.identity_authorized_bc_id identity_authorized_shop_id: $.rpc.output.gmv_max_data.shop_item_list[].identity_info.identity_authorized_shop_id identity_id: $.rpc.output.gmv_max_data.shop_item_list[].identity_info.identity_id identity_type: $.rpc.output.gmv_max_data.shop_item_list[].identity_info.identity_type name: $.rpc.output.gmv_max_data.shop_item_list[].identity_info.name profile_image: $.rpc.output.gmv_max_data.shop_item_list[].identity_info.avatar_url store_id: $.rpc.output.gmv_max_data.shop_item_list[].identity_info.store_id user_name: $.rpc.output.gmv_max_data.shop_item_list[].identity_info.user_name item_id: $.rpc.output.gmv_max_data.shop_item_list[].item_id spu_id_list: $.rpc.output.gmv_max_data.shop_item_list[].spu_id_list text: $.rpc.output.gmv_max_data.shop_item_list[].title video_info[]: - bit_rate: $.rpc.output.gmv_max_data.shop_item_list[].video_info.bitrate definition: $.rpc.output.gmv_max_data.shop_item_list[].video_info.definition duration: $.rpc.output.gmv_max_data.shop_item_list[].video_info.duration format: $.rpc.output.gmv_max_data.shop_item_list[].video_info.format fps: $.rpc.output.gmv_max_data.shop_item_list[].video_info.fps height: $.rpc.output.gmv_max_data.shop_item_list[].video_info.height preview_url: $.rpc.output.gmv_max_data.shop_item_list[].video_info.play_url signature: $.rpc.output.gmv_max_data.shop_item_list[].video_info.file_md5 size: $.rpc.output.gmv_max_data.shop_item_list[].video_info.file_size video_cover_url: $.rpc.output.gmv_max_data.shop_item_list[].video_info.cover_url video_id: $.rpc.output.gmv_max_data.shop_item_list[].video_info.video_id width: $.rpc.output.gmv_max_data.shop_item_list[].video_info.width location_ids: $.rpc.output.gmv_max_data.particle_locations operation_status: $.rpc.output.gmv_max_data.opt_status optimization_goal: $.rpc.output.gmv_max_data.optimize_goal placements: $.rpc.output.gmv_max_data.inventory_flow product_specific_type: $.rpc.output.gmv_max_data.product_specific_type product_video_specific_type: $.rpc.output.gmv_max_data.product_video_selection_type promotion_days: adjusted_roas_bid: $.rpc.output.gmv_max_data.promotion_days.adjusted_roas_bid auto_schedule_enabled: $.rpc.output.gmv_max_data.promotion_days.auto_schedule_enabled current_budget: $.rpc.output.gmv_max_data.promotion_days.current_budget custom_schedule_list[][]: - end_date: $.rpc.output.gmv_max_data.promotion_days.custom_schedule_list[].end_date start_date: $.rpc.output.gmv_max_data.promotion_days.custom_schedule_list[].start_date estimated_gross_revenue_increase: $.rpc.output.gmv_max_data.promotion_days.estimated_gross_revenue_increase is_enabled: $.rpc.output.gmv_max_data.promotion_days.is_enabled maximum_budget: $.rpc.output.gmv_max_data.promotion_days.maximum_budget next_increase: $.rpc.output.gmv_max_data.promotion_days.next_increase roas_bid_multiplier: $.rpc.output.gmv_max_data.promotion_days.roas_bid_multiplier roas_bid: $.rpc.output.gmv_max_data.roas_bid roi_protection_enabled: $.rpc.output.gmv_max_data.roi_protection_enabled schedule_end_time: $.rpc.output.gmv_max_data.end_time_stamp schedule_start_time: $.rpc.output.gmv_max_data.start_time_stamp schedule_type: $.rpc.output.gmv_max_data.schedule_type shopping_ads_type: $.rpc.output.gmv_max_data.promotion_flow_type store_authorized_bc_id: $.rpc.output.gmv_max_data.store_authorized_bc_id store_id: $.rpc.output.gmv_max_data.store_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /campaign/gmv_max/session/create/: post: operationId: Campaign Gmv_max Session 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: advertiser_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.advertiser_id campaign_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.campaign_id session: description: '' properties: 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: null enum_package_name: null enums: - description: '' is_valid: true key: NO_BID value: '2' - description: '' is_valid: true key: CREATIVE_NO_BID value: '3' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 7 budget: description: '' format: double type: number x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.session.budget item_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 product_list: description: '' items: properties: spu_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.session.product_list[].spu_id required: - spu_id type: object x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 1 minItems: 1 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.session.product_list schedule_end_time: description: '' 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: 4 x-open-source: $.http.body.session.schedule_end_time schedule_start_time: description: '' 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: 3 x-open-source: $.http.body.session.schedule_start_time 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: null enum_package_name: null 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: 5 x-open-source: $.http.body.session.schedule_type required: - budget - product_list type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.session store_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.shop_id required: - campaign_id - advertiser_id - store_id - session 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 GMV Max session [Smart Plus GMV Max Session Create](https://business-api.tiktok.com/portal/docs?id=1835246967275522) tags: - Campaign Creation x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: campaign_id required: true source: $.http.body.campaign_id type: number - name: advertiser_id required: true source: $.http.body.advertiser_id type: number - name: shop_id required: true source: $.http.body.store_id type: number - children: - name: budget required: true source: $.http.body.session.budget type: number - children: - children: - name: spu_id required: true source: $.http.body.session.product_list[].spu_id type: string is_expand: true type: object is_expand: true name: product_list required: false source: $.http.body.session.product_list sub_type: object type: array - name: schedule_start_time required: false source: $.http.body.session.schedule_start_time type: number - name: schedule_end_time required: false source: $.http.body.session.schedule_end_time type: number - name: schedule_type required: false source: $.http.body.session.schedule_type type: number - is_expand: false name: session_type required: false source: $.http.body.session.bid_type type: number - is_expand: false name: item_id required: false source: $.http.body.session.item_id type: string is_expand: true name: session required: true type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id campaign_id: $.http.body.campaign_id session: budget: $.http.body.session.budget item_id: $.http.body.session.item_id product_list: $.http.body.session.product_list schedule_end_time: $.http.body.session.schedule_end_time schedule_start_time: $.http.body.session.schedule_start_time schedule_type: $.http.body.session.schedule_type session_type: $.http.body.session.bid_type shop_id: $.http.body.store_id response_cookie: [] response_header: [] response_rule: session_id: $.rpc.output.session_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /campaign/gmv_max/session/delete/: post: operationId: Campaign Gmv_max Session Delete parameters: - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string requestBody: content: application/json: schema: properties: advertiser_id: description: '' 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 session_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.session_id required: - advertiser_id - session_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: Delete GMV Max session [Smart Plus GMV Max Session Delete](https://business-api.tiktok.com/portal/docs?id=1835246983475217) tags: - Campaign Creation 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: session_id required: true source: $.http.body.session_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id session_id: $.http.body.session_id response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /campaign/gmv_max/session/get/: get: operationId: Campaign Gmv_max Session 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: 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-source: $.http.query.session_ids description: '' in: query name: session_ids required: true x-open-field-id: 2 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get GMV Max session info [Smart Plus GMV Max Session Get](https://business-api.tiktok.com/portal/docs?id=1835247031331842) tags: - Campaign Creation x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - children: - type: number name: session_ids required: true source: $.http.query.session_ids sub_type: number type: array plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id session_ids: $.http.query.session_ids response_cookie: [] response_header: [] response_rule: session_list[][]: - bid_type: $.rpc.output.session_list[].session_type budget: $.rpc.output.session_list[].budget campaign_id: $.rpc.output.session_list[].campaign_id item_id: $.rpc.output.session_list[].item_id product_list: $.rpc.output.session_list[].product_list schedule_end_time: $.rpc.output.session_list[].schedule_end_time schedule_start_time: $.rpc.output.session_list[].schedule_start_time schedule_type: $.rpc.output.session_list[].schedule_type session_id: $.rpc.output.session_list[].id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /campaign/gmv_max/session/list/: get: operationId: Campaign Gmv_max Session List parameters: - description: '' in: query name: campaign_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.campaign_id x-open-field-id: 1 - 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: 2 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get GMV Max session list [Smart Plus GMV Max Session List](https://business-api.tiktok.com/portal/docs?id=1835246996436162) tags: - Campaign Creation x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: campaign_id required: true source: $.http.query.campaign_id type: number - name: advertiser_id required: true source: $.http.query.advertiser_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id campaign_id: $.http.query.campaign_id response_cookie: [] response_header: [] response_rule: session_list[][]: - bid_type: $.rpc.output.session_list[].session_type budget: $.rpc.output.session_list[].budget campaign_id: $.rpc.output.session_list[].campaign_id product_list: $.rpc.output.session_list[].product_list schedule_end_time: $.rpc.output.session_list[].schedule_end_time schedule_start_time: $.rpc.output.session_list[].schedule_start_time schedule_type: $.rpc.output.session_list[].schedule_type session_id: $.rpc.output.session_list[].id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /campaign/gmv_max/session/update/: post: operationId: Campaign Gmv_max Session 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: advertiser_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.advertiser_id campaign_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.campaign_id session: description: '' properties: budget: description: '' format: double type: number x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.session.budget schedule_end_time: description: '' 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: 3 x-open-source: $.http.body.session.schedule_end_time schedule_start_time: description: '' 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: 2 x-open-source: $.http.body.session.schedule_start_time 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: null enum_package_name: null 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: 4 x-open-source: $.http.body.session.schedule_type type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.body.session session_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 4 x-open-source: $.http.body.session_id store_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.shop_id required: - campaign_id - advertiser_id - store_id - session_id - session 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 GMV Max session [Smart Plus GMV Max Session Update](https://business-api.tiktok.com/portal/docs?id=1835247009119233) tags: - Campaign Creation x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: campaign_id required: true source: $.http.body.campaign_id type: number - name: advertiser_id required: true source: $.http.body.advertiser_id type: number - name: shop_id required: true source: $.http.body.store_id type: number - name: session_id required: true source: $.http.body.session_id type: number - children: - name: schedule_start_time required: false source: $.http.body.session.schedule_start_time type: number - name: schedule_end_time required: false source: $.http.body.session.schedule_end_time type: number - name: schedule_type required: false source: $.http.body.session.schedule_type type: number - is_expand: false name: budget required: false source: $.http.body.session.budget type: number is_expand: true name: session required: true type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id campaign_id: $.http.body.campaign_id session: budget: $.http.body.session.budget schedule_end_time: $.http.body.session.schedule_end_time schedule_start_time: $.http.body.session.schedule_start_time schedule_type: $.http.body.session.schedule_type session_id: $.http.body.session_id shop_id: $.http.body.store_id response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /campaign/gmv_max/update/: post: operationId: Campaign Gmv_max 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: 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 affiliate_posts_enabled: description: '' type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int32(%s) x-open-field-id: 9 auto_budget_enabled: description: '' type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 12 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 campaign_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.campaign_id campaign_name: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.campaign_name custom_anchor_video_list: description: '' items: properties: identity_info: description: '' properties: 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: 3 identity_authorized_shop_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 5 identity_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 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: true 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: true 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: 2 store_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 4 required: - identity_id - identity_type type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 item_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 spu_id_list: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 1 minItems: 1 type: array 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 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 10 item_group_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: 13 item_list: description: '' items: properties: identity_info: description: '' properties: 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: 3 x-open-source: $.http.body.shop_item_list[].identity_info.identity_authorized_bc_id identity_authorized_shop_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 5 x-open-source: $.http.body.shop_item_list[].identity_info.identity_authorized_shop_id identity_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.shop_item_list[].identity_info.identity_id 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: true 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: true 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: 2 x-open-source: $.http.body.shop_item_list[].identity_info.identity_type store_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 4 x-open-source: $.http.body.shop_item_list[].identity_info.store_id required: - identity_id - identity_type type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.shop_item_list[].identity_info item_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.shop_item_list[].item_id spu_id_list: 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: 3 x-open-source: $.http.body.shop_item_list[].spu_id_list video_info: description: '' properties: video_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.shop_item_list[].video_info.video_id required: - video_id type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.shop_item_list[].video_info 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: 8 x-open-source: $.http.body.shop_item_list promotion_days: description: '' properties: auto_schedule_enabled: description: '' type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 custom_schedule_list: description: '' items: properties: end_date: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - convert_time_format(%s, "yyyy-MM-dd", "yyyy-MM-dd 00:00:00", "local") x-open-field-id: 2 schedule_type: default: STARTEND description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: null enum_package_name: null enums: - description: '' is_valid: true key: STARTEND value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 3 start_date: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - convert_time_format(%s, "yyyy-MM-dd", "yyyy-MM-dd 00:00:00", "local") x-open-field-id: 1 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: 3 is_enabled: description: '' type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 roas_bid_multiplier: description: '' format: int64 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 11 roas_bid: description: '' format: double type: number x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.roas_bid schedule_end_time: description: '' 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: 6 x-open-source: $.http.body.end_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: 7 required: - advertiser_id - campaign_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 GMV Max campaign [Smart Plus GMV Max Campaign Update](https://business-api.tiktok.com/portal/docs?id=1822001009002497) tags: - Campaign Creation x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: campaign_id required: true source: $.http.body.campaign_id type: number - name: campaign_name required: false source: $.http.body.campaign_name type: string - name: roas_bid required: false source: $.http.body.roas_bid type: number - name: budget required: false source: $.http.body.budget type: number - name: end_time_stamp required: false source: $.http.body.schedule_end_time type: number - children: - children: - name: item_id required: false source: $.http.body.item_list[].item_id type: number - children: - name: identity_id required: true source: $.http.body.item_list[].identity_info.identity_id type: string - name: identity_type required: true source: $.http.body.item_list[].identity_info.identity_type type: number - name: identity_authorized_bc_id required: false source: $.http.body.item_list[].identity_info.identity_authorized_bc_id type: number - name: store_id required: false source: $.http.body.item_list[].identity_info.store_id type: number - name: avatar_url required: false source: $.http.body.item_list[].identity_info.avatar_url type: string - name: identity_authorized_shop_id required: false source: $.http.body.item_list[].identity_info.identity_authorized_shop_id type: number is_expand: true name: identity_info required: false source: $.http.body.item_list[].identity_info type: object - children: - type: string is_expand: true name: spu_id_list required: false source: $.http.body.item_list[].spu_id_list[] sub_type: string type: array - children: - name: video_id required: true source: $.http.body.item_list[].video_info.video_id type: string is_expand: true name: video_info required: false source: $.http.body.item_list[].video_info type: object is_expand: true type: object is_expand: false name: shop_item_list required: false source: $.http.body.item_list[] sub_type: object type: array - children: - name: app_id required: false source: $.http.body.context_info.app_id type: number - name: core_user_id required: false source: $.http.body.context_info.core_user_id type: number - name: developer_id required: false source: $.http.body.context_info.developer_id type: number - name: x_forwarded_for required: false source: $.http.body.context_info.x_forwarded_for type: string - name: x_real_ip required: false source: $.http.body.context_info.x_real_ip type: string - name: user_agent required: false source: $.http.body.context_info.user_agent type: string - name: referer required: false source: $.http.body.context_info.referer type: string is_expand: false name: context_info required: false source: $.http.body.context_info type: object - name: schedule_type required: false source: $.http.body.schedule_type type: number - name: shop_aca_mode required: false source: $.http.body.affiliate_posts_enabled type: number - name: advertiser_id required: true source: $.http.body.advertiser_id type: number - children: - children: - name: item_id required: false source: $.http.body.custom_anchor_video_list[].item_id type: number - children: - name: identity_id required: true source: $.http.body.custom_anchor_video_list[].identity_info.identity_id type: string - name: identity_type required: true source: $.http.body.custom_anchor_video_list[].identity_info.identity_type type: number - name: identity_authorized_bc_id required: false source: $.http.body.custom_anchor_video_list[].identity_info.identity_authorized_bc_id type: number - name: store_id required: false source: $.http.body.custom_anchor_video_list[].identity_info.store_id type: number - name: identity_authorized_shop_id required: false source: $.http.body.custom_anchor_video_list[].identity_info.identity_authorized_shop_id type: number is_expand: true name: identity_info required: false source: $.http.body.custom_anchor_video_list[].identity_info type: object - children: - type: string is_expand: true name: spu_id_list required: false source: $.http.body.custom_anchor_video_list[].spu_id_list[] sub_type: string type: array is_expand: true type: object is_expand: true name: custom_anchor_video_list required: false source: $.http.body.custom_anchor_video_list[] sub_type: object type: array - children: - name: is_enabled required: false source: $.http.body.promotion_days.is_enabled type: boolean - name: auto_schedule_enabled required: false source: $.http.body.promotion_days.auto_schedule_enabled type: boolean - children: - children: - name: start_date required: false source: $.http.body.promotion_days.custom_schedule_list[].start_date type: string - name: end_date required: false source: $.http.body.promotion_days.custom_schedule_list[].end_date type: string - name: schedule_type required: false source: $.http.body.promotion_days.custom_schedule_list[].schedule_type type: number is_expand: true type: object is_expand: true name: custom_schedule_list required: false source: $.http.body.promotion_days.custom_schedule_list[] sub_type: object type: array - name: roas_bid_multiplier required: false source: $.http.body.promotion_days.roas_bid_multiplier type: number is_expand: true name: promotion_days required: false source: $.http.body.promotion_days type: object - name: auto_budget_enabled required: false source: $.http.body.auto_budget_enabled type: boolean - children: - type: string is_expand: true name: spu_list required: false source: $.http.body.item_group_ids[] sub_type: string type: array plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id auto_budget_enabled: $.http.body.auto_budget_enabled budget: $.http.body.budget campaign_id: $.http.body.campaign_id campaign_name: $.http.body.campaign_name context_info: $.http.body.context_info custom_anchor_video_list: $.http.body.custom_anchor_video_list[] end_time_stamp: $.http.body.schedule_end_time promotion_days: $.http.body.promotion_days roas_bid: $.http.body.roas_bid schedule_type: $.http.body.schedule_type shop_aca_mode: $.http.body.affiliate_posts_enabled shop_item_list: $.http.body.item_list[] spu_list: $.http.body.item_group_ids[] response_cookie: [] response_header: [] response_rule: advertiser_id: $.rpc.output.gmv_max_data.advertiser_id affiliate_posts_enabled: $.rpc.output.gmv_max_data.shop_aca_mode age_groups: $.rpc.output.gmv_max_data.age auto_budget_enabled: $.rpc.output.gmv_max_data.auto_budget_enabled budget: $.rpc.output.gmv_max_data.budget campaign_custom_anchor_video_id: $.rpc.output.gmv_max_data.custom_anchor_video_ref_id campaign_id: $.rpc.output.gmv_max_data.campaign_id campaign_name: $.rpc.output.gmv_max_data.campaign_name custom_anchor_video_list[][]: - identity_info[]: - identity_authorized_bc_id: $.rpc.output.gmv_max_data.custom_anchor_video_list[].identity_info.identity_authorized_bc_id identity_authorized_shop_id: $.rpc.output.gmv_max_data.custom_anchor_video_list[].identity_info.identity_authorized_shop_id identity_id: $.rpc.output.gmv_max_data.custom_anchor_video_list[].identity_info.identity_id identity_type: $.rpc.output.gmv_max_data.custom_anchor_video_list[].identity_info.identity_type name: $.rpc.output.gmv_max_data.custom_anchor_video_list[].identity_info.name profile_image: $.rpc.output.gmv_max_data.custom_anchor_video_list[].identity_info.avatar_url store_id: $.rpc.output.gmv_max_data.custom_anchor_video_list[].identity_info.store_id user_name: $.rpc.output.gmv_max_data.custom_anchor_video_list[].identity_info.user_name item_id: $.rpc.output.gmv_max_data.custom_anchor_video_list[].item_id spu_id_list: $.rpc.output.gmv_max_data.custom_anchor_video_list[].spu_id_list text: $.rpc.output.gmv_max_data.custom_anchor_video_list[].title video_info[]: - bit_rate: $.rpc.output.gmv_max_data.custom_anchor_video_list[].video_info.bitrate definition: $.rpc.output.gmv_max_data.custom_anchor_video_list[].video_info.definition duration: $.rpc.output.gmv_max_data.custom_anchor_video_list[].video_info.duration format: $.rpc.output.gmv_max_data.custom_anchor_video_list[].video_info.format fps: $.rpc.output.gmv_max_data.custom_anchor_video_list[].video_info.fps height: $.rpc.output.gmv_max_data.custom_anchor_video_list[].video_info.height preview_url: $.rpc.output.gmv_max_data.custom_anchor_video_list[].video_info.play_url signature: $.rpc.output.gmv_max_data.custom_anchor_video_list[].video_info.file_md5 size: $.rpc.output.gmv_max_data.custom_anchor_video_list[].video_info.file_size video_cover_url: $.rpc.output.gmv_max_data.custom_anchor_video_list[].video_info.cover_url video_id: $.rpc.output.gmv_max_data.custom_anchor_video_list[].video_info.video_id width: $.rpc.output.gmv_max_data.custom_anchor_video_list[].video_info.width deep_bid_type: $.rpc.output.gmv_max_data.deep_bid_type identity_list: $.rpc.output.gmv_max_data.identity_list item_group_ids: $.rpc.output.gmv_max_data.spu_list item_list[][]: - identity_info[]: - identity_authorized_bc_id: $.rpc.output.gmv_max_data.shop_item_list[].identity_info.identity_authorized_bc_id identity_authorized_shop_id: $.rpc.output.gmv_max_data.shop_item_list[].identity_info.identity_authorized_shop_id identity_id: $.rpc.output.gmv_max_data.shop_item_list[].identity_info.identity_id identity_type: $.rpc.output.gmv_max_data.shop_item_list[].identity_info.identity_type name: $.rpc.output.gmv_max_data.shop_item_list[].identity_info.name profile_image: $.rpc.output.gmv_max_data.shop_item_list[].identity_info.avatar_url store_id: $.rpc.output.gmv_max_data.shop_item_list[].identity_info.store_id user_name: $.rpc.output.gmv_max_data.shop_item_list[].identity_info.user_name item_id: $.rpc.output.gmv_max_data.shop_item_list[].item_id spu_id_list: $.rpc.output.gmv_max_data.shop_item_list[].spu_id_list text: $.rpc.output.gmv_max_data.shop_item_list[].title video_info[]: - bit_rate: $.rpc.output.gmv_max_data.shop_item_list[].video_info.bitrate definition: $.rpc.output.gmv_max_data.shop_item_list[].video_info.definition duration: $.rpc.output.gmv_max_data.shop_item_list[].video_info.duration format: $.rpc.output.gmv_max_data.shop_item_list[].video_info.format fps: $.rpc.output.gmv_max_data.shop_item_list[].video_info.fps height: $.rpc.output.gmv_max_data.shop_item_list[].video_info.height preview_url: $.rpc.output.gmv_max_data.shop_item_list[].video_info.play_url signature: $.rpc.output.gmv_max_data.shop_item_list[].video_info.file_md5 size: $.rpc.output.gmv_max_data.shop_item_list[].video_info.file_size video_cover_url: $.rpc.output.gmv_max_data.shop_item_list[].video_info.cover_url video_id: $.rpc.output.gmv_max_data.shop_item_list[].video_info.video_id width: $.rpc.output.gmv_max_data.shop_item_list[].video_info.width location_ids: $.rpc.output.gmv_max_data.particle_locations operation_status: $.rpc.output.gmv_max_data.opt_status optimization_goal: $.rpc.output.gmv_max_data.optimize_goal placements: $.rpc.output.gmv_max_data.inventory_flow product_specific_type: $.rpc.output.gmv_max_data.product_specific_type product_video_specific_type: $.rpc.output.gmv_max_data.product_video_selection_type promotion_days: adjusted_roas_bid: $.rpc.output.gmv_max_data.promotion_days.adjusted_roas_bid auto_schedule_enabled: $.rpc.output.gmv_max_data.promotion_days.auto_schedule_enabled current_budget: $.rpc.output.gmv_max_data.promotion_days.current_budget custom_schedule_list[][]: - end_date: $.rpc.output.gmv_max_data.promotion_days.custom_schedule_list[].end_date start_date: $.rpc.output.gmv_max_data.promotion_days.custom_schedule_list[].start_date estimated_gross_revenue_increase: $.rpc.output.gmv_max_data.promotion_days.estimated_gross_revenue_increase is_enabled: $.rpc.output.gmv_max_data.promotion_days.is_enabled maximum_budget: $.rpc.output.gmv_max_data.promotion_days.maximum_budget next_increase: $.rpc.output.gmv_max_data.promotion_days.next_increase roas_bid_multiplier: $.rpc.output.gmv_max_data.promotion_days.roas_bid_multiplier roas_bid: $.rpc.output.gmv_max_data.roas_bid roi_protection_enabled: $.rpc.output.gmv_max_data.roi_protection_enabled schedule_end_time: $.rpc.output.gmv_max_data.end_time_stamp schedule_start_time: $.rpc.output.gmv_max_data.start_time_stamp schedule_type: $.rpc.output.gmv_max_data.schedule_type shopping_ads_type: $.rpc.output.gmv_max_data.promotion_flow_type store_authorized_bc_id: $.rpc.output.gmv_max_data.store_authorized_bc_id store_id: $.rpc.output.gmv_max_data.store_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /gmv_max/bid/recommend/: get: operationId: Gmv_max Bid Recommend 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 - description: '' in: query name: store_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.store_id x-open-field-id: 2 - description: '' in: query name: shopping_ads_type required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1810159239577601 enum_package_name: PromotionFlowType enums: - description: '' is_valid: false key: CATALOG_LISTING_ADS value: '3' - description: '' is_valid: true key: LIVE value: '2' - description: 推商品广告（VIDEO + PSA） is_valid: true key: PRODUCT value: '5' - description: '' is_valid: false key: PRODUCT_SHOPPING_ADS value: '4' - description: '' is_valid: false key: UNSET value: '0' - description: '' is_valid: false key: VIDEO value: '1' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-source: $.http.query.promotion_flow_type x-open-field-id: 3 - description: '' in: query name: optimization_goal required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804193306612737 enum_package_name: OptimizeGoal enums: - description: '' is_valid: false key: ANCHOR_CLICK value: '112' - description: '' is_valid: false key: ANCHOR_CLICK_PURCHASE value: '117' - description: '' is_valid: false key: AUTOMATED_VALUE value: '125' - description: '' is_valid: false key: CLICK value: '101' - description: '' is_valid: false key: CONVERSATION value: '124' - description: '' is_valid: false key: CONVERSION_LEADS value: '121' - description: '' is_valid: false key: CONVERT value: '100' - description: '' is_valid: false key: DESTINATION_VISIT value: '123' - description: '' is_valid: false key: ENGAGED_VIEW value: '118' - description: '' is_valid: false key: ENGAGED_VIEW_FIFTEEM value: '120' - description: '' is_valid: false key: FOLLOWERS value: '108' - description: '' is_valid: false key: INSTALL value: '105' - description: '' is_valid: false key: IN_APP_EVENT value: '106' - description: '' is_valid: false key: LEAD_GENERATION value: '107' - description: '' is_valid: false key: MESSAGE value: '119' - description: '' is_valid: false key: MT_LIVE_FOLLOW value: '126' - description: '' is_valid: false key: MT_LIVE_ROOM value: '113' - description: '' is_valid: false key: MT_LIVE_SHOPPING value: '116' - description: '' is_valid: false key: PAGE_VISIT value: '122' - description: '' is_valid: false key: POST_ENGAGEMNT value: '110' - description: '' is_valid: false key: PREFERRED_LEAD value: '127' - description: '' is_valid: false key: PRODUCT_CLICK_IN_LIVE value: '114' - description: '' is_valid: false key: PROFILE_VIEWS value: '109' - description: '' is_valid: false key: REACH value: '103' - description: '' is_valid: false key: SHOW value: '102' - description: '' is_valid: false key: TRAFFIC_LANDING_PAGE_VIEW value: '115' - description: '' is_valid: true key: VALUE value: '111' - description: '' is_valid: false key: VIDEO_VIEW value: '104' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-source: $.http.query.optimize_goal x-open-field-id: 4 - content: application/json: schema: items: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) maxItems: 50 minItems: 1 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.spu_list description: '' in: query name: item_group_ids required: false x-open-field-id: 5 - description: '' in: query name: identity_id required: false schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.identity_id x-open-field-id: 6 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get GMV Max bid recommendation [Smart Plus GMV Max Bid Recommend](https://business-api.tiktok.com/portal/docs?id=1822001024720897) tags: - Campaign Creation x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - name: store_id required: true source: $.http.query.store_id type: number - name: promotion_flow_type required: true source: $.http.query.shopping_ads_type type: number - name: optimize_goal required: true source: $.http.query.optimization_goal type: number - children: - type: number is_expand: true name: spu_list required: false source: $.http.query.item_group_ids[] sub_type: number type: array - name: identity_id required: false source: $.http.query.identity_id type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id identity_id: $.http.query.identity_id optimize_goal: $.http.query.optimization_goal promotion_flow_type: $.http.query.shopping_ads_type spu_list: $.http.query.item_group_ids[] store_id: $.http.query.store_id response_cookie: [] response_header: [] response_rule: budget: $.rpc.output.budget cpa_bid: $.rpc.output.cpa_bid roas_bid: $.rpc.output.roas_bid x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /gmv_max/custom_anchor_video_list/get/: get: operationId: Gmv_max Custom_anchor_video_list Get parameters: - description: '' in: query name: advertiser_id required: true schema: format: int64 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.advertiser_id x-open-field-id: 1 - description: '' in: query name: campaign_custom_anchor_video_id required: true schema: format: int64 type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.custom_anchor_video_ref_id x-open-field-id: 2 - content: application/json: schema: items: properties: identity_info: description: '' properties: 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: 3 identity_authorized_shop_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 5 identity_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.query.query_custom_anchor_video_list[].identity_info.identity_id 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: true 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: true 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: 2 x-open-source: $.http.query.query_custom_anchor_video_list[].identity_info.identity_type store_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 4 required: - identity_id - identity_type type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.query.query_custom_anchor_video_list[].identity_info item_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.query.query_custom_anchor_video_list[].item_id spu_id_list: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 1 minItems: 1 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.query.query_custom_anchor_video_list[].spu_id_list required: - item_id type: object x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 20 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.query_custom_anchor_video_list description: '' in: query name: custom_anchor_video_list required: true x-open-field-id: 3 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get GMV Max custom anchor video list [Smart Plus GMV Max Custom Anchor Video List Get](https://business-api.tiktok.com/portal/docs?id=1830215925061633) tags: - Campaign Creation x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - name: custom_anchor_video_ref_id required: true source: $.http.query.campaign_custom_anchor_video_id type: number - children: - children: - name: item_id required: false source: $.http.query.custom_anchor_video_list[].item_id type: number - children: - name: identity_id required: true source: $.http.query.custom_anchor_video_list[].identity_info.identity_id type: string - name: identity_type required: true source: $.http.query.custom_anchor_video_list[].identity_info.identity_type type: number - name: identity_authorized_bc_id required: false source: $.http.query.custom_anchor_video_list[].identity_info.identity_authorized_bc_id type: number - name: store_id required: false source: $.http.query.custom_anchor_video_list[].identity_info.store_id type: number - name: identity_authorized_shop_id required: false source: $.http.query.custom_anchor_video_list[].identity_info.identity_authorized_shop_id type: number is_expand: true name: identity_info required: false source: $.http.query.custom_anchor_video_list[].identity_info type: object - children: - type: string is_expand: true name: spu_id_list required: false source: $.http.query.custom_anchor_video_list[].spu_id_list[] sub_type: string type: array is_expand: true type: object is_expand: true name: query_custom_anchor_video_list required: true source: $.http.query.custom_anchor_video_list[] sub_type: object type: array plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id custom_anchor_video_ref_id: $.http.query.campaign_custom_anchor_video_id query_custom_anchor_video_list: $.http.query.custom_anchor_video_list[] response_cookie: [] response_header: [] response_rule: custom_anchor_video_list[][]: - identity_info[]: - identity_authorized_bc_id: $.rpc.output.custom_anchor_video_list[].identity_info.identity_authorized_bc_id identity_authorized_shop_id: $.rpc.output.custom_anchor_video_list[].identity_info.identity_authorized_shop_id identity_id: $.rpc.output.custom_anchor_video_list[].identity_info.identity_id identity_type: $.rpc.output.custom_anchor_video_list[].identity_info.identity_type name: $.rpc.output.custom_anchor_video_list[].identity_info.name profile_image: $.rpc.output.custom_anchor_video_list[].identity_info.avatar_url store_id: $.rpc.output.custom_anchor_video_list[].identity_info.store_id user_name: $.rpc.output.custom_anchor_video_list[].identity_info.user_name item_id: $.rpc.output.custom_anchor_video_list[].item_id spu_id_list: $.rpc.output.custom_anchor_video_list[].spu_id_list text: $.rpc.output.custom_anchor_video_list[].title video_info[]: - bit_rate: $.rpc.output.custom_anchor_video_list[].video_info.bitrate definition: $.rpc.output.custom_anchor_video_list[].video_info.definition duration: $.rpc.output.custom_anchor_video_list[].video_info.duration format: $.rpc.output.custom_anchor_video_list[].video_info.format fps: $.rpc.output.custom_anchor_video_list[].video_info.fps height: $.rpc.output.custom_anchor_video_list[].video_info.height preview_url: $.rpc.output.custom_anchor_video_list[].video_info.play_url signature: $.rpc.output.custom_anchor_video_list[].video_info.file_md5 size: $.rpc.output.custom_anchor_video_list[].video_info.file_size video_cover_url: $.rpc.output.custom_anchor_video_list[].video_info.cover_url video_id: $.rpc.output.custom_anchor_video_list[].video_info.video_id width: $.rpc.output.custom_anchor_video_list[].video_info.width x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /gmv_max/occupied_custom_shop_ads/list/: get: operationId: Gmv_max Occupied_custom_shop_ads List 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 - description: '' in: query name: store_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.store_id x-open-field-id: 2 - content: application/json: schema: items: type: string x-open-allow-strlist: false x-open-allow-strnum: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.asset_ids description: '' in: query name: asset_ids required: true x-open-field-id: 3 - description: '' in: query name: occupied_asset_type required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1817683760236609 enum_package_name: MutexAssetIdType enums: - description: bc代投tt user 授权账号类型 is_valid: true key: IDENTITY_BC_AUTH_TT value: '5' - description: TTS 店铺授权来源的identity is_valid: true key: IDENTITY_TTS_TT value: '8' - description: tt user 授权账号类型 is_valid: true key: IDENTITY_TT_USER value: '3' - description: 麦哲伦店铺ID is_valid: true key: SHOP value: '100' - description: 麦哲伦商品 is_valid: true key: SPU value: '101' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.mutex_asset_id_type x-open-field-id: 4 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 type: - integer - 'null' x-open-allow-strlist: false x-open-field-id: 4 data: description: Returned data. The response for the SDK can be checked in the document for the API given in the description. properties: {} type: - object - 'null' x-open-allow-strlist: false x-open-field-id: 1 x-open-source: $.rpc.output.data message: description: Response message. For details, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. type: - string - 'null' x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get GMV Max occupied custom shop ads [Smart Plus GMV Max Occupied Custom Shop Ads List](https://business-api.tiktok.com/portal/docs?id=1822001136924674) tags: - Campaign Creation x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - name: store_id required: true source: $.http.query.store_id type: number - children: - type: string is_expand: false name: asset_ids required: true source: $.http.query.asset_ids sub_type: string type: array - name: mutex_asset_id_type required: true source: $.http.query.occupied_asset_type type: number - children: - name: app_id required: false source: $.http.query.context_info.app_id type: number - name: core_user_id required: false source: $.http.query.context_info.core_user_id type: number - name: developer_id required: false source: $.http.query.context_info.developer_id type: number - name: x_forwarded_for required: false source: $.http.query.context_info.x_forwarded_for type: string - name: x_real_ip required: false source: $.http.query.context_info.x_real_ip type: string - name: user_agent required: false source: $.http.query.context_info.user_agent type: string - name: referer required: false source: $.http.query.context_info.referer type: string is_expand: false name: context_info required: false source: $.http.query.context_info type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id asset_ids: $.http.query.asset_ids context_info: $.http.query.context_info mutex_asset_id_type: $.http.query.occupied_asset_type store_id: $.http.query.store_id response_cookie: [] response_header: [] response_rule: occupied_custom_shop_ads: $.rpc.output.excluded_roi1_ads x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /smart_plus/campaign/create/: post: operationId: Smart_plus Campaign 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: 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: 10 x-open-source: $.http.body.app_id app_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: 1799795397435394 enum_package_name: AppCampaignType enums: - description: '' is_valid: true key: APP_INSTALL value: '1' - description: '' is_valid: false key: APP_PREREGISTRATION value: '3' - description: '' is_valid: false key: APP_RETARGETING value: '2' - description: '' is_valid: false key: PAID_CONTENT value: '4' - 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: 12 x-open-source: $.http.body.app_campaign_type bid_align_type: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1836609049482561 enum_package_name: BidAlignType enums: - description: SAN口径出价 is_valid: true key: SAN value: '1' - description: SKAN口径出价 is_valid: true key: SKAN value: '2' - description: 存量数据，默认走SKAN口径出价 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: 20 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 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: false key: BUDGET_MODE_DAY value: '0' - description: '' is_valid: true key: BUDGET_MODE_DYNAMIC_DAILY_BUDGET value: '3' - description: '' is_valid: false key: BUDGET_MODE_INFINITE value: '-1' - description: '' is_valid: true key: BUDGET_MODE_TOTAL value: '1' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 4 x-open-source: $.http.body.budget_mode budget_optimize_on: description: '' type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.body.budget_optimize_on campaign_app_profile_page_state: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1799795483636802 enum_package_name: AppProfilePageType enums: - description: '' is_valid: false key: INVALID value: '-1' - description: '' is_valid: true key: 'OFF' value: '2' - description: '' is_valid: true key: 'ON' value: '1' - 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: 13 x-open-source: $.http.body.campaign_app_profile_page_type campaign_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 campaign_type: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803460221791298 enum_package_name: DedicateType enums: - description: '' is_valid: true key: IOS14_CAMPAIGN value: '2' - description: '' is_valid: true key: REGULAR_CAMPAIGN value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 11 x-open-source: $.http.body.dedicate_type catalog_enabled: description: '' type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 15 x-open-source: $.http.body.catalog_enabled catalog_type: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1836342576635921 enum_package_name: SPCatalogType enums: - description: '' is_valid: true key: ECOMMERCE value: '1' - description: '' is_valid: true key: MINI_SERIES value: '3' - description: '' is_valid: true key: TRAVEL_ENTERTAINMENT value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 19 disable_skan_campaign: description: '' type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 17 x-open-source: $.http.body.disable_skan_campaign is_advanced_dedicated_campaign: default: true description: '' type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 16 x-open-source: $.http.body.is_advanced_dedicated_campaign is_promotional_campaign: description: '' type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 22 x-open-source: $.http.body.is_promotional_campaign 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.body.objective_type open_api_partner: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 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: true key: FROZEN value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 9 x-open-source: $.http.body.opt_status po_number: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 23 postback_window_mode: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804193901260801 enum_package_name: DCPostbackMode enums: - description: 暂停或删除Campaign后4天回收quota is_valid: true key: POSTBACK_WINDOW_MODE1 value: '1' - description: 暂停或删除Campaign后13天回收quota is_valid: true key: POSTBACK_WINDOW_MODE2 value: '2' - description: 暂停或删除Campaign后41天回收quota is_valid: true key: POSTBACK_WINDOW_MODE3 value: '3' - description: 暂停或删除Campaign后3天回收quota 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: 21 request_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 14 x-open-source: $.http.body.dedup_token sales_destination: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1831416494721026 enum_package_name: CampaignSalesDestination enums: - description: '' is_valid: false key: APP value: '4' - description: '' is_valid: false key: TIKTOK_SHOP value: '2' - description: '' is_valid: true key: WEBSITE value: '3' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 18 x-open-source: $.http.body.sales_destination special_industries: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800966552221698 enum_package_name: IndustryType enums: - description: '' is_valid: true key: CREDIT value: '3' - description: '' is_valid: true key: EMPLOYMENT value: '2' - description: '' is_valid: true key: HOUSING value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 8 x-open-source: $.http.body.industry_types required: - advertiser_id - campaign_name - objective_type - 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 campaign [Smart Plus Campaign Create] tags: - Campaign Creation 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.campaign_name type: string - name: objective_type required: true source: $.http.body.objective_type type: number - name: budget_mode required: false source: $.http.body.budget_mode type: number - name: budget required: false source: $.http.body.budget type: number - name: budget_optimize_on required: false source: $.http.body.budget_optimize_on type: boolean - name: open_api_partner required: false source: $.http.body.open_api_partner type: string - children: - type: number is_expand: false name: industry_types required: false source: $.http.body.special_industries sub_type: number type: array - name: opt_status required: false source: $.http.body.operation_status type: number - name: app_id required: false source: $.http.body.app_id type: number - name: dedicate_type required: false source: $.http.body.campaign_type type: number - name: app_campaign_type required: false source: $.http.body.app_promotion_type type: number - name: campaign_app_profile_page_type required: false source: $.http.body.campaign_app_profile_page_state type: number - name: dedup_token required: false source: $.http.body.request_id type: number - name: catalog_enabled required: false source: $.http.body.catalog_enabled type: boolean - name: is_advanced_dedicated_campaign required: false source: $.http.body.is_advanced_dedicated_campaign type: boolean - name: disable_skan_campaign required: false source: $.http.body.disable_skan_campaign type: boolean - name: sales_destination required: false source: $.http.body.sales_destination type: number - name: catalog_type required: false source: $.http.body.catalog_type type: number - name: operation_status required: false source: $.http.body.operation_status type: number - name: dc_postback_mode required: false source: $.http.body.postback_window_mode type: number - name: is_promotional_campaign required: false source: $.http.body.is_promotional_campaign type: boolean - name: po_number required: false source: $.http.body.po_number type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id app_campaign_type: $.http.body.app_promotion_type app_id: $.http.body.app_id budget: $.http.body.budget budget_mode: $.http.body.budget_mode budget_optimize_on: $.http.body.budget_optimize_on campaign_app_profile_page_type: $.http.body.campaign_app_profile_page_state catalog_enabled: $.http.body.catalog_enabled catalog_type: $.http.body.catalog_type dc_postback_mode: $.http.body.postback_window_mode dedicate_type: $.http.body.campaign_type dedup_token: $.http.body.request_id disable_skan_campaign: $.http.body.disable_skan_campaign industry_types: $.http.body.special_industries is_advanced_dedicated_campaign: $.http.body.is_advanced_dedicated_campaign is_promotional_campaign: $.http.body.is_promotional_campaign name: $.http.body.campaign_name objective_type: $.http.body.objective_type open_api_partner: $.http.body.open_api_partner operation_status: $.http.body.operation_status opt_status: $.http.body.operation_status po_number: $.http.body.po_number sales_destination: $.http.body.sales_destination response_cookie: [] response_header: [] response_rule: advertiser_id: $.rpc.output.campaign_data.advertiser_id app_id: $.rpc.output.campaign_data.app_id app_promotion_type: $.rpc.output.campaign_data.app_campaign_type bid_align_type: $.rpc.output.campaign_data.bid_align_type budget: $.rpc.output.campaign_data.budget budget_mode: $.rpc.output.campaign_data.budget_mode budget_optimize_on: $.rpc.output.campaign_data.budget_optimize_on campaign_app_profile_page_state: $.rpc.output.campaign_data.campaign_app_profile_page_type campaign_id: $.rpc.output.campaign_data.campaign_id campaign_name: $.rpc.output.campaign_data.name campaign_type: $.rpc.output.campaign_data.dedicate_type catalog_enabled: $.rpc.output.campaign_data.catalog_enabled catalog_type: $.rpc.output.campaign_data.catalog_type create_time: $.rpc.output.campaign_data.create_time disable_skan_campaign: $.rpc.output.campaign_data.disable_skan_campaign is_advanced_dedicated_campaign: $.rpc.output.campaign_data.is_advanced_dedicated_campaign is_promotional_campaign: $.rpc.output.campaign_data.is_promotional_campaign modify_time: $.rpc.output.campaign_data.modify_time objective_type: $.rpc.output.campaign_data.objective_type operation_status: $.rpc.output.campaign_data.operation_status po_number: $.rpc.output.campaign_data.po_number postback_window_mode: $.rpc.output.campaign_data.dc_postback_mode sales_destination: $.rpc.output.campaign_data.sales_destination secondary_status: $.rpc.output.campaign_data.secondary_status smart_plus_adgroup_mode: $.rpc.output.campaign_data.spc_multi_ad_mode special_industries: $.rpc.output.campaign_data.industry_types x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /smart_plus/campaign/get/: get: operationId: Smart_plus Campaign 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: 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: 2 - content: application/json: schema: properties: 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: 1 x-open-source: $.http.query.filtering.campaign_ids campaign_name: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.query.filtering.campaign_name creation_filter_end_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_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: 6 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: 2 x-open-source: $.http.query.filtering.objective_type 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: 1809973489656834 enum_package_name: CampaignPrimaryStatus 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_NOT_DELETE value: no_delete - description: '' is_valid: true key: STATUS_NOT_DELIVERY value: not_delivery key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 4 x-open-source: $.http.query.filtering.primary_status 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: 1836704060612609 enum_package_name: CampaignSecondaryStatus enums: - 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: CAMPAIGN_STATUS_ADVERTISER_AUDIT value: advertiser_audit - description: '' is_valid: true key: CAMPAIGN_STATUS_ADVERTISER_AUDIT_DENY value: advertiser_offline_audit - description: '' is_valid: true key: CAMPAIGN_STATUS_AD_UNAVAILABLE value: tts_no_available_ad - description: '' is_valid: true key: CAMPAIGN_STATUS_ALL value: None - description: '' is_valid: true key: CAMPAIGN_STATUS_AWAITING_RELEASE value: dc_waiting_release - description: '' is_valid: true key: CAMPAIGN_STATUS_BUDGET_EXCEED value: campaign_offline_budget - description: '' is_valid: true key: CAMPAIGN_STATUS_DELETE value: campaign_delete - description: '' is_valid: true key: CAMPAIGN_STATUS_DISABLE value: campaign_disable - description: '' is_valid: true key: CAMPAIGN_STATUS_ENABLE value: campaign_delivery_ok - description: '' is_valid: true key: CAMPAIGN_STATUS_IDENTITY_USED_BY_GMV_MAX_AD value: roi2_mutex_enable - description: '' is_valid: true key: CAMPAIGN_STATUS_IDENTITY_USED_BY_LIVE_GMV_MAX value: roi2_mutex_exclusive - description: '' is_valid: true key: CAMPAIGN_STATUS_LIVE_GMV_MAX_AUTHORIZATION_CANCEL value: roi2_exclusive_cancel - description: '' is_valid: true key: CAMPAIGN_STATUS_NOT_DELETE value: no_delete - description: '' is_valid: true key: CAMPAIGN_STATUS_PRODUCT_GMV_MAX_AUTHORIZATION_CANCEL value: roi2_exclusive_cancel_product - description: '' is_valid: true key: CAMPAIGN_STATUS_PRODUCT_UNAVAILABLE value: tts_product_unavailable - description: '' is_valid: true key: CAMPAIGN_STATUS_PRODUCT_USED_BY_PRODUCT_GMV_MAX value: roi2_mutex_exclusive_product - description: '' is_valid: true key: CAMPAIGN_STATUS_REVIEW_DISAPPROVED value: tts_review_disapproved - description: '' is_valid: true key: CAMPAIGN_STATUS_TIKTOK_SHOP_UNAVAILABLE value: tts_shop_unavailable - description: '' is_valid: true key: CAMPAIGN_STATUS_TTS_TT_ASSET_UNAVAILABLE value: tts_asset_unavailable - description: '' is_valid: true key: CAMPAIGN_STATUS_TTS_TT_IDENTITY_UNAVAILABLE value: tts_identity_unavailable - 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_NOT_DELIVERY value: not_delivery key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 3 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: 3 - 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: 4 - 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: 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 campaign details [Smart Plus Campaign Get] tags: - Campaign Creation x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - children: - type: string is_expand: false name: fields required: false source: $.http.query.fields sub_type: string type: array - children: - children: - type: number is_expand: true 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: campaign_name required: false source: $.http.query.filtering.campaign_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 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 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[][]: - advertiser_id: $.rpc.output.campaign_list[].advertiser_id app_id: $.rpc.output.campaign_list[].app_id app_promotion_type: $.rpc.output.campaign_list[].app_campaign_type bid_align_type: $.rpc.output.campaign_list[].bid_align_type budget: $.rpc.output.campaign_list[].budget budget_mode: $.rpc.output.campaign_list[].budget_mode budget_optimize_on: $.rpc.output.campaign_list[].budget_optimize_on campaign_app_profile_page_state: $.rpc.output.campaign_list[].campaign_app_profile_page_type campaign_id: $.rpc.output.campaign_list[].campaign_id campaign_name: $.rpc.output.campaign_list[].name campaign_type: $.rpc.output.campaign_list[].dedicate_type catalog_enabled: $.rpc.output.campaign_list[].catalog_enabled catalog_type: $.rpc.output.campaign_list[].catalog_type create_time: $.rpc.output.campaign_list[].create_time disable_skan_campaign: $.rpc.output.campaign_list[].disable_skan_campaign is_advanced_dedicated_campaign: $.rpc.output.campaign_list[].is_advanced_dedicated_campaign is_promotional_campaign: $.rpc.output.campaign_list[].is_promotional_campaign modify_time: $.rpc.output.campaign_list[].modify_time objective_type: $.rpc.output.campaign_list[].objective_type operation_status: $.rpc.output.campaign_list[].operation_status po_number: $.rpc.output.campaign_list[].po_number postback_window_mode: $.rpc.output.campaign_list[].dc_postback_mode sales_destination: $.rpc.output.campaign_list[].sales_destination secondary_status: $.rpc.output.campaign_list[].secondary_status smart_plus_adgroup_mode: $.rpc.output.campaign_list[].spc_multi_ad_mode special_industries: $.rpc.output.campaign_list[].industry_types page_info: $.rpc.output.page_info x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /smart_plus/campaign/status/update/: post: operationId: Smart_plus Campaign 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: 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 campaign_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.campaign_ids 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 postback_window_mode: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804193901260801 enum_package_name: DCPostbackMode enums: - description: 暂停或删除Campaign后4天回收quota is_valid: true key: POSTBACK_WINDOW_MODE1 value: '1' - description: 暂停或删除Campaign后13天回收quota is_valid: true key: POSTBACK_WINDOW_MODE2 value: '2' - description: 暂停或删除Campaign后41天回收quota is_valid: true key: POSTBACK_WINDOW_MODE3 value: '3' - description: 暂停或删除Campaign后3天回收quota 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: 4 x-open-source: $.http.body.postback_window_mode required: - advertiser_id - campaign_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 campaign status [Smart Plus Campaign Status Update] tags: - Campaign Creation 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 name: campaign_ids required: true source: $.http.body.campaign_ids sub_type: number type: array - name: operation_status required: true source: $.http.body.operation_status type: number - name: postback_window_mode required: false source: $.http.body.postback_window_mode type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id campaign_ids: $.http.body.campaign_ids operation_status: $.http.body.operation_status postback_window_mode: $.http.body.postback_window_mode response_cookie: [] response_header: [] response_rule: campaign_list[][]: - campaign_id: $.rpc.output.campaign_list[].obj_id postback_window_mode: $.rpc.output.campaign_list[].postback_window_mode status: $.rpc.output.campaign_list[].status error_list[][]: - campaign_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/campaign/update/: post: operationId: Smart_plus Campaign 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: 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 budget: description: '' format: double type: number x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.budget campaign_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.campaign_id campaign_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 po_number: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 required: - advertiser_id - campaign_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 existing campaign [Smart Plus Campaign Update] tags: - Campaign Creation x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.body.advertiser_id type: number - name: campaign_id required: true source: $.http.body.campaign_id type: number - name: name required: false source: $.http.body.campaign_name type: string - name: budget required: false source: $.http.body.budget type: number - name: po_number required: false source: $.http.body.po_number type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id budget: $.http.body.budget campaign_id: $.http.body.campaign_id name: $.http.body.campaign_name po_number: $.http.body.po_number response_cookie: [] response_header: [] response_rule: advertiser_id: $.rpc.output.campaign_data.advertiser_id app_id: $.rpc.output.campaign_data.app_id app_promotion_type: $.rpc.output.campaign_data.app_campaign_type budget: $.rpc.output.campaign_data.budget budget_mode: $.rpc.output.campaign_data.budget_mode budget_optimize_on: $.rpc.output.campaign_data.budget_optimize_on campaign_app_profile_page_state: $.rpc.output.campaign_data.campaign_app_profile_page_type campaign_id: $.rpc.output.campaign_data.campaign_id campaign_name: $.rpc.output.campaign_data.name campaign_type: $.rpc.output.campaign_data.dedicate_type catalog_enabled: $.rpc.output.campaign_data.catalog_enabled catalog_type: $.rpc.output.campaign_data.catalog_type create_time: $.rpc.output.campaign_data.create_time disable_skan_campaign: $.rpc.output.campaign_data.disable_skan_campaign is_advanced_dedicated_campaign: $.rpc.output.campaign_data.is_advanced_dedicated_campaign is_promotional_campaign: $.rpc.output.campaign_data.is_promotional_campaign modify_time: $.rpc.output.campaign_data.modify_time objective_type: $.rpc.output.campaign_data.objective_type operation_status: $.rpc.output.campaign_data.operation_status po_number: $.rpc.output.campaign_data.po_number postback_window_mode: $.rpc.output.campaign_data.dc_postback_mode sales_destination: $.rpc.output.campaign_data.sales_destination secondary_status: $.rpc.output.campaign_data.secondary_status smart_plus_adgroup_mode: $.rpc.output.campaign_data.spc_multi_ad_mode special_industries: $.rpc.output.campaign_data.industry_types 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