openapi: 3.0.1 info: title: TikTok API for Business — Marketing 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 tags: - name: APP Management - name: Account Management - name: Ad - name: Adgroup - name: Ads Management - name: Audience - name: Automated_Rules - name: BC - name: Campaign Creation - name: Catalog - name: Comments - name: Creative Management - name: Identity - name: Measurement - name: Reporting - name: Store - name: Tool - name: Video - name: catalog paths: /adgroup/quota/: get: operationId: Adgroup Quota parameters: - description: Advertiser ID. in: query name: advertiser_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.advertiser_id x-open-field-id: 1 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get the dynamic quota [Adgroup Quota](https://ads.tiktok.com/marketing_api/docs?id=1768463039162369) tags: - Ads Management x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id response_cookie: [] response_header: [] response_rule: total_adgroup_quota: $.rpc.output.total_adgroup_quota used_adgroup_quota: $.rpc.output.used_adgroup_quota x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /advertiser/info/: get: operationId: Advertiser Info parameters: - content: application/json: schema: items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.advertiser_ids description: '' in: query name: advertiser_ids required: true x-open-field-id: 1 - content: application/json: schema: items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: 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 - 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get ad account details. [Advertiser Info](https://business-api.tiktok.com/portal/docs?id=1739593083610113) tags: - Account Management x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - children: - type: string name: advertiser_ids required: true source: $.http.query.advertiser_ids sub_type: string type: array - children: - type: string name: fields required: false source: $.http.query.fields sub_type: string type: array - 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 name: context_info required: true source: $.http.query.context_info type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_ids: $.http.query.advertiser_ids context_info: $.http.query.context_info fields: $.http.query.fields response_cookie: [] response_header: [] response_rule: list: $.rpc.output.advertiser_info_list x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /advertiser/update/: post: operationId: Advertiser 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: address: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 17 x-open-source: $.http.body.address advertiser_budgets: description: '' items: nullable: false properties: advertiser_id: description: '' format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.advertiser_budgets[].advertiser_id budget: description: '' format: double nullable: false type: number x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.advertiser_budgets[].budget budget_mode: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800785014543361 enum_package_name: AccountBudgetMode enums: - description: '' is_valid: true key: CUSTOM_BUDGET value: '5' - description: '' is_valid: true key: DAILY_BUDGET value: '1' - description: '' is_valid: true key: MONTHLY_BUDGET value: '3' - description: '' is_valid: true key: UNLIMITED value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 2 x-open-source: $.http.body.advertiser_budgets[].budget_mode type: object x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 16 x-open-source: $.http.body.advertiser_budgets advertiser_id: description: '' nullable: false 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 advertiser_name: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.advertiser_name bc_id: description: '' format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 13 x-open-source: $.http.body.bc_id budget_update_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 15 x-open-source: $.http.body.budget_update_type child_bc_id: description: '' format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 14 x-open-source: $.http.body.child_bc_id company: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.company contact_email: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.body.contact_email contact_name: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.contact_name contact_number: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.body.contact_number license_image_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 9 x-open-source: $.http.body.license_image_id license_no: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 8 x-open-source: $.http.body.license_no need_submit_certificate: description: '' nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 12 x-open-source: $.http.body.need_submit_certificate promotion_link: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 x-open-source: $.http.body.promotion_link qualification_images: description: '' items: nullable: false properties: image_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.qualification_images[].image_id type: object x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 10 x-open-source: $.http.body.qualification_images tax_map: additionalProperties: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false description: '' nullable: false type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 11 x-open-source: $.http.body.tax_map 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Update an ad account. [Advertiser Update](https://business-api.tiktok.com/portal/docs?id=1739939050770434) tags: - Account Management 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: false source: $.http.body.advertiser_id type: number - name: advertiser_name required: false source: $.http.body.advertiser_name type: string - name: company required: false source: $.http.body.company type: string - name: contact_name required: false source: $.http.body.contact_name type: string - name: contact_email required: false source: $.http.body.contact_email type: string - name: contact_number required: false source: $.http.body.contact_number type: string - name: promotion_link required: false source: $.http.body.promotion_link type: string - name: license_no required: false source: $.http.body.license_no type: string - name: license_image_id required: false source: $.http.body.license_image_id type: string - children: - children: - name: image_id required: false source: $.http.body.qualification_images[].image_id type: string type: object name: qualification_images required: false source: $.http.body.qualification_images sub_type: object type: array - children: - type: string name: tax_map required: false source: $.http.body.tax_map sub_type: string type: dict - name: need_submit_certificate required: false source: $.http.body.need_submit_certificate type: boolean - name: bc_id required: false source: $.http.body.bc_id type: number - name: child_bc_id required: false source: $.http.body.child_bc_id type: number - name: budget_update_type required: false source: $.http.body.budget_update_type type: string - children: - children: - name: advertiser_id required: false source: $.http.body.advertiser_budgets[].advertiser_id type: number - name: budget_mode required: false source: $.http.body.advertiser_budgets[].budget_mode type: number - name: budget required: false source: $.http.body.advertiser_budgets[].budget type: number type: object name: advertiser_budgets required: false source: $.http.body.advertiser_budgets sub_type: object type: array - name: address required: false source: $.http.body.address type: string - 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: context_info required: true source: $.http.body.context_info type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: address: $.http.body.address advertiser_budgets: $.http.body.advertiser_budgets advertiser_id: $.http.body.advertiser_id advertiser_name: $.http.body.advertiser_name bc_id: $.http.body.bc_id budget_update_type: $.http.body.budget_update_type child_bc_id: $.http.body.child_bc_id company: $.http.body.company contact_email: $.http.body.contact_email contact_name: $.http.body.contact_name contact_number: $.http.body.contact_number context_info: $.http.body.context_info license_image_id: $.http.body.license_image_id license_no: $.http.body.license_no need_submit_certificate: $.http.body.need_submit_certificate promotion_link: $.http.body.promotion_link qualification_images: $.http.body.qualification_images tax_map: $.http.body.tax_map response_cookie: [] response_header: [] response_rule: advertiser_list: $.rpc.output.advertiser_list x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /app/create/: post: operationId: App 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: '' nullable: false 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.AdvertiserId download_url: description: '' format: url nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.DownloadUrl enable_retargeting: default: NON_RETARGETING description: '' nullable: false 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: RETARGETING value: '1' - description: '' is_valid: true key: NON_RETARGETING value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 5 x-open-source: $.http.body.RetargetingState partner: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1816188710840322 enum_package_name: partnerForAppCreate enums: - description: '' is_valid: true key: AdBrix value: '14' - description: '' is_valid: true key: Adform value: '23' - description: '' is_valid: true key: Adjust value: '2' - description: '' is_valid: true key: Adzcore value: '7' - description: '' is_valid: true key: AppAdforce value: '5' - description: '' is_valid: true key: AppLink value: '13' - description: '' is_valid: true key: AppMetrica value: '20' - description: '' is_valid: true key: AppsFlyer value: '1' - description: '' is_valid: true key: BASE value: '48' - description: '' is_valid: true key: BigCommerce value: '36' - description: '' is_valid: true key: Cafe24 value: '47' - description: '' is_valid: true key: Cinarra value: '31' - description: '' is_valid: true key: Dentsu value: '21' - description: '' is_valid: true key: DoubleClick value: '10' - description: '' is_valid: true key: ECWID value: '37' - description: '' is_valid: true key: FlashTalking value: '12' - description: '' is_valid: true key: Huangbaoche value: '15' - description: '' is_valid: true key: Kantar value: '30' - description: '' is_valid: true key: Kochava value: '4' - description: '' is_valid: true key: Lazada value: '16' - description: '' is_valid: true key: LeadBolt value: '17' - description: '' is_valid: true key: Macromil value: '27' - description: '' is_valid: true key: Magento value: '40' - description: '' is_valid: true key: Metaps value: '18' - description: '' is_valid: true key: Nielsen value: '25' - description: '' is_valid: true key: OpenCart value: '45' - description: '' is_valid: true key: Other value: '9' - description: '' is_valid: true key: Placed_powered_by_Foursquare value: '26' - description: '' is_valid: true key: PrestaShop value: '38' - description: '' is_valid: true key: SHOPLINE value: '46' - description: '' is_valid: true key: Salesforce value: '44' - description: '' is_valid: true key: ServingsSys value: '11' - description: '' is_valid: true key: Shopify value: '34' - description: '' is_valid: true key: Singular value: '6' - description: '' is_valid: true key: Square value: '35' - description: '' is_valid: true key: Tenjin value: '8' - description: '' is_valid: true key: Testee value: '28' - description: '' is_valid: true key: TikTokCustomInstantPage value: '41' - description: '' is_valid: true key: TikTokEC1PSeller value: '42' - description: '' is_valid: true key: TikTokEC3PStore value: '43' - description: '' is_valid: true key: TikTokLeadAd value: '33' - description: '' is_valid: true key: TlnkIo value: '3' - description: '' is_valid: true key: Vidoadsplus value: '19' - description: '' is_valid: true key: Weborama value: '29' - description: '' is_valid: true key: WooCommerce value: '39' - description: '' is_valid: true key: doubleverify value: '24' - description: '' is_valid: true key: myTracker value: '22' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 4 x-open-source: $.http.body.PartnerId tracking_url: description: '' nullable: false properties: click_url: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.Tracking.ClickUrl impression_url: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.Tracking.ImpressionUrl retargeting_click_url: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.Tracking.RetargetingClickUrl retargeting_impression_url: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.Tracking.RetargetingImpressionUrl type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.Tracking required: - advertiser_id - download_url 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Create an app. [APP Create](https://business-api.tiktok.com/portal/docs?id=1740859280958466) tags: - APP Management x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: AdvertiserId required: true source: $.http.body.advertiser_id type: number - name: DownloadUrl required: true source: $.http.body.download_url type: string - children: - name: ClickUrl required: false source: $.http.body.tracking_url.click_url type: string - name: ImpressionUrl required: false source: $.http.body.tracking_url.impression_url type: string - name: RetargetingClickUrl required: false source: $.http.body.tracking_url.retargeting_click_url type: string - name: RetargetingImpressionUrl required: false source: $.http.body.tracking_url.retargeting_impression_url type: string is_expand: true name: Tracking required: false type: object - name: PartnerId required: false source: $.http.body.partner type: number - name: RetargetingState required: false source: $.http.body.enable_retargeting type: number - name: CoreUserId required: false source: $.context.core_user_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: AdvertiserId: $.http.body.advertiser_id CoreUserId: $.context.core_user_id DownloadUrl: $.http.body.download_url PartnerId: $.http.body.partner RetargetingState: $.http.body.enable_retargeting Tracking: ClickUrl: $.http.body.tracking_url.click_url ImpressionUrl: $.http.body.tracking_url.impression_url RetargetingClickUrl: $.http.body.tracking_url.retargeting_click_url RetargetingImpressionUrl: $.http.body.tracking_url.retargeting_impression_url response_cookie: [] response_header: [] response_rule: app_id: $.rpc.output.id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /app/info/: get: operationId: App Info parameters: - description: '' in: query name: advertiser_id required: true schema: nullable: false 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: app_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.app_id x-open-field-id: 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get info of an app. [APP Info](https://business-api.tiktok.com/portal/docs?id=1740859272887297) tags: - APP Management 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: app_id required: true source: $.http.query.app_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id app_id: $.http.query.app_id response_cookie: [] response_header: [] response_rule: app: $.rpc.output.app x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /app/list/: get: operationId: App List parameters: - description: Advertiser ID. in: query name: advertiser_id required: true schema: nullable: false 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: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.app_platform_ids description: List of app platform ID for filter purpose. in: query name: app_platform_ids required: false x-open-field-id: 2 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get the app list. [APP List](https://business-api.tiktok.com/portal/docs?id=1740859313270786) tags: - APP Management x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - children: - type: string is_expand: true name: app_platform_ids required: true source: $.http.query.app_platform_ids[] sub_type: string type: array plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id app_platform_ids: $.http.query.app_platform_ids[] response_cookie: [] response_header: [] response_rule: apps: $.rpc.output.apps x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /app/optimization_event/: get: operationId: App Optimization_event parameters: - description: Your App ID, obtained after successfully creating your app. in: query name: app_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.app_id x-open-field-id: 1 - description: Advertiser ID in: query name: advertiser_id required: true schema: nullable: false 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 - content: application/json: schema: items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: null enum_package_name: InventoryFlow enums: - description: '' is_valid: true key: PLACEMENT_TOPBUZZ value: '1000' - description: '' is_valid: true key: PLACEMENT_VIGO value: '2000' - description: '' is_valid: true key: PLACEMENT_TIKTOK value: '3000' - description: '' is_valid: true key: PLACEMENT_HELO value: '4000' - description: '' is_valid: true key: PLACEMENT_PANGLE value: '9000' - description: '' is_valid: true key: PLACEMENT_GLOBAL_APP_BUNDLE value: '1000' key_format: string strict: true use_part: false validate_only: false value_format: int32 minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.placement description: 'The apps where you want to deliver your ads. Required when placement_type is PLACEMENT_TYPE_NORMAL, and ignored when placement_type is PLACEMENT_TYPE_AUTOMATIC. Note: Currently, we support PLACEMENT_TIKTOK, PLACEMENT_PANGLE and PLACEMENT_GLOBAL_APP_BUNDLE. Please don''t select PLACEMENT_TOPBUZZ or PLACEMENT_HELO as your placements since they''ve been deprecated. For a full list of enum values, see Enumeration - Placement. For Product Sales campaigns (objective_type = PRODUCT_SALES), only TikTok placement (PLACEMENT_TIKTOK) is supported.' in: query name: placement required: false x-open-field-id: 3 - description: '版位类型。 枚举值：PLACEMENT_TYPE_AUTOMATIC（自动版位）,PLACEMENT_TYPE_NORMAL （编辑版位）。 默认值: PLACEMENT_TYPE_NORMAL。' in: query name: placement_type required: false schema: nullable: false 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: PLACEMENT_TYPE_NORMAL value: '1' - description: '' is_valid: true key: PLACEMENT_TYPE_AUTOMATIC value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.placement_type x-open-field-id: 4 - description: Optimization goal. For enum values, see Enumeration-Optimization Goal for more in: query name: optimization_goal required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int32(%s) x-open-enum: enum_package_expired: false enum_package_id: 1804193306612737 enum_package_name: OptimizeGoal enums: - description: '' is_valid: true key: ANCHOR_CLICK value: '112' - description: '' is_valid: true key: ANCHOR_CLICK_PURCHASE value: '117' - description: '' is_valid: true key: AUTOMATED_VALUE value: '125' - description: '' is_valid: true key: CLICK value: '101' - description: '' is_valid: true key: CONVERSATION value: '124' - description: '' is_valid: true key: CONVERSION_LEADS value: '121' - description: '' is_valid: true key: CONVERT value: '100' - description: '' is_valid: true key: DESTINATION_VISIT value: '123' - description: '' is_valid: true key: ENGAGED_VIEW value: '118' - description: '' is_valid: true key: ENGAGED_VIEW_FIFTEEM value: '120' - description: '' is_valid: true key: FOLLOWERS value: '108' - description: '' is_valid: true key: INSTALL value: '105' - description: '' is_valid: true key: IN_APP_EVENT value: '106' - description: '' is_valid: true key: LEAD_GENERATION value: '107' - description: '' is_valid: true key: MESSAGE value: '119' - description: '' is_valid: true key: MT_LIVE_FOLLOW value: '126' - description: '' is_valid: true key: MT_LIVE_ROOM value: '113' - description: '' is_valid: true key: MT_LIVE_SHOPPING value: '116' - description: '' is_valid: true key: PAGE_VISIT value: '122' - description: '' is_valid: true key: POST_ENGAGEMNT value: '110' - description: '' is_valid: true key: PREFERRED_LEAD value: '127' - description: '' is_valid: true key: PRODUCT_CLICK_IN_LIVE value: '114' - description: '' is_valid: true key: PROFILE_VIEWS value: '109' - description: '' is_valid: true key: REACH value: '103' - description: '' is_valid: true key: SHOW value: '102' - description: '' is_valid: true key: TRAFFIC_LANDING_PAGE_VIEW value: '115' - description: '' is_valid: true key: VALUE value: '111' - description: '' is_valid: true key: VIDEO_VIEW value: '104' key_format: string strict: true use_part: false validate_only: false value_format: int64 x-open-source: $.http.query.optimization_goal x-open-field-id: 5 - description: Advertising Objective. For enum values, see Enumeration-Advertising Objective in: query name: objective required: false schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: null enum_package_name: CampaignObjectiveType enums: - description: '' is_valid: true key: NONE_TYPE value: '0' - description: '' is_valid: true key: TRAFFIC value: '1' - description: '' is_valid: true key: APP_INSTALL value: '2' - description: '' is_valid: true key: CONVERSIONS value: '3' - description: '' is_valid: true key: VIDEO_VIEW value: '4' - description: '' is_valid: true key: REACH value: '5' - description: '' is_valid: true key: CATALOG_SALES value: '6' - description: '' is_valid: true key: LEAD_GENERATION value: '8' - description: '' is_valid: true key: ENGAGEMENT value: '9' - description: '' is_valid: true key: RF_REACH value: '7' - description: '' is_valid: true key: RF_VIDEO_VIEW value: '10' - description: '' is_valid: true key: RF_TRAFFIC value: '11' - description: '' is_valid: true key: RF_ENGAGEMENT value: '12' - description: '' is_valid: true key: RF_APP_INSTALL value: '13' - description: '' is_valid: true key: PRODUCT_SALES value: '15' - description: '' is_valid: true key: APP_PROMOTION value: '16' - description: '' is_valid: true key: WEB_CONVERSIONS value: '3' - description: '' is_valid: true key: TOPVIEW_REACH value: '50' - description: '' is_valid: true key: EST_AD value: '51' - description: '' is_valid: true key: SS_HTC_AD value: '52' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.objective x-open-field-id: 6 - description: 'Whether to return only available conversion events. The default value: True (only return available conversion events)' in: query name: available_only required: false schema: nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.available_only x-open-field-id: 7 - description: Whether the app is using Skan features. in: query name: is_skan required: false schema: nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.is_skan x-open-field-id: 8 - description: 'App promotion type. Required when objective_type is APP_PROMOTION. Enum values: APP_INSTALL, APP_RETARGETING. Note: APP_INSTALL can be used in an iOS14 Dedicated Campaign, while APP_RETARGETING cannot be used.' in: query name: app_promotion_type required: false schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1799795397435394 enum_package_name: AppCampaignType enums: - description: '' is_valid: true key: APP_INSTALL value: '1' - description: '' is_valid: true key: APP_PREREGISTRATION value: '3' - description: '' is_valid: true key: APP_RETARGETING value: '2' - description: '' is_valid: true key: UNSET value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.app_promotion_type x-open-field-id: 9 - description: 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get App Conversion Events. [App Optimization Event](https://business-api.tiktok.com/portal/docs?id=1740859338750977) tags: - APP Management x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: app_id required: true source: $.http.query.app_id type: number - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - children: - type: number is_expand: true name: placement required: false source: $.http.query.placement[] sub_type: number type: array - name: placement_type required: false source: $.http.query.placement_type type: number - name: optimization_goal required: true source: $.http.query.optimization_goal type: number - name: objective required: false source: $.http.query.objective type: number - name: available_only required: false source: $.http.query.available_only type: boolean - name: is_skan required: false source: $.http.query.is_skan type: boolean - name: app_promotion_type required: false source: $.http.query.app_promotion_type type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id app_id: $.http.query.app_id app_promotion_type: $.http.query.app_promotion_type available_only: $.http.query.available_only is_skan: $.http.query.is_skan objective: $.http.query.objective optimization_goal: $.http.query.optimization_goal placement: $.http.query.placement[] placement_type: $.http.query.placement_type response_cookie: [] response_header: [] response_rule: optimization_events: $.rpc.output.optimization_events x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /app/optimization_event/retargeting/: get: operationId: App Optimization_event Retargeting parameters: - description: '' in: query name: app_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.id x-open-field-id: 1 - description: '' in: query name: advertiser_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.AdvertiserId x-open-field-id: 2 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get App Retargeting Events. [App Optimization Event Retargeting](https://business-api.tiktok.com/portal/docs?id=1740859371033601) tags: - APP Management x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: id required: true source: $.http.query.app_id type: number - name: AdvertiserId required: true source: $.http.query.advertiser_id type: number plugins: after_response: - Plugin_GetEnumValueFromObj_4615312: - description: test - request_params: - $.rpc.output - result_params: - $.resp - version: 6304383dbb125fa7bc457bef7ec2d259 before_request: [] request_query_rule: null request_rule: AdvertiserId: $.http.query.advertiser_id id: $.http.query.app_id response_cookie: [] response_header: [] response_rule: optimization_events: $.resp x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /app/update/: post: operationId: App 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: '' nullable: false 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 app_id: description: '' nullable: false 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.app_id download_url: description: '' format: url nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.download_url enable_retargeting: default: NON_RETARGETING description: '' nullable: false 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: RETARGETING value: '1' - description: '' is_valid: true key: NON_RETARGETING value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 5 x-open-source: $.http.body.enable_retargeting partner: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1805946629089281 enum_package_name: MeteorConstPartner enums: - description: '' is_valid: true key: AdBrix value: '14' - description: '' is_valid: true key: Adform value: '23' - description: '' is_valid: true key: Adjust value: '2' - description: '' is_valid: true key: Adobe value: '85' - description: '' is_valid: true key: AdobeRTCDP value: '132' - description: '' is_valid: true key: Adzcore value: '7' - description: '' is_valid: true key: Amperity value: '80' - description: '' is_valid: true key: AnyTrack value: '79' - description: '' is_valid: true key: AppAdforce value: '5' - description: '' is_valid: true key: AppLink value: '13' - description: '' is_valid: true key: AppMetrica value: '20' - description: '' is_valid: true key: AppsFlyer value: '1' - description: '' is_valid: true key: Apptrian value: '110' - description: TTOP is_valid: true key: Ayomakan value: '113' - description: '' is_valid: true key: BASE value: '48' - description: '' is_valid: true key: BigCommerce value: '36' - description: ctm is_valid: true key: Bird value: '126' - description: ctm is_valid: true key: Blip value: '116' - description: '' is_valid: true key: Blotout value: '76' - description: '' is_valid: true key: CTMDefault value: '100' - description: '' is_valid: true key: Cafe24 value: '47' - description: '' is_valid: true key: Capico value: '129' - description: '' is_valid: true key: Chatcone value: '108' - description: '' is_valid: true key: Cheq value: '98' - description: '' is_valid: true key: Cinarra value: '31' - description: '' is_valid: true key: CommandersAct value: '106' - description: '' is_valid: true key: ConversionLiftStudy value: '96' - description: '' is_valid: true key: DataHash value: '88' - description: '' is_valid: true key: Dentsu value: '21' - description: '' is_valid: true key: Desty value: '97' - description: '' is_valid: true key: DoubleClick value: '10' - description: '' is_valid: true key: Driftrock value: '109' - description: '' is_valid: true key: ECWID value: '37' - description: '' is_valid: true key: ECWID_RESELLER value: '57' - description: '' is_valid: true key: Elevar value: '78' - description: TTOP is_valid: true key: Eventbrite value: '114' - description: '' is_valid: true key: EventsAPIGateway value: '131' - description: '' is_valid: true key: Fandango value: '81' - description: '' is_valid: true key: FlashTalking value: '12' - description: '' is_valid: true key: FutureShop value: '73' - description: '' is_valid: true key: Gamesight value: '72' - description: '' is_valid: true key: GoogleSheet value: '94' - description: '' is_valid: true key: GoogleTagManagerClient value: '105' - description: '' is_valid: true key: GoogleTagManagerServer value: '75' - description: '' is_valid: true key: Grivy value: '67' - description: '' is_valid: true key: Habu value: '70' - description: ctm is_valid: true key: Halosis value: '118' - description: '' is_valid: true key: Haravan value: '64' - description: ctm is_valid: true key: HiPlatform value: '124' - description: '' is_valid: true key: Hightouch value: '66' - description: '' is_valid: true key: Huangbaoche value: '15' - description: '' is_valid: true key: HubSpot value: '92' - description: '' is_valid: true key: Journify value: '122' - description: '' is_valid: true key: Kantar value: '30' - description: '' is_valid: true key: Kargo value: '71' - description: '' is_valid: true key: Kochava value: '4' - description: TTOP is_valid: true key: KopiKenangan value: '111' - description: '' is_valid: true key: Kyte value: '58' - description: '' is_valid: true key: LadiPage value: '102' - description: '' is_valid: true key: Lazada value: '16' - description: '' is_valid: true key: LeadBolt value: '17' - description: '' is_valid: true key: LeadCenterCSV value: '87' - description: '' is_valid: true key: Lifesight value: '89' - description: '' is_valid: true key: LiveRamp value: '61' - description: '' is_valid: true key: MParticle value: '65' - description: '' is_valid: true key: Macromil value: '27' - description: '' is_valid: true key: Magento value: '40' - description: ctm is_valid: true key: ManyChat value: '121' - description: '' is_valid: true key: Marketo value: '93' - description: '' is_valid: true key: MercadoShops value: '82' - description: '' is_valid: true key: Merkle value: '83' - description: '' is_valid: true key: MetaRouter value: '77' - description: '' is_valid: true key: Metaps value: '18' - description: '' is_valid: true key: Nielsen value: '25' - description: 'Notice: ECWID_RESELLER is different from ECWID' is_valid: true key: Nuvemshop value: '56' - description: ctm is_valid: true key: OhoChat value: '115' - description: ctm is_valid: true key: OneChatAi value: '123' - description: '' is_valid: true key: OpenCart value: '45' - description: '' is_valid: true key: Other value: '9' - description: '' is_valid: true key: PMG value: '128' - description: '' is_valid: true key: Pancake value: '101' - description: '' is_valid: true key: Placed_powered_by_Foursquare value: '26' - description: '' is_valid: true key: PrestaShop value: '38' - description: '' is_valid: true key: Qiscus value: '103' - description: '' is_valid: true key: Qontak value: '104' - description: ctm is_valid: true key: RespondIo value: '117' - description: '' is_valid: true key: RudderStack value: '69' - description: '' is_valid: true key: SHOPLINE value: '46' - description: '' is_valid: true key: Salesforce value: '50' - description: '' is_valid: true key: SalesforceMarketingCloud value: '95' - description: ctm is_valid: true key: Sapo value: '120' - description: '' is_valid: true key: Segment value: '59' - description: '' is_valid: true key: ServingsSys value: '11' - description: '' is_valid: true key: Shift4Shop value: '62' - description: '' is_valid: true key: Shopify value: '34' - description: '' is_valid: true key: Shoplazza value: '90' - description: '' is_valid: true key: Shopware value: '54' - description: '' is_valid: true key: SignalSight value: '84' - description: '' is_valid: true key: Singoo value: '99' - description: ctm is_valid: true key: SingooCloud value: '127' - description: '' is_valid: true key: Singular value: '6' - description: '' is_valid: true key: Square value: '35' - description: '' is_valid: true key: Tealium value: '60' - description: '' is_valid: true key: Tenjin value: '8' - description: '' is_valid: true key: Testee value: '28' - description: '' is_valid: true key: Ticketmaster value: '68' - description: '' is_valid: true key: Tiendanube value: '74' - description: '' is_valid: true key: TikTokAppAPI value: '49' - description: '' is_valid: true key: TikTokBusinessSDK value: '44' - description: '' is_valid: true key: TikTokCustomInstantPage value: '41' - description: '' is_valid: true key: TikTokEC1PSeller value: '42' - description: '' is_valid: true key: TikTokEC3PStore value: '43' - description: '' is_valid: true key: TikTokLeadAd value: '33' - description: '' is_valid: true key: TlnkIo value: '3' - description: TTOP is_valid: true key: TomoroCoffee value: '112' - description: '' is_valid: true key: Tray value: '53' - description: '' is_valid: true key: TripleWhale value: '130' - description: '' is_valid: true key: VTEX value: '55' - description: '' is_valid: true key: Vidoadsplus value: '19' - description: '' is_valid: true key: Weborama value: '29' - description: '' is_valid: true key: Wix value: '51' - description: '' is_valid: true key: WooCommerce value: '39' - description: '' is_valid: true key: WordPress value: '125' - description: '' is_valid: true key: ZZG value: '63' - description: '' is_valid: true key: Zapier value: '91' - description: for lead crm is_valid: true key: Zoho value: '86' - description: '' is_valid: true key: Zwiz value: '107' - description: '' is_valid: true key: doubleverify value: '24' - description: '' is_valid: true key: lojaintegrada value: '52' - description: '' is_valid: true key: myTracker value: '22' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 7 x-open-source: $.http.body.partner platform: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804229743233025 enum_package_name: 'AudiencePlatformType ' enums: - description: '' is_valid: true key: ANDROID value: '1' - description: '' is_valid: true key: IOS value: '2' - description: '' is_valid: true key: PC value: '16' - description: '' is_valid: true key: UNKNOWN value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 3 x-open-source: $.http.body.platform tracking_url: description: '' nullable: false properties: click_url: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.tracking_url.click_url impression_url: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.tracking_url.impression_url retargeting_click_url: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.tracking_url.retargeting_click_url retargeting_impression_url: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.tracking_url.retargeting_impression_url type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.body.tracking_url required: - app_id - advertiser_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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Update an app. [APP Update](https://business-api.tiktok.com/portal/docs?id=1740859300069378) tags: - APP Management x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: app_id required: true source: $.http.body.app_id type: number - name: advertiser_id required: true source: $.http.body.advertiser_id type: number - name: platform required: false source: $.http.body.platform type: number - name: download_url required: false source: $.http.body.download_url type: string - name: enable_retargeting required: false source: $.http.body.enable_retargeting type: number - children: - name: click_url required: false source: $.http.body.tracking_url.click_url type: string - name: impression_url required: false source: $.http.body.tracking_url.impression_url type: string - name: retargeting_click_url required: false source: $.http.body.tracking_url.retargeting_click_url type: string - name: retargeting_impression_url required: false source: $.http.body.tracking_url.retargeting_impression_url type: string is_expand: true name: tracking_url required: false source: $.http.body.tracking_url type: object - name: partner required: false source: $.http.body.partner type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id app_id: $.http.body.app_id download_url: $.http.body.download_url enable_retargeting: $.http.body.enable_retargeting partner: $.http.body.partner platform: $.http.body.platform tracking_url: $.http.body.tracking_url response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /audience/insight/overlap/: get: operationId: Audience Insight Overlap parameters: - description: '' in: query name: advertiser_id required: true schema: nullable: false 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: benchmark_custom_audience_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.benchmark_custom_audience_id x-open-field-id: 2 - description: '' in: query name: comparison_custom_audience_ids required: false schema: items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) maxItems: 4 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.comparison_custom_audience_ids 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get details of audience overlap. [Audience Insight Overlap](https://business-api.tiktok.com/portal/docs?id=1797023590780930) tags: - Audience 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: benchmark_custom_audience_id required: true source: $.http.query.benchmark_custom_audience_id type: number - children: - type: number is_expand: true name: comparison_custom_audience_ids required: false source: $.http.query.comparison_custom_audience_ids sub_type: number type: array - children: - name: core_user_id required: false source: $.http.query.context_info.core_user_id type: number is_expand: true 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 benchmark_custom_audience_id: $.http.query.benchmark_custom_audience_id comparison_custom_audience_ids: $.http.query.comparison_custom_audience_ids context_info: $.http.query.context_info response_cookie: [] response_header: [] response_rule: benchmark_audience: $.rpc.output.benchmark_audience comparison_audiences: $.rpc.output.comparison_audiences x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /bc/account/transaction/get/: get: operationId: Bc Account Transaction Get parameters: - description: '' in: query name: bc_id required: false schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.bc_id x-open-field-id: 1 - description: '' in: query name: child_bc_id required: false schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.child_bc_id x-open-field-id: 2 - description: '' in: query name: transaction_level required: false schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1807919387053057 enum_package_name: TransactionLevel enums: - description: '' is_valid: true key: ADVERTISER value: '2' - description: '' is_valid: true key: BC value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.transaction_level x-open-field-id: 3 - content: application/json: schema: nullable: false properties: account_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 account_name: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 billing_types: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 end_time: description: '' format: datetime nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 owner_of_account: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 start_time: description: '' format: datetime nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 transaction_types: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 type: object x-open-allow-strlist: false x-open-allow-strnum: false description: '' in: query name: filtering required: false x-open-field-id: 4 - description: '' in: query name: page required: false schema: default: 1 format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page x-open-field-id: 5 - description: '' in: query name: page_size required: false schema: default: 10 format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page_size 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get the transaction records of a BC or ad accounts. [BC Account Transaction Get](https://business-api.tiktok.com/portal/docs?id=1792849810925569) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: false source: $.http.query.bc_id type: number - name: child_bc_id required: false source: $.http.query.child_bc_id type: number - name: transaction_level required: false source: $.http.query.transaction_level type: number - children: - type: string is_expand: true name: transaction_types required: false source: $.http.query.filtering.transaction_types[] sub_type: string type: array - children: - type: string is_expand: true name: owner_of_account required: false source: $.http.query.filtering.owner_of_account[] sub_type: string type: array - children: - type: number is_expand: true name: account_ids required: false source: $.http.query.filtering.account_ids[] sub_type: number type: array - name: account_name required: false source: $.http.query.filtering.account_name type: string - children: - type: string is_expand: true name: billing_types required: false source: $.http.query.filtering.billing_types[] sub_type: string type: array - name: start_time required: false source: $.http.query.filtering.start_time type: string - name: end_time required: false source: $.http.query.filtering.end_time type: string - name: page required: false source: $.http.query.page type: number - name: page_size required: false source: $.http.query.page_size type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: account_ids: $.http.query.filtering.account_ids[] account_name: $.http.query.filtering.account_name bc_id: $.http.query.bc_id billing_types: $.http.query.filtering.billing_types[] child_bc_id: $.http.query.child_bc_id end_time: $.http.query.filtering.end_time owner_of_account: $.http.query.filtering.owner_of_account[] page: $.http.query.page page_size: $.http.query.page_size start_time: $.http.query.filtering.start_time transaction_level: $.http.query.transaction_level transaction_types: $.http.query.filtering.transaction_types[] response_cookie: [] response_header: [] response_rule: page_info: $.rpc.output.page_info transaction_list: $.rpc.output.transaction_list x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/asset/admin/delete/: post: operationId: Bc Asset Admin 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: asset_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.asset_ids asset_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803356502782978 enum_package_name: BCAsset enums: - description: '' is_valid: true key: ADVERTISER value: '1' - description: '' is_valid: true key: CATALOG value: '4' - description: '' is_valid: true key: DOMAIN value: '6' - description: '' is_valid: true key: LEAD value: '9' - description: '' is_valid: true key: PIXEL value: '3' - description: '' is_valid: true key: STOREFRONT value: '5' - description: '' is_valid: true key: TIKTOK_SHOP value: '10' - description: '' is_valid: true key: TT_ACCOUNT value: '8' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 3 x-open-source: $.http.body.asset_type bc_id: description: '' nullable: false 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.bc_id child_bc_id: description: '' nullable: false 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.child_bc_id required: - bc_id - asset_type - asset_ids type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Delete assets. [BC Asset Admin Delete](https://business-api.tiktok.com/portal/docs?id=1739657251102722) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: child_bc_id required: false source: $.http.body.child_bc_id type: number - name: asset_type required: true source: $.http.body.asset_type type: number - children: - type: number name: asset_ids required: false source: $.http.body.asset_ids sub_type: number type: array plugins: after_response: [] before_request: [] request_query_rule: null request_rule: asset_ids: $.http.body.asset_ids asset_type: $.http.body.asset_type bc_id: $.http.body.bc_id child_bc_id: $.http.body.child_bc_id response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/asset/admin/get/: get: operationId: Bc Asset Admin Get parameters: - description: '' in: query name: bc_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.bc_id x-open-field-id: 1 - description: '' in: query name: child_bc_id required: false schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.child_bc_id x-open-field-id: 2 - description: '' in: query name: asset_type required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803356502782978 enum_package_name: BCAsset enums: - description: '' is_valid: true key: ADVERTISER value: '1' - description: '' is_valid: true key: CATALOG value: '4' - description: '' is_valid: false key: DOMAIN value: '6' - description: '' is_valid: true key: LEAD value: '9' - description: '' is_valid: true key: PIXEL value: '3' - description: '' is_valid: true key: STOREFRONT value: '5' - description: '' is_valid: true key: TIKTOK_SHOP value: '10' - description: '' is_valid: true key: TT_ACCOUNT value: '8' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-source: $.http.query.asset_type x-open-field-id: 3 - content: application/json: schema: nullable: false properties: advertiser_show_status: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800605795462145 enum_package_name: ShowAccountStatus enums: - description: '' is_valid: true key: SHOW_ACCOUNT_STATUS_APPROVED value: '2' - description: '' is_valid: true key: SHOW_ACCOUNT_STATUS_IN_REVIEW value: '3' - description: '' is_valid: true key: SHOW_ACCOUNT_STATUS_NOT_APPROVED value: '1' - description: '' is_valid: true key: SHOW_ACCOUNT_STATUS_PUNISHED value: '4' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 1 x-open-source: $.http.query.filtering.advertiser_show_status keyword: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.query.filtering.keyword relation_status: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803448727394305 enum_package_name: BCAssetRelationStatus enums: - description: '' is_valid: true key: BOUND value: '1' - description: '' is_valid: true key: PENDING value: '4' - description: 拒绝 is_valid: false key: REJECT value: '5' - description: 被拒绝 is_valid: true key: REJECTED value: '3' - description: '' is_valid: true key: UNBOUND value: '2' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 4 x-open-source: $.http.query.filtering.relation_status relation_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803448641906690 enum_package_name: AssetRelationType enums: - description: '' is_valid: true key: OWNER_BC value: '1' - description: '' is_valid: true key: OWNER_INDIVIDUAL value: '3' - description: '' is_valid: true key: OWNER_PARTNER value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 3 x-open-source: $.http.query.filtering.relation_type 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: 4 - description: '' in: query name: page required: false schema: default: 1 format: int64 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page x-open-field-id: 5 - description: '' in: query name: page_size required: false schema: default: 10 format: int64 maximum: 50 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page_size 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get assets of a Business Center as admins. [BC Asset Admin Get](https://business-api.tiktok.com/portal/docs?id=1739433007779841) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.query.bc_id type: number - name: child_bc_id required: false source: $.http.query.child_bc_id type: number - name: asset_type required: true source: $.http.query.asset_type type: number - children: - name: advertiser_show_status required: false source: $.http.query.filtering.advertiser_show_status type: number - name: keyword required: false source: $.http.query.filtering.keyword type: string - name: relation_type required: false source: $.http.query.filtering.relation_type type: number - name: relation_status required: false source: $.http.query.filtering.relation_status type: number name: filtering required: false source: $.http.query.filtering type: object - name: page required: false source: $.http.query.page type: number - name: page_size required: false source: $.http.query.page_size type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: asset_type: $.http.query.asset_type bc_id: $.http.query.bc_id child_bc_id: $.http.query.child_bc_id filtering: $.http.query.filtering page: $.http.query.page page_size: $.http.query.page_size response_cookie: [] response_header: [] response_rule: list[][]: - ad_creation_eligible: $.rpc.output.assets[].ad_creation_eligible advertiser_account_type: $.rpc.output.assets[].advertiser_account_type advertiser_role: $.rpc.output.assets[].advertiser_role advertiser_status: $.rpc.output.assets[].advertiser_status asset_id: $.rpc.output.assets[].asset_id asset_name: $.rpc.output.assets[].asset_name asset_type: $.rpc.output.assets[].asset_type catalog_role: $.rpc.output.assets[].catalog_role owner_bc_name: $.rpc.output.assets[].owner_bc_name pixel_code: $.rpc.output.assets[].pixel_code relation_status: $.rpc.output.assets[].relation_status relation_type: $.rpc.output.assets[].relation_type store_role: $.rpc.output.assets[].shop_role tt_account_roles: $.rpc.output.assets[].tt_account_roles page_info: $.rpc.output.page_info x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/asset/assign/: post: operationId: Bc Asset Assign 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_role: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803356642456577 enum_package_name: AdvertiserRole enums: - description: '' is_valid: true key: ADMIN value: '0' - description: '' is_valid: true key: ANALYST value: '2' - description: '' is_valid: true key: OPERATOR value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 5 x-open-source: $.http.body.advertiser_role asset_id: description: '' nullable: false 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.asset_id asset_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803356502782978 enum_package_name: BCAsset enums: - description: '' is_valid: true key: ADVERTISER value: '1' - description: '' is_valid: true key: CATALOG value: '4' - description: '' is_valid: true key: DOMAIN value: '6' - description: '' is_valid: true key: LEAD value: '9' - description: '' is_valid: true key: PIXEL value: '3' - description: '' is_valid: true key: STOREFRONT value: '5' - description: '' is_valid: true key: TIKTOK_SHOP value: '10' - description: '' is_valid: true key: TT_ACCOUNT value: '8' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 3 x-open-source: $.http.body.asset_type bc_id: description: '' nullable: false 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.bc_id catalog_role: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803438583019522 enum_package_name: CatalogRole enums: - description: '' is_valid: true key: ADMIN value: '1000' - description: '' is_valid: true key: AD_PROMOTE value: '1100' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 6 x-open-source: $.http.body.catalog_role form_library_role: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803457011208193 enum_package_name: FormLibraryRole enums: - description: '' is_valid: true key: ADMIN value: '6000' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 8 x-open-source: $.http.body.form_library_role store_role: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803457066320897 enum_package_name: StoreRole enums: - description: '' is_valid: true key: AD_PROMOTION value: '3100' - description: '' is_valid: true key: MANAGER value: '3000' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 9 x-open-source: $.http.body.store_role tt_account_roles: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803438620652801 enum_package_name: TTAccountRole enums: - description: '' is_valid: true key: DIRECT_MESSAGE value: '5005' - description: '' is_valid: true key: LIVE value: '5001' - description: '' is_valid: true key: POST value: '5000' key_format: string strict: true use_part: false validate_only: false value_format: int32 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 x-open-source: $.http.body.tt_account_roles user_id: description: '' nullable: false 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.user_id required: - bc_id - user_id - asset_type - asset_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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Assign assets to a user. [BC Asset Assign](https://business-api.tiktok.com/portal/docs?id=1739438211077121) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: user_id required: true source: $.http.body.user_id type: number - name: asset_type required: true source: $.http.body.asset_type type: number - name: asset_id required: true source: $.http.body.asset_id type: number - name: advertiser_role required: false source: $.http.body.advertiser_role type: number - name: catalog_role required: false source: $.http.body.catalog_role type: number - children: - type: number name: tt_account_roles required: false source: $.http.body.tt_account_roles sub_type: number type: array - name: form_library_role required: false source: $.http.body.form_library_role type: number - name: store_role required: false source: $.http.body.store_role type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_role: $.http.body.advertiser_role asset_id: $.http.body.asset_id asset_type: $.http.body.asset_type bc_id: $.http.body.bc_id catalog_role: $.http.body.catalog_role form_library_role: $.http.body.form_library_role store_role: $.http.body.store_role tt_account_roles: $.http.body.tt_account_roles user_id: $.http.body.user_id response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/asset/get/: get: operationId: Bc Asset Get parameters: - description: '' in: query name: bc_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.bc_id x-open-field-id: 1 - description: '' in: query name: asset_type required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803356502782978 enum_package_name: BCAsset enums: - description: '' is_valid: true key: ADVERTISER value: '1' - description: '' is_valid: true key: CATALOG value: '4' - description: '' is_valid: false key: DOMAIN value: '6' - description: '' is_valid: true key: LEAD value: '9' - description: '' is_valid: true key: PIXEL value: '3' - description: '' is_valid: true key: STOREFRONT value: '5' - description: '' is_valid: true key: TIKTOK_SHOP value: '10' - description: '' is_valid: true key: TT_ACCOUNT value: '8' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-source: $.http.query.asset_type x-open-field-id: 2 - description: '' in: query name: child_bc_id required: false schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.child_bc_id x-open-field-id: 3 - content: application/json: schema: nullable: false properties: keyword: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.query.filtering.keyword user_email: description: '' format: email nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.query.filtering.user_email user_id: description: '' nullable: false 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.filtering.user_id 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: 4 - description: '' in: query name: page required: false schema: default: 1 format: int64 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page x-open-field-id: 5 - description: '' in: query name: page_size required: false schema: default: 10 format: int64 maximum: 50 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page_size 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get assets of a Business Center. [BC Asset Get](https://business-api.tiktok.com/portal/docs?id=1739432717798401) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.query.bc_id type: number - name: asset_type required: true source: $.http.query.asset_type type: number - name: child_bc_id required: false source: $.http.query.child_bc_id type: number - children: - name: user_id required: false source: $.http.query.filtering.user_id type: number - name: user_email required: false source: $.http.query.filtering.user_email type: string - name: keyword required: false source: $.http.query.filtering.keyword type: string name: filtering required: false source: $.http.query.filtering type: object - name: page required: false source: $.http.query.page type: number - name: page_size required: false source: $.http.query.page_size type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: asset_type: $.http.query.asset_type bc_id: $.http.query.bc_id child_bc_id: $.http.query.child_bc_id filtering: $.http.query.filtering page: $.http.query.page page_size: $.http.query.page_size response_cookie: [] response_header: [] response_rule: list[][]: - ad_creation_eligible: $.rpc.output.assets[].ad_creation_eligible advertiser_account_type: $.rpc.output.assets[].advertiser_account_type advertiser_role: $.rpc.output.assets[].advertiser_role asset_id: $.rpc.output.assets[].asset_id asset_name: $.rpc.output.assets[].asset_name asset_type: $.rpc.output.assets[].asset_type catalog_role: $.rpc.output.assets[].catalog_role owner_bc_name: $.rpc.output.assets[].owner_bc_name store_role: $.rpc.output.assets[].shop_role tt_account_roles: $.rpc.output.assets[].tt_account_roles page_info: $.rpc.output.page_info x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/asset/member/get/: get: operationId: Bc Asset Member Get parameters: - description: '' in: query name: bc_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.bc_id x-open-field-id: 1 - description: '' in: query name: asset_type required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803356502782978 enum_package_name: BCAsset enums: - description: '' is_valid: true key: ADVERTISER value: '1' - description: '' is_valid: true key: CATALOG value: '4' - description: '' is_valid: false key: DOMAIN value: '6' - description: '' is_valid: true key: LEAD value: '9' - description: '' is_valid: false key: PIXEL value: '3' - description: '' is_valid: false key: STOREFRONT value: '5' - description: '' is_valid: false key: TIKTOK_SHOP value: '10' - description: '' is_valid: false key: TT_ACCOUNT value: '8' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-source: $.http.query.asset_type x-open-field-id: 2 - description: '' in: query name: asset_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.asset_id x-open-field-id: 3 - content: application/json: schema: nullable: false properties: keyword: description: '' maxLength: 250 nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.keyword description: '' in: query name: filtering required: false x-open-field-id: 4 - description: '' in: query name: page required: false schema: default: 1 format: int64 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page x-open-field-id: 5 - description: '' in: query name: page_size required: false schema: default: 10 format: int64 maximum: 20 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page_size 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get members by an asset. [BC Asset Member Get](https://business-api.tiktok.com/portal/docs?id=1739659558931458) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.query.bc_id type: number - name: asset_type required: true source: $.http.query.asset_type type: number - name: asset_id required: true source: $.http.query.asset_id type: number - name: keyword required: false source: $.http.query.filtering.keyword type: string - name: page required: false source: $.http.query.page type: number - name: page_size required: false source: $.http.query.page_size type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: asset_id: $.http.query.asset_id asset_type: $.http.query.asset_type bc_id: $.http.query.bc_id keyword: $.http.query.filtering.keyword page: $.http.query.page page_size: $.http.query.page_size response_cookie: [] response_header: [] response_rule: list: $.rpc.output.members page_info: $.rpc.output.page_info x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/asset/partner/get/: get: operationId: Bc Asset Partner Get parameters: - description: '' in: query name: bc_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.bc_id x-open-field-id: 1 - description: '' in: query name: asset_type required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803356502782978 enum_package_name: BCAsset enums: - description: '' is_valid: true key: ADVERTISER value: '1' - description: '' is_valid: true key: CATALOG value: '4' - description: '' is_valid: true key: DOMAIN value: '6' - description: '' is_valid: true key: LEAD value: '9' - description: '' is_valid: true key: PIXEL value: '3' - description: '' is_valid: true key: STOREFRONT value: '5' - description: '' is_valid: true key: TIKTOK_SHOP value: '10' - description: '' is_valid: true key: TT_ACCOUNT value: '8' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.asset_type x-open-field-id: 2 - description: '' in: query name: asset_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.asset_id x-open-field-id: 3 - content: application/json: schema: nullable: false properties: keyword: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.keyword description: '' in: query name: filtering required: false x-open-field-id: 4 - description: '' in: query name: page required: false schema: default: 1 format: int64 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page x-open-field-id: 5 - description: '' in: query name: page_size required: false schema: default: 10 format: int64 maximum: 50 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page_size 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get partners by assets. [BC Asset Partner Get](https://business-api.tiktok.com/portal/docs?id=1739663268166722) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.query.bc_id type: number - name: asset_type required: true source: $.http.query.asset_type type: number - name: asset_id required: true source: $.http.query.asset_id type: number - name: keyword required: false source: $.http.query.filtering.keyword type: string - name: page required: false source: $.http.query.page type: number - name: page_size required: false source: $.http.query.page_size type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: asset_id: $.http.query.asset_id asset_type: $.http.query.asset_type bc_id: $.http.query.bc_id keyword: $.http.query.filtering.keyword page: $.http.query.page page_size: $.http.query.page_size response_cookie: [] response_header: [] response_rule: list: $.rpc.output.partners page_info: $.rpc.output.page_info x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/asset/unassign/: post: operationId: Bc Asset Unassign 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: asset_id: description: '' nullable: false 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.asset_id asset_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803356502782978 enum_package_name: BCAsset enums: - description: '' is_valid: true key: ADVERTISER value: '1' - description: '' is_valid: true key: CATALOG value: '4' - description: '' is_valid: true key: DOMAIN value: '6' - description: '' is_valid: true key: LEAD value: '9' - description: '' is_valid: true key: PIXEL value: '3' - description: '' is_valid: true key: STOREFRONT value: '5' - description: '' is_valid: true key: TIKTOK_SHOP value: '10' - description: '' is_valid: true key: TT_ACCOUNT value: '8' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 3 x-open-source: $.http.body.asset_type bc_id: description: '' nullable: false 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.bc_id user_id: description: '' nullable: false 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.user_id required: - bc_id - user_id - asset_type - asset_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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Revoke the access to an asset from a user. [BC Asset Unassign](https://business-api.tiktok.com/portal/docs?id=1739448126749698) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: user_id required: true source: $.http.body.user_id type: number - name: asset_type required: true source: $.http.body.asset_type type: number - name: asset_id required: true source: $.http.body.asset_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: asset_id: $.http.body.asset_id asset_type: $.http.body.asset_type bc_id: $.http.body.bc_id user_id: $.http.body.user_id response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/asset_group/create/: post: operationId: Bc Asset_group 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: asset_group_name: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.asset_group_name assets: description: '' items: nullable: false properties: asset_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.assets[].asset_id asset_type: default: ADVERTISER description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1815197592334338 enum_package_name: BCAssetGroupAssetType enums: - description: '' is_valid: true key: ADVERTISER value: ADVERTISER key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 2 x-open-source: $.http.body.assets[].asset_type required: - asset_id type: object x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 200 minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.assets bc_id: description: '' nullable: false 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.bc_id members: description: '' items: nullable: false properties: asset_roles: additionalProperties: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1815197697677314 enum_package_name: BCAssetGroupRole enums: - description: '' is_valid: true key: ADVERTISER_ROLE_ADMIN value: ADVERTISER_ROLE_ADMIN - description: '' is_valid: true key: ADVERTISER_ROLE_ANALYST value: ADVERTISER_ROLE_ANALYST - description: '' is_valid: true key: ADVERTISER_ROLE_OPERATOR value: ADVERTISER_ROLE_OPERATOR key_format: string strict: true use_part: false validate_only: false value_format: string description: '' nullable: false type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.members[].asset_roles member_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.members[].member_id required: - member_id type: object x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 50 minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.members required: - bc_id - asset_group_name - assets - members 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Create an Asset Group in your Business Center. [BC Asset Group Create](https://business-api.tiktok.com/portal/docs?id=1749001658583105) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: asset_group_name required: true source: $.http.body.asset_group_name type: string - children: - children: - name: asset_id required: true source: $.http.body.assets[].asset_id type: string - name: asset_type required: true source: $.http.body.assets[].asset_type type: string is_expand: true type: object is_expand: true name: assets required: true source: $.http.body.assets sub_type: object type: array - children: - children: - name: member_id required: true source: $.http.body.members[].member_id type: string - children: - type: string is_expand: true name: asset_roles required: false source: $.http.body.members[].asset_roles sub_type: string type: dict is_expand: true type: object is_expand: true name: members required: true source: $.http.body.members sub_type: object type: array - children: - name: app_id required: false source: $.context.app_id type: number - name: core_user_id required: false source: $.context.core_user_id type: number - name: developer_id required: false source: $.context.developer_id type: number - name: x_real_ip required: false source: $.context.source_ip type: string is_expand: true name: context_info required: false type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: asset_group_name: $.http.body.asset_group_name assets: $.http.body.assets bc_id: $.http.body.bc_id context_info: app_id: $.context.app_id core_user_id: $.context.core_user_id developer_id: $.context.developer_id x_real_ip: $.context.source_ip members: $.http.body.members response_cookie: [] response_header: [] response_rule: asset_group_id: $.rpc.output.asset_group_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/asset_group/delete/: post: operationId: Bc Asset_group 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: asset_group_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) maxItems: 1 minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.asset_group_ids bc_id: description: '' nullable: false 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.bc_id required: - bc_id - asset_group_ids type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Remove members' access to an Asset Group. [BC Asset Group Delete](https://business-api.tiktok.com/portal/docs?id=1749001673406466) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - children: - type: number is_expand: true name: asset_group_ids required: true source: $.http.body.asset_group_ids[] sub_type: number type: array - children: - name: app_id required: false source: $.context.app_id type: number - name: core_user_id required: false source: $.context.core_user_id type: number - name: developer_id required: false source: $.context.developer_id type: number is_expand: true name: context_info required: false type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: asset_group_ids: $.http.body.asset_group_ids[] bc_id: $.http.body.bc_id context_info: app_id: $.context.app_id core_user_id: $.context.core_user_id developer_id: $.context.developer_id response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/asset_group/get/: get: operationId: Bc Asset_group Get parameters: - description: '' in: query name: bc_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.bc_id x-open-field-id: 1 - description: '' in: query name: asset_group_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.asset_group_id x-open-field-id: 2 - description: '' in: query name: query_entity required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1815197887739905 enum_package_name: BCAssetGroupQueryEntity enums: - description: '' is_valid: true key: ASSET value: ASSET - description: '' is_valid: true key: MEMBER value: MEMBER key_format: string strict: true use_part: false validate_only: false value_format: string x-open-source: $.http.query.query_entity x-open-field-id: 3 - content: application/json: schema: nullable: false properties: keyword: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.query.filtering.keyword required: - keyword 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: 4 - description: '' in: query name: page required: false schema: default: 1 format: int64 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page x-open-field-id: 5 - description: '' in: query name: page_size required: false schema: default: 10 format: int64 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page_size 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get the assets or members of an Asset Group in a Business Center. [BC Asset Group Get](https://business-api.tiktok.com/portal/docs?id=1749001669670913) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.query.bc_id type: number - name: asset_group_id required: true source: $.http.query.asset_group_id type: number - name: query_entity required: true source: $.http.query.query_entity type: string - children: - name: keyword required: true source: $.http.query.filtering.keyword type: string is_expand: true name: filtering required: false source: $.http.query.filtering type: object - name: page required: true source: $.http.query.page type: number - name: page_size required: true source: $.http.query.page_size type: number - children: - name: app_id required: false source: $.context.app_id type: number - name: core_user_id required: false source: $.context.core_user_id type: number - name: developer_id required: false source: $.context.developer_id type: number - name: x_real_ip required: false source: $.context.source_ip type: string is_expand: true name: context_info required: false type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: asset_group_id: $.http.query.asset_group_id bc_id: $.http.query.bc_id context_info: app_id: $.context.app_id core_user_id: $.context.core_user_id developer_id: $.context.developer_id x_real_ip: $.context.source_ip filtering: $.http.query.filtering page: $.http.query.page page_size: $.http.query.page_size query_entity: $.http.query.query_entity response_cookie: [] response_header: [] response_rule: asset_group: asset_group_id: $.rpc.output.asset_group.asset_group_id asset_group_name: $.rpc.output.asset_group.asset_group_name assets: $.rpc.output.asset_group.assets members: $.rpc.output.asset_group.members page_info: $.rpc.output.page_info x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /bc/asset_group/list/: get: operationId: Bc Asset_group List parameters: - description: '' in: query name: bc_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.bc_id x-open-field-id: 1 - content: application/json: schema: nullable: false properties: keyword: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.query.filtering.keyword required: - keyword type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.filtering description: '' in: query name: filtering required: false x-open-field-id: 2 - description: '' in: query name: page required: false schema: default: 1 format: int64 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page x-open-field-id: 3 - description: '' in: query name: page_size required: false schema: default: 10 format: int64 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page_size 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get all Asset Groups in your Business Center. [BC Asset Group List](https://business-api.tiktok.com/portal/docs?id=1749001665910786) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.query.bc_id type: number - children: - name: keyword required: true source: $.http.query.filtering.keyword type: string is_expand: true name: filtering required: false source: $.http.query.filtering type: object - name: page required: true source: $.http.query.page type: number - name: page_size required: true source: $.http.query.page_size type: number - children: - name: app_id required: false source: $.context.app_id type: number - name: core_user_id required: false source: $.context.core_user_id type: number - name: developer_id required: false source: $.context.developer_id type: number - name: x_real_ip required: false source: $.context.source_ip type: string is_expand: true name: context_info required: false type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.query.bc_id context_info: app_id: $.context.app_id core_user_id: $.context.core_user_id developer_id: $.context.developer_id x_real_ip: $.context.source_ip filtering: $.http.query.filtering page: $.http.query.page page_size: $.http.query.page_size response_cookie: [] response_header: [] response_rule: asset_groups[][]: - asset_group_id: $.rpc.output.asset_groups[].asset_group_id asset_group_name: $.rpc.output.asset_groups[].asset_group_name assets: $.rpc.output.asset_groups[].assets members: $.rpc.output.asset_groups[].members page_info: $.rpc.output.page_info x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /bc/asset_group/update/: post: operationId: Bc Asset_group 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: action: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1815197776304130 enum_package_name: BCAssetGroupAction enums: - description: '' is_valid: true key: ADD value: ADD - description: '' is_valid: true key: DELETE value: DELETE key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 4 x-open-source: $.http.body.action asset_group_id: description: '' nullable: false 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.asset_group_id asset_group_name: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.body.asset_group_name assets: description: '' items: nullable: false properties: asset_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.assets[].asset_id asset_type: default: ADVERTISER description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1815197592334338 enum_package_name: BCAssetGroupAssetType enums: - description: '' is_valid: true key: ADVERTISER value: ADVERTISER key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 2 x-open-source: $.http.body.assets[].asset_type required: - asset_id type: object x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 200 minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.body.assets bc_id: description: '' nullable: false 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.bc_id members: description: '' items: nullable: false properties: asset_roles: additionalProperties: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1815197697677314 enum_package_name: BCAssetGroupRole enums: - description: '' is_valid: true key: ADVERTISER_ROLE_ADMIN value: ADVERTISER_ROLE_ADMIN - description: '' is_valid: true key: ADVERTISER_ROLE_ANALYST value: ADVERTISER_ROLE_ANALYST - description: '' is_valid: true key: ADVERTISER_ROLE_OPERATOR value: ADVERTISER_ROLE_OPERATOR key_format: string strict: true use_part: false validate_only: false value_format: string description: '' nullable: false type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.members[].asset_roles member_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.members[].member_id required: - member_id type: object x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 50 minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 x-open-source: $.http.body.members update_entity: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1815197825973249 enum_package_name: BCAssetGroupUpdateEntity enums: - description: '' is_valid: true key: ASSET value: ASSET - description: '' is_valid: true key: MEMBER value: MEMBER - description: '' is_valid: true key: NAME value: NAME key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 3 x-open-source: $.http.body.update_entity required: - bc_id - asset_group_id - update_entity 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Update assets, members or the name of an Asset Group. [BC Asset Group Update](https://business-api.tiktok.com/portal/docs?id=1749001662156801) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: asset_group_id required: true source: $.http.body.asset_group_id type: number - name: update_entity required: true source: $.http.body.update_entity type: string - name: action required: false source: $.http.body.action type: string - name: asset_group_name required: false source: $.http.body.asset_group_name type: string - children: - children: - name: asset_id required: true source: $.http.body.assets[].asset_id type: string - name: asset_type required: true source: $.http.body.assets[].asset_type type: string is_expand: true type: object is_expand: true name: assets required: false source: $.http.body.assets sub_type: object type: array - children: - children: - name: member_id required: true source: $.http.body.members[].member_id type: string - children: - type: string is_expand: true name: asset_roles required: false source: $.http.body.members[].asset_roles sub_type: string type: dict is_expand: true type: object is_expand: true name: members required: false source: $.http.body.members sub_type: object type: array - children: - name: app_id required: false source: $.context.app_id type: number - name: core_user_id required: false source: $.context.core_user_id type: number - name: developer_id required: false source: $.context.developer_id type: number - name: x_real_ip required: false source: $.context.source_ip type: string is_expand: true name: context_info required: false type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: action: $.http.body.action asset_group_id: $.http.body.asset_group_id asset_group_name: $.http.body.asset_group_name assets: $.http.body.assets bc_id: $.http.body.bc_id context_info: app_id: $.context.app_id core_user_id: $.context.core_user_id developer_id: $.context.developer_id x_real_ip: $.context.source_ip members: $.http.body.members update_entity: $.http.body.update_entity response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/balance/get/: get: operationId: Bc Balance Get parameters: - description: '' in: query name: bc_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.bc_id x-open-field-id: 1 - description: '' in: query name: child_bc_id required: false schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.child_bc_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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get the balance of a Business Center. [BC Balance Get](https://business-api.tiktok.com/portal/docs?id=1739939128198145) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.query.bc_id type: number - name: child_bc_id required: false source: $.http.query.child_bc_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.query.bc_id child_bc_id: $.http.query.child_bc_id response_cookie: [] response_header: [] response_rule: account_balance: $.rpc.output.account_balance bc_id: $.rpc.output.bc_id cash_balance: $.rpc.output.cash_balance currency: $.rpc.output.currency frozen_balance: $.rpc.output.frozen_balance grant_balance: $.rpc.output.grant_balance tax: $.rpc.output.tax valid_account_balance: $.rpc.output.valid_account_balance valid_cash_balance: $.rpc.output.valid_cash_balance valid_grant_balance: $.rpc.output.valid_grant_balance x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/billing_group/create/: post: operationId: Bc Billing_group Create parameters: - description: '' in: header name: Access-Token required: false schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 requestBody: content: application/json: schema: properties: advertiser_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) maxItems: 100 minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.advertiser_ids bc_id: description: '' nullable: false 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.bc_id billing_group_emails: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 20 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.billing_group_emails billing_group_name: description: '' maxLength: 100 minLength: 1 nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.billing_group_name billing_group_type: default: AUCTION description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1799595859566593 enum_package_name: BillingGroupType20 enums: - description: '' is_valid: true key: AUCTION value: '2' - description: '' is_valid: true key: RESERVATION value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int64 x-open-field-id: 6 x-open-source: $.http.body.billing_group_type is_primary: default: false description: '' nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.body.is_primary required: - bc_id - billing_group_name - advertiser_ids type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Create a billing group in a Business Center. [BC Billing Group Create](https://business-api.tiktok.com/portal/docs?id=1738947780033537) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: billing_group_name required: true source: $.http.body.billing_group_name type: string - children: - type: string is_expand: true name: billing_group_emails required: false source: $.http.body.billing_group_emails sub_type: string type: array - children: - type: number is_expand: true name: advertiser_ids required: true source: $.http.body.advertiser_ids sub_type: number type: array - name: is_primary required: true source: $.http.body.is_primary type: boolean - name: billing_group_type required: true source: $.http.body.billing_group_type type: number - name: core_user_id required: true source: $.context.core_user_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_ids: $.http.body.advertiser_ids bc_id: $.http.body.bc_id billing_group_emails: $.http.body.billing_group_emails billing_group_name: $.http.body.billing_group_name billing_group_type: $.http.body.billing_group_type core_user_id: $.context.core_user_id is_primary: $.http.body.is_primary response_cookie: [] response_header: [] response_rule: billing_group_id: $.rpc.output.billing_group_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/billing_group/get/: get: operationId: Bc Billing_group Get parameters: - description: '' in: query name: bc_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.bc_id x-open-field-id: 1 - content: application/json: schema: nullable: false properties: billed_to_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1799071172528130 enum_package_name: BillingGroupReconBillTo enums: - description: '' is_valid: true key: ACCOUNT value: '1' - description: '' is_valid: true key: ADVERTISER value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int64 x-open-field-id: 2 x-open-source: $.http.query.filtering.recon_bill_to billing_group_id: description: '' nullable: false 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.query.filtering.billing_group_id billing_group_name: description: '' maxLength: 256 minLength: 1 nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.query.filtering.billing_group_name billing_group_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1799071211040770 enum_package_name: AdvertiserType enums: - description: '' is_valid: true key: AUCTION value: '2' - description: '' is_valid: true key: RESERVATION value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int64 x-open-field-id: 3 x-open-source: $.http.query.filtering.advertiser_type invoice_group_by: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1799071148973058 enum_package_name: BillingGroupReconGroupBy enums: - description: '' is_valid: true key: ACCOUNT value: '1' - description: '' is_valid: true key: ADVERTISER value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int64 x-open-field-id: 1 x-open-source: $.http.query.filtering.recon_group_by status: description: '' format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.query.filtering.status type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.filtering description: '' in: query name: filtering required: false x-open-field-id: 2 - description: '' in: query name: page required: false schema: default: 1 format: int64 maximum: 9223372036854776000 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page x-open-field-id: 3 - description: '' in: query name: page_size required: false schema: default: 10 format: int64 maximum: 50 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page_size 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get all billing groups in a Business Center. [BC Billing Group Get](https://business-api.tiktok.com/portal/docs?id=1738944324279297) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.query.bc_id type: number - children: - name: recon_group_by required: false source: $.http.query.filtering.invoice_group_by type: number - name: recon_bill_to required: false source: $.http.query.filtering.billed_to_type type: number - name: advertiser_type required: false source: $.http.query.filtering.billing_group_type type: number - name: billing_group_id required: false source: $.http.query.filtering.billing_group_id type: number - name: billing_group_name required: false source: $.http.query.filtering.billing_group_name type: string - name: status required: false source: $.http.query.filtering.status type: number is_expand: true name: filtering required: false type: object - name: page required: true source: $.http.query.page type: number - name: page_size required: true source: $.http.query.page_size type: number - name: core_user_id required: true source: $.context.core_user_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.query.bc_id core_user_id: $.context.core_user_id filtering: advertiser_type: $.http.query.filtering.billing_group_type billing_group_id: $.http.query.filtering.billing_group_id billing_group_name: $.http.query.filtering.billing_group_name recon_bill_to: $.http.query.filtering.billed_to_type recon_group_by: $.http.query.filtering.invoice_group_by status: $.http.query.filtering.status page: $.http.query.page page_size: $.http.query.page_size response_cookie: [] response_header: [] response_rule: list[][]: - advertisers: $.rpc.output.bg_list[].advertiser_info_list billed_to_type: $.rpc.output.bg_list[].recon_bill_to billing_group_emails: $.rpc.output.bg_list[].contact_emails billing_group_id: $.rpc.output.bg_list[].billing_group_id billing_group_name: $.rpc.output.bg_list[].billing_group_name billing_group_type: $.rpc.output.bg_list[].advertiser_type invoice_group_by: $.rpc.output.bg_list[].recon_group_by invoice_object_name: $.rpc.output.bg_list[].invoice_object_name is_primary: $.rpc.output.bg_list[].is_primary status: $.rpc.output.bg_list[].status page_info: $.rpc.output.page_info x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/billing_group/update/: post: operationId: Bc Billing_group 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: add_advertiser_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: 5 x-open-source: $.http.body.add_advertiser_ids bc_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.bc_id billing_group_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.billing_group_id delete_advertiser_ids: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.body.delete_advertiser_ids is_primary: description: '' type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 x-open-source: $.http.body.is_primary new_billing_group_emails: description: '' items: format: email maxLength: 20 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: 4 x-open-source: $.http.body.billing_group_emails new_billing_group_name: description: '' maxLength: 100 minLength: 1 type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.billing_group_name required: - bc_id - billing_group_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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Update settings of a billing group. [BC Billing Group Update](https://business-api.tiktok.com/portal/docs?id=1738947843447809) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: billing_group_id required: true source: $.http.body.billing_group_id type: number - name: billing_group_name required: false source: $.http.body.new_billing_group_name type: string - children: - type: string is_expand: true name: billing_group_emails required: false source: $.http.body.new_billing_group_emails[] sub_type: string type: array - children: - type: number is_expand: true name: add_advertiser_ids required: false source: $.http.body.add_advertiser_ids sub_type: number type: array - children: - type: number is_expand: true name: delete_advertiser_ids required: false source: $.http.body.delete_advertiser_ids sub_type: number type: array - name: is_primary required: false source: $.http.body.is_primary type: boolean - name: core_user_id required: true source: $.context.core_user_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: add_advertiser_ids: $.http.body.add_advertiser_ids bc_id: $.http.body.bc_id billing_group_emails: $.http.body.new_billing_group_emails[] billing_group_id: $.http.body.billing_group_id billing_group_name: $.http.body.new_billing_group_name core_user_id: $.context.core_user_id delete_advertiser_ids: $.http.body.delete_advertiser_ids is_primary: $.http.body.is_primary response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/create/: post: operationId: Bc 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: bc_name: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.bc_name company_name: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 x-open-source: $.http.body.company contact_info: description: '' nullable: false properties: email: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 name: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 phone: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 phone_region_code: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 secondary_industry: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 5 type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 8 currency: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.body.currency plugin_partner: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.plugin_partner registered_area: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.body.registered_area timezone: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.timezone type: default: NORMAL description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803660610513921 enum_package_name: BusinessCenterType enums: - description: '' is_valid: false key: AGENCY value: '2' - description: '' is_valid: false key: DIRECT value: '4' - description: '' is_valid: true key: NORMAL value: '1' - description: '' is_valid: true key: SELF_SERVICE value: '5' - description: '' is_valid: true key: SELF_SERVICE_AGENCY value: '6' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 4 x-open-source: $.http.body.type required: - bc_name - timezone 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: null tags: null x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_name required: true source: $.http.body.bc_name type: string - name: timezone required: true source: $.http.body.timezone type: string - name: plugin_partner required: false source: $.http.body.plugin_partner type: string - name: type required: false source: $.http.body.type type: number - name: registered_area required: false source: $.http.body.registered_area type: string - name: currency required: false source: $.http.body.currency type: string - name: company required: false source: $.http.body.company_name type: string - children: - name: secondary_industry required: false type: number - name: name required: false type: string - name: email required: false type: string - name: phone required: false type: string - name: phone_region_code required: false type: string is_expand: true name: contact_info required: false source: $.http.body.contact_info type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_name: $.http.body.bc_name company: $.http.body.company_name contact_info: $.http.body.contact_info currency: $.http.body.currency plugin_partner: $.http.body.plugin_partner registered_area: $.http.body.registered_area timezone: $.http.body.timezone type: $.http.body.type response_cookie: [] response_header: [] response_rule: bc_id: $.rpc.output.bc_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/get/: get: operationId: Bc Get parameters: - description: '' in: query name: bc_id required: false schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.bc_id x-open-field-id: 1 - description: '' in: query name: scene required: false schema: default: SINGLE_ACCOUNT nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803660327790593 enum_package_name: BCGetScene enums: - description: '' is_valid: true key: SINGLE_ACCOUNT value: '1' - description: '' is_valid: true key: TIERED_ACCOUNT value: '2' key_format: string strict: true use_part: false validate_only: true value_format: int32 x-open-source: $.http.query.scene x-open-field-id: 2 - content: application/json: schema: nullable: false properties: keyword: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 keyword_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803660403768321 enum_package_name: BCSearchKeywordType enums: - description: '' is_valid: true key: ASSET value: '5' - description: '' is_valid: true key: MEMBER value: '4' - description: '' is_valid: true key: PARTNER value: '3' - description: '' is_valid: true key: TIER value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 2 relation_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803660432711682 enum_package_name: TierBCRelationType enums: - description: '' is_valid: true key: CHILD value: '2' - description: '' is_valid: true key: PARENT value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 3 type: object x-open-allow-strlist: false x-open-allow-strnum: false description: '' in: query name: filtering required: false x-open-field-id: 3 - description: '' in: query name: page required: false schema: default: 1 format: int64 nullable: false 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: 50 minimum: 1 nullable: false 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get Business Centers that you have access to. [BC Get](https://business-api.tiktok.com/portal/docs?id=1737115687501826) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: false source: $.http.query.bc_id type: number - name: scene required: false source: $.http.query.scene type: string - name: keyword required: false source: $.http.query.filtering.keyword type: string - name: keyword_type required: false source: $.http.query.filtering.keyword_type type: number - name: relation_type required: false source: $.http.query.filtering.relation_type type: number - name: page required: false source: $.http.query.page type: number - name: page_size required: false source: $.http.query.page_size type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.query.bc_id keyword: $.http.query.filtering.keyword keyword_type: $.http.query.filtering.keyword_type page: $.http.query.page page_size: $.http.query.page_size relation_type: $.http.query.filtering.relation_type scene: $.http.query.scene response_cookie: [] response_header: [] response_rule: list[][]: - bc_info[]: - bc_id: $.rpc.output.bc_infos[].bc_base_info.bc_id company: $.rpc.output.bc_infos[].bc_base_info.company currency: $.rpc.output.bc_infos[].bc_base_info.currency name: $.rpc.output.bc_infos[].bc_base_info.bc_name organization_type: $.rpc.output.bc_infos[].bc_base_info.organization_type registered_area: $.rpc.output.bc_infos[].bc_base_info.registered_area status: $.rpc.output.bc_infos[].bc_base_info.status timezone: $.rpc.output.bc_infos[].bc_base_info.timezone type: $.rpc.output.bc_infos[].bc_base_info.type binding_status: $.rpc.output.bc_infos[].binding_status ext_user_role: $.rpc.output.bc_infos[].ext_user_role user_role: $.rpc.output.bc_infos[].user_role page_info: $.rpc.output.page_info parent_bc: bc_info: bc_id: $.rpc.output.parent_bc.bc_base_info.bc_id company: $.rpc.output.parent_bc.bc_base_info.company currency: $.rpc.output.parent_bc.bc_base_info.currency name: $.rpc.output.parent_bc.bc_base_info.bc_name organization_type: $.rpc.output.parent_bc.bc_base_info.organization_type registered_area: $.rpc.output.parent_bc.bc_base_info.registered_area status: $.rpc.output.parent_bc.bc_base_info.status timezone: $.rpc.output.parent_bc.bc_base_info.timezone type: $.rpc.output.parent_bc.bc_base_info.type binding_status: $.rpc.output.parent_bc.binding_status ext_user_role: $.rpc.output.parent_bc.ext_user_role user_role: $.rpc.output.parent_bc.user_role x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /bc/image/upload/: post: operationId: Bc Image Upload 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: multipart/form-data: schema: properties: bc_id: description: '' nullable: false 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.bc_id image_file: description: '' format: binary nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.image_file required: - bc_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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: null tags: null x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: image_file required: false source: $.http.body.image_file type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.body.bc_id image_file: $.http.body.image_file response_cookie: [] response_header: [] response_rule: image_id: $.rpc.output.image_id image_url: $.rpc.output.image_url x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/invoice/unpaid/get/: get: operationId: Bc Invoice Unpaid Get parameters: - description: '' in: query name: bc_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 - description: '' in: query name: invoice_type required: true schema: nullable: false 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: RECON value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 2 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Finance Managers and Finance Analysts of a Business Center account can use this endpoint to get total unpaid amount of their Business Center accounts. [BC Invoice Unpaid Get](https://business-api.tiktok.com/portal/docs?id=1740295904843777) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: BcId required: false source: $.http.query.bc_id type: number - name: Classify required: false source: $.http.query.invoice_type type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: BcId: $.http.query.bc_id Classify: $.http.query.invoice_type response_cookie: [] response_header: [] response_rule: result: $.rpc.output.Currency2NeedPayAmount x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/member/assign/: post: operationId: Bc Member Assign 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: bc_id: description: '' nullable: false 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.bc_id target_child_bc_id: description: '' nullable: false 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.target_child_bc_id users: description: '' items: nullable: false properties: ext_user_role: description: '' nullable: false properties: finance_role: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1802167339779074 enum_package_name: BCFinanceRole enums: - description: '' is_valid: true key: ANALYST value: '6' - description: '' is_valid: true key: MANAGER value: '5' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 1 type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.members[].finance_role source_child_bc_id: description: '' nullable: false 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.members[].source_child_bc_id user_id: description: '' nullable: false 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.members[].user_id user_role: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1802163064740866 enum_package_name: BCUserRole enums: - description: '' is_valid: true key: ADMIN value: '1' - description: '' is_valid: true key: STANDARD value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 2 x-open-source: $.http.body.members[].user_role required: - user_id - source_child_bc_id type: object x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 100 minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.members required: - bc_id - target_child_bc_id - users 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: null tags: null x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: target_child_bc_id required: true source: $.http.body.target_child_bc_id type: number - children: - children: - name: user_id required: false source: $.http.body.users[].user_id type: number - name: user_role required: false source: $.http.body.users[].user_role type: number - name: finance_role required: false source: $.http.body.users[].ext_user_role.finance_role type: number - name: source_child_bc_id required: false source: $.http.body.users[].source_child_bc_id type: number is_expand: true type: object is_expand: true name: members required: true source: '' sub_type: object type: array plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.body.bc_id members[][]: - finance_role: $.http.body.users[].ext_user_role.finance_role source_child_bc_id: $.http.body.users[].source_child_bc_id user_id: $.http.body.users[].user_id user_role: $.http.body.users[].user_role target_child_bc_id: $.http.body.target_child_bc_id response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/member/delete/: post: operationId: Bc Member 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: bc_id: description: '' nullable: false 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.bc_id child_bc_id: description: '' nullable: false 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.child_bc_id user_email: description: '' format: email nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.user_email user_id: description: '' nullable: false 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.user_id required: - bc_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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Delete member. [BC Member Delete](https://business-api.tiktok.com/portal/docs?id=1739939482851329) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: child_bc_id required: false source: $.http.body.child_bc_id type: number - name: user_id required: false source: $.http.body.user_id type: number - name: user_email required: false source: $.http.body.user_email type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.body.bc_id child_bc_id: $.http.body.child_bc_id user_email: $.http.body.user_email user_id: $.http.body.user_id response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/member/get/: get: operationId: Bc Member Get parameters: - description: '' in: query name: bc_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.bc_id x-open-field-id: 1 - description: '' in: query name: child_bc_id required: false schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - string(%s) x-open-source: $.http.query.child_bc_id x-open-field-id: 2 - content: application/json: schema: nullable: false properties: keyword: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.query.filtering.keyword relation_status: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1802163238919169 enum_package_name: UserRelationStatusToBC enums: - description: '' is_valid: true key: BOUND value: '1' - description: '' is_valid: true key: PENDING value: '4' - description: 被拒绝 is_valid: true key: REJECTED value: '3' - description: '' is_valid: true key: UNBOUND value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 3 x-open-source: $.http.query.filtering.relation_status user_role: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1802163064740866 enum_package_name: BCUserRole enums: - description: '' is_valid: true key: ADMIN value: '1' - description: '' is_valid: true key: STANDARD value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 2 x-open-source: $.http.query.filtering.user_role 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 nullable: false 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 nullable: false 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get BC members. [BC Member Get](https://business-api.tiktok.com/portal/docs?id=1739939404802049) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.query.bc_id type: number - name: child_bc_id required: false source: $.http.query.child_bc_id type: number - children: - name: keyword required: false source: $.http.query.filtering.keyword type: string - name: user_role required: false source: $.http.query.filtering.user_role type: number - name: relation_status required: false source: $.http.query.filtering.relation_status type: number name: filtering required: false source: $.http.query.filtering type: object - name: page required: false source: $.http.query.page type: number - name: page_size required: false source: $.http.query.page_size type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.query.bc_id child_bc_id: $.http.query.child_bc_id filtering: $.http.query.filtering page: $.http.query.page page_size: $.http.query.page_size response_cookie: [] response_header: [] response_rule: list[][]: - ext_user_role[]: - finance_role: $.rpc.output.members[].finance_role relation_status: $.rpc.output.members[].relation_status user_email: $.rpc.output.members[].user_email user_id: $.rpc.output.members[].user_id user_name: $.rpc.output.members[].user_name user_role: $.rpc.output.members[].user_role page_info: $.rpc.output.page_info x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/member/invite/: post: operationId: Bc Member Invite 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_role: default: ANALYST description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803356642456577 enum_package_name: AdvertiserRole enums: - description: '' is_valid: true key: ADMIN value: '0' - description: '' is_valid: true key: ANALYST value: '2' - description: '' is_valid: true key: OPERATOR value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 6 x-open-source: $.http.body.advertiser_role asset_ids: description: '' items: default: '[]' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.body.asset_ids asset_type: default: ADVERTISER description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803356502782978 enum_package_name: BCAsset enums: - description: '' is_valid: true key: ADVERTISER value: '1' - description: '' is_valid: false key: CATALOG value: '4' - description: '' is_valid: false key: DOMAIN value: '6' - description: '' is_valid: false key: LEAD value: '9' - description: '' is_valid: false key: PIXEL value: '3' - description: '' is_valid: false key: STOREFRONT value: '5' - description: '' is_valid: false key: TIKTOK_SHOP value: '10' - description: '' is_valid: false key: TT_ACCOUNT value: '8' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 4 x-open-source: $.http.body.asset_type bc_id: description: '' nullable: false 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.bc_id emails: description: '' items: format: email nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 50 minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.emails ext_user_role: description: '' nullable: false properties: finance_role: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1802167339779074 enum_package_name: BCFinanceRole enums: - description: '' is_valid: true key: ANALYST value: '6' - description: '' is_valid: true key: MANAGER value: '5' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 1 type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 user_role: default: STANDARD description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1802163064740866 enum_package_name: BCUserRole enums: - description: '' is_valid: true key: ADMIN value: '1' - description: '' is_valid: true key: STANDARD value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 3 x-open-source: $.http.body.user_role required: - bc_id - emails 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Invite members to BC. [BC Member Invite](https://business-api.tiktok.com/portal/docs?id=1739939455765505) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - children: - type: string is_expand: true name: emails required: true source: $.http.body.emails sub_type: string type: array - name: user_role required: false source: $.http.body.user_role type: number - name: asset_type required: false source: $.http.body.asset_type type: number - children: - type: number is_expand: true name: asset_ids required: true source: $.http.body.asset_ids sub_type: number type: array - name: advertiser_role required: false source: $.http.body.advertiser_role type: number - name: finance_role required: false source: $.http.body.ext_user_role.finance_role type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_role: $.http.body.advertiser_role asset_ids: $.http.body.asset_ids asset_type: $.http.body.asset_type bc_id: $.http.body.bc_id emails: $.http.body.emails finance_role: $.http.body.ext_user_role.finance_role user_role: $.http.body.user_role response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/member/update/: post: operationId: Bc Member 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: bc_id: description: '' nullable: false 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.bc_id child_bc_id: description: '' nullable: false 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.child_bc_id ext_user_role: description: '' nullable: false properties: finance_role: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1802167339779074 enum_package_name: BCFinanceRole enums: - description: '' is_valid: true key: ANALYST value: '6' - description: '' is_valid: true key: MANAGER value: '5' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 1 type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.body.finance_role user_id: description: '' nullable: false 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.user_id user_name: description: '' maxLength: 250 nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.body.user_name user_role: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1802163064740866 enum_package_name: BCUserRole enums: - description: '' is_valid: true key: ADMIN value: '1' - description: '' is_valid: true key: STANDARD 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.user_role required: - bc_id - user_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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Update member information. [BC Member Update](https://business-api.tiktok.com/portal/docs?id=1739696704424961) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: child_bc_id required: false source: $.http.body.child_bc_id type: number - name: user_id required: true source: $.http.body.user_id type: number - name: user_role required: false source: $.http.body.user_role type: number - name: user_name required: false source: $.http.body.user_name type: string - name: finance_role required: false source: $.http.body.ext_user_role.finance_role type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.body.bc_id child_bc_id: $.http.body.child_bc_id finance_role: $.http.body.ext_user_role.finance_role user_id: $.http.body.user_id user_name: $.http.body.user_name user_role: $.http.body.user_role response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/partner/add/: post: operationId: Bc Partner Add 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_role: default: ANALYST description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803356642456577 enum_package_name: AdvertiserRole enums: - description: '' is_valid: true key: ADMIN value: '0' - description: '' is_valid: true key: ANALYST value: '2' - description: '' is_valid: true key: OPERATOR value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 7 x-open-source: $.http.body.advertiser_role asset_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) maxItems: 50 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.body.asset_ids asset_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803356502782978 enum_package_name: BCAsset enums: - description: '' is_valid: true key: ADVERTISER value: '1' - description: '' is_valid: false key: CATALOG value: '4' - description: '' is_valid: false key: DOMAIN value: '6' - description: '' is_valid: false key: LEAD value: '9' - description: '' is_valid: false key: PIXEL value: '3' - description: '' is_valid: false key: STOREFRONT value: '5' - description: '' is_valid: false key: TIKTOK_SHOP value: '10' - description: '' is_valid: false key: TT_ACCOUNT value: '8' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 5 x-open-source: $.http.body.asset_type bc_id: description: '' nullable: false 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.bc_id catalog_role: default: AD_PROMOTE description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803438583019522 enum_package_name: CatalogRole enums: - description: '' is_valid: true key: ADMIN value: '1000' - description: '' is_valid: true key: AD_PROMOTE value: '1100' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 8 x-open-source: $.http.body.catalog_role partner_id: description: '' nullable: false 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.partner_id source_child_bc_id: description: '' nullable: false 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.source_child_bc_id target_child_bc_id: description: '' nullable: false 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.target_child_bc_id required: - bc_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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Add partner to Business Center. [BC Partner Add](https://business-api.tiktok.com/portal/docs?id=1739662756510721) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: target_child_bc_id required: false source: $.http.body.target_child_bc_id type: number - name: source_child_bc_id required: false source: $.http.body.source_child_bc_id type: number - name: partner_id required: false source: $.http.body.partner_id type: number - name: asset_type required: true source: $.http.body.asset_type type: number - children: - type: number name: asset_ids required: true source: $.http.body.asset_ids sub_type: number type: array - name: advertiser_role required: false source: $.http.body.advertiser_role type: number - name: catalog_role required: false source: $.http.body.catalog_role type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_role: $.http.body.advertiser_role asset_ids: $.http.body.asset_ids asset_type: $.http.body.asset_type bc_id: $.http.body.bc_id catalog_role: $.http.body.catalog_role partner_id: $.http.body.partner_id source_child_bc_id: $.http.body.source_child_bc_id target_child_bc_id: $.http.body.target_child_bc_id response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/partner/asset/delete/: post: operationId: Bc Partner Asset 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: asset_ids: description: '' items: default: '[]' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.asset_ids asset_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803356502782978 enum_package_name: BCAsset enums: - description: '' is_valid: true key: ADVERTISER value: '1' - description: '' is_valid: true key: CATALOG value: '4' - description: '' is_valid: true key: DOMAIN value: '6' - description: '' is_valid: true key: LEAD value: '9' - description: '' is_valid: true key: PIXEL value: '3' - description: '' is_valid: true key: STOREFRONT value: '5' - description: '' is_valid: true key: TIKTOK_SHOP value: '10' - description: '' is_valid: true key: TT_ACCOUNT value: '8' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 3 x-open-source: $.http.body.asset_type bc_id: description: '' nullable: false 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.bc_id partner_id: description: '' nullable: false 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.partner_id required: - bc_id - partner_id - asset_type - asset_ids type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Cancel asset sharing. [BC Partner Asset Delete](https://business-api.tiktok.com/portal/docs?id=1739662800930817) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: partner_id required: true source: $.http.body.partner_id type: number - name: asset_type required: true source: $.http.body.asset_type type: number - children: - type: number name: asset_ids required: true source: $.http.body.asset_ids sub_type: number type: array plugins: after_response: [] before_request: [] request_query_rule: null request_rule: asset_ids: $.http.body.asset_ids asset_type: $.http.body.asset_type bc_id: $.http.body.bc_id partner_id: $.http.body.partner_id response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/partner/asset/get/: get: operationId: Bc Partner Asset Get parameters: - description: '' in: query name: bc_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.bc_id x-open-field-id: 1 - description: '' in: query name: partner_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.partner_id x-open-field-id: 2 - description: '' in: query name: asset_type required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803356502782978 enum_package_name: BCAsset enums: - description: '' is_valid: true key: ADVERTISER value: '1' - description: '' is_valid: true key: CATALOG value: '4' - description: '' is_valid: true key: DOMAIN value: '6' - description: '' is_valid: false key: LEAD value: '9' - description: '' is_valid: false key: PIXEL value: '3' - description: '' is_valid: false key: STOREFRONT value: '5' - description: '' is_valid: false key: TIKTOK_SHOP value: '10' - description: '' is_valid: false key: TT_ACCOUNT value: '8' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-source: $.http.query.asset_type x-open-field-id: 3 - description: '' in: query name: share_type required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803477991512065 enum_package_name: ShareType enums: - description: '' is_valid: true key: SHARED value: '2' - description: '' is_valid: true key: SHARING value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.share_type x-open-field-id: 4 - content: application/json: schema: nullable: false properties: keyword: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.keyword description: '' in: query name: filtering required: false x-open-field-id: 5 - description: '' in: query name: page required: false schema: default: 1 format: int64 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page x-open-field-id: 6 - description: '' in: query name: page_size required: false schema: default: 10 format: int64 maximum: 50 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page_size x-open-field-id: 7 - 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get partner assets. [BC Partner Asset Get](https://business-api.tiktok.com/portal/docs?id=1739662828320769) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.query.bc_id type: number - name: partner_id required: true source: $.http.query.partner_id type: number - name: asset_type required: true source: $.http.query.asset_type type: number - name: share_type required: true source: $.http.query.share_type type: number - name: keyword required: false source: $.http.query.filtering.keyword type: string - name: page required: false source: $.http.query.page type: number - name: page_size required: false source: $.http.query.page_size type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: asset_type: $.http.query.asset_type bc_id: $.http.query.bc_id keyword: $.http.query.filtering.keyword page: $.http.query.page page_size: $.http.query.page_size partner_id: $.http.query.partner_id share_type: $.http.query.share_type response_cookie: [] response_header: [] response_rule: list: $.rpc.output.assets page_info: $.rpc.output.page_info x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/partner/delete/: post: operationId: Bc Partner 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: bc_id: description: '' nullable: false 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.bc_id partner_id: description: '' nullable: false 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.partner_id required: - bc_id - partner_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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Delete partner. [BC Partner Delete](https://business-api.tiktok.com/portal/docs?id=1739662779301890) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: partner_id required: true source: $.http.body.partner_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.body.bc_id partner_id: $.http.body.partner_id response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/partner/get/: get: operationId: Bc Partner Get parameters: - description: '' in: query name: bc_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.bc_id x-open-field-id: 1 - description: '' in: query name: page required: false schema: default: 1 format: int64 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page x-open-field-id: 2 - description: '' in: query name: page_size required: false schema: default: 10 format: int64 maximum: 50 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page_size x-open-field-id: 3 - content: application/json: schema: nullable: false properties: name: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 type: object x-open-allow-strlist: false x-open-allow-strnum: false description: '' in: query name: filtering required: false 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get partners. [BC Partner Get](https://business-api.tiktok.com/portal/docs?id=1739662727395330) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.query.bc_id type: number - name: keyword required: false source: $.http.query.filtering.name type: string - name: page required: false source: $.http.query.page type: number - name: page_size required: false source: $.http.query.page_size type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.query.bc_id keyword: $.http.query.filtering.name page: $.http.query.page page_size: $.http.query.page_size response_cookie: [] response_header: [] response_rule: list: $.rpc.output.partners page_info: $.rpc.output.page_info x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/pixel/link/get/: get: operationId: Bc Pixel Link Get parameters: - description: '' in: query name: bc_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.bc_id x-open-field-id: 1 - description: '' in: query name: pixel_code required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.pixel_code x-open-field-id: 2 - description: '' in: query name: page required: false schema: default: 1 format: int64 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page x-open-field-id: 3 - description: '' in: query name: page_size required: false schema: default: 10 format: int64 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page_size 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Use this endpoint to get a list of ad accounts that have been linked to the request pixel. [BC Pixel Link Get](https://business-api.tiktok.com/portal/docs?id=1753994966965249) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.query.bc_id type: number - name: pixel_code required: true source: $.http.query.pixel_code type: string - name: page required: false source: $.http.query.page type: number - name: page_size required: false source: $.http.query.page_size type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.query.bc_id page: $.http.query.page page_size: $.http.query.page_size pixel_code: $.http.query.pixel_code response_cookie: [] response_header: [] response_rule: list: $.rpc.output.advertisers page_info: $.rpc.output.page_info x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/pixel/link/update/: post: operationId: Bc Pixel Link 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_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) maxItems: 100 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.advertiser_ids bc_id: description: '' nullable: false 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.bc_id pixel_code: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.pixel_code relation_status: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803549054361601 enum_package_name: PixelAdvertiserRelationStatus enums: - description: '' is_valid: true key: LINK value: '999' - description: '' is_valid: true key: UNLINK value: '9999' key_format: string strict: true use_part: false validate_only: true value_format: int32 x-open-field-id: 4 x-open-source: $.http.body.relation_status required: - bc_id - pixel_code - advertiser_ids - relation_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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Use this endpoint to link and unlink pixel to advertiser accounts. [BC Pixel Link Update](https://business-api.tiktok.com/portal/docs?id=1753994950327297) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: pixel_code required: true source: $.http.body.pixel_code type: string - children: - type: number name: advertiser_ids required: true source: $.http.body.advertiser_ids sub_type: number type: array - name: relation_status required: true source: $.http.body.relation_status type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_ids: $.http.body.advertiser_ids bc_id: $.http.body.bc_id pixel_code: $.http.body.pixel_code relation_status: $.http.body.relation_status response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/pixel/transfer/: post: operationId: Bc Pixel Transfer 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: bc_id: description: '' nullable: false 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.bc_id pixel_code: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.pixel_code required: - bc_id - pixel_code 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Transfer Pixel from Advertiser to BC. [BC Pixel Transfer](https://business-api.tiktok.com/portal/docs?id=1753994928261122) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: pixel_code required: true source: $.http.body.pixel_code type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.body.bc_id pixel_code: $.http.body.pixel_code response_cookie: [] response_header: [] response_rule: asset_id: $.rpc.output.asset_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/transaction/get/: get: operationId: Bc Transaction Get parameters: - description: '' in: query name: bc_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.bc_id x-open-field-id: 1 - content: application/json: schema: nullable: false properties: funds_type: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803629000016898 enum_package_name: FundsType enums: - description: '' is_valid: true key: FUNDS_TYPE_CASH value: '1' - description: '' is_valid: true key: FUNDS_TYPE_GRANT value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.funds_types description: '' in: query name: filtering required: false x-open-field-id: 2 - description: '' in: query name: start_date required: false schema: format: date nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.start_date x-open-field-id: 3 - description: '' in: query name: end_date required: false schema: format: date nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.end_date x-open-field-id: 4 - description: '' in: query name: page required: false schema: default: 1 format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page x-open-field-id: 5 - description: '' in: query name: page_size required: false schema: default: 10 format: int64 maximum: 50 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page_size 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get translaction records of a Business Center. [BC Transaction Get](https://business-api.tiktok.com/portal/docs?id=1739939140408322) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.query.bc_id type: number - children: - type: number is_expand: true name: funds_types required: false source: $.http.query.filtering.funds_type[] sub_type: number type: array - name: start_date required: false source: $.http.query.start_date type: string - name: end_date required: false source: $.http.query.end_date type: string - name: page required: false source: $.http.query.page type: number - name: page_size required: false source: $.http.query.page_size type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.query.bc_id end_date: $.http.query.end_date funds_types: $.http.query.filtering.funds_type[] page: $.http.query.page page_size: $.http.query.page_size start_date: $.http.query.start_date response_cookie: [] response_header: [] response_rule: list: $.rpc.output.transactions page_info: $.rpc.output.page_info transaction_summary: $.rpc.output.transaction_summary x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /bc/transfer/: post: operationId: Bc Transfer 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: 4 x-open-source: $.http.body.advertiser_id bc_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.bc_id cash_amount: description: '' format: float type: number x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.body.cash_amount child_bc_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.child_bc_id grant_amount: description: '' format: float type: number x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 x-open-source: $.http.body.grant_amount request_id: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 8 x-open-source: $.http.body.request_id transfer_level: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.transfer_level transfer_type: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1811243935576066 enum_package_name: TransferType enums: - description: '' is_valid: true key: RECHARGE value: '1' - description: '' is_valid: true key: REFUND value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 5 x-open-source: $.http.body.transfer_type required: - bc_id - transfer_type type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Process payments (recharge money to or deduct money from an ad account in a Business Center. [BC Transfer](https://business-api.tiktok.com/portal/docs?id=1739939095321601) tags: - BC x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: child_bc_id required: false source: $.http.body.child_bc_id type: number - name: transfer_level required: false source: $.http.body.transfer_level type: string - name: advertiser_id required: false source: $.http.body.advertiser_id type: number - name: transfer_type required: true source: $.http.body.transfer_type type: number - name: cash_amount required: false source: $.http.body.cash_amount type: number - name: grant_amount required: false source: $.http.body.grant_amount type: number - name: request_id required: false source: $.http.body.request_id type: string - 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: context_info required: true source: $.http.body.context_info type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id bc_id: $.http.body.bc_id cash_amount: $.http.body.cash_amount child_bc_id: $.http.body.child_bc_id context_info: $.http.body.context_info grant_amount: $.http.body.grant_amount request_id: $.http.body.request_id transfer_level: $.http.body.transfer_level transfer_type: $.http.body.transfer_type response_cookie: [] response_header: [] response_rule: advertiser_id: $.rpc.output.advertiser_id bc_id: $.rpc.output.bc_id child_bc_id: $.rpc.output.child_bc_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /blockedword/check/: get: operationId: Blockedword Check parameters: - description: '' in: query name: advertiser_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 - content: application/json: schema: items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false description: '' in: query name: blocked_words 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Check if a list of words is blocked. [Blockedword Check](https://business-api.tiktok.com/portal/docs?id=1739029247961089) tags: - Comments x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - children: - type: string is_expand: true name: blocked_words required: true source: $.http.query.blocked_words[] sub_type: string type: array plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id blocked_words: $.http.query.blocked_words[] response_cookie: [] response_header: [] response_rule: results[][]: - blocked: $.rpc.output.results[].blocked word: $.rpc.output.results[].word x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /blockedword/create/: post: operationId: Blockedword 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: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 blocked_words: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 required: - advertiser_id - blocked_words 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Add words to the block list. [Blockedword Create](https://business-api.tiktok.com/portal/docs?id=1739029218470913) tags: - Comments x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: adv_id required: true source: $.http.body.advertiser_id type: number - children: - type: string is_expand: true name: bw_contents required: true source: $.http.body.blocked_words sub_type: string type: array plugins: after_response: [] before_request: [] request_query_rule: null request_rule: adv_id: $.http.body.advertiser_id bw_contents: $.http.body.blocked_words response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /blockedword/delete/: post: operationId: Blockedword 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: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 blocked_words: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 required: - advertiser_id - blocked_words 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Delete one or more blocked words. [Blockedword Delete](https://business-api.tiktok.com/portal/docs?id=1739029277346817) tags: - Comments x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: adv_id required: false source: $.http.body.advertiser_id type: number - children: - type: string is_expand: true name: bw_contents required: false source: $.http.body.blocked_words[] sub_type: string type: array - name: source required: true source: '2' type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: adv_id: $.http.body.advertiser_id bw_contents: $.http.body.blocked_words[] source: 2 response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /blockedword/list/: get: operationId: Blockedword List parameters: - description: '' in: query name: advertiser_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 - content: application/json: schema: nullable: false properties: page: default: 1 description: '' format: int64 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.query.page_info.page page_size: default: 10 description: '' format: int64 maximum: 500 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.query.page_info.page_size type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page_info description: '' in: query name: page_info required: false x-open-field-id: 2 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get the list of blocked words for an ad account. [Blockedword List](https://business-api.tiktok.com/portal/docs?id=1739029260837889) tags: - Comments x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - children: - name: page required: false source: $.http.query.page_info.page type: number - name: page_size required: false source: $.http.query.page_info.page_size type: number is_expand: true name: page_info required: false type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id page_info: page: $.http.query.page_info.page page_size: $.http.query.page_info.page_size response_cookie: [] response_header: [] response_rule: list[][]: - bw_content: $.rpc.output.blocked_word_list[].bw_content page_info: page: $.rpc.output.page_info.page page_size: $.rpc.output.page_info.page_size total_number: $.rpc.output.page_info.total_number total_page: $.rpc.output.page_info.total_page x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /blockedword/task/check/: get: operationId: Blockedword Task Check parameters: - description: '' in: query name: task_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 - description: '' in: query name: advertiser_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Check the status of the export task. [Blockedword Task Check](https://business-api.tiktok.com/portal/docs?id=1739029311687681) tags: - Comments x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: task_id required: false source: $.http.query.task_id type: string - children: - name: source required: true source: '2' type: number - name: adv_id required: false source: $.http.query.advertiser_id type: number is_expand: true name: condition required: true type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: condition: adv_id: $.http.query.advertiser_id source: 2 task_id: $.http.query.task_id response_cookie: [] response_header: [] response_rule: status: $.rpc.output.status task_id: $.rpc.output.task_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /blockedword/task/create/: post: operationId: Blockedword Task 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: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 blocked_words: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 lang: default: EN description: '' nullable: false 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: English is_valid: true key: EN value: en - description: Japanese is_valid: true key: JA value: ja - description: Chinese is_valid: true key: ZH value: zh key_format: string strict: false use_part: false validate_only: false value_format: string x-open-field-id: 3 required: - advertiser_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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Create a task to export blocked words. [Blockedword Task Create](https://business-api.tiktok.com/portal/docs?id=1739029296119809) tags: - Comments x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - children: - name: source required: true source: '2' type: number - name: adv_id required: false source: $.http.body.advertiser_id type: number - children: - type: string is_expand: true name: bw_contents required: false source: $.http.body.blocked_words[] sub_type: string type: array - name: lang required: false source: $.http.body.lang type: string is_expand: true name: condition required: true type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: condition: adv_id: $.http.body.advertiser_id bw_contents: $.http.body.blocked_words[] lang: $.http.body.lang source: 2 response_cookie: [] response_header: [] response_rule: task_id: $.rpc.output.task_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /blockedword/update/: post: operationId: Blockedword 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: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 new_word: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 old_word: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 required: - advertiser_id - new_word - old_word 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Replace a blocked word with another word. [Blockedword Task Update](https://business-api.tiktok.com/portal/docs?id=1739029234526209) tags: - Comments x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: adv_id required: false source: $.http.body.advertiser_id type: number - name: old_content required: false source: $.http.body.old_word type: string - name: new_content required: false source: $.http.body.new_word type: string - name: source required: true source: '2' type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: adv_id: $.http.body.advertiser_id new_content: $.http.body.new_word old_content: $.http.body.old_word source: 2 response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /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: '' nullable: false 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: '' nullable: false 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: '' nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 22 budget: description: '' format: double nullable: false 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: '' nullable: false 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: nullable: false properties: identity_info: description: '' nullable: false properties: identity_authorized_bc_id: description: '' nullable: false 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: '' nullable: false 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: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 identity_type: description: '' nullable: false 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: '' nullable: false 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: '' nullable: false 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: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 1 minItems: 1 nullable: false 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 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 20 deep_bid_type: description: '' nullable: false 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: nullable: false properties: identity_authorized_bc_id: description: '' nullable: false 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: '' nullable: false 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: '' nullable: false 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: '' nullable: false 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: '' nullable: false 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 nullable: 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: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 50 minItems: 1 nullable: false 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: nullable: false properties: identity_info: description: '' nullable: false properties: identity_authorized_bc_id: description: '' nullable: false 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: '' nullable: false 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: '' nullable: false 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: '' nullable: false 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: '' nullable: false 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: '' nullable: false 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: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: 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: '' nullable: false properties: video_id: description: '' nullable: false 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 nullable: 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: '' nullable: false 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: '' nullable: false 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: '' nullable: false 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: '' nullable: false properties: auto_schedule_enabled: default: true description: '' nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 custom_schedule_list: description: '' items: nullable: false properties: end_date: description: '' format: date nullable: false 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: '' nullable: false 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 nullable: false 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 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 is_enabled: default: true description: '' nullable: false 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 nullable: false 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: '' nullable: false 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 nullable: false 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: '' nullable: false 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: '' nullable: false 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: '' nullable: false 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: '' nullable: false 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: '' nullable: false 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: '' nullable: false 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string 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: nullable: false 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: nullable: false 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string 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: '' nullable: false 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: '' nullable: false 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: '' nullable: false properties: bid_type: description: '' nullable: false 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 nullable: false 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: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 product_list: description: '' items: nullable: false properties: spu_id: description: '' nullable: false 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 nullable: false 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: '' nullable: false 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: '' nullable: false 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: '' nullable: false 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: '' nullable: false 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string 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: '' nullable: false 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: '' nullable: false 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string 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: nullable: false 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: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) maxItems: 20 minItems: 1 nullable: false 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string 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: nullable: false 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: nullable: false 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string 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: '' nullable: false 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: '' nullable: false 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: '' nullable: false properties: budget: description: '' format: double nullable: false 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: '' nullable: false 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: '' nullable: false 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: '' nullable: false 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: '' nullable: false 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: '' nullable: false 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string 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: '' nullable: false 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: '' nullable: false 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: '' nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 12 budget: description: '' format: double nullable: false 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: '' nullable: false 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: '' nullable: false 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: nullable: false properties: identity_info: description: '' nullable: false properties: identity_authorized_bc_id: description: '' nullable: false 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: '' nullable: false 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: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 identity_type: description: '' nullable: false 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: '' nullable: false 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: '' nullable: false 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: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 1 minItems: 1 nullable: false 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 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 10 item_group_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 13 item_list: description: '' items: nullable: false properties: identity_info: description: '' nullable: false properties: identity_authorized_bc_id: description: '' nullable: false 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: '' nullable: false 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: '' nullable: false 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: '' nullable: false 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: '' nullable: false 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: '' nullable: false 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: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: 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: '' nullable: false properties: video_id: description: '' nullable: false 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 nullable: 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: '' nullable: false properties: auto_schedule_enabled: description: '' nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 custom_schedule_list: description: '' items: nullable: false properties: end_date: description: '' nullable: false 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: '' nullable: false 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: '' nullable: false 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 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 is_enabled: description: '' nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 roas_bid_multiplier: description: '' format: int64 nullable: false 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 nullable: false 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: '' nullable: false 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: '' nullable: false 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string 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 /catalog/available_country/get/: get: operationId: Catalog Available_country Get parameters: - description: '' in: query name: bc_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.bc_id x-open-field-id: 1 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get the countries and regions that ads for a catalog can be delivered to. [Catalog Available Country Get](https://business-api.tiktok.com/portal/docs?id=1740491257516034) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.query.bc_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.query.bc_id response_cookie: [] response_header: [] response_rule: region_codes: $.rpc.output.countrys x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/capitalize/: post: operationId: Catalog Capitalize 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: '' nullable: false 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.adv_id bc_id: description: '' nullable: false 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.bc_id catalog_id: description: '' nullable: false 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.catalog_id required: - bc_id - advertiser_id - catalog_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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Migrate catalogs under your ad account to your Business Center. [Catalog Capitalize](https://business-api.tiktok.com/portal/docs?id=1740490222539778) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: user_id required: true source: $.context.core_user_id type: number - name: adv_id required: true source: $.http.body.advertiser_id type: number - name: catalog_id required: true source: $.http.body.catalog_id type: number - name: source required: true source: '2' type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: adv_id: $.http.body.advertiser_id bc_id: $.http.body.bc_id catalog_id: $.http.body.catalog_id source: 2 user_id: $.context.core_user_id response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/create/: post: operationId: Catalog 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: bc_id: description: '' nullable: false 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.bc_id catalog_conf: description: '' nullable: false properties: business_platform: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 channel: description: '' nullable: false 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: CLIENT value: CLIENT - description: '' is_valid: true key: BUSINESS_PLATFORM value: BUSINESS_PLATFORM - description: '' is_valid: true key: PARTNER value: PARTNER key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 3 x-open-source: $.http.body.catalog_conf.channel currency: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1802164933598209 enum_package_name: CatalogCurrency enums: - description: '' is_valid: true key: AED value: '784' - description: '' is_valid: true key: ALL value: '8' - description: '' is_valid: true key: AOA value: '973' - description: '' is_valid: true key: ARS value: '32' - description: '' is_valid: true key: AUD value: '36' - description: '' is_valid: true key: BAM value: '977' - description: '' is_valid: true key: BDT value: '50' - description: '' is_valid: true key: BGN value: '975' - description: '' is_valid: true key: BHD value: '48' - description: '' is_valid: true key: BND value: '96' - description: '' is_valid: true key: BOB value: '68' - description: '' is_valid: true key: BRL value: '986' - description: '' is_valid: true key: BWP value: '72' - description: '' is_valid: true key: BYN value: '933' - description: '' is_valid: true key: CAD value: '124' - description: '' is_valid: true key: CHF value: '756' - description: '' is_valid: true key: CLP value: '152' - description: '' is_valid: true key: CNY value: '156' - description: '' is_valid: true key: COP value: '170' - description: '' is_valid: true key: CRC value: '188' - description: '' is_valid: true key: CZK value: '203' - description: '' is_valid: true key: DKK value: '208' - description: '' is_valid: true key: DZD value: '12' - description: '' is_valid: true key: EGP value: '818' - description: '' is_valid: true key: EUR value: '978' - description: '' is_valid: true key: GBP value: '826' - description: '' is_valid: true key: GHS value: '936' - description: '' is_valid: true key: GTQ value: '320' - description: '' is_valid: true key: GYD value: '328' - description: '' is_valid: true key: HKD value: '344' - description: '' is_valid: true key: HNL value: '340' - description: '' is_valid: true key: HRK value: '191' - description: '' is_valid: true key: HUF value: '348' - description: '' is_valid: true key: IDR value: '360' - description: '' is_valid: true key: ILS value: '376' - description: '' is_valid: true key: INR value: '356' - description: '' is_valid: true key: IQD value: '368' - description: '' is_valid: true key: IRR value: '364' - description: '' is_valid: true key: ISK value: '352' - description: '' is_valid: true key: JOD value: '400' - description: '' is_valid: true key: JPY value: '392' - description: '' is_valid: true key: KES value: '404' - description: '' is_valid: true key: KHR value: '116' - description: '' is_valid: true key: KRW value: '410' - description: '' is_valid: true key: KWD value: '414' - description: '' is_valid: true key: KZT value: '398' - description: '' is_valid: true key: LAK value: '418' - description: '' is_valid: true key: LBP value: '422' - description: '' is_valid: true key: LKR value: '144' - description: '' is_valid: true key: LYD value: '434' - description: '' is_valid: true key: MAD value: '504' - description: '' is_valid: true key: MDL value: '498' - description: '' is_valid: true key: MKD value: '807' - description: '' is_valid: true key: MMK value: '104' - description: '' is_valid: true key: MNT value: '496' - description: '' is_valid: true key: MOP value: '446' - description: '' is_valid: true key: MUR value: '480' - description: '' is_valid: true key: MVR value: '462' - description: '' is_valid: true key: MWK value: '454' - description: '' is_valid: true key: MXN value: '484' - description: '' is_valid: true key: MYR value: '458' - description: '' is_valid: true key: NGN value: '566' - description: '' is_valid: true key: NIO value: '558' - description: '' is_valid: true key: NOK value: '578' - description: '' is_valid: true key: NPR value: '524' - description: '' is_valid: true key: NZD value: '554' - description: '' is_valid: true key: OMNI value: '-1' - description: '' is_valid: true key: OMR value: '512' - description: '' is_valid: true key: PEN value: '604' - description: '' is_valid: true key: PHP value: '608' - description: '' is_valid: true key: PKR value: '586' - description: '' is_valid: true key: PLN value: '985' - description: '' is_valid: true key: PYG value: '600' - description: '' is_valid: true key: QAR value: '634' - description: '' is_valid: true key: RON value: '946' - description: '' is_valid: true key: RSD value: '941' - description: '' is_valid: true key: RUB value: '643' - description: '' is_valid: true key: SAR value: '682' - description: '' is_valid: true key: SDG value: '938' - description: '' is_valid: true key: SEK value: '752' - description: '' is_valid: true key: SGD value: '702' - description: '' is_valid: true key: SLL value: '694' - description: '' is_valid: true key: SRD value: '968' - description: '' is_valid: true key: SSP value: '728' - description: '' is_valid: true key: SYP value: '760' - description: '' is_valid: true key: THB value: '764' - description: '' is_valid: true key: TND value: '788' - description: '' is_valid: true key: TRY value: '949' - description: '' is_valid: true key: TWD value: '901' - description: '' is_valid: true key: TZS value: '834' - description: '' is_valid: true key: UAH value: '980' - description: '' is_valid: true key: UGX value: '800' - description: '' is_valid: true key: USD value: '840' - description: '' is_valid: true key: UYU value: '858' - description: '' is_valid: true key: UZS value: '860' - description: '' is_valid: true key: VEF value: '937' - description: '' is_valid: true key: VND value: '704' - description: '' is_valid: true key: XAF value: '950' - description: '' is_valid: true key: YER value: '886' - description: '' is_valid: true key: ZAR value: '710' - description: '' is_valid: true key: ZMW value: '967' key_format: string strict: true use_part: false validate_only: true value_format: int32 x-open-field-id: 2 x-open-source: $.http.body.catalog_conf.currency region_code: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.catalog_conf.region_code required: - region_code - currency type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.catalog_conf catalog_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1802164714465281 enum_package_name: CatalogType enums: - description: '' is_valid: true key: AUTO value: '11' - description: '' is_valid: true key: DESTINATION value: '15' - description: '' is_valid: true key: ECOM value: '10' - description: '' is_valid: true key: ENTERTAINMENT value: '12' - description: '' is_valid: true key: FLIGHT value: '14' - description: '' is_valid: true key: HOTEL value: '13' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 2 x-open-source: $.http.body.catalog_type creative_asset_type: description: '' nullable: false 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: VIDEO value: VIDEO key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 5 name: description: '' maxLength: 128 minLength: 1 nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.catalog_name required: - bc_id - catalog_type - name - catalog_conf 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Create a catalog by specifying information such as name, targeted locations, and currency. [Catalog Create](https://business-api.tiktok.com/portal/docs?id=1740306481704961) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: catalog_type required: true source: $.http.body.catalog_type type: number - name: catalog_name required: true source: $.http.body.name type: string - children: - name: region_code required: true source: $.http.body.catalog_conf.region_code type: string - name: currency required: true source: $.http.body.catalog_conf.currency type: string - name: channel required: false source: $.http.body.catalog_conf.channel type: string - name: business_platform required: false source: $.http.body.catalog_conf.business_platform type: string is_expand: true name: catalog_conf required: true type: object - name: creative_asset_type required: false source: $.http.query.creative_asset_type type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.body.bc_id catalog_conf: business_platform: $.http.body.catalog_conf.business_platform channel: $.http.body.catalog_conf.channel currency: $.http.body.catalog_conf.currency region_code: $.http.body.catalog_conf.region_code catalog_name: $.http.body.name catalog_type: $.http.body.catalog_type creative_asset_type: $.http.query.creative_asset_type response_cookie: [] response_header: [] response_rule: catalog_id: $.rpc.output.catalog_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/delete/: post: operationId: Catalog 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: bc_id: description: '' nullable: false 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.bc_id catalog_id: description: '' nullable: false 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.catalog_id required: - catalog_id - bc_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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Delete a catalog. [Catalog Delete](https://business-api.tiktok.com/portal/docs?id=1740310064588801) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: request_source required: true source: '1' type: number - name: opt_type required: true source: '2' type: number - name: catalog_id required: true source: $.http.body.catalog_id type: number - name: user_id required: false source: $.context.core_user_id type: number - name: bc_id required: false source: $.http.body.bc_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.body.bc_id catalog_id: $.http.body.catalog_id opt_type: 2 request_source: 1 user_id: $.context.core_user_id response_cookie: [] response_header: [] response_rule: catalog_id: $.http.body.catalog_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/eventsource/bind/: post: operationId: Catalog Eventsource Bind 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: '' nullable: false 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 app_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.body.mobile_app_id bc_id: description: '' nullable: false 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.bc_id catalog_id: description: '' nullable: false 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.catalog_id pixel_code: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.pixel_code required: - bc_id - advertiser_id - catalog_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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Bind app or website event sources to a catalog in a Business Center. [Catalog Eventsource Bind](https://business-api.tiktok.com/portal/docs?id=1740492491200513) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: advertiser_id required: true source: $.http.body.advertiser_id type: number - name: catalog_id required: true source: $.http.body.catalog_id type: number - name: opt_type required: true source: '1' type: number - name: core_user_id required: true source: $.context.core_user_id type: number - name: pixel_code required: false source: $.http.body.pixel_code type: string - name: mobile_app_id required: false source: $.http.body.app_id type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id bc_id: $.http.body.bc_id catalog_id: $.http.body.catalog_id core_user_id: $.context.core_user_id mobile_app_id: $.http.body.app_id opt_type: 1 pixel_code: $.http.body.pixel_code response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/eventsource/unbind/: post: operationId: Catalog Eventsource Unbind 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: '' nullable: false 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 app_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.body.mobile_app_id bc_id: description: '' nullable: false 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.bc_id catalog_id: description: '' nullable: false 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.catalog_id pixel_code: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.pixel_code required: - bc_id - advertiser_id - catalog_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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Unbind event sources from a catalog. [Catalog Eventsource Unbind](https://business-api.tiktok.com/portal/docs?id=1740492512449538) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: advertiser_id required: true source: $.http.body.advertiser_id type: number - name: catalog_id required: true source: $.http.body.catalog_id type: number - name: opt_type required: true source: '2' type: number - name: core_user_id required: true source: $.context.core_user_id type: number - name: pixel_code required: false source: $.http.body.pixel_code type: string - name: mobile_app_id required: false source: $.http.body.app_id type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id bc_id: $.http.body.bc_id catalog_id: $.http.body.catalog_id core_user_id: $.context.core_user_id mobile_app_id: $.http.body.app_id opt_type: 2 pixel_code: $.http.body.pixel_code response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/eventsource_bind/get/: get: operationId: Catalog Eventsource_bind Get parameters: - description: '' in: query name: catalog_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.catalogue_id x-open-field-id: 1 - description: '' in: query name: bc_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.bc_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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get event source binding information. [Catalog Eventsource Bind Get](https://business-api.tiktok.com/portal/docs?id=1740492531343362) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: catalogue_id required: false source: $.http.query.catalog_id type: number - name: user_id required: false source: $.context.core_user_id type: number - name: bc_id required: false source: $.http.query.bc_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.query.bc_id catalogue_id: $.http.query.catalog_id user_id: $.context.core_user_id response_cookie: [] response_header: [] response_rule: catalog_id: $.http.query.catalog_id event_sources[][]: - app_id: $.rpc.output.event_sources[].meteor_app_id event_source_name: $.rpc.output.event_sources[].app_name pixel_code: $.rpc.output.event_sources[].pixel_code x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/feed/create/: post: operationId: Catalog Feed 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: bc_id: description: '' nullable: false 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.bc_id catalog_id: description: '' nullable: false 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.catalog_id feed_name: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.feed_name schedule_param: description: '' nullable: false properties: day_of_month: description: '' format: int32 maximum: 31 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.body.schedule_param.day_of_month hour: description: '' format: int32 maximum: 23 minimum: 0 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.body.schedule_param.hour interval_count: description: '' format: int32 maximum: 30 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.schedule_param.interval_count interval_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1822447827658753 enum_package_name: CatalogFeedIntervalType enums: - description: '' is_valid: true key: DAILY value: '2' - description: '' is_valid: true key: HOURLY value: '1' - description: '' is_valid: true key: MONTHLY value: '4' key_format: string strict: true use_part: false validate_only: false value_format: int64 x-open-field-id: 2 x-open-source: $.http.body.schedule_param.interval_type minute: description: '' format: int32 maximum: 59 minimum: 0 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 x-open-source: $.http.body.schedule_param.minute source: description: '' nullable: false properties: password: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.schedule_param.source.password uri: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.schedule_param.source.uri username: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.schedule_param.source.username type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.schedule_param.source timezone: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.schedule_param.timezone type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.body.schedule_param update_mode: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1822447728485378 enum_package_name: CatalogFeedUpdateMode enums: - description: '' is_valid: true key: INCREMENTAL value: '1' - description: '' is_valid: true key: OVERWRITE value: '2' - description: '' is_valid: false key: SUPPLEMENT value: '3' key_format: string strict: true use_part: true validate_only: false value_format: int64 x-open-field-id: 4 x-open-source: $.http.body.update_mode required: - bc_id - catalog_id - feed_name - update_mode 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Create a feed. [Catalog Feed Create](https://business-api.tiktok.com/portal/docs?id=1740665161957377) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: catalog_id required: true source: $.http.body.catalog_id type: number - name: feed_name required: false source: $.http.body.feed_name type: string - name: update_mode required: true source: $.http.body.update_mode type: number - children: - children: - name: uri required: false source: $.http.body.schedule_param.source.uri type: string - name: username required: false source: $.http.body.schedule_param.source.username type: string - name: password required: false source: $.http.body.schedule_param.source.password type: string name: source required: false source: $.http.body.schedule_param.source type: object - name: interval_type required: false source: $.http.body.schedule_param.interval_type type: number - name: interval_count required: false source: $.http.body.schedule_param.interval_count type: number - name: timezone required: false source: $.http.body.schedule_param.timezone type: string - name: day_of_month required: false source: $.http.body.schedule_param.day_of_month type: number - name: hour required: false source: $.http.body.schedule_param.hour type: number - name: minute required: false source: $.http.body.schedule_param.minute type: number name: schedule_param required: false source: $.http.body.schedule_param type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.body.bc_id catalog_id: $.http.body.catalog_id feed_name: $.http.body.feed_name schedule_param: $.http.body.schedule_param update_mode: $.http.body.update_mode response_cookie: [] response_header: [] response_rule: feed_id: $.rpc.output.feed_data.feed_id feed_name: $.rpc.output.feed_data.feed_name last_update_param: $.rpc.output.feed_data.last_update_param next_update_time: $.rpc.output.feed_data.next_update_time number_of_products: $.rpc.output.feed_data.number_of_products status: $.rpc.output.feed_data.status x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/feed/delete/: post: operationId: Catalog Feed 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: bc_id: description: '' nullable: false 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.advertiserId catalog_id: description: '' nullable: false 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.multiLocLangType feed_id: description: '' nullable: false 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.feedIds required: - bc_id - feed_id - catalog_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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Delete a feed. [Catalog Feed Delete](https://business-api.tiktok.com/portal/docs?id=1740665210863617) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - children: - name: id required: false source: $.http.body.feed_id type: number - name: platformId required: false source: $.http.body.catalog_id type: number is_expand: true name: feed required: false type: object - name: optType required: false source: '3' type: number - children: - type: number is_expand: true name: feedIds required: false source: $.feed_ids sub_type: number type: array plugins: after_response: [] before_request: - Plugin_mk_list_5934464: - description: make list - request_params: - $.http.body.feed_id - result_params: - $.feed_ids - version: c9e39304e3af5001d163ef81733004ce request_query_rule: null request_rule: feed: id: $.http.body.feed_id platformId: $.http.body.catalog_id feedIds: $.feed_ids optType: 3 response_cookie: [] response_header: [] response_rule: feed_id: $.http.body.feed_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/feed/get/: get: operationId: Catalog Feed Get parameters: - description: '' in: query name: bc_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.bc_id x-open-field-id: 1 - description: '' in: query name: catalog_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.catalog_id x-open-field-id: 2 - description: '' in: query name: feed_id required: false schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.feed_id 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get all feeds or a particular feed. [Catalog Feed Get](https://business-api.tiktok.com/portal/docs?id=1740665183073281) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.query.bc_id type: number - name: catalog_id required: true source: $.http.query.catalog_id type: number - name: feed_id required: false source: $.http.query.feed_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.query.bc_id catalog_id: $.http.query.catalog_id feed_id: $.http.query.feed_id response_cookie: [] response_header: [] response_rule: feed_list: $.rpc.output.feed_list x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/feed/log/: get: operationId: Catalog Feed Log parameters: - description: '' in: query name: bc_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.bc_id x-open-field-id: 1 - description: '' in: query name: catalog_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.catalog_id x-open-field-id: 2 - description: '' in: query name: feed_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.feed_id x-open-field-id: 3 - description: '' in: query name: context_info required: false schema: $ref: ./openapi.yaml#/definitions/Context_infoCatalogFeedLog 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get the last 10 operations of a feed. [Catalog Feed Log](https://business-api.tiktok.com/portal/docs?id=1740665225631810) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.query.bc_id type: number - name: catalog_id required: true source: $.http.query.catalog_id type: number - name: feed_id required: true source: $.http.query.feed_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 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: bc_id: $.http.query.bc_id catalog_id: $.http.query.catalog_id context_info: $.http.query.context_info feed_id: $.http.query.feed_id response_cookie: [] response_header: [] response_rule: feed_logs: $.rpc.output.feed_logs x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/feed/update/: post: operationId: Catalog Feed 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: bc_id: description: '' nullable: false 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.bc_id catalog_id: description: '' nullable: false 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.catalog_id feed_id: description: '' nullable: false 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.feed_id feed_name: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.feed_name schedule_param: description: '' nullable: false properties: day_of_month: description: '' format: int32 maximum: 31 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.body.schedule_param.day_of_month hour: description: '' format: int32 maximum: 23 minimum: 0 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.body.schedule_param.hour interval_count: description: '' format: int32 maximum: 30 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.schedule_param.interval_count interval_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1822447827658753 enum_package_name: CatalogFeedIntervalType enums: - description: '' is_valid: true key: DAILY value: '2' - description: '' is_valid: true key: HOURLY value: '1' - description: '' is_valid: true key: MONTHLY value: '4' key_format: string strict: true use_part: false validate_only: false value_format: int64 x-open-field-id: 2 x-open-source: $.http.body.schedule_param.interval_type minute: description: '' format: int32 maximum: 59 minimum: 0 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 x-open-source: $.http.body.schedule_param.minute source: description: '' nullable: false properties: password: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.schedule_param.source.password uri: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.schedule_param.source.uri username: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.schedule_param.source.username type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.schedule_param.source timezone: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.schedule_param.timezone type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.body.schedule_param update_mode: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1822447728485378 enum_package_name: CatalogFeedUpdateMode enums: - description: '' is_valid: true key: INCREMENTAL value: '1' - description: '' is_valid: true key: OVERWRITE value: '2' - description: '' is_valid: false key: SUPPLEMENT value: '3' key_format: string strict: true use_part: true validate_only: false value_format: int64 x-open-field-id: 5 x-open-source: $.http.body.update_mode required: - bc_id - catalog_id - feed_id - feed_name - update_mode 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Update a feed. [Catalog Feed Update](https://business-api.tiktok.com/portal/docs?id=1740665197662210) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: catalog_id required: true source: $.http.body.catalog_id type: number - name: feed_id required: false source: $.http.body.feed_id type: number - name: update_mode required: true source: $.http.body.update_mode type: number - children: - children: - name: uri required: false source: $.http.body.schedule_param.source.uri type: string - name: username required: false source: $.http.body.schedule_param.source.username type: string - name: password required: false source: $.http.body.schedule_param.source.password type: string is_expand: true name: source required: false source: $.http.body.schedule_param.source type: object - name: interval_type required: false source: $.http.body.schedule_param.interval_type type: number - name: interval_count required: false source: $.http.body.schedule_param.interval_count type: number - name: timezone required: false source: $.http.body.schedule_param.timezone type: string - name: day_of_month required: false source: $.http.body.schedule_param.day_of_month type: number - name: hour required: false source: $.http.body.schedule_param.hour type: number - name: minute required: false source: $.http.body.schedule_param.minute type: number is_expand: false name: schedule_param required: false source: $.http.body.schedule_param type: object - name: feed_name required: false source: $.http.body.feed_name type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.body.bc_id catalog_id: $.http.body.catalog_id feed_id: $.http.body.feed_id feed_name: $.http.body.feed_name schedule_param: $.http.body.schedule_param update_mode: $.http.body.update_mode response_cookie: [] response_header: [] response_rule: feed_id: $.rpc.output.feed_data.feed_id feed_name: $.rpc.output.feed_data.feed_name last_update_param: $.rpc.output.feed_data.last_update_param next_update_time: $.rpc.output.feed_data.next_update_time number_of_products: $.rpc.output.feed_data.number_of_products status: $.rpc.output.feed_data.status x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/get/: get: operationId: Catalog Get parameters: - description: '' in: query name: catalog_id required: false schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.catalog_id x-open-field-id: 1 - description: '' in: query name: bc_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.bc_id x-open-field-id: 2 - description: '' in: query name: page required: false schema: default: 1 format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page x-open-field-id: 3 - description: '' in: query name: page_size required: false schema: default: 10 format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page_size 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get all catalogs or a particular catalog. [Catalog Get](https://business-api.tiktok.com/portal/docs?id=1740315452868610) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: catalog_id required: false source: $.http.query.catalog_id type: number - name: bc_id required: true source: $.http.query.bc_id type: number - 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: - Plugin_catalog_get_7931521: - description: filter resp by catalog_id - request_params: - $.http.query.catalog_id - $.rpc.output.catalog_infos[] - result_params: - $.resp_catalog_infos - version: e7b0b08a293ff345d513b1ce2005b5e7 before_request: [] request_query_rule: null request_rule: bc_id: $.http.query.bc_id catalog_id: $.http.query.catalog_id page: $.http.query.page page_size: $.http.query.page_size response_cookie: [] response_header: [] response_rule: list[][]: - bc_info[]: - bc_id: $.rpc.output.catalog_info[].bc_info.id bc_name: $.rpc.output.catalog_info[].bc_info.name picture_url: $.rpc.output.catalog_info[].bc_info.picture_url catalog_conf: $.rpc.output.catalog_info[].catalog_conf catalog_id: $.rpc.output.catalog_info[].catalog_id catalog_name: $.rpc.output.catalog_info[].catalog_name catalog_type: $.rpc.output.catalog_info[].catalog_type create_time: $.rpc.output.catalog_info[].create_time creative_asset_type: $.rpc.output.catalog_info[].creative_asset_type update_time: $.rpc.output.catalog_info[].update_time page_info: $.rpc.output.page_info x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /catalog/lexicon/get/: get: operationId: Catalog Lexicon Get parameters: - description: '' in: query name: catalog_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.catalog_id x-open-field-id: 1 - description: '' in: query name: bc_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.lexicon_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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get the lexicon for your catalog for use in ad texts. [Catalog Lexicon Get](https://business-api.tiktok.com/portal/docs?id=1740488375815169) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: dpaID required: false source: $.http.query.catalog_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: dpaID: $.http.query.catalog_id response_cookie: [] response_header: [] response_rule: list[][]: - catalog_id: $.rpc.output.lexicons[].dpaID default_value: $.rpc.output.lexicons[].defaultValue lexicon_id: $.rpc.output.lexicons[].lexiconID metadata: $.rpc.output.lexicons[].metaField name: $.rpc.output.lexicons[].name type: $.rpc.output.lexicons[].type update_time: $.rpc.output.lexicons[].modifyTime x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/location_currency/get/: get: operationId: Catalog Location_currency Get 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 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get supported locations and corresponding currencies for Catalog API. [Catalog Location Currency Get](https://business-api.tiktok.com/portal/docs?id=1740491571747841) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: [] plugins: after_response: - Plugin_resp_to_list_7973814: - description: map to list - request_params: - $.rpc.output.item - result_params: - $.myList - version: 2d4da8e18a9a66f726c055fc084ea5ec before_request: [] request_query_rule: null request_rule: null response_cookie: [] response_header: [] response_rule: list: $.myList x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/overview/: get: operationId: Catalog Overview parameters: - description: '' in: query name: catalog_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.catalog_id x-open-field-id: 1 - description: '' in: query name: bc_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get the number of products in different audit statuses in a catalog. [Catalog Overview](https://business-api.tiktok.com/portal/docs?id=1740492470201345) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: catalog_id required: true source: $.http.query.catalog_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: catalog_id: $.http.query.catalog_id response_cookie: [] response_header: [] response_rule: approved: $.rpc.output.approved processing: $.rpc.output.processing rejected: $.rpc.output.rejected x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/product/delete/: post: operationId: Catalog Product 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: bc_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 catalog_id: description: '' nullable: false 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.catalog_id destination_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 9 feed_id: description: '' nullable: false 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.feed_id flight_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 hotel_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 media_title_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 sku_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 vehicle_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 8 required: - bc_id - catalog_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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Delete products in bulk. [Catalog Product Delete](https://business-api.tiktok.com/portal/docs?id=1740562489236481) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: request_source required: true source: '1' type: number - name: opt_type required: true source: '2' type: number - name: catalog_id required: true source: $.http.body.catalog_id type: number - children: - children: - name: product_id required: true source: $.http.body.products[].product_id type: string - name: name required: true source: $.http.body.products[].name type: string - name: title required: true source: $.http.body.products[].title type: string - name: description required: true source: $.http.body.products[].description type: string - children: - name: url required: true source: $.http.body.products[].image.url type: string - name: width required: true source: $.http.body.products[].image.width type: number - name: height required: true source: $.http.body.products[].image.height type: number - name: ratio required: true source: $.http.body.products[].image.ratio type: number - name: description required: true source: $.http.body.products[].image.description type: string - name: duration required: true source: $.http.body.products[].image.duration type: number - name: video_id required: true source: $.http.body.products[].image.video_id type: string - name: template_id required: true source: $.http.body.products[].image.template_id type: string - name: item_id required: true source: $.http.body.products[].image.item_id type: string - name: is_origin_video required: true source: $.http.body.products[].image.is_origin_video type: boolean - name: tos_uri required: true source: $.http.body.products[].image.tos_uri type: string - name: video_package_type required: true source: $.http.body.products[].image.video_package_type type: number - name: image_label required: false source: $.http.body.products[].image.image_label type: string is_expand: true name: image required: false source: $.http.body.products[].image type: object - children: - children: - name: url required: true source: $.http.body.products[].images[].url type: string - name: width required: true source: $.http.body.products[].images[].width type: number - name: height required: true source: $.http.body.products[].images[].height type: number - name: ratio required: true source: $.http.body.products[].images[].ratio type: number - name: description required: true source: $.http.body.products[].images[].description type: string - name: duration required: true source: $.http.body.products[].images[].duration type: number - name: video_id required: true source: $.http.body.products[].images[].video_id type: string - name: template_id required: true source: $.http.body.products[].images[].template_id type: string - name: item_id required: true source: $.http.body.products[].images[].item_id type: string - name: is_origin_video required: true source: $.http.body.products[].images[].is_origin_video type: boolean - name: tos_uri required: true source: $.http.body.products[].images[].tos_uri type: string - name: video_package_type required: true source: $.http.body.products[].images[].video_package_type type: number - name: image_label required: false source: $.http.body.products[].images[].image_label type: string is_expand: true type: object is_expand: true name: images required: false source: $.http.body.products[].images sub_type: object type: array - children: - name: url required: true source: $.http.body.products[].video.url type: string - name: width required: true source: $.http.body.products[].video.width type: number - name: height required: true source: $.http.body.products[].video.height type: number - name: ratio required: true source: $.http.body.products[].video.ratio type: number - name: description required: true source: $.http.body.products[].video.description type: string - name: duration required: true source: $.http.body.products[].video.duration type: number - name: video_id required: true source: $.http.body.products[].video.video_id type: string - name: template_id required: true source: $.http.body.products[].video.template_id type: string - name: item_id required: true source: $.http.body.products[].video.item_id type: string - name: is_origin_video required: true source: $.http.body.products[].video.is_origin_video type: boolean - name: tos_uri required: true source: $.http.body.products[].video.tos_uri type: string - name: video_package_type required: true source: $.http.body.products[].video.video_package_type type: number - name: image_label required: false source: $.http.body.products[].video.image_label type: string is_expand: true name: video required: false source: $.http.body.products[].video type: object - children: - name: brand_id required: true source: $.http.body.products[].brand.brand_id type: string - name: brand_name required: true source: $.http.body.products[].brand.brand_name type: string - name: en_brand required: true source: $.http.body.products[].brand.en_brand type: string - children: - name: targetUrl required: false source: $.http.body.products[].brand.target_url.targetUrl type: string - name: targetUrlMobile required: false source: $.http.body.products[].brand.target_url.targetUrlMobile type: string - name: targetUrlAndroidApp required: false source: $.http.body.products[].brand.target_url.targetUrlAndroidApp type: string - name: packageAndroidApp required: false source: $.http.body.products[].brand.target_url.packageAndroidApp type: string - name: appNameAndroidApp required: false source: $.http.body.products[].brand.target_url.appNameAndroidApp type: string - name: targetUrlIosApp required: false source: $.http.body.products[].brand.target_url.targetUrlIosApp type: string - name: AppStoreIdIosApp required: false source: $.http.body.products[].brand.target_url.AppStoreIdIosApp type: string - name: AppNameIosApp required: false source: $.http.body.products[].brand.target_url.AppNameIosApp type: string - name: AppStoreIdIphoneApp required: false source: $.http.body.products[].brand.target_url.AppStoreIdIphoneApp type: string - name: AppNameIphoneApp required: false source: $.http.body.products[].brand.target_url.AppNameIphoneApp type: string - name: AppStoreIdIpadApp required: false source: $.http.body.products[].brand.target_url.AppStoreIdIpadApp type: string - name: AppNameIpadApp required: false source: $.http.body.products[].brand.target_url.AppNameIpadApp type: string - name: universalLink required: false source: $.http.body.products[].brand.target_url.universalLink type: string - name: checkoutUrl required: false source: $.http.body.products[].brand.target_url.checkoutUrl type: string is_expand: true name: target_url required: false source: $.http.body.products[].brand.target_url type: object - name: brand_logo required: true source: $.http.body.products[].brand.brand_logo type: string is_expand: true name: brand required: false source: $.http.body.products[].brand type: object - children: - name: shopKeeperID required: false source: $.http.body.products[].shop_keeper.shopKeeperID type: string - name: shopKeeperName required: false source: $.http.body.products[].shop_keeper.shopKeeperName type: string - name: logo required: false source: $.http.body.products[].shop_keeper.logo type: string - name: address required: false source: $.http.body.products[].shop_keeper.address type: string - name: contact required: false source: $.http.body.products[].shop_keeper.contact type: string - name: servicePhone required: false source: $.http.body.products[].shop_keeper.servicePhone type: string - children: - name: targetUrl required: false source: $.http.body.products[].shop_keeper.targetUrl.targetUrl type: string - name: targetUrlMobile required: false source: $.http.body.products[].shop_keeper.targetUrl.targetUrlMobile type: string - name: targetUrlAndroidApp required: false source: $.http.body.products[].shop_keeper.targetUrl.targetUrlAndroidApp type: string - name: packageAndroidApp required: false source: $.http.body.products[].shop_keeper.targetUrl.packageAndroidApp type: string - name: appNameAndroidApp required: false source: $.http.body.products[].shop_keeper.targetUrl.appNameAndroidApp type: string - name: targetUrlIosApp required: false source: $.http.body.products[].shop_keeper.targetUrl.targetUrlIosApp type: string - name: AppStoreIdIosApp required: false source: $.http.body.products[].shop_keeper.targetUrl.AppStoreIdIosApp type: string - name: AppNameIosApp required: false source: $.http.body.products[].shop_keeper.targetUrl.AppNameIosApp type: string - name: AppStoreIdIphoneApp required: false source: $.http.body.products[].shop_keeper.targetUrl.AppStoreIdIphoneApp type: string - name: AppNameIphoneApp required: false source: $.http.body.products[].shop_keeper.targetUrl.AppNameIphoneApp type: string - name: AppStoreIdIpadApp required: false source: $.http.body.products[].shop_keeper.targetUrl.AppStoreIdIpadApp type: string - name: AppNameIpadApp required: false source: $.http.body.products[].shop_keeper.targetUrl.AppNameIpadApp type: string - name: universalLink required: false source: $.http.body.products[].shop_keeper.targetUrl.universalLink type: string - name: checkoutUrl required: false source: $.http.body.products[].shop_keeper.targetUrl.checkoutUrl type: string is_expand: true name: targetUrl required: false source: $.http.body.products[].shop_keeper.targetUrl type: object is_expand: true name: shop_keeper required: false source: $.http.body.products[].shop_keeper type: object - children: - children: - name: id required: true source: $.http.body.products[].category.category.id type: string - name: name required: true source: $.http.body.products[].category.category.name type: string is_expand: true name: category required: false source: $.http.body.products[].category.category type: object - children: - name: id required: true source: $.http.body.products[].category.first_category.id type: string - name: name required: true source: $.http.body.products[].category.first_category.name type: string is_expand: true name: first_category required: false source: $.http.body.products[].category.first_category type: object - children: - name: id required: true source: $.http.body.products[].category.sub_category.id type: string - name: name required: true source: $.http.body.products[].category.sub_category.name type: string is_expand: true name: sub_category required: false source: $.http.body.products[].category.sub_category type: object - children: - name: id required: true source: $.http.body.products[].category.third_category.id type: string - name: name required: true source: $.http.body.products[].category.third_category.name type: string is_expand: true name: third_category required: false source: $.http.body.products[].category.third_category type: object - children: - name: targetUrl required: false source: $.http.body.products[].category.landing_url.targetUrl type: string - name: targetUrlMobile required: false source: $.http.body.products[].category.landing_url.targetUrlMobile type: string - name: targetUrlAndroidApp required: false source: $.http.body.products[].category.landing_url.targetUrlAndroidApp type: string - name: packageAndroidApp required: false source: $.http.body.products[].category.landing_url.packageAndroidApp type: string - name: appNameAndroidApp required: false source: $.http.body.products[].category.landing_url.appNameAndroidApp type: string - name: targetUrlIosApp required: false source: $.http.body.products[].category.landing_url.targetUrlIosApp type: string - name: AppStoreIdIosApp required: false source: $.http.body.products[].category.landing_url.AppStoreIdIosApp type: string - name: AppNameIosApp required: false source: $.http.body.products[].category.landing_url.AppNameIosApp type: string - name: AppStoreIdIphoneApp required: false source: $.http.body.products[].category.landing_url.AppStoreIdIphoneApp type: string - name: AppNameIphoneApp required: false source: $.http.body.products[].category.landing_url.AppNameIphoneApp type: string - name: AppStoreIdIpadApp required: false source: $.http.body.products[].category.landing_url.AppStoreIdIpadApp type: string - name: AppNameIpadApp required: false source: $.http.body.products[].category.landing_url.AppNameIpadApp type: string - name: universalLink required: false source: $.http.body.products[].category.landing_url.universalLink type: string - name: checkoutUrl required: false source: $.http.body.products[].category.landing_url.checkoutUrl type: string is_expand: true name: landing_url required: false source: $.http.body.products[].category.landing_url type: object is_expand: true name: category required: false source: $.http.body.products[].category type: object - children: - name: targetUrl required: false source: $.http.body.products[].landing_url.targetUrl type: string - name: targetUrlMobile required: false source: $.http.body.products[].landing_url.targetUrlMobile type: string - name: targetUrlAndroidApp required: false source: $.http.body.products[].landing_url.targetUrlAndroidApp type: string - name: packageAndroidApp required: false source: $.http.body.products[].landing_url.packageAndroidApp type: string - name: appNameAndroidApp required: false source: $.http.body.products[].landing_url.appNameAndroidApp type: string - name: targetUrlIosApp required: false source: $.http.body.products[].landing_url.targetUrlIosApp type: string - name: AppStoreIdIosApp required: false source: $.http.body.products[].landing_url.AppStoreIdIosApp type: string - name: AppNameIosApp required: false source: $.http.body.products[].landing_url.AppNameIosApp type: string - name: AppStoreIdIphoneApp required: false source: $.http.body.products[].landing_url.AppStoreIdIphoneApp type: string - name: AppNameIphoneApp required: false source: $.http.body.products[].landing_url.AppNameIphoneApp type: string - name: AppStoreIdIpadApp required: false source: $.http.body.products[].landing_url.AppStoreIdIpadApp type: string - name: AppNameIpadApp required: false source: $.http.body.products[].landing_url.AppNameIpadApp type: string - name: universalLink required: false source: $.http.body.products[].landing_url.universalLink type: string - name: checkoutUrl required: false source: $.http.body.products[].landing_url.checkoutUrl type: string is_expand: true name: landing_url required: false source: $.http.body.products[].landing_url type: object - children: - type: string is_expand: true name: tags required: false source: $.http.body.products[].tags sub_type: string type: array - name: status required: true source: $.http.body.products[].status type: number - name: audit_status required: true source: $.http.body.products[].audit_status type: number - children: - name: value required: true source: $.http.body.products[].price.value type: number - name: price_unit required: true source: $.http.body.products[].price.price_unit type: string - name: saving required: true source: $.http.body.products[].price.saving type: number - name: price required: true source: $.http.body.products[].price.price type: number - name: sales_promotion required: true source: $.http.body.products[].price.sales_promotion type: string - name: down_payment required: true source: $.http.body.products[].price.down_payment type: string - name: mortgage required: true source: $.http.body.products[].price.mortgage type: string - name: daily_mortgage required: true source: $.http.body.products[].price.daily_mortgage type: string - name: discount required: true source: $.http.body.products[].price.discount type: number - name: currency required: true source: $.http.body.products[].price.currency type: string - name: sale_price required: true source: $.http.body.products[].price.sale_price type: number - children: - type: number is_expand: true name: sale_price_effective_date required: true source: $.http.body.products[].price.sale_price_effective_date sub_type: number type: array - name: std_price required: true source: $.http.body.products[].price.std_price type: string - name: std_sale_price required: true source: $.http.body.products[].price.std_sale_price type: string - name: has_sale_price required: true source: $.http.body.products[].price.has_sale_price type: boolean - name: total_price required: true source: $.http.body.products[].price.total_price type: number - name: sale_price_effective_date_str required: false source: $.http.body.products[].price.sale_price_effective_date_str type: string is_expand: true name: price required: false source: $.http.body.products[].price type: object - children: - type: string is_expand: true name: profession required: false source: $.http.body.products[].profession sub_type: string type: dict - name: spu_id required: true source: $.http.body.products[].spu_id type: string - name: outer_id required: true source: $.http.body.products[].outer_id type: string - name: gtin required: true source: $.http.body.products[].gtin type: string - name: mpn required: true source: $.http.body.products[].mpn type: string - name: availability required: true source: $.http.body.products[].availability type: string - children: - type: string is_expand: true name: options_field_name required: false source: $.http.body.products[].options_field_name sub_type: string type: array - children: - name: custom_label_0 required: false source: $.http.body.products[].ext.custom_label_0 type: string - name: custom_label_1 required: false source: $.http.body.products[].ext.custom_label_1 type: string - name: custom_label_2 required: false source: $.http.body.products[].ext.custom_label_2 type: string - name: custom_label_3 required: false source: $.http.body.products[].ext.custom_label_3 type: string - name: custom_label_4 required: false source: $.http.body.products[].ext.custom_label_4 type: string is_expand: true name: ext required: false source: $.http.body.products[].ext type: object - name: mark required: true source: $.http.body.products[].mark type: number - children: - name: OriginRichTextDescription required: false source: $.http.body.products[].rich_text.OriginRichTextDescription type: string - name: RichTextDescription required: false source: $.http.body.products[].rich_text.RichTextDescription type: string - name: RichTextDescriptionHtml required: false source: $.http.body.products[].rich_text.RichTextDescriptionHtml type: string is_expand: true name: rich_text required: false source: $.http.body.products[].rich_text type: object - name: vehicle_launched_year required: true source: $.http.body.products[].vehicle_launched_year type: number - name: vehicle_model required: true source: $.http.body.products[].vehicle_model type: string - name: vehicle_body_style required: true source: $.http.body.products[].vehicle_body_style type: string - name: vehicle_vin required: true source: $.http.body.products[].vehicle_vin type: string - children: - name: value required: false source: $.http.body.products[].vehicle_mileage.value type: number - name: unit required: false source: $.http.body.products[].vehicle_mileage.unit type: string - name: mileage required: false source: $.http.body.products[].vehicle_mileage.mileage type: number is_expand: true name: vehicle_mileage required: false source: $.http.body.products[].vehicle_mileage type: object - name: vehicle_trim required: true source: $.http.body.products[].vehicle_trim type: string - name: vehicle_drive_train required: true source: $.http.body.products[].vehicle_drive_train type: string - name: vehicle_fuel_type required: true source: $.http.body.products[].vehicle_fuel_type type: string - children: - type: string is_expand: true name: media_genres required: false source: $.http.body.products[].media_genres sub_type: string type: array - name: room_type required: true source: $.http.body.products[].room_type type: string - name: origin_airport required: true source: $.http.body.products[].origin_airport type: string - name: destination_airport required: true source: $.http.body.products[].destination_airport type: string - name: origin_city required: true source: $.http.body.products[].origin_city type: string - name: destination_city required: true source: $.http.body.products[].destination_city type: string - name: airline_company required: true source: $.http.body.products[].airline_company type: string - name: cabin_class required: true source: $.http.body.products[].cabin_class type: string - name: airline_id required: true source: $.http.body.products[].airline_id type: string - name: feature required: true source: $.http.body.products[].feature type: string - name: stock required: true source: $.http.body.products[].stock type: number - name: time_line required: true source: $.http.body.products[].time_line type: string - children: - name: deliverVideo required: false source: $.http.body.products[].delivery.deliverVideo type: number is_expand: true name: delivery required: true source: $.http.body.products[].delivery type: object - name: has_video required: true source: $.http.body.products[].has_video type: number - children: - children: - type: number is_expand: true name: bidwords required: false source: $.http.body.products[].product_additional_info.bidwords sub_type: number type: array - children: - type: string is_expand: true name: videoTids required: false source: $.http.body.products[].product_additional_info.videoTids sub_type: string type: array - children: - type: number is_expand: true name: videoImageModes required: false source: $.http.body.products[].product_additional_info.videoImageModes sub_type: number type: array is_expand: true name: product_additional_info required: false source: $.http.body.products[].product_additional_info type: object - name: active_status required: true source: $.http.body.products[].active_status type: number - children: - name: language required: false source: $.http.body.products[].i18n_local_info.language type: string - children: - type: number is_expand: true name: tags required: false source: $.http.body.products[].i18n_local_info.tags sub_type: number type: array - children: - type: string is_expand: true name: detectLanguage required: false source: $.http.body.products[].i18n_local_info.detectLanguage sub_type: string type: array is_expand: true name: i18n_local_info required: false source: $.http.body.products[].i18n_local_info type: object - name: pxx_id required: true source: $.http.body.products[].pxx_id type: string - children: - type: string is_expand: true name: label required: false source: $.http.body.products[].label sub_type: string type: array - children: - children: - name: url required: true source: $.http.body.products[].videos[].url type: string - name: width required: true source: $.http.body.products[].videos[].width type: number - name: height required: true source: $.http.body.products[].videos[].height type: number - name: ratio required: true source: $.http.body.products[].videos[].ratio type: number - name: description required: true source: $.http.body.products[].videos[].description type: string - name: duration required: true source: $.http.body.products[].videos[].duration type: number - name: video_id required: true source: $.http.body.products[].videos[].video_id type: string - name: template_id required: true source: $.http.body.products[].videos[].template_id type: string - name: item_id required: true source: $.http.body.products[].videos[].item_id type: string - name: is_origin_video required: true source: $.http.body.products[].videos[].is_origin_video type: boolean - name: tos_uri required: true source: $.http.body.products[].videos[].tos_uri type: string - name: video_package_type required: true source: $.http.body.products[].videos[].video_package_type type: number - name: image_label required: false source: $.http.body.products[].videos[].image_label type: string is_expand: true type: object is_expand: true name: videos required: false source: $.http.body.products[].videos sub_type: object type: array - name: version required: true source: $.http.body.products[].version type: number - children: - type: number is_expand: true name: product_set_ids required: false source: $.http.body.products[].product_set_ids sub_type: number type: array - name: address required: true source: $.http.body.products[].address type: string - name: city required: true source: $.http.body.products[].city type: string - name: rating required: true source: $.http.body.products[].rating type: string - name: user_rating required: true source: $.http.body.products[].user_rating type: string - name: qid required: true source: $.http.body.products[].qid type: string - name: vehicle_exterior_color required: true source: $.http.body.products[].vehicle_exterior_color type: string - name: address_region required: true source: $.http.body.products[].address_region type: string - name: address_country required: true source: $.http.body.products[].address_country type: string - name: vehicle_state required: true source: $.http.body.products[].vehicle_state type: string - name: vehicle_make required: true source: $.http.body.products[].vehicle_make type: string - name: loyalty_program required: true source: $.http.body.products[].loyalty_program type: string - name: margin_level required: true source: $.http.body.products[].margin_level type: string - name: hotel_retailer_id required: true source: $.http.body.products[].hotel_retailer_id type: string - name: hotel_room_id required: true source: $.http.body.products[].hotel_room_id type: string - name: meal_policy required: true source: $.http.body.products[].meal_policy type: string - name: cancellation_policy required: true source: $.http.body.products[].cancellation_policy type: string - name: phone required: true source: $.http.body.products[].phone type: string - name: organic_audit_status required: true source: $.http.body.products[].organic_audit_status type: number - name: appeal_status required: false source: $.http.body.products[].appeal_status type: boolean - children: - children: - name: reason required: false source: $.http.body.products[].reject_infos[].reason type: string - name: suggestion required: false source: $.http.body.products[].reject_infos[].suggestion type: string - children: - type: string is_expand: true name: affected_country required: false source: $.http.body.products[].reject_infos[].affected_country sub_type: string type: array - children: - type: number is_expand: true name: affected_placement required: false source: $.http.body.products[].reject_infos[].affected_placement sub_type: number type: array is_expand: true type: object is_expand: true name: reject_infos required: false source: $.http.body.products[].reject_infos sub_type: object type: array - children: - name: dealerID required: false source: $.http.body.products[].dealer.dealerID type: string - name: name required: false source: $.http.body.products[].dealer.name type: string - name: phone required: false source: $.http.body.products[].dealer.phone type: string - name: stockNumber required: false source: $.http.body.products[].dealer.stockNumber type: string is_expand: true name: dealer required: false source: $.http.body.products[].dealer type: object - name: vehicle_interior_color required: false source: $.http.body.products[].vehicle_interior_color type: string - name: transmission required: false source: $.http.body.products[].transmission type: string - name: vehicleType required: false source: $.http.body.products[].vehicleType type: string - name: dateFirstOnLot required: false source: $.http.body.products[].dateFirstOnLot type: string - name: daysOnLot required: false source: $.http.body.products[].daysOnLot type: number - name: postcode required: false source: $.http.body.products[].postcode type: string - name: lat required: false source: $.http.body.products[].lat type: number - name: lon required: false source: $.http.body.products[].lon type: number - name: product_type required: false source: $.http.body.products[].product_type type: string - name: google_product_category required: false source: $.http.body.products[].google_product_category type: string - children: - children: - name: RatingSystem required: false source: $.http.body.products[].guest_ratings[].RatingSystem type: string - name: MaxScore required: false source: $.http.body.products[].guest_ratings[].MaxScore type: number - name: Score required: false source: $.http.body.products[].guest_ratings[].Score type: number - name: NumberOfReviewers required: false source: $.http.body.products[].guest_ratings[].NumberOfReviewers type: number is_expand: true type: object is_expand: true name: guest_ratings required: false source: $.http.body.products[].guest_ratings sub_type: object type: array - children: - type: string is_expand: true name: destination_types required: false source: $.http.body.products[].destination_types sub_type: string type: array is_expand: true type: object is_expand: false name: products required: true source: $.myProducts sub_type: object type: array - name: feed_id required: false source: $.http.body.feed_id type: number - children: - type: string is_expand: true name: outer_id_list required: false source: $.myOuterIds sub_type: string type: array plugins: after_response: [] before_request: - Plugin_fill_empty_products_6806181: - description: get only one outer_ids - request_params: - $.http.body.sku_ids - $.http.body.vehicle_ids - $.http.body.flight_ids - $.http.body.media_title_ids - $.http.body.hotel_ids - $.http.body.destination_ids - result_params: - $.myProducts - $.myOuterIds - version: f252d6f26daa93852c121840d707a759 request_query_rule: null request_rule: catalog_id: $.http.body.catalog_id feed_id: $.http.body.feed_id opt_type: 2 outer_id_list: $.myOuterIds products: $.myProducts request_source: 1 response_cookie: [] response_header: [] response_rule: feed_log_id: $.rpc.output.feed_log_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/product/file/: post: operationId: Catalog Product File 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: bc_id: description: '' nullable: false 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.bc_id catalog_id: description: '' nullable: false 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.catalog_id feed_id: description: '' format: int64 nullable: false type: integer 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.feed_id file_url: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.file_url update_mode: default: INCREMENTAL description: '' nullable: false 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: INCREMENTAL value: '1' - description: '' is_valid: true key: OVERWRITE value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int64 x-open-field-id: 5 x-open-source: $.http.body.update_mode required: - bc_id - catalog_id - file_url 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Upload products via file URL. [Catalog Product File](https://business-api.tiktok.com/portal/docs?id=1740496787164161) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: catalog_id required: true source: $.http.body.catalog_id type: number - name: file_url required: true source: $.http.body.file_url type: string - name: feed_id required: false source: $.http.body.feed_id type: number - name: update_mode required: true source: $.http.body.update_mode type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.body.bc_id catalog_id: $.http.body.catalog_id feed_id: $.http.body.feed_id file_url: $.http.body.file_url update_mode: $.http.body.update_mode response_cookie: [] response_header: [] response_rule: feed_log_id: $.rpc.output.feed_log_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/product/log/: get: operationId: Catalog Product Log parameters: - description: '' in: query name: bc_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.bc_id x-open-field-id: 1 - description: '' in: query name: catalog_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.catalog_id x-open-field-id: 2 - description: '' in: query name: feed_log_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.feed_log_id x-open-field-id: 3 - description: '' in: query name: advertiser_id required: false schema: nullable: false 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: 4 - description: '' in: query name: language required: false schema: default: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.language x-open-field-id: 5 - description: '' in: query name: context_info required: false schema: $ref: ./openapi.yaml#/definitions/Context_infoCatalogProductLog 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Use this endpoint to find out if a product was uploaded or deleted successfully, and what to do if it failed. [Catalog Product Get](https://business-api.tiktok.com/portal/docs?id=1740570027173889) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.query.bc_id type: number - name: catalog_id required: true source: $.http.query.catalog_id type: number - name: feed_log_id required: true source: $.http.query.feed_log_id type: number - name: advertiser_id required: false source: $.http.query.advertiser_id type: number - name: language required: false source: $.http.query.language type: string - 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: 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 bc_id: $.http.query.bc_id catalog_id: $.http.query.catalog_id context_info: $.http.query.context_info feed_log_id: $.http.query.feed_log_id language: $.http.query.language response_cookie: [] response_header: [] response_rule: product_feed_log: add_count: $.rpc.output.product_feed_log.add_count catalog_id: $.rpc.output.product_feed_log.catalog_id delete_count: $.rpc.output.product_feed_log.delete_count end_time: $.rpc.output.product_feed_log.end_time error_count: $.rpc.output.product_feed_log.error_count feed_id: $.rpc.output.product_feed_log.feed_id feed_log_data: download_path: $.rpc.output.product_feed_log.feed_log_data.download_path error_affected_products[][]: - affected_product_count: $.rpc.output.product_feed_log.feed_log_data.error_affected_products[].affected_product_count affected_product_item_list[][]: - airline_company: $.rpc.output.product_feed_log.feed_log_data.error_affected_products[].affected_product_item_list[].airline_company brand: $.rpc.output.product_feed_log.feed_log_data.error_affected_products[].affected_product_item_list[].brand description: $.rpc.output.product_feed_log.feed_log_data.error_affected_products[].affected_product_item_list[].description flight_id: $.rpc.output.product_feed_log.feed_log_data.error_affected_products[].affected_product_item_list[].flight_id home_listing_id: $.rpc.output.product_feed_log.feed_log_data.error_affected_products[].affected_product_item_list[].home_listing_id hotel_id: $.rpc.output.product_feed_log.feed_log_data.error_affected_products[].affected_product_item_list[].hotel_id index: $.rpc.output.product_feed_log.feed_log_data.error_affected_products[].affected_product_item_list[].index make: $.rpc.output.product_feed_log.feed_log_data.error_affected_products[].affected_product_item_list[].make media_title_id: $.rpc.output.product_feed_log.feed_log_data.error_affected_products[].affected_product_item_list[].media_title_id name: $.rpc.output.product_feed_log.feed_log_data.error_affected_products[].affected_product_item_list[].name product_url: $.rpc.output.product_feed_log.feed_log_data.error_affected_products[].affected_product_item_list[].product_url series_id: $.rpc.output.product_feed_log.feed_log_data.error_affected_products[].affected_product_item_list[].series_id sku_id: $.rpc.output.product_feed_log.feed_log_data.error_affected_products[].affected_product_item_list[].sku_id title: $.rpc.output.product_feed_log.feed_log_data.error_affected_products[].affected_product_item_list[].title value: $.rpc.output.product_feed_log.feed_log_data.error_affected_products[].affected_product_item_list[].value vehicle_id: $.rpc.output.product_feed_log.feed_log_data.error_affected_products[].affected_product_item_list[].vehicle_id field: $.rpc.output.product_feed_log.feed_log_data.error_affected_products[].field issue: $.rpc.output.product_feed_log.feed_log_data.error_affected_products[].issue suggestion: $.rpc.output.product_feed_log.feed_log_data.error_affected_products[].suggestion warn_affected_products[][]: - affected_product_count: $.rpc.output.product_feed_log.feed_log_data.warn_affected_products[].affected_product_count affected_product_item_list[][]: - airline_company: $.rpc.output.product_feed_log.feed_log_data.warn_affected_products[].affected_product_item_list[].airline_company brand: $.rpc.output.product_feed_log.feed_log_data.warn_affected_products[].affected_product_item_list[].brand description: $.rpc.output.product_feed_log.feed_log_data.warn_affected_products[].affected_product_item_list[].description flight_id: $.rpc.output.product_feed_log.feed_log_data.warn_affected_products[].affected_product_item_list[].flight_id home_listing_id: $.rpc.output.product_feed_log.feed_log_data.warn_affected_products[].affected_product_item_list[].home_listing_id hotel_id: $.rpc.output.product_feed_log.feed_log_data.warn_affected_products[].affected_product_item_list[].hotel_id index: $.rpc.output.product_feed_log.feed_log_data.warn_affected_products[].affected_product_item_list[].index make: $.rpc.output.product_feed_log.feed_log_data.warn_affected_products[].affected_product_item_list[].make media_title_id: $.rpc.output.product_feed_log.feed_log_data.warn_affected_products[].affected_product_item_list[].media_title_id name: $.rpc.output.product_feed_log.feed_log_data.warn_affected_products[].affected_product_item_list[].name product_url: $.rpc.output.product_feed_log.feed_log_data.warn_affected_products[].affected_product_item_list[].product_url series_id: $.rpc.output.product_feed_log.feed_log_data.warn_affected_products[].affected_product_item_list[].series_id sku_id: $.rpc.output.product_feed_log.feed_log_data.warn_affected_products[].affected_product_item_list[].sku_id title: $.rpc.output.product_feed_log.feed_log_data.warn_affected_products[].affected_product_item_list[].title value: $.rpc.output.product_feed_log.feed_log_data.warn_affected_products[].affected_product_item_list[].value vehicle_id: $.rpc.output.product_feed_log.feed_log_data.warn_affected_products[].affected_product_item_list[].vehicle_id field: $.rpc.output.product_feed_log.feed_log_data.warn_affected_products[].field issue: $.rpc.output.product_feed_log.feed_log_data.warn_affected_products[].issue suggestion: $.rpc.output.product_feed_log.feed_log_data.warn_affected_products[].suggestion process_status: $.rpc.output.product_feed_log.process_status start_time: $.rpc.output.product_feed_log.start_time update_count: $.rpc.output.product_feed_log.update_count update_mode: $.rpc.output.product_feed_log.update_mode warn_count: $.rpc.output.product_feed_log.warn_count x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /catalog/set/delete/: post: operationId: Catalog Set 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: bc_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 catalog_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 2 product_set_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) maxItems: 10 minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 required: - bc_id - catalog_id - product_set_ids type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Delete product sets. [Catalog Set Delete](https://business-api.tiktok.com/portal/docs?id=1740573143966722) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: optType required: false source: '7' type: number - children: - children: - name: id required: false type: number - name: platformId required: false type: number - name: name required: false type: string - children: - children: - name: field required: false type: string - name: op required: false type: string - name: fieldType required: false type: string - name: value required: false type: string - name: sensType required: false type: number is_expand: true type: object is_expand: false name: conditions required: false sub_type: object type: array - name: createTime required: false type: number - name: modifyTime required: false type: number - name: bindType required: false type: number - name: pSetType required: false type: number - name: pSetCreateType required: false type: number - name: skuListTosUrl required: false type: string - children: - name: id required: false type: number - name: platformId required: false type: number - name: productSetId required: false type: number - name: status required: false type: number - name: totalCount required: false type: number - name: resolvedCount required: false type: number - name: errorCount required: false type: number - name: uploadPath required: false type: string - name: downloadPath required: false type: string - name: createTime required: false type: number - name: modifyTime required: false type: number is_expand: false name: productSetLog required: false type: object is_expand: false type: object is_expand: true name: pSets required: false source: $.pSets sub_type: object type: array plugins: after_response: [] before_request: - Plugin_map_setids_2329204: - description: map list of setids to pSets - request_params: - $.http.body.product_set_ids - $.http.body.catalog_id - result_params: - $.pSets - version: 40b87f525366565b0a358a95b6bed5cc request_query_rule: null request_rule: optType: 7 pSets: $.pSets response_cookie: [] response_header: [] response_rule: product_set_ids: $.http.body.product_set_ids[] x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/set/get/: get: operationId: Catalog Set Get parameters: - description: '' in: query name: catalog_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.catalog_id x-open-field-id: 1 - description: '' in: query name: bc_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.bc_id x-open-field-id: 2 - description: '' in: query name: product_set_id required: false schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.product_set_id x-open-field-id: 3 - description: '' in: query name: return_product_count required: false schema: default: true nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.return_product_count 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get product sets. [Catalog Set Get](https://business-api.tiktok.com/portal/docs?id=1740570556295169) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: catalog_id required: true source: $.http.query.catalog_id type: number - name: bc_id required: true source: $.http.query.bc_id type: number - name: product_set_id required: false source: $.http.query.product_set_id type: number - name: return_product_count required: false source: $.http.query.return_product_count type: boolean plugins: after_response: - Plugin_json_loads_resp_14621553: - description: sdadsasd - request_params: - $.rpc.output.result_list[] - result_params: - $.processed_list - version: e2b9b697638e7c43eb264f9aa412a4f8 before_request: [] request_query_rule: null request_rule: bc_id: $.http.query.bc_id catalog_id: $.http.query.catalog_id product_set_id: $.http.query.product_set_id return_product_count: $.http.query.return_product_count response_cookie: [] response_header: [] response_rule: list: $.processed_list x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/set/product/get/: get: operationId: Catalog Set Product Get parameters: - description: '' in: query name: bc_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.bc_id x-open-field-id: 1 - description: '' in: query name: catalog_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.catalog_id x-open-field-id: 2 - description: '' in: query name: product_set_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.product_set_id x-open-field-id: 3 - description: '' in: query name: page required: false schema: default: 1 format: int64 minimum: 1 nullable: false 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: 20 format: int64 maximum: 100 minimum: 1 nullable: false 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get products in a product set. [Catalog Set Product Get](https://business-api.tiktok.com/portal/docs?id=1740571478441986) tags: - catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: false source: $.http.query.bc_id type: number - name: catalog_id required: true source: $.http.query.catalog_id type: number - children: - name: page_size required: false source: $.http.query.page_size type: number - name: page_num required: false source: $.http.query.page type: number is_expand: true name: page_info required: false type: object - children: - type: string is_expand: true name: pset_ids required: false source: $.pset_ids sub_type: string type: array - name: user_id required: false source: $.context.core_user_id type: number - name: request_source required: true source: '1' type: number plugins: after_response: - Plugin_handle_dpa_products_13408686: - description: map set products & total_page - request_params: - $.rpc.output.data - $.rpc.output.storeType - $.http.query.page_size - result_params: - $.total_cnt - $.products - $.total_page - version: ccae030c27ac65b7bb312d1083fdbcf4 before_request: - Plugin_pset_ids_list_13403048: - description: string to string list - request_params: - $.http.query.product_set_id - result_params: - $.pset_ids - version: 59f372763e33e608849ed73e192da44e request_query_rule: null request_rule: bc_id: $.http.query.bc_id catalog_id: $.http.query.catalog_id page_info: page_num: $.http.query.page page_size: $.http.query.page_size pset_ids: $.pset_ids request_source: 1 user_id: $.context.core_user_id response_cookie: [] response_header: [] response_rule: catalog_id: $.http.query.catalog_id page_info: page: $.http.query.page page_size: $.http.query.page_size total_number: $.total_cnt total_page: $.total_page product_count: $.total_cnt product_set_id: $.http.query.product_set_id products: $.products x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/set/update/: post: operationId: Catalog Set 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: bc_id: description: '' nullable: false 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.bc_id catalog_id: description: '' nullable: false 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.catalog_id conditions: description: '' nullable: false properties: and: description: '' items: nullable: false properties: {} type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - json_dumps(%s) minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.conditions.and_condition or: description: '' items: nullable: false properties: {} type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - json_dumps(%s) minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.conditions.or_condition type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.body.conditions product_set_id: description: '' nullable: false 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.product_set_id product_set_name: description: '' maxLength: 28 minLength: 1 nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.product_set_name required: - catalog_id - bc_id - product_set_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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Use this endpoint to update the filter conditions or name of a product set. [Catalog Set Get](https://business-api.tiktok.com/portal/docs?id=1740572974725122) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: catalog_id required: true source: $.http.body.catalog_id type: number - name: bc_id required: true source: $.http.body.bc_id type: number - name: product_set_id required: false source: $.http.body.product_set_id type: number - name: product_set_name required: false source: $.http.body.product_set_name type: string - children: - children: - type: string is_expand: true name: and_condition required: false source: $.http.body.conditions.and[] sub_type: string type: array - children: - type: string is_expand: true name: or_condition required: false source: $.http.body.conditions.or[] sub_type: string type: array is_expand: true name: conditions required: false type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.body.bc_id catalog_id: $.http.body.catalog_id conditions: and_condition: $.http.body.conditions.and[] or_condition: $.http.body.conditions.or[] product_set_id: $.http.body.product_set_id product_set_name: $.http.body.product_set_name response_cookie: [] response_header: [] response_rule: product_count: $.rpc.output.product_count product_set_id: $.rpc.output.product_set_id product_set_name: $.rpc.output.product_set_name x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/update/: post: operationId: Catalog 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: bc_id: description: '' nullable: false 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.bc_id catalog_id: description: '' nullable: false 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.catalog_id name: description: '' maxLength: 100 minLength: 1 nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.name required: - catalog_id - bc_id - name 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Use this endpoint to update the name of a catalog. The catalog must be under a Business Center. [Catalog Update](https://business-api.tiktok.com/portal/docs?id=1740306544966657) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - children: - name: platformId required: false source: $.http.body.catalog_id type: number - name: name required: false source: $.http.body.name type: string - name: source required: false source: '2' type: number is_expand: true name: productLibrary required: false type: object - name: optType required: false source: '2' type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: optType: 2 productLibrary: name: $.http.body.name platformId: $.http.body.catalog_id source: 2 response_cookie: [] response_header: [] response_rule: catalog_id: $.rpc.output.dataTicket x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/video/delete/: post: operationId: Catalog Video 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: bc_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.bc_id catalog_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.catalog_id catalog_video_ids: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false minItems: 1 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.catalog_video_ids required: - bc_id - catalog_id - catalog_video_ids type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Delete uploaded catalog videos. [Catalog Video Delete](https://business-api.tiktok.com/portal/docs?id=1803655103069185) tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: catalog_id required: true source: $.http.body.catalog_id type: number - children: - type: string name: catalog_video_ids required: false source: $.http.body.catalog_video_ids sub_type: string type: array plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.body.bc_id catalog_id: $.http.body.catalog_id catalog_video_ids: $.http.body.catalog_video_ids response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/video/file/: post: operationId: Catalog Video File 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_ids: description: '' items: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) maxItems: 100 type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.advertiser_ids bc_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.bc_id catalog_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.catalog_id file_url: description: '' type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.file_url required: - bc_id - catalog_id - file_url 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: null tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.body.bc_id type: number - name: catalog_id required: true source: $.http.body.catalog_id type: number - name: file_url required: true source: $.http.body.file_url type: string - children: - type: number name: advertiser_ids required: false source: $.http.body.advertiser_ids sub_type: number type: array plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_ids: $.http.body.advertiser_ids bc_id: $.http.body.bc_id catalog_id: $.http.body.catalog_id file_url: $.http.body.file_url response_cookie: [] response_header: [] response_rule: feed_log_id: $.rpc.output.feed_log_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /catalog/video/get/: get: operationId: Catalog Video Get parameters: - description: '' in: query name: bc_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.bc_id x-open-field-id: 1 - description: '' in: query name: catalog_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.catalog_id x-open-field-id: 2 - description: '' in: query name: catalog_video_ids required: false schema: items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 50 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.catalog_video_ids x-open-field-id: 3 - description: '' in: query name: page required: false schema: default: 1 format: int64 nullable: false 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: 50 nullable: false 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: null tags: - Catalog x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: bc_id required: true source: $.http.query.bc_id type: number - name: catalog_id required: true source: $.http.query.catalog_id type: number - children: - type: string name: catalog_video_ids required: false source: $.http.query.catalog_video_ids sub_type: string type: array - name: page required: false source: $.http.query.page type: number - name: page_size required: false source: $.http.query.page_size type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: bc_id: $.http.query.bc_id catalog_id: $.http.query.catalog_id catalog_video_ids: $.http.query.catalog_video_ids page: $.http.query.page page_size: $.http.query.page_size response_cookie: [] response_header: [] response_rule: page_info: $.rpc.output.page_info videos: $.rpc.output.videos x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /comment/delete/: post: operationId: Comment 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: ad_id: description: '' nullable: false 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.creative_id advertiser_id: description: '' nullable: false 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.adv_id comment_id: description: '' nullable: false 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.comment_id identity_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.body.identity_id identity_type: description: '' nullable: false 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: false key: BC_AUTH_TT value: '5' - description: '' is_valid: false key: BC_SELF_TT value: '4' - description: '' is_valid: true key: CUSTOMIZED_USER value: '1' - 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: 5 x-open-source: $.http.body.identity_type tiktok_item_id: description: '' nullable: false 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.item_id required: - advertiser_id - ad_id - tiktok_item_id - comment_id - identity_type - identity_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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Delete comments. [Comment Delete](https://business-api.tiktok.com/portal/docs?id=1738957772267522) tags: - Comments x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: tt4b_uid required: true source: $.context.core_user_id type: number - name: adv_id required: true source: $.http.body.advertiser_id type: number - name: identity_type required: true source: $.http.body.identity_type type: number - name: identity_id required: true source: $.http.body.identity_id type: string - name: item_id required: true source: $.http.body.tiktok_item_id type: number - name: comment_id required: true source: $.http.body.comment_id type: number - name: creative_id required: true source: $.http.body.ad_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: adv_id: $.http.body.advertiser_id comment_id: $.http.body.comment_id creative_id: $.http.body.ad_id identity_id: $.http.body.identity_id identity_type: $.http.body.identity_type item_id: $.http.body.tiktok_item_id tt4b_uid: $.context.core_user_id response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /comment/list/: get: operationId: Comment List parameters: - description: '' in: query name: advertiser_id required: true schema: nullable: false 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: start_time required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.start_time x-open-field-id: 2 - description: '' in: query name: end_time required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.end_time x-open-field-id: 3 - description: '' in: query name: sort_field required: false schema: default: CREATE_TIME nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804526557570050 enum_package_name: CommentSortField enums: - description: '' is_valid: true key: CREATE_TIME value: create_time - description: '' is_valid: true key: LIKES value: digg_count_long - description: '' is_valid: true key: REPLIES value: reply_count_long - description: '' is_valid: true key: SMART value: smart_hot key_format: string strict: true use_part: false validate_only: false value_format: string x-open-source: $.http.query.sort_field x-open-field-id: 4 - description: '' in: query name: sort_type required: false schema: default: DESC nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804526601709569 enum_package_name: CommentSortType enums: - description: '' is_valid: true key: ASC value: ASC - description: '' is_valid: true key: DESC value: DESC key_format: string strict: true use_part: false validate_only: false value_format: string x-open-source: $.http.query.sort_type x-open-field-id: 5 - description: '' in: query name: page required: false schema: default: 1 format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page x-open-field-id: 6 - description: '' in: query name: page_size required: false schema: default: 10 format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page_size x-open-field-id: 7 - content: application/json: schema: items: default: ALL nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804526161934338 enum_package_name: CommentLevel enums: - description: '' is_valid: true key: ALL value: '0' - description: '' is_valid: true key: COMMENT value: '1' - description: '' is_valid: true key: REPLY value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.comment_type description: '' in: query name: comment_type required: false x-open-field-id: 8 - content: application/json: schema: items: default: ALL nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804526126395393 enum_package_name: CommentStatus enums: - description: '' is_valid: true key: ALL value: '0' - description: '' is_valid: true key: HIDDEN value: '2' - description: '' is_valid: true key: PUBLIC value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.comment_status description: '' in: query name: comment_status required: false x-open-field-id: 9 - description: '' in: query name: search_field required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804526075543618 enum_package_name: CommentSearchType enums: - description: '' is_valid: true key: ADGROUP_ID value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.search_field x-open-field-id: 10 - description: '' in: query name: search_value required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.search_value x-open-field-id: 11 - 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get comments for your ads. [Comment List](https://business-api.tiktok.com/portal/docs?id=1738086301876225) tags: - Comments 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: tt4b_uid required: true source: $.context.core_user_id type: number - name: start_time required: true source: $.http.query.start_time type: string - name: end_time required: true source: $.http.query.end_time type: string - name: sort_field required: true source: $.http.query.sort_field type: string - name: sort_type required: true source: $.http.query.sort_type type: string - name: page required: true source: $.http.query.page type: number - name: page_size required: true source: $.http.query.page_size type: number - children: - type: number is_expand: true name: comment_type required: false source: $.http.query.comment_type sub_type: number type: array - children: - type: number is_expand: true name: comment_status required: false source: $.http.query.comment_status sub_type: number type: array - name: search_field required: false source: $.http.query.search_field type: number - name: search_value required: false source: $.http.query.search_value type: string - children: - name: app_id required: false source: $.context.app_id type: number - name: core_user_id required: false source: $.context.core_user_id type: number - name: developer_id required: false source: $.context.developer_id type: number is_expand: true name: context_info required: false type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id comment_status: $.http.query.comment_status comment_type: $.http.query.comment_type context_info: app_id: $.context.app_id core_user_id: $.context.core_user_id developer_id: $.context.developer_id end_time: $.http.query.end_time page: $.http.query.page page_size: $.http.query.page_size search_field: $.http.query.search_field search_value: $.http.query.search_value sort_field: $.http.query.sort_field sort_type: $.http.query.sort_type start_time: $.http.query.start_time tt4b_uid: $.context.core_user_id response_cookie: [] response_header: [] response_rule: comments[][]: - ad_id: $.rpc.output.comment_list[].ad_id ad_name: $.rpc.output.comment_list[].ad_name ad_text: $.rpc.output.comment_list[].ad_text adgroup_id: $.rpc.output.comment_list[].adgroup_id adgroup_name: $.rpc.output.comment_list[].adgroup_name app: $.rpc.output.comment_list[].app campaign_id: $.rpc.output.comment_list[].campaign_id campaign_name: $.rpc.output.comment_list[].campaign_name can_delete: $.rpc.output.comment_list[].can_delete comment_id: $.rpc.output.comment_list[].comment_id comment_status: $.rpc.output.comment_list[].comment_status comment_type: $.rpc.output.comment_list[].comment_type content: $.rpc.output.comment_list[].content create_time: $.rpc.output.comment_list[].create_time hit_blockedword: $.rpc.output.comment_list[].hit_blockedword identity_id: $.rpc.output.comment_list[].identity_id identity_type: $.rpc.output.comment_list[].identity_type is_auth_comment_manage_scope: $.rpc.output.comment_list[].is_auth_comment_manage_scope is_auth_ttba: $.rpc.output.comment_list[].is_auth_ttba is_pinned: $.rpc.output.comment_list[].is_pinned likes: $.rpc.output.comment_list[].likes original_comment_id: $.rpc.output.comment_list[].original_comment_id replies: $.rpc.output.comment_list[].replies tiktok_item_id: $.rpc.output.comment_list[].tiktok_item_id user_avatar_url: $.rpc.output.comment_list[].user_avatar_url user_id: $.rpc.output.comment_list[].user_id user_name: $.rpc.output.comment_list[].user_name video_cover_url: $.rpc.output.comment_list[].video_cover_url video_play_url: $.rpc.output.comment_list[].video_play_url page_info: page: $.rpc.output.page_info.page page_size: $.rpc.output.page_info.page_size total_number: $.rpc.output.page_info.total_number total_page: $.rpc.output.page_info.total_page x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /comment/post/: post: operationId: Comment Post 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: ad_id: description: '' nullable: false 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.creative_id advertiser_id: description: '' nullable: false 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.adv_id comment_id: description: '' nullable: false 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.comment_id comment_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1816409670277122 enum_package_name: AdCommentType enums: - description: '' is_valid: true key: POST value: '1' - description: '' is_valid: true key: REPLY 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.comment_type identity_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 8 x-open-source: $.http.body.identity_id identity_type: description: '' nullable: false 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: false key: BC_AUTH_TT value: '5' - description: '' is_valid: false key: BC_SELF_TT value: '4' - description: '' is_valid: true key: CUSTOMIZED_USER value: '1' - 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: 7 x-open-source: $.http.body.identity_type text: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.body.text tiktok_item_id: description: '' nullable: false 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.item_id required: - advertiser_id - ad_id - tiktok_item_id - comment_id - comment_type - text - identity_type - identity_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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Reply to comments. [Comment Post](https://business-api.tiktok.com/portal/docs?id=1738957702411265) tags: - Comments x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: tt4b_uid required: true source: $.context.core_user_id type: number - name: adv_id required: true source: $.http.body.advertiser_id type: number - name: identity_type required: true source: $.http.body.identity_type type: number - name: identity_id required: true source: $.http.body.identity_id type: string - name: item_id required: true source: $.http.body.tiktok_item_id type: number - name: text required: true source: $.http.body.text type: string - name: comment_type required: true source: $.http.body.comment_type type: number - name: creative_id required: true source: $.http.body.ad_id type: number - name: comment_id required: false source: $.http.body.comment_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: adv_id: $.http.body.advertiser_id comment_id: $.http.body.comment_id comment_type: $.http.body.comment_type creative_id: $.http.body.ad_id identity_id: $.http.body.identity_id identity_type: $.http.body.identity_type item_id: $.http.body.tiktok_item_id text: $.http.body.text tt4b_uid: $.context.core_user_id response_cookie: [] response_header: [] response_rule: comment: comment_id: $.rpc.output.comment.comment_id create_time: $.rpc.output.comment.create_time reply_to_comment_id: $.rpc.output.comment.reply_to_comment_id text: $.rpc.output.comment.text tiktok_item_id: $.rpc.output.comment.item_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /comment/reference/: get: operationId: Comment Reference parameters: - description: '' in: query name: advertiser_id required: true schema: nullable: false 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: comment_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.comment_id x-open-field-id: 2 - description: '' in: query name: comment_type required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804526161934338 enum_package_name: CommentLevel enums: - description: '' is_valid: true key: ALL value: '0' - description: '' is_valid: true key: COMMENT value: '1' - description: '' is_valid: true key: REPLY value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.comment_type x-open-field-id: 3 - description: '' in: query name: original_comment_id required: false schema: default: '0' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.original_comment_id x-open-field-id: 4 - description: '' in: query name: app required: false schema: default: TIKTOK nullable: false 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: TIKTOK value: '1233' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.app x-open-field-id: 5 - description: '' in: query name: page required: false schema: default: 1 format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page x-open-field-id: 6 - description: '' in: query name: page_size required: false schema: default: 10 format: int64 maximum: 100 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page_size x-open-field-id: 7 - 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get related comments. [Comment Reference](https://business-api.tiktok.com/portal/docs?id=1738086824859650) tags: - Comments 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: comment_id required: true source: $.http.query.comment_id type: number - name: comment_type required: true source: $.http.query.comment_type type: number - name: original_comment_id required: true source: $.http.query.original_comment_id type: number - name: app required: true source: $.http.query.app type: number - name: page required: true source: $.http.query.page type: number - name: page_size required: true source: $.http.query.page_size type: number - children: - name: app_id required: false source: $.context.app_id type: number - name: core_user_id required: false source: $.context.core_user_id type: number - name: developer_id required: false source: $.context.developer_id type: number is_expand: true name: context_info required: false type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id app: $.http.query.app comment_id: $.http.query.comment_id comment_type: $.http.query.comment_type context_info: app_id: $.context.app_id core_user_id: $.context.core_user_id developer_id: $.context.developer_id original_comment_id: $.http.query.original_comment_id page: $.http.query.page page_size: $.http.query.page_size response_cookie: [] response_header: [] response_rule: comments[][]: - can_delete: $.rpc.output.comments[].can_delete comment_id: $.rpc.output.comments[].comment_id comment_status: $.rpc.output.comments[].comment_status comment_type: $.rpc.output.comments[].comment_type content: $.rpc.output.comments[].content create_time: $.rpc.output.comments[].create_time hit_blockedword: $.rpc.output.comments[].hit_blockedword identity_id: $.rpc.output.comments[].identity_id identity_type: $.rpc.output.comments[].identity_type is_auth_comment_manage_scope: $.rpc.output.comments[].is_auth_comment_manage_scope is_auth_ttba: $.rpc.output.comments[].is_auth_ttba is_pinned: $.rpc.output.comments[].is_pinned reply_user_info[]: - user_avatar_url: $.rpc.output.comments[].reply_user_info.user_avatar_url user_name: $.rpc.output.comments[].reply_user_info.user_name tiktok_item_id: $.rpc.output.comments[].tiktok_item_id user_avatar_url: $.rpc.output.comments[].user_avatar_url user_id: $.rpc.output.comments[].user_id user_name: $.rpc.output.comments[].user_name page_info: $.rpc.output.page_info x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /comment/status/update/: post: operationId: Comment 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: ad_type: default: BIDDING description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804602577431553 enum_package_name: CommentSource enums: - description: '' is_valid: true key: BIDDING value: '2' - description: '' is_valid: true key: BRAND value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 1 x-open-source: $.http.body.source advertiser_id: description: '' nullable: false 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.adv_id comment_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.comment_ids operation: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1816408217647105 enum_package_name: CommentOperation enums: - description: '' is_valid: true key: HIDDEN value: '2' - description: '' is_valid: true key: PUBLIC 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 required: - advertiser_id - operation - comment_ids type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Use this endpoint to change the status of a list of comments from public to hidden, or vice versa. [Comment Status Update](https://business-api.tiktok.com/portal/docs?id=1738086844585985) tags: - Comments x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: source required: true source: $.http.body.ad_type type: number - name: adv_id required: true source: $.http.body.advertiser_id type: number - children: - type: number is_expand: true name: comment_ids required: true source: $.http.body.comment_ids sub_type: number type: array - name: operation required: true source: $.http.body.operation type: number - name: tt4b_uid required: false source: $.context.core_user_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: adv_id: $.http.body.advertiser_id comment_ids: $.http.body.comment_ids operation: $.http.body.operation source: $.http.body.ad_type tt4b_uid: $.context.core_user_id response_cookie: [] response_header: [] response_rule: extra: $.rpc.output.extra x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /comment/task/check/: get: operationId: Comment Task Check parameters: - description: '' in: query name: task_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.task_id x-open-field-id: 1 - description: '' in: query name: advertiser_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 2 - description: '' in: query name: source required: false schema: default: BIDDING nullable: false 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: BIDDING value: '2' - description: '' is_valid: true key: BRAND value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get comment export status. [Comment Task Check](https://business-api.tiktok.com/portal/docs?id=1738088242659330) tags: - Comments x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: task_id required: false source: $.http.query.task_id type: string - children: - name: source required: true source: $.http.query.source type: number - name: adv_id required: true source: $.http.query.advertiser_id type: number is_expand: true name: condition required: true type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: condition: adv_id: $.http.query.advertiser_id source: $.http.query.source task_id: $.http.query.task_id response_cookie: [] response_header: [] response_rule: status: $.rpc.output.status task_id: $.rpc.output.task_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /comment/task/create/: post: operationId: Comment Task 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: '' nullable: false 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 comment_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 11 x-open-source: $.http.body.comment_ids comment_status: description: '' items: default: ALL nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804526126395393 enum_package_name: CommentStatus enums: - description: '' is_valid: true key: ALL value: '0' - description: '' is_valid: true key: HIDDEN value: '2' - description: '' is_valid: true key: PUBLIC value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 x-open-source: $.http.body.comment_status comment_type: description: '' items: default: ALL nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804526161934338 enum_package_name: CommentLevel enums: - description: '' is_valid: true key: ALL value: '0' - description: '' is_valid: true key: COMMENT value: '1' - description: '' is_valid: true key: REPLY value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.body.comment_type end_time: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.body.end_time lang: default: EN description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1825169386905665 enum_package_name: CommentLang enums: - description: '' is_valid: true key: EN value: en - description: '' is_valid: true key: JA value: ja - description: '' is_valid: true key: ZH value: zh key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 10 x-open-source: $.http.body.lang search_field: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804526075543618 enum_package_name: CommentSearchType enums: - description: '' is_valid: true key: ADGROUP_ID value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 2 x-open-source: $.http.body.search_field search_value: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.search_value sort_field: default: CREATE_TIME description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804526557570050 enum_package_name: CommentSortField enums: - description: '' is_valid: true key: CREATE_TIME value: create_time - description: '' is_valid: true key: LIKES value: digg_count_long - description: '' is_valid: true key: REPLIES value: reply_count_long - description: '' is_valid: true key: SMART value: smart_hot key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 8 x-open-source: $.http.body.sort_field sort_type: default: DESC description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804526601709569 enum_package_name: CommentSortType enums: - description: '' is_valid: true key: ASC value: ASC - description: '' is_valid: true key: DESC value: DESC key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 9 x-open-source: $.http.body.sort_type start_time: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.start_time required: - advertiser_id - search_field - search_value - start_time - end_time 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Create comment export task. [Comment Task Create](https://business-api.tiktok.com/portal/docs?id=1738088144215041) tags: - Comments 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: search_field required: false source: $.http.body.search_field type: number - name: search_value required: false source: $.http.body.search_value type: string - name: start_time required: false source: $.http.body.start_time type: string - name: end_time required: false source: $.http.body.end_time type: string - children: - type: number name: comment_type required: false source: $.http.body.comment_type sub_type: number type: array - children: - type: number name: comment_status required: false source: $.http.body.comment_status sub_type: number type: array - name: sort_field required: false source: $.http.body.sort_field type: string - name: sort_type required: false source: $.http.body.sort_type type: string - name: lang required: false source: $.http.body.lang type: string - children: - type: number name: comment_ids required: false source: $.http.body.comment_ids sub_type: number 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: context_info required: false source: $.http.body.context_info type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id comment_ids: $.http.body.comment_ids comment_status: $.http.body.comment_status comment_type: $.http.body.comment_type context_info: $.http.body.context_info end_time: $.http.body.end_time lang: $.http.body.lang search_field: $.http.body.search_field search_value: $.http.body.search_value sort_field: $.http.body.sort_field sort_type: $.http.body.sort_type start_time: $.http.body.start_time response_cookie: [] response_header: [] response_rule: task_id: $.rpc.output.task_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /creative/asset/delete/: post: operationId: Creative Asset 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: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.advertiser_id image_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 50 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.image_ids video_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 50 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.video_ids required: - advertiser_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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Delete creative assets. [Asset Delete](https://business-api.tiktok.com/portal/docs?id=1797202997456897) tags: - Creative Management 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: string - children: - type: string name: video_ids required: false source: $.http.body.video_ids sub_type: string type: array - children: - type: string name: image_ids required: false source: $.http.body.image_ids sub_type: string type: array plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id image_ids: $.http.body.image_ids video_ids: $.http.body.video_ids response_cookie: [] response_header: [] response_rule: failed_image_ids: $.rpc.output.failed_image_ids failed_video_ids: $.rpc.output.failed_video_ids x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /creative/asset/share/: post: operationId: Creative Asset Share 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: '' nullable: false 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 asset_type: default: VIDEO description: '' nullable: false 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: VIDEO value: '3' - description: '' is_valid: true key: IMAGE value: '2' - description: '' is_valid: true key: MUSIC value: '5' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 4 x-open-source: $.http.body.asset_type material_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) maxItems: 20 minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.material_ids shared_advertiser_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) maxItems: 10 minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.shared_advertiser_ids required: - advertiser_id - material_ids - shared_advertiser_ids type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: SShare creative assets with other advertiser accounts. [Asset Share](https://business-api.tiktok.com/portal/docs?id=1773192725768193) tags: - Creative Management 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: material_ids required: true source: $.http.body.material_ids sub_type: number type: array - children: - type: number name: shared_advertiser_ids required: true source: $.http.body.shared_advertiser_ids sub_type: number type: array - name: asset_type required: true source: $.http.body.asset_type type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id asset_type: $.http.body.asset_type material_ids: $.http.body.material_ids shared_advertiser_ids: $.http.body.shared_advertiser_ids response_cookie: [] response_header: [] response_rule: failed_infos: $.rpc.output.failed_infos x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /creative/image/edit/: post: operationId: Creative Image Edit 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: '' nullable: false 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 edit_method: default: fix_size description: '' maxLength: 100 nullable: false 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: fix_size value: fix_size - description: '' is_valid: true key: only_gauss_pad value: only_gauss_pad - description: '' is_valid: true key: gauss_padding_reserve_score value: gauss_padding_reserve_score key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 6 x-open-source: $.http.body.edit_method height: description: '' format: int64 minimum: 3 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.height image_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.image_id image_name: description: '' maxLength: 100 nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.body.image_name width: description: '' format: int64 minimum: 3 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.width required: - advertiser_id - image_id - width - height 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Edit an image according to the size you want as well as apply creative trimmings. [Image Edit](https://business-api.tiktok.com/portal/docs?id=1739067107903489) tags: - Creative Management 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: image_id required: true source: $.http.body.image_id type: string - name: width required: true source: $.http.body.width type: number - name: height required: true source: $.http.body.height type: number - name: image_name required: false source: $.http.body.image_name type: string - name: edit_method required: true source: $.http.body.edit_method type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id edit_method: $.http.body.edit_method height: $.http.body.height image_id: $.http.body.image_id image_name: $.http.body.image_name width: $.http.body.width response_cookie: [] response_header: [] response_rule: create_time: $.rpc.output.create_time displayable: $.rpc.output.displayable file_name: $.rpc.output.file_name format: $.rpc.output.format height: $.rpc.output.height image_id: $.rpc.output.image_id image_url: $.rpc.output.image_url is_carousel_usable: $.rpc.output.is_carousel_usable material_id: $.rpc.output.material_id modify_time: $.rpc.output.modify_time signature: $.rpc.output.signature size: $.rpc.output.size width: $.rpc.output.width x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /creative/portfolio/create/: post: operationId: Creative Portfolio 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: '' nullable: false 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 creative_portfolio_type: default: CTA description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804132825869313 enum_package_name: CreativePortfolioType enums: - description: '' is_valid: true key: CARD value: '2' - description: '' is_valid: true key: COUNTDOWN_STICKER value: '7' - description: '' is_valid: true key: CTA value: '1' - description: '' is_valid: true key: DESTINATION_CARD value: '25' - description: '' is_valid: true key: DOWNLOAD_CARD value: '13' - description: '' is_valid: true key: DYNAMIC_ADD_ON value: '200' - description: '' is_valid: true key: FLIGHT_CARD value: '22' - description: Corresponds to GESTURE is_valid: true key: GESTURE value: '4' - description: '' is_valid: true key: GIFTCODE_STICKER value: '8' - description: '' is_valid: true key: HOTEL_CARD value: '21' - description: AutoInventoryCard is_valid: true key: INVENTORY_CARD value: '18' - description: '' is_valid: true key: LIVE_REMINDER_COUNTDOWN_STICKER value: '14' - description: Corresponds to MOVIE_CARD is_valid: true key: MEDIA_CARD value: '20' - description: '' is_valid: true key: NON_CLICK_SUPER_LIKE value: '12' - description: Corresponds to PAINTED_EGG is_valid: true key: PREMIUM_BADGE value: '5' - description: '' is_valid: true key: PRODUCT_CARD value: '11' - description: '' is_valid: true key: PRODUCT_INFO_CARD value: '24' - description: '' is_valid: true key: PRODUCT_SHOWCASE_TILE value: '26' - description: '' is_valid: true key: PRODUCT_TILE value: '17' - description: '' is_valid: true key: REMINDER_COUNTDOWN_STICKER value: '10' - description: '' is_valid: true key: SHAKE_SURPRISE value: '15' - description: '' is_valid: true key: SHOPIFY_PRODUCT_CARD value: '19' - description: Corresponds to VOTING_STICKER is_valid: true key: STICKER value: '6' - description: '' is_valid: true key: STORY_SELECTION value: '16' - description: '' is_valid: true key: SUPER_LIKE value: '9' - description: InfomativeCTA is_valid: true key: WEB_INFO_CARD value: '23' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 2 x-open-source: $.http.body.creative_portfolio_type portfolio_content: description: '' items: nullable: false properties: ad_text: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 38 x-open-source: $.http.body.portfolio_content[].title advanced_audio_info: description: '' nullable: false properties: video_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.portfolio_content[].advanced_audio_info.video_id type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 14 x-open-source: $.http.body.portfolio_content[].advanced_audio_info advanced_gesture_icon: description: '' nullable: false properties: image_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.portfolio_content[].advanced_gesture_icon.image_id type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 12 x-open-source: $.http.body.portfolio_content[].advanced_gesture_icon advanced_gesture_image: description: '' nullable: false properties: image_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.portfolio_content[].advanced_gesture_image.image_id type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 13 x-open-source: $.http.body.portfolio_content[].advanced_gesture_image advanced_interact_shape: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804268028189761 enum_package_name: CreativeGestureInteractShape enums: - description: '' is_valid: true key: CURVE value: '1' - description: '' is_valid: true key: LINE 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.portfolio_content[].advanced_interact_shape advanced_interact_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804138054020098 enum_package_name: CreativePortfolioGestureInteract enums: - description: '' is_valid: true key: CLICK value: '0' - description: '' is_valid: true key: SLIDE value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 10 x-open-source: $.http.body.portfolio_content[].advanced_interact_type app_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 19 x-open-source: $.http.body.portfolio_content[].app_id asset_content: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.portfolio_content[].asset_content asset_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.portfolio_content[].asset_ids badge_image_info: description: '' nullable: false properties: image_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.portfolio_content[].advanced_image_info.image_id type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 9 x-open-source: $.http.body.portfolio_content[].advanced_image_info badge_position: description: '' nullable: false properties: angle: description: '' format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.portfolio_content[].advanced_position.angle position_x: description: '' format: double nullable: false type: number x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.portfolio_content[].advanced_position.position_x position_y: description: '' format: double nullable: false type: number x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.portfolio_content[].advanced_position.position_y type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 8 x-open-source: $.http.body.portfolio_content[].advanced_position badge_show_time: description: '' format: int64 minimum: 3 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.body.portfolio_content[].advanced_show_time call_to_action: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 21 x-open-source: $.http.body.portfolio_content[].cta call_to_action_text: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 x-open-source: $.http.body.portfolio_content[].advanced_guide_text_bottom card_image_index: description: '' format: int64 minimum: 0 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 45 x-open-source: $.http.body.portfolio_content[].card_image_index card_show_price: description: '' nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 43 x-open-source: $.http.body.portfolio_content[].card_show_price card_tags: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804139531927554 enum_package_name: ProductTag enums: - description: '' is_valid: true key: BRAND value: '1' - description: '' is_valid: true key: CATEGORY value: '2' - description: '' is_valid: true key: DESC value: '5' - description: '' is_valid: true key: FREE_SHIPPING value: '4' - description: '' is_valid: true key: MATERIAL value: '3' key_format: string strict: true use_part: false validate_only: false value_format: int32 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 44 x-open-source: $.http.body.portfolio_content[].card_tags card_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804137888825410 enum_package_name: CreativePortfolioCardType enums: - description: '' is_valid: true key: IMAGE value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 1 x-open-source: $.http.body.portfolio_content[].card_type catalog_authorized_bc_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 29 x-open-source: $.http.body.portfolio_content[].catalog_authorized_bc catalog_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 28 x-open-source: $.http.body.portfolio_content[].product_platform_id category_label: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 18 x-open-source: $.http.body.portfolio_content[].category_label country_code: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 23 x-open-source: $.http.body.portfolio_content[].country_code description: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 17 x-open-source: $.http.body.portfolio_content[].description display_price_enabled: description: '' nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 48 x-open-source: $.http.body.portfolio_content[].display_price_info dynamic_format: default: UNSET description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1826186631243841 enum_package_name: DynamicCreativeStrategy enums: - description: smart creative is_valid: true key: DYNAMIC_CREATIVE value: '1' - description: 未设置 is_valid: true key: UNSET value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 41 x-open-source: $.http.body.portfolio_content[].vertical_creative_strategy gesture_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1829049153107970 enum_package_name: GestureType enums: - description: '' is_valid: true key: CLICK value: '0' - description: '' is_valid: true key: CURVED_SLIDE value: '2' - description: '' is_valid: true key: STRAIGHT_SLIDE value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 50 identity_authorized_bc_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 34 x-open-source: $.http.body.portfolio_content[].identity_bc_id identity_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 32 x-open-source: $.http.body.portfolio_content[].identity_id identity_type: description: '' nullable: false 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: true key: BC_SELF_TT value: '4' - description: '' is_valid: true key: CUSTOMIZED_USER value: '1' - description: TTS 授权来源TT账号 is_valid: false key: TTS_TT value: '8' - description: '' is_valid: true key: TT_USER value: '3' - description: '' is_valid: true key: UNSET value: '0' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 33 x-open-source: $.http.body.portfolio_content[].identity_type image_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.portfolio_content[].image_uri image_optimization_enabled: description: '' nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 49 x-open-source: $.http.body.portfolio_content[].enable_image_optimization interactive_music_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 51 item_group_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 37 x-open-source: $.http.body.portfolio_content[].spu_list layouts: description: '' items: nullable: false 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: TYPE_1 value: '1' - description: '' is_valid: true key: TYPE_2 value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 16 x-open-source: $.http.body.portfolio_content[].layouts mobile_app_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 22 x-open-source: $.http.body.portfolio_content[].origin_app_id pop_up_window_image_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 primary_text: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1826185093536770 enum_package_name: VerticalCatalogCardTextType enums: - description: '' is_valid: true key: CUSTOM_LABEL value: '1' - description: '' is_valid: true key: DEALS value: '3' - description: '' is_valid: true key: GENRE value: '2' - description: '' is_valid: true key: NONE value: '5' - description: '' is_valid: true key: RATING value: '4' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 24 x-open-source: $.http.body.portfolio_content[].primary_text product_set_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 35 x-open-source: $.http.body.portfolio_content[].product_set_id product_source: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1807533400732674 enum_package_name: ProductSource enums: - description: '' is_valid: true key: CATALOG value: '1' - description: '' is_valid: true key: SHOWCASE value: '3' - description: '' is_valid: true key: STORE value: '2' - description: '' is_valid: true key: UNSET value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 27 x-open-source: $.http.body.portfolio_content[].product_source product_specific_type: default: UNSET description: '' nullable: false 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: true key: PRODUCT_SET value: '2' - description: '' is_valid: true key: UNSET value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 40 x-open-source: $.http.body.portfolio_content[].product_specific_type profile_image: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 20 x-open-source: $.http.body.portfolio_content[].avatar secondary_text: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1826185093536770 enum_package_name: VerticalCatalogCardTextType enums: - description: '' is_valid: true key: CUSTOM_LABEL value: '1' - description: '' is_valid: true key: DEALS value: '3' - description: '' is_valid: true key: GENRE value: '2' - description: '' is_valid: true key: NONE value: '5' - description: '' is_valid: true key: RATING value: '4' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 25 x-open-source: $.http.body.portfolio_content[].secondary_text selling_points: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 5 minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 46 x-open-source: $.http.body.portfolio_content[].selling_points showcase_products: description: '' items: nullable: false properties: catalog_id: description: '' nullable: false 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.portfolio_content[].showcase_spu_list[].catalog_id item_group_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.portfolio_content[].showcase_spu_list[].spu_id store_id: description: '' nullable: false 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.portfolio_content[].showcase_spu_list[].shop_id type: object x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 20 minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 39 x-open-source: $.http.body.portfolio_content[].showcase_spu_list sku_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 36 x-open-source: $.http.body.portfolio_content[].sku_ids slide_dimension: description: '' nullable: false properties: dimension_height: description: '' format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 dimension_width: description: '' format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 53 slide_length: description: '' format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 52 sticker_param: description: '' nullable: false properties: color: description: '' nullable: false 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: ORANGE value: ORANGE - description: '' is_valid: true key: BLACK value: BLACK - description: '' is_valid: true key: RED value: RED - description: '' is_valid: true key: BLUE value: BLUE key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 3 x-open-source: $.http.body.portfolio_content[].sticker_param.color cutoff_time: description: '' format: datetime nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.portfolio_content[].sticker_param.cutoff_time display_angle: description: '' format: int64 maximum: 180 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.portfolio_content[].sticker_param.display_angle giftcode: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 13 x-open-source: $.http.body.portfolio_content[].sticker_param.giftcode landing_page_url: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 10 x-open-source: $.http.body.portfolio_content[].sticker_param.landing_page_url live_tiktok_user_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 11 x-open-source: $.http.body.portfolio_content[].sticker_param.live_account_user_id opacity: description: '' nullable: false 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: '0.7' value: '0.7' - description: '' is_valid: true key: '0.8' value: '0.8' - description: '' is_valid: true key: '0.9' value: '0.9' - description: '' is_valid: true key: '1' value: '1' key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 8 x-open-source: $.http.body.portfolio_content[].sticker_param.opacity position_x: description: '' format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.body.portfolio_content[].sticker_param.position_x position_y: description: '' format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.body.portfolio_content[].sticker_param.position_y predefined_placement: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 14 x-open-source: $.http.body.portfolio_content[].sticker_param.predefined_placement reminder_time: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1826186173387777 enum_package_name: ReminderTime enums: - description: '' is_valid: true key: FIVE_MINUTES_AFTER value: '4' - description: '' is_valid: true key: ONE_DAY_EARLIER value: '2' - description: '' is_valid: true key: ONE_HOUR_EARLIER value: '1' - description: '' is_valid: true key: ONE_MINUTE_AFTER value: '3' - description: '' is_valid: true key: ONE_MINUTE_EARLIER value: '0' - description: '' is_valid: true key: TEN_MINUTES_AFTER value: '5' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 9 x-open-source: $.http.body.portfolio_content[].sticker_param.reminder_time size: description: '' nullable: false 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: '0.6' value: '0.6' - description: '' is_valid: true key: '0.7' value: '0.7' - description: '' is_valid: true key: '0.8' value: '0.8' - description: '' is_valid: true key: '0.9' value: '0.9' - description: '' is_valid: true key: '1' value: '1' - description: '' is_valid: true key: '1.1' value: '1.1' key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 7 x-open-source: $.http.body.portfolio_content[].sticker_param.size sticker_type: default: COUNTDOWN description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804139609682946 enum_package_name: StickerType enums: - description: '' is_valid: true key: COUNTDOWN value: '7' - description: '' is_valid: true key: GIFTCODE value: '8' - description: '' is_valid: true key: LIVE_REMINDER_COUNTDOWN value: '14' - description: '' is_valid: true key: REMINDER_COUNTDOWN value: '10' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 12 x-open-source: $.http.body.portfolio_content[].sticker_param.sticker_type title: description: '' maxLength: 54 minLength: 1 nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.portfolio_content[].sticker_param.title required: - title - color type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 26 x-open-source: $.http.body.portfolio_content[].sticker_param store_authorized_bc_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 31 x-open-source: $.http.body.portfolio_content[].shop_authorized_bc store_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 30 x-open-source: $.http.body.portfolio_content[].shop_id tags: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804139457244162 enum_package_name: CreativePortfolioDownloadCardTag enums: - description: '' is_valid: true key: CATEGORIES value: '1' - description: '' is_valid: true key: COMMENT_VOLUME value: '5' - description: '' is_valid: true key: FILESIZE value: '2' - description: '' is_valid: true key: RANKING value: '4' - description: '' is_valid: true key: RATING value: '3' key_format: string strict: true use_part: false validate_only: false value_format: int32 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 15 x-open-source: $.http.body.portfolio_content[].tags title: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 47 x-open-source: $.http.body.portfolio_content[].card_title vertical_video_strategy: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1828883174105281 enum_package_name: CreativeVerticalVideoStrategy enums: - description: '' is_valid: true key: CATALOG_UPLOADED_VIDEOS value: '5' - description: '' is_valid: true key: CATALOG_VIDEOS value: '2' - description: '' is_valid: true key: LIVE_STREAM value: '3' - description: '' is_valid: true key: SINGLE_VIDEO value: '1' - description: '' is_valid: true key: UNSET value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 42 x-open-source: $.http.body.portfolio_content[].vertical_video_strategy type: object x-open-allow-strlist: false x-open-allow-strnum: false minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.portfolio_content required: - advertiser_id - portfolio_content 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Create a portfolio. [Creative Portfolie Create](https://business-api.tiktok.com/portal/docs?id=1739091950439426) tags: - Creative Management 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: creative_portfolio_type required: false source: $.http.body.creative_portfolio_type type: number - children: - children: - name: card_type required: false source: $.http.body.portfolio_content[].card_type type: number - children: - type: number is_expand: false name: asset_ids required: false source: $.http.body.portfolio_content[].asset_ids sub_type: number type: array - name: asset_content required: false source: $.http.body.portfolio_content[].asset_content type: string - name: image_uri required: false source: $.http.body.portfolio_content[].image_id type: string - name: jump_image_uri required: false source: $.http.body.portfolio_content[].pop_up_window_image_id type: string - name: advanced_show_time required: false source: $.http.body.portfolio_content[].badge_show_time type: number - name: advanced_guide_text_bottom required: false source: $.http.body.portfolio_content[].call_to_action_text type: string - children: - name: position_x required: false source: $.http.body.portfolio_content[].advanced_position.position_x type: number - name: position_y required: false source: $.http.body.portfolio_content[].advanced_position.position_y type: number - name: angle required: false source: $.http.body.portfolio_content[].advanced_position.angle type: number is_expand: true name: advanced_position required: false source: $.http.body.portfolio_content[].badge_position type: object - children: - name: image_id required: false source: $.http.body.portfolio_content[].advanced_image_info.image_id type: string is_expand: true name: advanced_image_info required: false source: $.http.body.portfolio_content[].badge_image_info type: object - name: advanced_interact_type required: false source: $.http.body.portfolio_content[].advanced_interact_type type: number - name: advanced_interact_shape required: false source: $.http.body.portfolio_content[].advanced_interact_shape type: number - children: - name: image_id required: false source: $.http.body.portfolio_content[].advanced_gesture_icon.image_id type: string is_expand: true name: advanced_gesture_icon required: false source: $.http.body.portfolio_content[].advanced_gesture_icon type: object - children: - name: image_id required: false source: $.http.body.portfolio_content[].advanced_gesture_image.image_id type: string is_expand: true name: advanced_gesture_image required: false source: $.http.body.portfolio_content[].advanced_gesture_image type: object - children: - name: video_id required: false source: $.http.body.portfolio_content[].advanced_audio_info.video_id type: string is_expand: true name: advanced_audio_info required: false source: $.http.body.portfolio_content[].advanced_audio_info type: object - children: - type: number is_expand: true name: tags required: false source: $.http.body.portfolio_content[].tags sub_type: number type: array - children: - type: number is_expand: true name: layouts required: false source: $.http.body.portfolio_content[].layouts sub_type: number type: array - name: description required: false source: $.http.body.portfolio_content[].description type: string - name: category_label required: false source: $.http.body.portfolio_content[].category_label type: string - name: app_id required: false source: $.http.body.portfolio_content[].app_id type: string - name: avatar required: false source: $.http.body.portfolio_content[].profile_image type: string - name: cta required: false source: $.http.body.portfolio_content[].call_to_action type: string - name: origin_app_id required: false source: $.http.body.portfolio_content[].mobile_app_id type: string - children: - type: string is_expand: true name: country_code required: false source: $.http.body.portfolio_content[].country_code sub_type: string type: array - name: primary_text required: false source: $.http.body.portfolio_content[].primary_text type: number - name: secondary_text required: false source: $.http.body.portfolio_content[].secondary_text type: number - children: - name: title required: true source: $.http.body.portfolio_content[].sticker_param.title type: string - name: cutoff_time required: false source: $.http.body.portfolio_content[].sticker_param.cutoff_time type: string - name: color required: true source: $.http.body.portfolio_content[].sticker_param.color type: string - name: display_angle required: false source: $.http.body.portfolio_content[].sticker_param.display_angle type: number - name: position_x required: false source: $.http.body.portfolio_content[].sticker_param.position_x type: number - name: position_y required: false source: $.http.body.portfolio_content[].sticker_param.position_y type: number - name: size required: false source: $.http.body.portfolio_content[].sticker_param.size type: string - name: opacity required: false source: $.http.body.portfolio_content[].sticker_param.opacity type: string - name: reminder_time required: false source: $.http.body.portfolio_content[].sticker_param.reminder_time type: number - name: landing_page_url required: false source: $.http.body.portfolio_content[].sticker_param.landing_page_url type: string - name: live_account_user_id required: false source: $.http.body.portfolio_content[].sticker_param.live_tiktok_user_id type: number - name: sticker_type required: false source: $.http.body.portfolio_content[].sticker_param.sticker_type type: number - name: giftcode required: false source: $.http.body.portfolio_content[].sticker_param.giftcode type: string - name: predefined_placement required: false source: $.http.body.portfolio_content[].sticker_param.predefined_placement type: string is_expand: true name: sticker_param required: false type: object - name: product_source required: false source: $.http.body.portfolio_content[].product_source type: number - name: product_platform_id required: false source: $.http.body.portfolio_content[].catalog_id type: number - name: catalog_authorized_bc required: false source: $.http.body.portfolio_content[].catalog_authorized_bc_id type: number - name: shop_id required: false source: $.http.body.portfolio_content[].store_id type: number - name: shop_authorized_bc required: false source: $.http.body.portfolio_content[].store_authorized_bc_id type: number - name: identity_id required: false source: $.http.body.portfolio_content[].identity_id type: string - name: identity_type required: false source: $.http.body.portfolio_content[].identity_type type: number - name: identity_bc_id required: false source: $.http.body.portfolio_content[].identity_authorized_bc_id type: number - name: product_set_id required: false source: $.http.body.portfolio_content[].product_set_id type: number - children: - type: string is_expand: true name: sku_ids required: false source: $.http.body.portfolio_content[].sku_ids sub_type: string type: array - children: - type: string is_expand: true name: spu_list required: false source: $.http.body.portfolio_content[].item_group_ids sub_type: string type: array - name: title required: false source: $.http.body.portfolio_content[].ad_text type: string - children: - children: - name: spu_id required: false source: $.http.body.portfolio_content[].showcase_products[].item_group_id type: string - name: shop_id required: false source: $.http.body.portfolio_content[].showcase_products[].store_id type: number - name: catalog_id required: false source: $.http.body.portfolio_content[].showcase_products[].catalog_id type: number is_expand: true type: object is_expand: true name: showcase_spu_list required: false sub_type: object type: array - name: product_specific_type required: false source: $.http.body.portfolio_content[].product_specific_type type: number - name: vertical_creative_strategy required: false source: $.http.body.portfolio_content[].dynamic_format type: number - name: vertical_video_strategy required: false source: $.http.body.portfolio_content[].vertical_video_strategy type: number - name: card_show_price required: false source: $.http.body.portfolio_content[].card_show_price type: boolean - children: - type: number is_expand: true name: card_tags required: false source: $.http.body.portfolio_content[].card_tags sub_type: number type: array - name: card_image_index required: false source: $.http.body.portfolio_content[].card_image_index type: number - children: - type: string is_expand: true name: selling_points required: false source: $.http.body.portfolio_content[].selling_points sub_type: string type: array - name: card_title required: false source: $.http.body.portfolio_content[].title type: string - name: display_price_info required: false source: $.http.body.portfolio_content[].display_price_enabled type: boolean - name: enable_image_optimization required: false source: $.http.body.portfolio_content[].image_optimization_enabled type: boolean - name: gesture_type required: false source: $.http.body.portfolio_content[].gesture_type type: number - name: interactive_music_id required: false source: $.http.body.portfolio_content[].interactive_music_id type: string - name: slide_length required: false source: $.http.body.portfolio_content[].slide_length type: number - children: - name: dimension_width required: false source: $.http.body.portfolio_content[].slide_dimension.dimension_width type: number - name: dimension_height required: false source: $.http.body.portfolio_content[].slide_dimension.dimension_height type: number is_expand: false name: slide_dimension required: false source: $.http.body.portfolio_content[].slide_dimension type: object is_expand: true type: object is_expand: true name: portfolio_content required: true 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: true source: $.http.body.context_info type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id context_info: $.http.body.context_info creative_portfolio_type: $.http.body.creative_portfolio_type portfolio_content[][]: - advanced_audio_info: $.http.body.portfolio_content[].advanced_audio_info advanced_gesture_icon: $.http.body.portfolio_content[].advanced_gesture_icon advanced_gesture_image: $.http.body.portfolio_content[].advanced_gesture_image advanced_guide_text_bottom: $.http.body.portfolio_content[].call_to_action_text advanced_image_info: $.http.body.portfolio_content[].badge_image_info advanced_interact_shape: $.http.body.portfolio_content[].advanced_interact_shape advanced_interact_type: $.http.body.portfolio_content[].advanced_interact_type advanced_position: $.http.body.portfolio_content[].badge_position advanced_show_time: $.http.body.portfolio_content[].badge_show_time app_id: $.http.body.portfolio_content[].app_id asset_content: $.http.body.portfolio_content[].asset_content asset_ids: $.http.body.portfolio_content[].asset_ids avatar: $.http.body.portfolio_content[].profile_image card_image_index: $.http.body.portfolio_content[].card_image_index card_show_price: $.http.body.portfolio_content[].card_show_price card_tags: $.http.body.portfolio_content[].card_tags card_title: $.http.body.portfolio_content[].title card_type: $.http.body.portfolio_content[].card_type catalog_authorized_bc: $.http.body.portfolio_content[].catalog_authorized_bc_id category_label: $.http.body.portfolio_content[].category_label country_code: $.http.body.portfolio_content[].country_code cta: $.http.body.portfolio_content[].call_to_action description: $.http.body.portfolio_content[].description display_price_info: $.http.body.portfolio_content[].display_price_enabled enable_image_optimization: $.http.body.portfolio_content[].image_optimization_enabled gesture_type: $.http.body.portfolio_content[].gesture_type identity_bc_id: $.http.body.portfolio_content[].identity_authorized_bc_id identity_id: $.http.body.portfolio_content[].identity_id identity_type: $.http.body.portfolio_content[].identity_type image_uri: $.http.body.portfolio_content[].image_id interactive_music_id: $.http.body.portfolio_content[].interactive_music_id jump_image_uri: $.http.body.portfolio_content[].pop_up_window_image_id layouts: $.http.body.portfolio_content[].layouts origin_app_id: $.http.body.portfolio_content[].mobile_app_id primary_text: $.http.body.portfolio_content[].primary_text product_platform_id: $.http.body.portfolio_content[].catalog_id product_set_id: $.http.body.portfolio_content[].product_set_id product_source: $.http.body.portfolio_content[].product_source product_specific_type: $.http.body.portfolio_content[].product_specific_type secondary_text: $.http.body.portfolio_content[].secondary_text selling_points: $.http.body.portfolio_content[].selling_points shop_authorized_bc: $.http.body.portfolio_content[].store_authorized_bc_id shop_id: $.http.body.portfolio_content[].store_id showcase_spu_list[][]: - catalog_id: $.http.body.portfolio_content[].showcase_products[].catalog_id shop_id: $.http.body.portfolio_content[].showcase_products[].store_id spu_id: $.http.body.portfolio_content[].showcase_products[].item_group_id sku_ids: $.http.body.portfolio_content[].sku_ids slide_dimension: $.http.body.portfolio_content[].slide_dimension slide_length: $.http.body.portfolio_content[].slide_length spu_list: $.http.body.portfolio_content[].item_group_ids sticker_param[]: - color: $.http.body.portfolio_content[].sticker_param.color cutoff_time: $.http.body.portfolio_content[].sticker_param.cutoff_time display_angle: $.http.body.portfolio_content[].sticker_param.display_angle giftcode: $.http.body.portfolio_content[].sticker_param.giftcode landing_page_url: $.http.body.portfolio_content[].sticker_param.landing_page_url live_account_user_id: $.http.body.portfolio_content[].sticker_param.live_tiktok_user_id opacity: $.http.body.portfolio_content[].sticker_param.opacity position_x: $.http.body.portfolio_content[].sticker_param.position_x position_y: $.http.body.portfolio_content[].sticker_param.position_y predefined_placement: $.http.body.portfolio_content[].sticker_param.predefined_placement reminder_time: $.http.body.portfolio_content[].sticker_param.reminder_time size: $.http.body.portfolio_content[].sticker_param.size sticker_type: $.http.body.portfolio_content[].sticker_param.sticker_type title: $.http.body.portfolio_content[].sticker_param.title tags: $.http.body.portfolio_content[].tags title: $.http.body.portfolio_content[].ad_text vertical_creative_strategy: $.http.body.portfolio_content[].dynamic_format vertical_video_strategy: $.http.body.portfolio_content[].vertical_video_strategy response_cookie: [] response_header: [] response_rule: creative_portfolio_id: $.rpc.output.creative_portfolio_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /creative/portfolio/get/: get: operationId: Creative Portfolio Get parameters: - description: '' in: query name: advertiser_id required: true schema: nullable: false 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: creative_portfolio_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.creative_portfolio_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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get a portfolio by ID. [Portfolio Get](https://business-api.tiktok.com/portal/docs?id=1739092113671170) tags: - Creative Management 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: creative_portfolio_id required: true source: $.http.query.creative_portfolio_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id creative_portfolio_id: $.http.query.creative_portfolio_id response_cookie: [] response_header: [] response_rule: creative_portfolio_id: $.rpc.output.creative_portfolio_id creative_portfolio_type: $.rpc.output.creative_portfolio_type portfolio_content: $.rpc.output.portfolio_content x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /creative/portfolio/list/: get: operationId: Creative Portfolio List parameters: - description: '' in: query name: advertiser_id required: true schema: nullable: false 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: nullable: false properties: creative_portfolio_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.query.filtering.creative_portfolio_ids creative_portfolio_types: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804132825869313 enum_package_name: CreativePortfolioType enums: - description: '' is_valid: true key: CARD value: '2' - description: '' is_valid: true key: COUNTDOWN_STICKER value: '7' - description: '' is_valid: true key: CTA value: '1' - description: '' is_valid: true key: DESTINATION_CARD value: '25' - description: '' is_valid: true key: DOWNLOAD_CARD value: '13' - description: '' is_valid: false key: DYNAMIC_ADD_ON value: '200' - description: '' is_valid: true key: FLIGHT_CARD value: '22' - description: Corresponds to GESTURE is_valid: true key: GESTURE value: '4' - description: '' is_valid: true key: GIFTCODE_STICKER value: '8' - description: '' is_valid: true key: HOTEL_CARD value: '21' - description: AutoInventoryCard is_valid: true key: INVENTORY_CARD value: '18' - description: '' is_valid: true key: LIVE_REMINDER_COUNTDOWN_STICKER value: '14' - description: Corresponds to MOVIE_CARD is_valid: true key: MEDIA_CARD value: '20' - description: '' is_valid: false key: NON_CLICK_SUPER_LIKE value: '12' - description: Corresponds to PAINTED_EGG is_valid: true key: PREMIUM_BADGE value: '5' - description: '' is_valid: true key: PRODUCT_CARD value: '11' - description: '' is_valid: false key: PRODUCT_INFO_CARD value: '24' - description: '' is_valid: true key: PRODUCT_SHOWCASE_TILE value: '26' - description: '' is_valid: true key: PRODUCT_TILE value: '17' - description: '' is_valid: true key: REMINDER_COUNTDOWN_STICKER value: '10' - description: '' is_valid: false key: SHAKE_SURPRISE value: '15' - description: '' is_valid: false key: SHOPIFY_PRODUCT_CARD value: '19' - description: Corresponds to VOTING_STICKER is_valid: false key: STICKER value: '6' - description: '' is_valid: false key: STORY_SELECTION value: '16' - description: '' is_valid: true key: SUPER_LIKE value: '9' - description: InfomativeCTA is_valid: true key: WEB_INFO_CARD value: '23' key_format: string strict: true use_part: true validate_only: false value_format: int32 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.query.filtering.creative_portfolio_types type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.filtering description: '' in: query name: filtering required: false x-open-field-id: 2 - description: '' in: query name: page required: false schema: default: 1 format: int64 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page x-open-field-id: 3 - description: '' in: query name: page_size required: false schema: default: 20 format: int64 maximum: 100 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page_size 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get portfolios within an ad account. [Portfolio List](https://business-api.tiktok.com/portal/docs?id=1766324010279938) tags: - Creative Management x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - children: - children: - type: number is_expand: true name: creative_portfolio_types required: false source: $.http.query.filtering.creative_portfolio_types sub_type: number type: array - children: - type: number is_expand: true name: creative_portfolio_ids required: false source: $.http.query.filtering.creative_portfolio_ids sub_type: number type: array is_expand: true name: filtering required: false source: $.http.query.filtering type: object - name: page required: false source: $.http.query.page type: number - name: page_size required: false source: $.http.query.page_size type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id filtering: $.http.query.filtering page: $.http.query.page page_size: $.http.query.page_size response_cookie: [] response_header: [] response_rule: creative_portfolios[][]: - advanced_audio_info: $.rpc.output.creative_portfolios[].creative_portfolio_content.advanced_audio_info advanced_gesture_icon: $.rpc.output.creative_portfolios[].creative_portfolio_content.advanced_gesture_icon advanced_gesture_image: $.rpc.output.creative_portfolios[].creative_portfolio_content.advanced_gesture_image advanced_interact_shape: $.rpc.output.creative_portfolios[].creative_portfolio_content.advanced_interact_shape advanced_interact_type: $.rpc.output.creative_portfolios[].creative_portfolio_content.advanced_interact_type app_id: $.rpc.output.creative_portfolios[].creative_portfolio_content.app_id badge_image_info: $.rpc.output.creative_portfolios[].creative_portfolio_content.badge_image_info badge_position[]: - angle: $.rpc.output.creative_portfolios[].creative_portfolio_content.badge_position.angle position_x: $.rpc.output.creative_portfolios[].creative_portfolio_content.badge_position.position_x position_y: $.rpc.output.creative_portfolios[].creative_portfolio_content.badge_position.position_y badge_show_time: $.rpc.output.creative_portfolios[].creative_portfolio_content.badge_show_time call_to_action_text: $.rpc.output.creative_portfolios[].creative_portfolio_content.call_to_action_text card_image_index: $.rpc.output.creative_portfolios[].creative_portfolio_content.card_image_index card_show_price: $.rpc.output.creative_portfolios[].creative_portfolio_content.card_show_price card_tags: $.rpc.output.creative_portfolios[].creative_portfolio_content.card_tags card_type: $.rpc.output.creative_portfolios[].creative_portfolio_content.card_type content_url: $.rpc.output.creative_portfolios[].creative_portfolio_content.content_url creative_portfolio_id: $.rpc.output.creative_portfolios[].creative_portfolio_id creative_portfolio_preview_url: $.rpc.output.creative_portfolios[].creative_portfolio_preview_url creative_portfolio_type: $.rpc.output.creative_portfolios[].creative_portfolio_type description: $.rpc.output.creative_portfolios[].creative_portfolio_content.description display_price_enabled: $.rpc.output.creative_portfolios[].creative_portfolio_content.display_price_enabled gesture_type: $.rpc.output.creative_portfolios[].creative_portfolio_content.gesture_type image_id: $.rpc.output.creative_portfolios[].creative_portfolio_content.image_id image_optimization_enabled: $.rpc.output.creative_portfolios[].creative_portfolio_content.image_optimization_enabled interactive_music_id: $.rpc.output.creative_portfolios[].creative_portfolio_content.interactive_music_id layouts: $.rpc.output.creative_portfolios[].creative_portfolio_content.layouts pop_up_window_image_id: $.rpc.output.creative_portfolios[].creative_portfolio_content.pop_up_window_image_id primary_text: $.rpc.output.creative_portfolios[].creative_portfolio_content.primary_text secondary_text: $.rpc.output.creative_portfolios[].creative_portfolio_content.secondary_text selling_points: $.rpc.output.creative_portfolios[].creative_portfolio_content.selling_points slide_dimension[]: - dimension_height: $.rpc.output.creative_portfolios[].creative_portfolio_content.slide_dimension.dimension_height dimension_width: $.rpc.output.creative_portfolios[].creative_portfolio_content.slide_dimension.dimension_width slide_length: $.rpc.output.creative_portfolios[].creative_portfolio_content.slide_length sticker_param[]: - color: $.rpc.output.creative_portfolios[].creative_portfolio_content.sticker_param.color cutoff_time: $.rpc.output.creative_portfolios[].creative_portfolio_content.sticker_param.cutoff_time display_angle: $.rpc.output.creative_portfolios[].creative_portfolio_content.sticker_param.display_angle giftcode: $.rpc.output.creative_portfolios[].creative_portfolio_content.sticker_param.giftcode landing_page_url: $.rpc.output.creative_portfolios[].creative_portfolio_content.sticker_param.landing_page_url live_tiktok_user_id: $.rpc.output.creative_portfolios[].creative_portfolio_content.sticker_param.live_tiktok_user_id opacity: $.rpc.output.creative_portfolios[].creative_portfolio_content.sticker_param.opacity position_x: $.rpc.output.creative_portfolios[].creative_portfolio_content.sticker_param.position_x position_y: $.rpc.output.creative_portfolios[].creative_portfolio_content.sticker_param.position_y predefined_placement: $.rpc.output.creative_portfolios[].creative_portfolio_content.sticker_param.predefined_placement reminder_time: $.rpc.output.creative_portfolios[].creative_portfolio_content.sticker_param.reminder_time size: $.rpc.output.creative_portfolios[].creative_portfolio_content.sticker_param.size sticker_type: $.rpc.output.creative_portfolios[].creative_portfolio_content.sticker_param.sticker_type title: $.rpc.output.creative_portfolios[].creative_portfolio_content.sticker_param.title tags: $.rpc.output.creative_portfolios[].creative_portfolio_content.tags thumbnail_id: $.rpc.output.creative_portfolios[].creative_portfolio_content.thumbnail_id title: $.rpc.output.creative_portfolios[].creative_portfolio_content.title page_info: $.rpc.output.page_info x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /creative/shareable_link/create/: post: operationId: Creative Shareable_link 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: shared_assets: description: '' items: nullable: false properties: asset_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.shared_assets[].asset_id asset_name: description: '' maxLength: 30 nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.shared_assets[].asset_name type: object x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 20 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.shared_assets sharer: description: '' maxLength: 30 nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.sharer required: - shared_assets - sharer 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: '' tags: - Creative Management x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - children: - children: - name: asset_id required: false source: $.http.body.shared_assets[].asset_id type: string - name: asset_name required: false source: $.http.body.shared_assets[].asset_name type: string type: object name: shared_assets required: true source: $.http.body.shared_assets sub_type: object type: array - name: sharer required: true source: $.http.body.sharer type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: shared_assets: $.http.body.shared_assets sharer: $.http.body.sharer response_cookie: [] response_header: [] response_rule: shareable_link: $.rpc.output.shareable_link x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /creative/smart_text/generate/: post: operationId: Creative Smart_text Generate parameters: - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string requestBody: content: application/json: schema: properties: adgroup_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 2 x-open-source: $.http.body.adgroup_id advertiser_id: description: '' nullable: false 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 industry_id: description: '' nullable: false 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.industry_id keywords: description: '' items: minLength: 1 nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.body.keywords language: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804052384859137 enum_package_name: SmartTextLanguage enums: - description: '' is_valid: true key: EN value: '1' - description: '' is_valid: true key: JA value: '2' - description: '' is_valid: true key: RU value: '5' - description: '' is_valid: true key: VI value: '3' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 4 x-open-source: $.http.body.language limit: default: 10 description: '' format: int64 maximum: 20 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 x-open-source: $.http.body.limit param_type: default: CUSTOMIZED description: '' nullable: false 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: CUSTOMIZED value: CUSTOMIZED - description: '' is_valid: true key: RECOMMENDED value: RECOMMENDED key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 3 x-open-source: $.http.body.param_type required: - advertiser_id - adgroup_id type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Use smart text. [Smart Text Generate](https://business-api.tiktok.com/portal/docs?id=1739084248002626) tags: - Creative Management x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.body.advertiser_id type: number - name: adgroup_id required: true source: $.http.body.adgroup_id type: number - name: param_type required: false source: $.http.body.param_type type: string - name: language required: false source: $.http.body.language type: number - name: industry_id required: false source: $.http.body.industry_id type: number - children: - type: string name: keywords required: false source: $.http.body.keywords sub_type: string type: array - name: limit required: true source: $.http.body.limit type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: adgroup_id: $.http.body.adgroup_id advertiser_id: $.http.body.advertiser_id industry_id: $.http.body.industry_id keywords: $.http.body.keywords language: $.http.body.language limit: $.http.body.limit param_type: $.http.body.param_type response_cookie: [] response_header: [] response_rule: generate_id: $.rpc.output.generate_id industry_id: $.rpc.output.industry_id language: $.rpc.output.language texts: $.rpc.output.texts x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /discovery/detail/: get: operationId: Discovery Detail parameters: - description: '' in: query name: hashtag_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.hashtag_id x-open-field-id: 1 - description: '' in: query name: discovery_type required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1805543041665089 enum_package_name: DiscoveryType enums: - description: '' is_valid: true key: HASHTAG value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.discovery_type x-open-field-id: 2 - description: '' in: query name: country_code required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.country_code x-open-field-id: 3 - description: '' in: query name: date_range required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1805543099909121 enum_package_name: DiscoveryPeriodType enums: - description: '' is_valid: true key: 120DAY value: l120d - description: '' is_valid: true key: 1DAY value: l1d - description: '' is_valid: true key: 30DAY value: l30d - description: '' is_valid: true key: 7DAY value: l7d key_format: string strict: true use_part: false validate_only: false value_format: string x-open-source: $.http.query.date_range x-open-field-id: 4 - description: '' in: query name: advertiser_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get details of a popular hashtag. [Discovery Detail](https://business-api.tiktok.com/portal/docs?id=1825119047070721) tags: - Creative Management 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: hashtag_id required: true source: $.http.query.hashtag_id type: number - name: discovery_type required: true source: $.http.query.discovery_type type: number - name: country_code required: true source: $.http.query.country_code type: string - name: date_range required: true source: $.http.query.date_range type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id country_code: $.http.query.country_code date_range: $.http.query.date_range discovery_type: $.http.query.discovery_type hashtag_id: $.http.query.hashtag_id response_cookie: [] response_header: [] response_rule: audience_insights: $.rpc.output.audience_insights hashtag_id: $.rpc.output.hashtag_id hashtag_name: $.rpc.output.hashtag_name hashtag_status: $.rpc.output.hashtag_status posts: $.rpc.output.posts posts_global_lifetime: $.rpc.output.posts_global_lifetime top_country_list: $.rpc.output.top_country_list trending_history[][]: - date: $.rpc.output.trending_history[].date rank_position_daily: $.rpc.output.trending_history[].rank_position_daily views_daily: $.rpc.output.trending_history[].views_daily views: $.rpc.output.views views_global_lifetime: $.rpc.output.views_global_lifetime x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /discovery/trending_list/: get: operationId: Discovery Trending_list parameters: - description: '' in: query name: discovery_type required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1805543041665089 enum_package_name: DiscoveryType enums: - description: '' is_valid: true key: HASHTAG value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.discovery_type x-open-field-id: 1 - description: '' in: query name: country_code required: false schema: default: US nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.country_code x-open-field-id: 2 - description: '' in: query name: category_name required: false schema: default: ALL nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1805543216364546 enum_package_name: DiscoveryHashtagCategory enums: - description: '' is_valid: true key: ACADEMIC_RESOURCES value: ACADEMIC_RESOURCES - description: '' is_valid: true key: ALL value: ALL - description: '' is_valid: true key: ANIMATION_AND_COMICS value: ANIMATION_AND_COMICS - description: '' is_valid: true key: APPAREL_AND_ACCESSORIES value: APPAREL_AND_ACCESSORIES - description: '' is_valid: true key: ART value: ART - description: '' is_valid: true key: AUTOMOTIVE value: AUTOMOTIVE - description: '' is_valid: true key: BABY_CARE value: BABY_CARE - description: '' is_valid: true key: BABY_KIDS_AND_MATERNITY value: BABY_KIDS_AND_MATERNITY - description: '' is_valid: true key: BEAUTY value: BEAUTY - description: '' is_valid: true key: BEAUTY_AND_PERSONAL_CARE value: BEAUTY_AND_PERSONAL_CARE - description: '' is_valid: true key: BEAUTY_SERVICES value: BEAUTY_SERVICES - description: '' is_valid: true key: BUSINESS_AND_FINANCE value: BUSINESS_AND_FINANCE - description: '' is_valid: true key: BUSINESS_SERVICES value: BUSINESS_SERVICES - description: '' is_valid: true key: CARD_AND_BOARD_GAMES value: CARD_AND_BOARD_GAMES - description: '' is_valid: true key: CAREER_AND_PROFESSIONAL_GROWTH value: CAREER_AND_PROFESSIONAL_GROWTH - description: '' is_valid: true key: COLLEGE value: COLLEGE - description: '' is_valid: true key: COMEDY value: COMEDY - description: '' is_valid: true key: COMMUNITY_UPDATES_AND_ISSUES value: COMMUNITY_UPDATES_AND_ISSUES - description: '' is_valid: true key: CONVENTIONAL_AND_MAINSTREAM_SPORTS value: CONVENTIONAL_AND_MAINSTREAM_SPORTS - description: '' is_valid: true key: COOKING value: COOKING - description: '' is_valid: true key: CRAFTING_AND_CREATIONS value: CRAFTING_AND_CREATIONS - description: '' is_valid: true key: CULTURE value: CULTURE - description: '' is_valid: true key: DANCE value: DANCE - description: '' is_valid: true key: DIARY_AND_VLOG value: DIARY_AND_VLOG - description: '' is_valid: true key: DRINKS value: DRINKS - description: '' is_valid: true key: EATING_EXPERIENCES value: EATING_EXPERIENCES - description: '' is_valid: true key: EDUCATION value: EDUCATION - description: '' is_valid: true key: ENTERTAINMENT_AND_SPORTS_NEWS value: ENTERTAINMENT_AND_SPORTS_NEWS - description: '' is_valid: true key: ENVIRONMENT value: ENVIRONMENT - description: '' is_valid: true key: EXERCISE_AND_FITNESS value: EXERCISE_AND_FITNESS - description: '' is_valid: true key: EXTREME_AND_ADVENTURE_SPORTS value: EXTREME_AND_ADVENTURE_SPORTS - description: '' is_valid: true key: FAMILY value: FAMILY - description: '' is_valid: true key: FINANCIAL_SERVICES value: FINANCIAL_SERVICES - description: '' is_valid: true key: FOOD value: FOOD - description: '' is_valid: true key: FOOD_AND_BEVERAGE value: FOOD_AND_BEVERAGE - description: '' is_valid: true key: FOOD_RECOMMENDATIONS value: FOOD_RECOMMENDATIONS - description: '' is_valid: true key: GADGETS_AND_INNOVATION value: GADGETS_AND_INNOVATION - description: '' is_valid: true key: GAMES value: GAMES - description: '' is_valid: true key: GENERAL_TRAVEL value: GENERAL_TRAVEL - description: '' is_valid: true key: HAIR_CARE value: HAIR_CARE - description: '' is_valid: true key: HEALTH value: HEALTH - description: '' is_valid: true key: HEALTH_AND_WELLNESS value: HEALTH_AND_WELLNESS - description: '' is_valid: true key: HISTORY_AND_LITERATURE value: HISTORY_AND_LITERATURE - description: '' is_valid: true key: HOME_AND_GARDEN value: HOME_AND_GARDEN - description: '' is_valid: true key: HOME_IMPROVEMENT value: HOME_IMPROVEMENT - description: '' is_valid: true key: HOUSEHOLD_PRODUCTS value: HOUSEHOLD_PRODUCTS - description: '' is_valid: true key: LEARNING_AND_DEVELOPMENT value: LEARNING_AND_DEVELOPMENT - description: '' is_valid: true key: LEISURE_AND_RECREATION_FACILITIES value: LEISURE_AND_RECREATION_FACILITIES - description: '' is_valid: true key: LIFE_SERVICES value: LIFE_SERVICES - description: '' is_valid: true key: LIVESTOCK_AND_FARMING value: LIVESTOCK_AND_FARMING - description: '' is_valid: true key: MISCELLANEOUS_PERFORMANCES value: MISCELLANEOUS_PERFORMANCES - description: '' is_valid: true key: MOVIES_AND_TV value: MOVIES_AND_TV - description: '' is_valid: true key: MUSIC value: MUSIC - description: '' is_valid: true key: NEWS_AND_ENTERTAINMENT value: NEWS_AND_ENTERTAINMENT - description: '' is_valid: true key: OTHER_BEAUTY value: OTHER_BEAUTY - description: '' is_valid: true key: OTHER_FASHION value: OTHER_FASHION - description: '' is_valid: true key: OTHER_TRANSPORTATION value: OTHER_TRANSPORTATION - description: '' is_valid: true key: OUTDOOR_RECREATION value: OUTDOOR_RECREATION - description: '' is_valid: true key: OUTFITS value: OUTFITS - description: '' is_valid: true key: PERFORMING_ARTS value: PERFORMING_ARTS - description: '' is_valid: true key: PERSONAL_PHOTOGRAPHY value: PERSONAL_PHOTOGRAPHY - description: '' is_valid: true key: PETS value: PETS - description: '' is_valid: true key: PET_CARE_AND_ACCESSORIES value: PET_CARE_AND_ACCESSORIES - description: '' is_valid: true key: PHOTOGRAPHY value: PHOTOGRAPHY - description: '' is_valid: true key: PRODUCTIVITY_AND_EFFICIENCY value: PRODUCTIVITY_AND_EFFICIENCY - description: '' is_valid: true key: ROMANCE value: ROMANCE - description: '' is_valid: true key: SCIENCE value: SCIENCE - description: '' is_valid: true key: SENSORY_EXPERIENCES value: SENSORY_EXPERIENCES - description: '' is_valid: true key: SHOWS_FESTIVALS_AND_EXHIBITIONS value: SHOWS_FESTIVALS_AND_EXHIBITIONS - description: '' is_valid: true key: SOFTWARE_AND_APPS value: SOFTWARE_AND_APPS - description: '' is_valid: true key: SPECIAL_EFFECTS value: SPECIAL_EFFECTS - description: '' is_valid: true key: SPORTS value: SPORTS - description: '' is_valid: true key: SPORTS_AND_OUTDOOR value: SPORTS_AND_OUTDOOR - description: '' is_valid: true key: SUPERNATURAL_AND_HORROR value: SUPERNATURAL_AND_HORROR - description: '' is_valid: true key: TECHNOLOGY value: TECHNOLOGY - description: '' is_valid: true key: TOYS_COLLECTIBLES_AND_MEMORABILIA value: TOYS_COLLECTIBLES_AND_MEMORABILIA - description: '' is_valid: true key: TRAVEL value: TRAVEL - description: '' is_valid: true key: VEHICLE_AND_TRANSPORTATION value: VEHICLE_AND_TRANSPORTATION - description: '' is_valid: true key: VIDEO_GAMES value: VIDEO_GAMES - description: '' is_valid: true key: WILDLIFE_AND_EXOTIC_PETS value: WILDLIFE_AND_EXOTIC_PETS key_format: string strict: true use_part: false validate_only: false value_format: string x-open-source: $.http.query.category_name x-open-field-id: 3 - description: '' in: query name: date_range required: false schema: default: 7DAY nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1805543099909121 enum_package_name: DiscoveryPeriodType enums: - description: '' is_valid: true key: 120DAY value: l120d - description: '' is_valid: true key: 1DAY value: l1d - description: '' is_valid: true key: 30DAY value: l30d - description: '' is_valid: true key: 7DAY value: l7d key_format: string strict: true use_part: false validate_only: false value_format: string x-open-source: $.http.query.date_range x-open-field-id: 4 - description: '' in: query name: advertiser_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get popular hashtags. [Trending List](https://business-api.tiktok.com/portal/docs?id=1825119032526849) tags: - Creative Management x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: discovery_type required: true source: $.http.query.discovery_type type: number - name: country_code required: true source: $.http.query.country_code type: string - name: category_name required: true source: $.http.query.category_name type: string - name: date_range required: true source: $.http.query.date_range type: string - 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 category_name: $.http.query.category_name country_code: $.http.query.country_code date_range: $.http.query.date_range discovery_type: $.http.query.discovery_type response_cookie: [] response_header: [] response_rule: filter_info: category_name: $.rpc.output.filter_info.category_name country_code: $.rpc.output.filter_info.country_code date_range: $.rpc.output.filter_info.date_range list[][]: - hashtag_id: $.rpc.output.hashtag_list[].hashtag_id hashtag_name: $.rpc.output.hashtag_list[].hashtag_name posts: $.rpc.output.hashtag_list[].posts posts_global_lifetime: $.rpc.output.hashtag_list[].posts_global_lifetime rank_change: $.rpc.output.hashtag_list[].rank_change rank_position: $.rpc.output.hashtag_list[].rank_position top_country_list: $.rpc.output.hashtag_list[].top_country_list trending_history[][]: - date: $.rpc.output.hashtag_list[].trending_history[].date rank_position_daily: $.rpc.output.hashtag_list[].trending_history[].rank_position_daily views_daily: $.rpc.output.hashtag_list[].trending_history[].views_daily views: $.rpc.output.hashtag_list[].views views_global_lifetime: $.rpc.output.hashtag_list[].views_global_lifetime x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /dmp/custom_audience/apply/: post: operationId: Dmp Custom_audience Apply 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: action_mode: description: 'Specific operation to be performed on the audience. Enum values: Apply, Disconnect.' nullable: false 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: Apply value: Apply - description: '' is_valid: true key: Disconnect value: Disconnect key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 4 x-open-source: $.http.body.action_mode adgroup_ids: description: 'A list of ad group IDs. Note: adgroup_ids and custom_audience_id should be under the same advertiser account. Otherwise, an error will occur. Lookalike Audience cannot be used in Reach & Frequency ads. Otherwise, an error will occur. See below for more details. 1. If the custom_audience_id is a Lookalike Audience and the adgroup_ids are Reach & Frequency ad groups, an error will occur. 2. If the custom_audience_id is a Lookalike Audience with the REACH_FREQUENCY audience subtype, an error will occur.' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.adgroup_ids advertiser_id: description: Advertiser ID. nullable: false 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 custom_audience_id: description: Custom audience ID. You can only pass one custom audience ID. nullable: false 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.custom_audience_id usage_mode: description: 'Whether to include this audience in or exclude it from your ad groups. Required when action_mode is Apply. Enum values: Include, Exclude.' nullable: false 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: Include value: Include - description: '' is_valid: true key: Exclude value: Exclude key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 5 x-open-source: $.http.body.usage_mode required: - advertiser_id - custom_audience_id - adgroup_ids - action_mode 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Apply a shared custom audience [Dmp Custom_audience Apply](https://ads.tiktok.com/marketing_api/docs?id=1740245827044354) tags: - Audience 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: custom_audience_id required: true source: $.http.body.custom_audience_id type: number - children: - type: number is_expand: true name: adgroup_ids required: true source: $.http.body.adgroup_ids sub_type: number type: array - name: action_mode required: true source: $.http.body.action_mode type: string - name: usage_mode required: false source: $.http.body.usage_mode type: string - children: - name: core_user_id required: false source: $.context.core_user_id type: number is_expand: true name: context_info required: false type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: action_mode: $.http.body.action_mode adgroup_ids: $.http.body.adgroup_ids advertiser_id: $.http.body.advertiser_id context_info: core_user_id: $.context.core_user_id custom_audience_id: $.http.body.custom_audience_id usage_mode: $.http.body.usage_mode response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /dmp/custom_audience/apply/log/: get: operationId: Dmp Custom_audience Apply Log parameters: - description: Advertiser ID. in: query name: advertiser_id required: true schema: nullable: false 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: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.custom_audience_ids description: A list of custom audience IDs. Note The advertiser must be the owner of the custom_audience_ids. Otherwise, an error will occur. You can use the is_creator field returned in /dmp/custom_audience/list/ and /dmp/custom_audience/get/ to check whether this advertiser is the owner of this audience. in: query name: custom_audience_ids required: true x-open-field-id: 2 - description: 'Current page number. Default value: 1.' in: query name: page required: false schema: default: 1 format: int32 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.page x-open-field-id: 3 - description: 'Page size. Default value: 10.' in: query name: page_size required: false schema: default: 10 format: int32 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.page_size x-open-field-id: 4 - description: The timezone of returned value. For enum values, see Appendix - Time Zone. If not specified, UTC will be used. in: query name: timezone required: false schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.timezone 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get the latest application log of custom audiences [Dmp Custom_audience Apply Log](https://ads.tiktok.com/marketing_api/docs?id=1758615737388033) tags: - Audience x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - children: - type: number is_expand: true name: custom_audience_ids required: true source: $.http.query.custom_audience_ids sub_type: number type: array - name: page required: false source: $.http.query.page type: number - name: page_size required: false source: $.http.query.page_size type: number - name: timezone required: false source: $.http.query.timezone type: string - children: - name: app_id required: false source: $.context.app_id type: number - name: core_user_id required: false source: $.context.core_user_id type: number - name: developer_id required: false source: $.context.developer_id type: number - name: x_forwarded_for required: false source: $.context.is_same_identity type: string - name: x_real_ip required: false source: $.context.source_ip type: string is_expand: true name: context_info required: false type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id context_info: app_id: $.context.app_id core_user_id: $.context.core_user_id developer_id: $.context.developer_id x_forwarded_for: $.context.is_same_identity x_real_ip: $.context.source_ip custom_audience_ids: $.http.query.custom_audience_ids page: $.http.query.page page_size: $.http.query.page_size timezone: $.http.query.timezone response_cookie: [] response_header: [] response_rule: advertiser_id: $.rpc.output.advertiser_id list[][]: - action_timestamp: $.rpc.output.data[].action_timestamp adgroup_id: $.rpc.output.data[].adgroup_id adgroup_name: $.rpc.output.data[].adgroup_name audience_id: $.rpc.output.data[].audience_id editor: $.rpc.output.data[].editor usage_mode: $.rpc.output.data[].usage_mode page_info: $.rpc.output.page_info x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /dmp/custom_audience/create/: post: operationId: Dmp Custom_audience 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: Advertiser ID. nullable: false 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 audience_enhancement: default: 'False' description: '' nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 x-open-source: $.http.body.audience_enhancement audience_sub_type: default: NORMAL description: 'Audience sub type, indicating the type of ads that the audience can be used. Enum values: NORMAL Normal audience. It can be used in non-R&F ads. REACH_FREQUENCY: Audience for Reach & Frequency. It can only be used in R&F ads. Default: NORMAL.' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804315821131778 enum_package_name: AudienceSubType enums: - description: '' is_valid: true key: NORMAL value: '0' - description: '' is_valid: true key: REACH_FREQUENCY value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 5 x-open-source: $.http.body.audience_sub_type calculate_type: description: Encryption type. calculate_type should be the same as all the files in the file_path, or you will not get a audience id or get an invalid audience id. For enum values, see Enumeration - Encryption Type. nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804315795490817 enum_package_name: CalculateType enums: - description: '' is_valid: true key: EMAIL_SHA256 value: '8' - description: '' is_valid: true key: FIRST_MD5 value: '7' - description: '' is_valid: true key: FIRST_SHA256 value: '6' - description: '' is_valid: true key: GAID_MD5 value: '13' - description: '' is_valid: true key: GAID_SHA256 value: '16' - description: '' is_valid: true key: IDFA_MD5 value: '12' - description: '' is_valid: true key: IDFA_SHA256 value: '15' - description: '' is_valid: true key: MULTIPLE_TYPES value: '100' - description: '' is_valid: true key: PHONE_SHA256 value: '9' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 3 x-open-source: $.http.body.calculate_type custom_audience_name: description: Audience name. Maximum of 128 characters. maxLength: 128 minLength: 1 nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.custom_audience_name file_paths: description: List of file paths. The recommended size is <50 to ensure a stable request. You can use /dmp/custom_audience/update/ to append more data files to the audience. You get the file_path in response after you upload your file calling Upload audience files endpoint. items: default: '' maxLength: 16 minLength: 16 nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 500 minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.file_paths retention_in_days: description: 'Number of days to retain the audience. Value range: [1, 365]. Note: If this field is passed, the expiration date will be the specified number of retention days from the date when the audience was created. Any operations to the audience CANNOT reset the expiration date. If this field is not passed, the expiration date will be 365 days from the last time the audience was applied to an active ad group or modified. Applying the audience to an active ad group or modifying the audience will reset the expiration date. To learn about the actions that will reset the expiration date, refer to the Help Center article Audience Expiration Policy.' format: int32 maximum: 365 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 6 x-open-source: $.http.body.retention_in_days required: - advertiser_id - custom_audience_name - calculate_type - file_paths 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Create an audience by file [Dmp Custom_audience Create](https://ads.tiktok.com/marketing_api/docs?id=1739940570793985) tags: - Audience 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: custom_audience_name required: true source: $.http.body.custom_audience_name type: string - name: calculate_type required: true source: $.http.body.calculate_type type: number - children: - type: string is_expand: true name: file_paths required: true source: $.http.body.file_paths[] sub_type: string type: array - name: audience_sub_type required: false source: $.http.body.audience_sub_type type: number - name: retention_in_days required: false source: $.http.body.retention_in_days type: number - name: audience_enhancement required: false source: $.http.body.audience_enhancement type: boolean plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id audience_enhancement: $.http.body.audience_enhancement audience_sub_type: $.http.body.audience_sub_type calculate_type: $.http.body.calculate_type custom_audience_name: $.http.body.custom_audience_name file_paths: $.http.body.file_paths[] retention_in_days: $.http.body.retention_in_days response_cookie: [] response_header: [] response_rule: custom_audience_id: $.rpc.output.custom_audience_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /dmp/custom_audience/delete/: post: operationId: Dmp Custom_audience 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: Advertiser ID. nullable: false 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 custom_audience_ids: description: A list of Audience IDs. Length range is [1, 100]. items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) maxItems: 100 minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.custom_audience_ids required: - advertiser_id - custom_audience_ids type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Delete audiences [Dmp Custom_audience Delete](https://business-api.tiktok.com/portal/docs?id=1739940539757569) tags: - Audience x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.body.advertiser_id type: number - children: - type: number is_expand: true name: custom_audience_ids required: true source: $.http.body.custom_audience_ids[] sub_type: number type: array plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id custom_audience_ids: $.http.body.custom_audience_ids[] response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /dmp/custom_audience/file/upload/: post: operationId: Dmp Custom_audience File Upload 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: multipart/form-data: schema: properties: advertiser_id: description: Advertiser ID. nullable: false 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 calculate_type: description: Encryption type. The value for this field must be consistent with the actual file data. Otherwise, your upload will fail or you will not be able to create a valid audience. For enum values, see Enumeration - Encryption Type. nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1812020346560514 enum_package_name: DmpCalculateType enums: - description: '' is_valid: true key: EMAIL_SHA256 value: '8' - description: '' is_valid: true key: FIRST_MD5 value: '7' - description: '' is_valid: true key: FIRST_SHA256 value: '6' - description: '' is_valid: true key: GAID_MD5 value: '13' - description: '' is_valid: true key: GAID_SHA256 value: '16' - description: '' is_valid: true key: IDFA_MD5 value: '12' - description: '' is_valid: true key: IDFA_SHA256 value: '15' - description: '' is_valid: true key: MAID_MD5 value: '7' - description: '' is_valid: true key: MAID_SHA256 value: '6' - description: '' is_valid: true key: MULTIPLE_TYPES value: '100' - description: '' is_valid: true key: PHONE_SHA256 value: '9' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 4 x-open-source: $.http.body.calculate_type file: description: Data files. Only supports CSV and TXT files. The file suffixes should exactly be .csv or .txt. format: binary nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.file file_signature: description: The file's MD5, which is used for server-side verification. nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.file_signature name: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 required: - advertiser_id - file - file_signature - calculate_type type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Upload a data file [Dmp Custom_audience File Upload](https://business-api.tiktok.com/portal/docs?id=1739940567842818) tags: - Audience 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: file required: true source: $.http.body.file type: string - name: file_signature required: true source: $.http.body.file_signature type: string - name: calculate_type required: true source: $.http.body.calculate_type type: number - children: - name: app_id required: false source: $.context.app_id type: number - name: core_user_id required: false source: $.context.core_user_id type: number - name: developer_id required: false source: $.context.developer_id type: number is_expand: true name: context_info required: false type: object - name: name required: false source: $.http.body.name type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id calculate_type: $.http.body.calculate_type context_info: app_id: $.context.app_id core_user_id: $.context.core_user_id developer_id: $.context.developer_id file: $.http.body.file file_signature: $.http.body.file_signature name: $.http.body.name response_cookie: [] response_header: [] response_rule: file_path: $.rpc.output.file_path x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /dmp/custom_audience/get/: get: operationId: Dmp Custom_audience Get parameters: - description: Advertiser ID. in: query name: advertiser_id required: true schema: nullable: false 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: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) maxItems: 100 minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.custom_audience_ids description: A list of Audience IDs. Length range is [1, 100] . in: query name: custom_audience_ids required: true x-open-field-id: 2 - description: The size of the history data which the user requests. in: query name: history_size required: false schema: default: 100 format: int32 maximum: 100 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.history_size 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Obtain the details of specified audiences [Dmp Custom_audience Get](https://business-api.tiktok.com/portal/docs?id=1739940507792385) tags: - Audience x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - children: - type: number is_expand: true name: custom_audience_ids required: true source: $.http.query.custom_audience_ids[] sub_type: number type: array - name: history_size required: false source: $.http.query.history_size type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id custom_audience_ids: $.http.query.custom_audience_ids[] history_size: $.http.query.history_size response_cookie: [] response_header: [] response_rule: list[][]: - audience_details[]: - audience_enhancement: $.rpc.output.data[].audience_details.audience_enhancement audience_id: $.rpc.output.data[].audience_details.audience_id audience_sub_type: $.rpc.output.data[].audience_details.audience_sub_type calculate_type: $.rpc.output.data[].audience_details.calculate_type cover_num: $.rpc.output.data[].audience_details.cover_num create_time: $.rpc.output.data[].audience_details.create_time enhancement_status: $.rpc.output.data[].audience_details.enhancement_status error_msg: $.rpc.output.data[].audience_details.err_msg expired_time: $.rpc.output.data[].audience_details.expired_time is_auto_refresh: $.rpc.output.data[].audience_details.is_auto_refresh is_creator: $.rpc.output.data[].audience_details.is_creator is_expiring: $.rpc.output.data[].audience_details.is_expiring is_valid: $.rpc.output.data[].audience_details.is_valid lookalike_spec[]: - audience_size: $.rpc.output.data[].audience_details.lookalike_spec.lookalike_num include_source: $.rpc.output.data[].audience_details.lookalike_spec.is_contain_seed location_ids: $.rpc.output.data[].audience_details.lookalike_spec.country_ids mobile_os: $.rpc.output.data[].audience_details.lookalike_spec.platform placements: $.rpc.output.data[].audience_details.lookalike_spec.app_names source_audience_id: $.rpc.output.data[].audience_details.lookalike_spec.seed_id msg: $.rpc.output.data[].audience_details.msg name: $.rpc.output.data[].audience_details.name owner_id: $.rpc.output.data[].audience_details.owner_id rule: $.rpc.output.data[].audience_details.rule shared: $.rpc.output.data[].audience_details.shared type: $.rpc.output.data[].audience_details.type audience_history[][]: - action: $.rpc.output.data[].audience_history[].action action_detail: $.rpc.output.data[].audience_history[].action_detail editor: $.rpc.output.data[].audience_history[].editor msg: $.rpc.output.data[].audience_history[].msg opt_time: $.rpc.output.data[].audience_history[].opt_time x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /dmp/custom_audience/list/: get: operationId: Dmp Custom_audience List parameters: - description: Advertiser ID. in: query name: advertiser_id required: true schema: nullable: false 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: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) maxItems: 100 minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.custom_audience_ids description: A list of Audience IDs. Length range is [1, 100]. in: query name: custom_audience_ids required: false x-open-field-id: 2 - description: 'Current page number. Default value: 1. Value range: ≥ 1.' in: query name: page required: false schema: default: 1 format: int32 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.page x-open-field-id: 3 - description: 'Page size. Defaults is 10. Value range: 1-100.' in: query name: page_size required: false schema: default: 10 format: int32 maximum: 100 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.page_size 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get all audiences [Dmp Custom_audience List](https://business-api.tiktok.com/portal/docs?id=1739940506015746) tags: - Audience x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - children: - type: number is_expand: true name: custom_audience_ids required: false source: $.http.query.custom_audience_ids[] sub_type: number type: array - name: page required: false source: $.http.query.page type: number - name: page_size required: false source: $.http.query.page_size type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id custom_audience_ids: $.http.query.custom_audience_ids[] page: $.http.query.page page_size: $.http.query.page_size response_cookie: [] response_header: [] response_rule: list: $.rpc.output.data page_info: $.rpc.output.page_info x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /dmp/custom_audience/lookalike/create/: post: operationId: Dmp Custom_audience Lookalike 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: Advertiser ID. nullable: false 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 custom_audience_name: description: Audience name. Maximum of 128 characters. nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.custom_audience_name lookalike_spec: description: '' nullable: false properties: audience_size: description: 'Size of lookalike audience. Enum values: NARROW, BALANCED and BROAD.' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1808692160894978 enum_package_name: DmpLookalikeAudienceSizeType enums: - description: '' is_valid: true key: BALANCED value: '20' - description: '' is_valid: true key: BROAD value: '30' - description: '' is_valid: true key: NARROW value: '10' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 6 x-open-source: $.http.body.lookalike_spec.lookalike_num include_source: description: Whether to include the source audience in the new lookalike audience. nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.lookalike_spec.is_contain_seed location_ids: description: IDs of the locations that you want to target. For enum values, see Enumeration-Lookalike Locations. items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.body.lookalike_spec.country_ids mobile_os: description: Device operating systems. Enum values support ALL for both ANDROID and IOS. See Enumeration-Audience Management-Lookalike System for details. nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1828094114965570 enum_package_name: DmpLookalikePlatform enums: - description: '' is_valid: true key: ALL value: ALL - description: '' is_valid: true key: ANDROID value: ANDROID - description: '' is_valid: true key: IOS value: IOS key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 3 x-open-source: $.http.body.lookalike_spec.platform placements: description: 'The apps where you want to deliver your ads. Enum values: TikTok, TopBuzz & BuzzVideo, Pangle. See Enumeration - Audience Management-Lookalike Placement for details.' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.lookalike_spec.app_names source_audience_id: description: 'Source (seed) audience ID. Source audience cannot be an existing lookalike audience. Note: The size of source audience should be no less than 100.' nullable: false 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.lookalike_spec.seed_id required: - source_audience_id - include_source - mobile_os - placements - location_ids - audience_size type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.lookalike_spec required: - advertiser_id - custom_audience_name - lookalike_spec 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Create a lookalike audience [Dmp Custom_audience Lookalike Create](https://business-api.tiktok.com/portal/docs?id=1739940511844353) tags: - Audience 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: custom_audience_name required: true source: $.http.body.custom_audience_name type: string - children: - name: seed_id required: false source: $.http.body.lookalike_spec.source_audience_id type: number - name: is_contain_seed required: false source: $.http.body.lookalike_spec.include_source type: boolean - name: platform required: false source: $.http.body.lookalike_spec.mobile_os type: string - children: - type: string is_expand: true name: app_names required: false source: $.http.body.lookalike_spec.placements[] sub_type: string type: array - children: - type: string is_expand: true name: country_ids required: false source: $.http.body.lookalike_spec.location_ids[] sub_type: string type: array - name: lookalike_num required: false source: $.http.body.lookalike_spec.audience_size type: number is_expand: true name: lookalike_spec required: true type: object - children: - name: app_id required: false source: $.context.app_id type: number - name: core_user_id required: false source: $.context.core_user_id type: number - name: developer_id required: false source: $.context.developer_id type: number is_expand: true name: context_info required: false type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id context_info: app_id: $.context.app_id core_user_id: $.context.core_user_id developer_id: $.context.developer_id custom_audience_name: $.http.body.custom_audience_name lookalike_spec: app_names: $.http.body.lookalike_spec.placements[] country_ids: $.http.body.lookalike_spec.location_ids[] is_contain_seed: $.http.body.lookalike_spec.include_source lookalike_num: $.http.body.lookalike_spec.audience_size platform: $.http.body.lookalike_spec.mobile_os seed_id: $.http.body.lookalike_spec.source_audience_id response_cookie: [] response_header: [] response_rule: custom_audience_id: $.rpc.output.custom_audience_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /dmp/custom_audience/lookalike/update/: post: operationId: Dmp Custom_audience Lookalike 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: Advertiser ID. nullable: false 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 custom_audience_ids: description: A list of custom audience IDs. items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.custom_audience_ids required: - advertiser_id - custom_audience_ids type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Manually refresh a Lookalike Audience [Dmp Custom_audience Lookalike Update](https://ads.tiktok.com/marketing_api/docs?id=1758616888158209) tags: - Audience x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.body.advertiser_id type: number - children: - type: number is_expand: true name: custom_audience_ids required: true source: $.http.body.custom_audience_ids sub_type: number type: array - children: - name: core_user_id required: false source: $.context.core_user_id type: number is_expand: true name: context_info required: false type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id context_info: core_user_id: $.context.core_user_id custom_audience_ids: $.http.body.custom_audience_ids response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /dmp/custom_audience/rule/create/: post: operationId: Dmp Custom_audience Rule 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: Advertiser ID. nullable: false 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 audience_enhancement: default: false description: '' nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 11 audience_sub_type: description: 'Audience sub type, indicating the type of ads that the audience can be used. Enum values: NORMAL: Audience for non-Reach & Frequency ads. REACH_FREQUENCY: Audience for Reach & Frequency ads. It can only be used in Reach & Frequency ads. Default value: NORMAL.' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804315821131778 enum_package_name: AudienceSubType enums: - description: '' is_valid: true key: NORMAL value: '0' - description: '' is_valid: true key: REACH_FREQUENCY value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 4 x-open-source: $.http.body.audience_sub_type audience_type: description: 'Audience type. Enum values: ENGAGEMENT: Engagement Audience (with asset type as ad groups). ENGAGEMENT_ORGANIC_VIDEO: Organic Engagement Audience (with asset type as public video). ENGAGEMENT_LIVE_VIDEO: Live Engagement Audience (with asset type as live video). APP: App Activity Audience. PIXEL: Website Traffic Audience. LEAD_GENERATION: Lead Generation Audience. BUSINESS_ACCOUNT: Business Account Audience. TIKTOK_SHOP: Shop Activity Audience. OFFLINE: Offline Activity Audience.' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1805510940313602 enum_package_name: SecondPartyAudienceType enums: - description: '' is_valid: true key: APP value: '3' - description: '' is_valid: true key: BUSINESS_ACCOUNT value: '16' - description: '' is_valid: true key: ENGAGEMENT value: '2' - description: '' is_valid: true key: ENGAGEMENT_LIVE_VIDEO value: '200' - description: '' is_valid: true key: ENGAGEMENT_ORGANIC_VIDEO value: '100' - description: '' is_valid: true key: LEAD_GENERATION value: '15' - description: '' is_valid: true key: OFFLINE value: '25' - description: '' is_valid: true key: PIXEL value: '4' - description: '' is_valid: true key: TIKTOK_SHOP value: '21' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 3 x-open-source: $.http.body.audience_type custom_audience_name: description: 'Audience name. Length limit: 128 characters.' maxLength: 128 nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.custom_audience_name identity_authorized_bc_id: description: Required when identity_type is BC_AUTH_TT. ID of the Business Center that a TikTok Account User in Business Center identity is associated with. nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 9 x-open-source: $.http.body.identity_authorized_bc_id identity_id: description: Required when audience_type is ENGAGEMENT_LIVE_VIDEO or ENGAGEMENT_ORGANIC_VIDEO. Identity ID. nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 x-open-source: $.http.body.identity_id identity_type: description: 'Required when audience_type is ENGAGEMENT_LIVE_VIDEO or ENGAGEMENT_ORGANIC_VIDEO. Identity type. Enum values: TT_USER, BC_AUTH_TT' nullable: false 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: true key: BC_SELF_TT value: '4' - description: '' is_valid: true key: CUSTOMIZED_USER value: '1' - description: '' is_valid: true key: TT_USER value: '3' - description: '' is_valid: true key: UNSET value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 8 x-open-source: $.http.body.identity_type is_auto_refresh: description: 'Whether to turn on the audience auto-refresh function. Supported values: true, false. Default value: true. If you enable this feature, your audience will automatically refresh to include the latest user data according to the lookback window you set. If you disable this feature, your audience will not automatically refresh.' nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.body.is_auto_refresh retention_in_days: description: 'Number of days to retain the audience. Value range: 1-365. Note: If this field is passed, the expiration date will be the specified number of retention days from the date when the audience was created. Any operations to the audience CANNOT reset the expiration date. If this field is not passed, the expiration date will be 365 days from the last time the audience was applied to an active ad group or modified. Applying the audience to an active ad group or modifying the audience will reset the expiration date. To learn about the actions that will reset the expiration date, refer to the Help Center article Audience Expiration Policy.' format: int32 maximum: 365 minimum: 1 nullable: false type: integer 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.retention_in_days rule_spec: description: Rule of the audience. nullable: false properties: exclusion_rule_set: description: '' nullable: false properties: operator: description: 'Required when exclusion_rule_set is passed. Operator between the exclusion rules within the exclusion rule set. Enum value: OR.' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1805510775614465 enum_package_name: RuleSetOperatorType enums: - description: '' is_valid: true key: OR value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 1 x-open-source: $.http.body.rule_spec.exclusion_rule_set.operator rules: description: Required when exclusion_rule_set is passed. A list of exclusion rules within the exclusion rule set. items: nullable: false properties: event_source_ids: description: List of event source IDs of the rule. For an Engagement Audience, use ad group IDs as event source IDs. If not specified, all available event source IDs will be used. For an Organic Engagement Audience, use TikTok post IDs as event source IDs. You can use /identity/video/get/ to get TikTok post IDs. The maximum allowed number of TikTok post IDs is 10. For a Live Engagement Audience, use live video ID as event source IDs. You can use /identity/live/get/ to get live video IDs. The maximum allowed number of live video IDs is 10. For an App Activity Audience, use App IDs as event source IDs. For a Website Traffic Audience, use pixel IDs as event source IDs. For a Lead Generation Audience, do not pass in this field. Otherwise, an error will occur. If not specified, all available event source IDs will be used. For a Business Account Audience, use core user IDs of the advertisers. You can use /user/info/ to get a core user ID. For a Shop Activity Audience, use TikTok Shop IDs as event source IDs. You can use /store/list/ to get TikTok Shop IDs. For an Offline Activity Audience, use Offline Event set IDs as event source IDs. You can use /offline/get/ to get Offline Event set IDs. items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.rule_spec.exclusion_rule_set.rules[].event_source_ids filter_set: description: Required when exclusion_rule_set is passed. The set of filters for the exclusion rule. nullable: false properties: filters: description: 'Required when exclusion_rule_set is passed. An array of filters on previous audience actions and optionally also on URL keywords or parameters. Max size: 1.' items: nullable: false properties: field: description: 'Required when exclusion_rule_set is passed. Filter field. Enum value: EVENT: To exclude the people who''ve carried out a certain action in the past few days as indicated by retention_days.' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.rule_spec.exclusion_rule_set.rules[].filter_set.filters[].field operator: description: 'Required when exclusion_rule_set is passed. Filter operator between filter field and filter value. Enum value: EQ: equals.' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1805510758672386 enum_package_name: FilterFieldOperatorType enums: - description: '' is_valid: true key: EQ value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 2 x-open-source: $.http.body.rule_spec.exclusion_rule_set.rules[].filter_set.filters[].operator parameter_filters: description: 'List of filters on URL keywords or parameters. Within parameter_filters, you can add a maximum of one URL keyword filter (with field set to URL) and 10 parameter filters (with field not set to URL) . If specified, these filters (parameter_filters) are combined with the action filter (as specified by field, operator and value) using default AND logic to form the exclusion rule. For example, if retention_days is 30 and filter_set is set to {"operator": "OR", "filters":[{"field":"EVENT","operator":"EQ", "value":"PIXEL COMPLETE PAYMENT"},"parameter_filters":[{"field":"URL","operator":"CONTAINS","value":"us"}]]}, the exclusion rule will create an audience that excludes people who carried out the "Complete Payment" action on a webpage with "us" included in the page URL within the past 30 days on the website where the Pixel is installed.' items: nullable: false properties: field: description: 'Required when parameter_filters within exclusion_rule_set is passed. Filter condition. Use this field to specify whether to filter URL keywords, or Web Event parameters reported via the Pixel. Enum value: URL: URL keywords. CONTENT_TYPE: the parameter content_type. PRICE: the parameter price. VALUE: the parameter value. CONTENT_ID: the parameter content_id. CONTENT_CATEGORY: the parameter content_category.' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.rule_spec.exclusion_rule_set.rules[].filter_set.filters[].parameter_filters[].field operator: description: 'Required when parameter_filters within exclusion_rule_set is passed. Filter operator between filter condition and filter value. Enum value: CONTAINS: contains. DOES_NOT_CONTAIN: doesn''t contain. EQ: equals. IS_LESS_THAN: is less than. IS_GREATER_THAN: is greater than. IS_LESS_THAN_OR_EQUAL_TO: is less than or equal to. IS_GRETER_THAN_OR_EQUAL_TO: is greater than or equal to. The allowed values vary based on the field value: If field is set to URL, operator can only be set to CONTAINS, DOES_NOT_CONTAIN, or EQ. If field is not set to URL, operator can be set to CONTAINS, DOES_NOT_CONTAINS, EQ, IS_LESS_THAN, IS_GREATER_THAN, IS_LESS_THAN_OR_EQUAL_TO, or IS_GREATER_THAN_OR_EQUAL_TO.' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1813841099262977 enum_package_name: ParameterFilterOperatorType enums: - description: '' is_valid: true key: CONTAINS value: '3' - description: '' is_valid: true key: DOES_NOT_CONTAIN value: '4' - description: '' is_valid: true key: EQ value: '1' - description: '' is_valid: true key: IS_GREATER_THAN value: '5' - description: '' is_valid: true key: IS_GREATER_THAN_OR_EQUAL_TO value: '6' - description: '' is_valid: true key: IS_LESS_THAN value: '7' - description: '' is_valid: true key: IS_LESS_THAN_OR_EQUAL_TO value: '8' - description: '' is_valid: true key: NOT_EQUAL value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 2 x-open-source: $.http.body.rule_spec.exclusion_rule_set.rules[].filter_set.filters[].parameter_filters[].operator values: description: 'Required when parameter_filters within exclusion_rule_set is passed. A list of filter values. Max size: 10. Length limit for each value: 100 characters. If you specify multiple values, the values will be combined using OR logic.' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.rule_spec.exclusion_rule_set.rules[].filter_set.filters[].parameter_filters[].values required: - field - operator - values type: object x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.rule_spec.exclusion_rule_set.rules[].filter_set.filters[].parameter_filters value: description: Required when exclusion_rule_set is passed. Filter value. For enum values, see Enumeration - Filter Value. nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.rule_spec.exclusion_rule_set.rules[].filter_set.filters[].value required: - field - operator - value type: object x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.rule_spec.exclusion_rule_set.rules[].filter_set.filters operator: description: 'Required when exclusion_rule_set is passed. Operator between filters in the filters object array. Enum value: OR. Within each exclusion rule, you can only specify one object in filters.' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1805510742984706 enum_package_name: FilterSetOperatorType enums: - description: '' is_valid: true key: AND value: '1' - description: '' is_valid: true key: OR value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 2 x-open-source: $.http.body.rule_spec.exclusion_rule_set.rules[].filter_set.operator required: - filters - operator type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.rule_spec.exclusion_rule_set.rules[].filter_set retention_days: description: 'Required when exclusion_rule_set is passed. Audience lookback window. For enum values, see Enumerations - Lookback window. Note: If audience_type = BUSINESS_ACCOUNT, and the value in the filters object is not BUSINESS ACCOUNT PROFILE FOLLOW, then retention_days must be 7, 14, or 30. If audience_type = ENGAGEMENT_LIVE_VIDEO or ENGAGEMENT_ORGANIC_VIDEO, then retention_days must be 7, 14, or 30. To avoid confusion between retention_days and retention_in_days, we''ll rename retention_days in the next API version.' format: int32 nullable: false type: integer 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.rule_spec.exclusion_rule_set.rules[].retention_days required: - retention_days type: object x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.rule_spec.exclusion_rule_set.rules required: - operator - rules type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.rule_spec.exclusion_rule_set inclusion_rule_set: description: Details of the inclusion rule set. nullable: false properties: operator: description: 'Operator between the inclusion rules within the inclusion rule set. Enum value: OR. If you provide more than one inclusion rule, the inclusion rules will be combined using OR logic to broaden the audience.' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1805510775614465 enum_package_name: RuleSetOperatorType enums: - description: '' is_valid: true key: OR value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 1 x-open-source: $.http.body.rule_spec.inclusion_rule_set.operator rules: description: A list of inclusion rules within the inclusion rule set. items: nullable: false properties: event_source_ids: description: Required when audience_type is not ENGAGEMENT or LEAD_GENERATION. List of event source IDs of the rule. For an Engagement Audience, use ad group IDs as event source IDs. If not specified, all available event source IDs will be used. For an Organic Engagement Audience, use TikTok post IDs as event source IDs. You can use /identity/video/get/ to get TikTok post IDs. The maximum allowed number of TikTok post IDs is 10. For a Live Engagement Audience, use live video ID as event source IDs. You can use /identity/live/get/ to get live video IDs. The maximum allowed number of live video IDs is 10. For an App Activity Audience, use App IDs as event source IDs. For a Website Traffic Audience, use pixel IDs as event source IDs. For a Lead Generation Audience, do not pass in this field. Otherwise, an error will occur. If not specified, all available event source IDs will be used. For a Business Account Audience, use core user IDs of the advertisers. You can use /user/info/ to get a core user ID. For a Shop Activity Audience, use TikTok Shop IDs as event source IDs. You can use /store/list/ to get TikTok Shop IDs. For an Offline Activity Audience, use Offline Event set IDs as event source IDs. You can use /offline/get/ to get Offline Event set IDs. items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.rule_spec.inclusion_rule_set.rules[].event_source_ids filter_set: description: The set of filters for each inclusion rule. nullable: false properties: filters: description: 'An array of filters on previous audience actions and optionally also on URL keywords or parameters. Max size: 1.' items: nullable: false properties: field: description: 'Filter field. Enum value: EVENT: To include the people who''ve carried out a certain action in the past few days as indicated by retention_days.' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.rule_spec.inclusion_rule_set.rules[].filter_set.filters[].field operator: description: 'Filter operator between filter field and filter value. Enum value: EQ: equals.' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1805510758672386 enum_package_name: FilterFieldOperatorType enums: - description: '' is_valid: true key: EQ value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 2 x-open-source: $.http.body.rule_spec.inclusion_rule_set.rules[].filter_set.filters[].operator parameter_filters: description: 'List of filters on URL keywords or parameters. Within parameter_filters, you can add a maximum of one URL keyword filter (with field set to URL) and 10 parameter filters (with field not set to URL) . If specified, these filters (parameter_filters) are combined with the action filter (as specified by field, operator and value) using default AND logic to form the inclusion rule. For example, if retention_days is 30 and filter_set is set to {"operator": "OR", "filters":[{"field":"EVENT","operator":"EQ", "value":"PIXEL COMPLETE PAYMENT"},"parameter_filters":[{"field":"URL","operator":"CONTAINS","value":"us"}]]}, the inclusion rule will create an audience that includes people who carried out the "Complete Payment" action on a webpage with "us" included in the page URL within the past 30 days on the website where the Pixel is installed.' items: nullable: false properties: field: description: 'Required when parameter_filters within inclusion_rule_set is passed. Filter condition. Use this field to specify whether to filter URL keywords, or Web Event parameters reported via the Pixel. Enum value: URL: URL keywords. CONTENT_TYPE: the parameter content_type. PRICE: the parameter price. VALUE: the parameter value. CONTENT_ID: the parameter content_id. CONTENT_CATEGORY: the parameter content_category.' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.rule_spec.inclusion_rule_set.rules[].filter_set.filters[].parameter_filters[].field x-open-validate: - error_msg: '' expr: '%s in ["URL", "CONTENT_TYPE", "PRICE", "VALUE", "CONTENT_ID", "CONTENT_CATEGORY"]' operator: description: 'Required when parameter_filters within inclusion_rule_set is passed. Filter operator between filter condition and filter value. Enum value: CONTAINS: contains. DOES_NOT_CONTAIN: doesn''t contain. EQ: equals. IS_LESS_THAN: is less than. IS_GREATER_THAN: is greater than. IS_LESS_THAN_OR_EQUAL_TO: is less than or equal to. IS_GRETER_THAN_OR_EQUAL_TO: is greater than or equal to. The allowed values vary based on the field value: If field is set to URL, operator can only be set to CONTAINS, DOES_NOT_CONTAIN, or EQ. If field is not set to URL, operator can be set to CONTAINS, DOES_NOT_CONTAINS, EQ, IS_LESS_THAN, IS_GREATER_THAN, IS_LESS_THAN_OR_EQUAL_TO, or IS_GREATER_THAN_OR_EQUAL_TO.' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1813841099262977 enum_package_name: ParameterFilterOperatorType enums: - description: '' is_valid: true key: CONTAINS value: '3' - description: '' is_valid: true key: DOES_NOT_CONTAIN value: '4' - description: '' is_valid: true key: EQ value: '1' - description: '' is_valid: true key: IS_GREATER_THAN value: '5' - description: '' is_valid: true key: IS_GREATER_THAN_OR_EQUAL_TO value: '6' - description: '' is_valid: true key: IS_LESS_THAN value: '7' - description: '' is_valid: true key: IS_LESS_THAN_OR_EQUAL_TO value: '8' - description: '' is_valid: true key: NOT_EQUAL value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 2 x-open-source: $.http.body.rule_spec.inclusion_rule_set.rules[].filter_set.filters[].parameter_filters[].operator values: description: 'Required when parameter_filters within inclusion_rule_set is passed. A list of filter values. Max size: 10. Length limit for each value: 100 characters. If you specify multiple values, the values will be combined using OR logic.' items: maxLength: 100 nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 10 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.rule_spec.inclusion_rule_set.rules[].filter_set.filters[].parameter_filters[].values required: - field - operator - values type: object x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.rule_spec.inclusion_rule_set.rules[].filter_set.filters[].parameter_filters value: description: Filter value. For enum values, see Enumeration - Filter Value. nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.rule_spec.inclusion_rule_set.rules[].filter_set.filters[].value required: - field - operator - value type: object x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.rule_spec.inclusion_rule_set.rules[].filter_set.filters operator: description: 'Operator between filters in the filters object array. Enum value: OR. Within each inclusion rule, you can only specify one object in filters.' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1805510742984706 enum_package_name: FilterSetOperatorType enums: - description: '' is_valid: true key: AND value: '1' - description: '' is_valid: true key: OR value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 2 x-open-source: $.http.body.rule_spec.inclusion_rule_set.rules[].filter_set.operator required: - filters - operator type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.rule_spec.inclusion_rule_set.rules[].filter_set retention_days: description: 'Audience lookback window. For enum values, see Enumerations - Lookback window. Note: If audience_type = BUSINESS_ACCOUNT, and the value in the filters object is not BUSINESS ACCOUNT PROFILE FOLLOW, then retention_days must be 7, 14, or 30. If audience_type = ENGAGEMENT_LIVE_VIDEO or ENGAGEMENT_ORGANIC_VIDEO, then retention_days must be 7, 14, or 30. To avoid confusion between retention_days and retention_in_days, we''ll rename retention_days in the next API version.' format: int32 nullable: false type: integer 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.rule_spec.inclusion_rule_set.rules[].retention_days required: - retention_days type: object x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.rule_spec.inclusion_rule_set.rules required: - operator - rules type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.rule_spec.inclusion_rule_set required: - inclusion_rule_set type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 10 x-open-source: $.http.body.rule_spec required: - advertiser_id - custom_audience_name - audience_type - rule_spec 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Create an audience by rules [Dmp Custom_audience Rule Create](https://business-api.tiktok.com/portal/docs?id=1739940509849601) tags: - Audience 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: custom_audience_name required: true source: $.http.body.custom_audience_name type: string - name: audience_type required: true source: $.http.body.audience_type type: number - name: audience_sub_type required: false source: $.http.body.audience_sub_type type: number - name: retention_in_days required: false source: $.http.body.retention_in_days type: number - name: is_auto_refresh required: false source: $.http.body.is_auto_refresh type: boolean - name: identity_id required: false source: $.http.body.identity_id type: string - name: identity_type required: false source: $.http.body.identity_type type: number - name: identity_authorized_bc_id required: false source: $.http.body.identity_authorized_bc_id type: number - children: - children: - name: operator required: true source: $.http.body.rule_spec.inclusion_rule_set.operator type: number - children: - children: - name: retention_days required: true source: $.http.body.rule_spec.inclusion_rule_set.rules[].retention_days type: number - children: - type: string is_expand: true name: event_source_ids required: false source: $.http.body.rule_spec.inclusion_rule_set.rules[].event_source_ids sub_type: string type: array - children: - children: - children: - name: field required: true source: $.http.body.rule_spec.inclusion_rule_set.rules[].filter_set.filters[].field type: string - name: operator required: true source: $.http.body.rule_spec.inclusion_rule_set.rules[].filter_set.filters[].operator type: number - name: value required: true source: $.http.body.rule_spec.inclusion_rule_set.rules[].filter_set.filters[].value type: string - children: - children: - name: field required: true source: $.http.body.rule_spec.inclusion_rule_set.rules[].filter_set.filters[].parameter_filters[].field type: string - name: operator required: true source: $.http.body.rule_spec.inclusion_rule_set.rules[].filter_set.filters[].parameter_filters[].operator type: number - children: - type: string is_expand: true name: values required: true source: $.http.body.rule_spec.inclusion_rule_set.rules[].filter_set.filters[].parameter_filters[].values sub_type: string type: array is_expand: true type: object is_expand: true name: parameter_filters required: false sub_type: object type: array is_expand: true type: object is_expand: true name: filters required: true sub_type: object type: array - name: operator required: true source: $.http.body.rule_spec.inclusion_rule_set.rules[].filter_set.operator type: number is_expand: true name: filter_set required: false type: object is_expand: true type: object is_expand: true name: rules required: true sub_type: object type: array is_expand: true name: inclusion_rule_set required: true type: object - children: - name: operator required: true source: $.http.body.rule_spec.exclusion_rule_set.operator type: number - children: - children: - name: retention_days required: true source: $.http.body.rule_spec.exclusion_rule_set.rules[].retention_days type: number - children: - type: string is_expand: true name: event_source_ids required: false source: $.http.body.rule_spec.exclusion_rule_set.rules[].event_source_ids sub_type: string type: array - children: - children: - children: - name: field required: true source: $.http.body.rule_spec.exclusion_rule_set.rules[].filter_set.filters[].field type: string - name: operator required: true source: $.http.body.rule_spec.exclusion_rule_set.rules[].filter_set.filters[].operator type: number - name: value required: true source: $.http.body.rule_spec.exclusion_rule_set.rules[].filter_set.filters[].value type: string - children: - children: - name: field required: true source: $.http.body.rule_spec.exclusion_rule_set.rules[].filter_set.filters[].parameter_filters[].field type: string - name: operator required: true source: $.http.body.rule_spec.exclusion_rule_set.rules[].filter_set.filters[].parameter_filters[].operator type: number - children: - type: string is_expand: true name: values required: true source: $.http.body.rule_spec.exclusion_rule_set.rules[].filter_set.filters[].parameter_filters[].values sub_type: string type: array is_expand: true type: object is_expand: true name: parameter_filters required: false sub_type: object type: array is_expand: true type: object is_expand: true name: filters required: true sub_type: object type: array - name: operator required: true source: $.http.body.rule_spec.exclusion_rule_set.rules[].filter_set.operator type: number is_expand: true name: filter_set required: false type: object is_expand: true type: object is_expand: true name: rules required: true sub_type: object type: array is_expand: true name: exclusion_rule_set required: false type: object is_expand: false name: rule_spec required: true type: object - children: - name: core_user_id required: false source: $.http.body.context_info.core_user_id type: number is_expand: true name: context_info required: false type: object - name: audience_enhancement required: false source: $.http.body.audience_enhancement type: boolean plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id audience_enhancement: $.http.body.audience_enhancement audience_sub_type: $.http.body.audience_sub_type audience_type: $.http.body.audience_type context_info: core_user_id: $.http.body.context_info.core_user_id custom_audience_name: $.http.body.custom_audience_name identity_authorized_bc_id: $.http.body.identity_authorized_bc_id identity_id: $.http.body.identity_id identity_type: $.http.body.identity_type is_auto_refresh: $.http.body.is_auto_refresh retention_in_days: $.http.body.retention_in_days rule_spec: exclusion_rule_set: operator: $.http.body.rule_spec.exclusion_rule_set.operator rules[][]: - event_source_ids: $.http.body.rule_spec.exclusion_rule_set.rules[].event_source_ids filter_set[]: - filters[][]: - field: $.http.body.rule_spec.exclusion_rule_set.rules[].filter_set.filters[].field operator: $.http.body.rule_spec.exclusion_rule_set.rules[].filter_set.filters[].operator parameter_filters[][]: - field: $.http.body.rule_spec.exclusion_rule_set.rules[].filter_set.filters[].parameter_filters[].field operator: $.http.body.rule_spec.exclusion_rule_set.rules[].filter_set.filters[].parameter_filters[].operator values: $.http.body.rule_spec.exclusion_rule_set.rules[].filter_set.filters[].parameter_filters[].values value: $.http.body.rule_spec.exclusion_rule_set.rules[].filter_set.filters[].value operator: $.http.body.rule_spec.exclusion_rule_set.rules[].filter_set.operator retention_days: $.http.body.rule_spec.exclusion_rule_set.rules[].retention_days inclusion_rule_set: operator: $.http.body.rule_spec.inclusion_rule_set.operator rules[][]: - event_source_ids: $.http.body.rule_spec.inclusion_rule_set.rules[].event_source_ids filter_set[]: - filters[][]: - field: $.http.body.rule_spec.inclusion_rule_set.rules[].filter_set.filters[].field operator: $.http.body.rule_spec.inclusion_rule_set.rules[].filter_set.filters[].operator parameter_filters[][]: - field: $.http.body.rule_spec.inclusion_rule_set.rules[].filter_set.filters[].parameter_filters[].field operator: $.http.body.rule_spec.inclusion_rule_set.rules[].filter_set.filters[].parameter_filters[].operator values: $.http.body.rule_spec.inclusion_rule_set.rules[].filter_set.filters[].parameter_filters[].values value: $.http.body.rule_spec.inclusion_rule_set.rules[].filter_set.filters[].value operator: $.http.body.rule_spec.inclusion_rule_set.rules[].filter_set.operator retention_days: $.http.body.rule_spec.inclusion_rule_set.rules[].retention_days response_cookie: [] response_header: [] response_rule: custom_audience_id: $.rpc.output.custom_audience_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /dmp/custom_audience/share/: post: operationId: Dmp Custom_audience Share 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: Operator advertiser ID. nullable: false 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 context_info: description: '' nullable: false properties: app_id: description: '' format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.context_info.app_id core_user_id: description: '' format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.context_info.core_user_id developer_id: description: '' format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.context_info.developer_id x_forwarded_for: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.context_info.x_forwarded_for x_real_ip: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.body.context_info.x_real_ip type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.context_info custom_audience_ids: description: 'Custom audiences that you want to share. Size: 1-10.' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.custom_audience_ids shared_advertiser_ids: description: 'Advertisers that you want to share audiences with. They must be in the same Business Center as you. Size: 1-10.' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.shared_advertiser_ids required: - advertiser_id - custom_audience_ids - shared_advertiser_ids type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Share custom audiences with other advertisers [Dmp Custom_audience Share](https://business-api.tiktok.com/portal/docs?id=1740245803888706) tags: - Audience 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: false source: $.http.body.advertiser_id type: number - children: - type: number is_expand: true name: custom_audience_ids required: true source: $.http.body.custom_audience_ids sub_type: number type: array - children: - type: number is_expand: true name: shared_advertiser_ids required: true source: $.http.body.shared_advertiser_ids sub_type: number type: array - children: - name: app_id required: false source: $.context.app_id type: number - name: core_user_id required: false source: $.context.core_user_id type: number - name: developer_id required: false source: $.context.developer_id type: number is_expand: true name: context_info required: false source: '' type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id context_info: app_id: $.context.app_id core_user_id: $.context.core_user_id developer_id: $.context.developer_id custom_audience_ids: $.http.body.custom_audience_ids shared_advertiser_ids: $.http.body.shared_advertiser_ids response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /dmp/custom_audience/share/cancel/: post: operationId: Dmp Custom_audience Share Cancel 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: The advertiser ID that performed the operation. nullable: false 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 custom_audience_id: description: The audience ID that you want to stop sharing. nullable: false 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.custom_audience_id shared_advertiser_id: description: The advertiser ID you want to stop sharing with. You only need to pass this field if you want to stop sharing audiences with an advertiser. nullable: false 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.shared_advertiser_id required: - advertiser_id - custom_audience_id - shared_advertiser_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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Stop sharing custom audiences with other advertisers [Dmp Custom_audience Share Cancel](https://business-api.tiktok.com/portal/docs?id=1740245829978113) tags: - Audience 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: custom_audience_id required: true source: $.http.body.custom_audience_id type: number - name: shared_advertiser_id required: true source: $.http.body.shared_advertiser_id type: number - children: - name: core_user_id required: false source: $.context.core_user_id type: number is_expand: true name: context_info required: false type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id context_info: core_user_id: $.context.core_user_id custom_audience_id: $.http.body.custom_audience_id shared_advertiser_id: $.http.body.shared_advertiser_id response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /dmp/custom_audience/share/log/: get: operationId: Dmp Custom_audience Share Log parameters: - description: Advertiser ID. in: query name: advertiser_id required: true schema: nullable: false 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: Custom audiences that you want to get sharing log for. in: query name: custom_audience_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.custom_audience_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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get the sharing log of a custom audience [Dmp Custom_audience Share Log](https://ads.tiktok.com/marketing_api/docs?id=1740245827044354) tags: - Audience 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_audience_id required: true source: $.http.query.custom_audience_id type: number - children: - name: core_user_id required: false source: $.context.core_user_id type: number is_expand: true name: context_info required: false source: '' type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id context_info: core_user_id: $.context.core_user_id custom_audience_id: $.http.query.custom_audience_id response_cookie: [] response_header: [] response_rule: list[][]: - custom_audience_id: $.rpc.output.data[].custom_audience_id shared_advertiser_id: $.rpc.output.data[].shared_advertiser_id shared_advertiser_name: $.rpc.output.data[].shared_advertiser_name status: $.rpc.output.data[].status x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /dmp/custom_audience/update/: post: operationId: Dmp Custom_audience 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: action: default: REPLACE description: 'Modification type. This field is valid when file_paths is passed. Enum values: APPEND: Upload files to expand the Customer File audience. Only data not included in the original file will be added. REMOVE: Upload files to remove the Customer File audience. Only the data that coincide with the original file will be removed. REPLACE: Upload files to replace the Customer File audience. All the data in the original file will be replaced. Default value: REPLACE. Note: The APPEND, REMOVE and REPLACE operations will fail if the audience size is less than 1,000 after the operation.' nullable: false 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: REPLACE value: REPLACE - description: '' is_valid: true key: APPEND value: APPEND - description: '' is_valid: true key: REMOVE value: REMOVE key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 6 x-open-source: $.http.body.action advertiser_id: description: Advertiser ID. nullable: false 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 audience_enhancement: description: '' nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 x-open-source: $.http.body.audience_enhancement audience_sub_type: description: 'Audience sub type, indicating the type of ads that the audience can be used for. The allowed enum value: REACH_FREQUENCY(To enable the audience to be used in Reach & Frequency campaigns). It means you can only convert audience sub type from NORMAL to REACH_FREQUENCY, but not the other way round. Note: If you update this field, changes to other data fields will be ignored. If you want to update a Lookalike audience, you cannot change the audience_sub_type to REACH_FREQUENCY. Otherwise, an error will occur.' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.audience_sub_type context_info: description: '' nullable: false properties: core_user_id: description: '' format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.context_info.core_user_id type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 8 x-open-source: $.http.body.context_info custom_audience_id: description: Custom audience ID. nullable: false 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.custom_audience_id custom_audience_name: description: 'New name for the audience. Length limit: 128 characters. You must pass in either this field or file_paths.' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.custom_audience_name file_paths: description: The files you upload to update the Customer File audience. You must pass in either this field or custom_audience_name. The recommended size is <50 per request to ensure stability. Once you pass in this field, you can specify the modification type (APPEND, REMOVE or REPLACE) via action. The files must be encrypted with the same encryption method/type with the audience that you want to update. items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.body.file_paths required: - advertiser_id - custom_audience_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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Update the details of an audience [Dmp Custom_audience Update](https://business-api.tiktok.com/portal/docs?id=1739940572667906) tags: - Audience 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: custom_audience_id required: true source: $.http.body.custom_audience_id type: number - name: custom_audience_name required: false source: $.http.body.custom_audience_name type: string - name: audience_sub_type required: false source: $.http.body.audience_sub_type type: string - children: - type: string is_expand: true name: file_paths required: false source: $.http.body.file_paths sub_type: string type: array - name: action required: false source: $.http.body.action type: string - name: audience_enhancement required: false source: $.http.body.audience_enhancement type: boolean - children: - name: core_user_id required: false source: $.context.core_user_id type: number is_expand: true name: context_info required: false source: '' type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: action: $.http.body.action advertiser_id: $.http.body.advertiser_id audience_enhancement: $.http.body.audience_enhancement audience_sub_type: $.http.body.audience_sub_type context_info: core_user_id: $.context.core_user_id custom_audience_id: $.http.body.custom_audience_id custom_audience_name: $.http.body.custom_audience_name file_paths: $.http.body.file_paths response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /dmp/saved_audience/create/: post: operationId: Dmp Saved_audience 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: actions: description: A list of action category objects. items: nullable: false properties: action_category_ids: description: Required when actions has been specified and valid only when TikTok placement is the only placement selected in your ad group. IDs of the action categories (behaviors) or hashtags that you want to target. You can get action category IDs via /tool/action_category/. items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.actions[].action_category_ids action_period: description: 'Required when actions has been specified. The time period to include actions from. Enum values: 0, 7, 15. If action_scene is CREATOR_RELATED or HASHTAG_RELATED, 0 will be used regardless of the value you pass in. 0 means that there is no definite timeframe to select actions from.' format: int32 nullable: false type: integer 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.actions[].action_period action_scene: description: 'Required when actions has been specified. Where you can collect information about user actions. Enum values: VIDEO_RELATED, CREATOR_RELATED, HASHTAG_RELATED.' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800966577028098 enum_package_name: ActionScene enums: - description: '' is_valid: true key: CREATOR_RELATED value: '11' - description: '' is_valid: true key: HASHTAG_RELATED value: '13' - description: '' is_valid: true key: VIDEO_RELATED value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 1 x-open-source: $.http.body.actions[].action_scene video_user_actions: description: 'Required when actions has been specified. Video-related Actions. If action_scene is VIDEO_RELATED, the allowed values are: WATCHED_TO_END,LIKED,COMMENTED,SHARED. If action_scene is CREATOR_RELATED, the allowed values are: FOLLOWING, VIEW_HOMEPAGE. If action_scene is HASHTAG_RELATED, the allowed value is VIEW_HASHTAG.' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804237663605761 enum_package_name: VideoAction enums: - description: '' is_valid: true key: COMMENTED value: '2' - description: '' is_valid: true key: FOLLOWING value: '4' - description: '' is_valid: true key: LIKED value: '1' - description: '' is_valid: true key: SHARED value: '3' - description: '' is_valid: true key: VIEW_HASHTAG value: '6' - description: '' is_valid: true key: VIEW_HOMEPAGE value: '5' - description: '' is_valid: true key: WATCHED_TO_END value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.actions[].video_user_actions type: object x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 11 x-open-source: $.http.body.actions advertiser_id: description: Advertiser ID. nullable: false 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 age_groups: description: Age groups you want to target. For enum values, see Enumeration - Targeting Age Group. items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.body.age_groups audience_ids: description: List of audience IDs. You can get audience IDs via the /dmp/custom_audience/list/ endpoint. items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 x-open-source: $.http.body.audience_ids carrier_ids: description: Carriers that you want to target. Use /tool/carrier/ endpoint to get a list of carriers. A carrier is valid only when the in_use field for the carrier is true. The carriers must be consistent with the location(s) that you want to target. items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 17 x-open-source: $.http.body.carrier_ids device_model_ids: description: 'IDs of the device models that you want to target. Use /tool/device_model/ to get the complete list of device model IDs and their statuses, and only active devices (is_active = true in the response of /tool/device_model/) can be used to create ads. Note: Device model (device_model_ids) and device price (device_price_ranges) cannot be set at the same time.' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 15 x-open-source: $.http.body.device_model_ids device_price_ranges: description: '' items: format: int32 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 18 x-open-source: $.http.body.device_price_ranges excluded_audience_ids: description: List of audience IDs to be excluded. You can get audience IDs via the /dmp/custom_audience/list/ endpoint. items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 8 x-open-source: $.http.body.excluded_audience_ids gender: description: 'Gender that you want to target. Enum values: GENDER_FEMALE,GENDER_MALE,GENDER_UNLIMITED' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804229882527745 enum_package_name: AudienceGenderType enums: - description: '' is_valid: true key: GENDER_FEMALE value: '2' - description: '' is_valid: true key: GENDER_MALE value: '1' - description: '' is_valid: true key: GENDER_UNLIMITED value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 4 x-open-source: $.http.body.gender interest_category_ids: description: Interest classification. You can use /tool/target_recommend_tags/ to get a list of recommended interest categories based on your targeting regions and your industries, or use /tool/interest_category/ endpoint to get the complete list of interest categories. If the interest is specified, users who do not meet the interest target will be excluded during delivery. Do not specify if you wish to target everyone. items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 9 x-open-source: $.http.body.interest_category_ids interest_keyword_ids: description: IDs of interest keywords that you want to use to target audience. You can use /tool/interest_keyword/recommend/ to get recommended interest keywords. items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 10 x-open-source: $.http.body.interest_keyword_ids languages: description: Codes of the languages that you want to target. You can get language codes via /tool/language/, and if you don't want to limit the languages you target, assign an empty value to this field or do not pass in this field. items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.body.languages location_ids: description: 'IDs of the locations that you want to target. To get the available locations and corresponding IDs, use the /tool/region/ or /tool/targeting/search/ endpoint. Note: Overlapping targeted locations are not supported. For instance, you cannot target the U.S. and the state of California at the same time. DMA-level and city-level (or lower) targeting is only available in certain countries, and the access is managed by allowlist. If you would like to access it, please contact your TikTok representative for allowlisting.' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.location_ids min_android_version: description: Minimum device Android version. For enum values, see Enumeration - Minimum Android Version. nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 13 x-open-source: $.http.body.min_android_version min_ios_version: description: Minimum iOS version. For enum values, see Enumeration - Minimum iOS Version. nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 14 x-open-source: $.http.body.min_ios_version network_types: description: 'Device connection types that you want to target. Default: unlimited. For enum values, see Enumeration - Connection Type.' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803592836258818 enum_package_name: ReportAccessType enums: - description: '' is_valid: true key: 2G value: '2' - description: '' is_valid: true key: 3G value: '3' - description: '' is_valid: true key: 4G value: '4' - description: '' is_valid: true key: 5G value: '5' - description: '' is_valid: true key: UNKNOWN value: '0' - description: '' is_valid: true key: WIFI value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 16 x-open-source: $.http.body.network_types operating_systems: description: 'Device operating systems that you want to target. Enum values: ANDROID, IOS. Only one value is allowed.' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804229743233025 enum_package_name: 'AudiencePlatformType ' enums: - description: '' is_valid: true key: ANDROID value: '1' - description: '' is_valid: true key: IOS value: '2' - description: '' is_valid: true key: PC value: '16' - description: '' is_valid: true key: UNKNOWN value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 12 x-open-source: $.http.body.operating_systems saved_audience_name: description: Saved Audience name. Character limit is 512 and cannot contain emoji. nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.saved_audience_name required: - advertiser_id - saved_audience_name - location_ids type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Create a Saved Audience [Dmp Saved_audience Create](https://business-api.tiktok.com/portal/docs?id=1780154541898754) tags: - Audience 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: saved_audience_name required: true source: $.http.body.saved_audience_name type: string - children: - type: number is_expand: true name: location_ids required: true source: $.http.body.location_ids sub_type: number type: array - name: gender required: false source: $.http.body.gender type: number - children: - type: string is_expand: true name: age_groups required: false source: $.http.body.age_groups sub_type: string type: array - children: - type: string is_expand: true name: languages required: false source: $.http.body.languages sub_type: string type: array - children: - type: number is_expand: true name: audience_ids required: false source: $.http.body.audience_ids sub_type: number type: array - children: - type: number is_expand: true name: excluded_audience_ids required: false source: $.http.body.excluded_audience_ids sub_type: number type: array - children: - type: number is_expand: true name: interest_category_ids required: false source: $.http.body.interest_category_ids sub_type: number type: array - children: - type: number is_expand: true name: interest_keyword_ids required: false source: $.http.body.interest_keyword_ids sub_type: number type: array - children: - children: - name: action_scene required: false source: $.http.body.actions[].action_scene type: number - name: action_period required: false source: $.http.body.actions[].action_period type: number - children: - type: number is_expand: true name: video_user_actions required: false source: $.http.body.actions[].video_user_actions sub_type: number type: array - children: - type: number is_expand: true name: action_category_ids required: false source: $.http.body.actions[].action_category_ids sub_type: number type: array is_expand: true type: object is_expand: true name: actions required: false sub_type: object type: array - children: - type: number is_expand: true name: operating_systems required: false source: $.http.body.operating_systems sub_type: number type: array - name: min_android_version required: false source: $.http.body.min_android_version type: string - name: min_ios_version required: false source: $.http.body.min_ios_version type: string - children: - type: number is_expand: true name: device_model_ids required: false source: $.http.body.device_model_ids sub_type: number type: array - children: - type: number is_expand: true name: network_types required: false source: $.http.body.network_types sub_type: number type: array - children: - type: number is_expand: true name: carrier_ids required: false source: $.http.body.carrier_ids sub_type: number type: array - children: - type: number is_expand: true name: device_price_ranges required: false source: $.http.body.device_price_ranges sub_type: number type: array - children: - name: core_user_id required: false source: $.context.core_user_id type: number is_expand: true name: context_info required: false type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: actions[][]: - action_category_ids: $.http.body.actions[].action_category_ids action_period: $.http.body.actions[].action_period action_scene: $.http.body.actions[].action_scene video_user_actions: $.http.body.actions[].video_user_actions advertiser_id: $.http.body.advertiser_id age_groups: $.http.body.age_groups audience_ids: $.http.body.audience_ids carrier_ids: $.http.body.carrier_ids context_info: core_user_id: $.context.core_user_id device_model_ids: $.http.body.device_model_ids device_price_ranges: $.http.body.device_price_ranges excluded_audience_ids: $.http.body.excluded_audience_ids gender: $.http.body.gender interest_category_ids: $.http.body.interest_category_ids interest_keyword_ids: $.http.body.interest_keyword_ids languages: $.http.body.languages location_ids: $.http.body.location_ids min_android_version: $.http.body.min_android_version min_ios_version: $.http.body.min_ios_version network_types: $.http.body.network_types operating_systems: $.http.body.operating_systems saved_audience_name: $.http.body.saved_audience_name response_cookie: [] response_header: [] response_rule: saved_audience_id: $.rpc.output.saved_audience_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /dmp/saved_audience/delete/: post: operationId: Dmp Saved_audience 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: Advertiser ID. nullable: false 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 saved_audience_ids: description: IDs of Saved Audiences that you want to delete. Max size = 100. items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) maxItems: 100 minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.saved_audience_ids required: - advertiser_id - saved_audience_ids type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Delete Saved Audiences [Dmp Saved_audience Delete](https://business-api.tiktok.com/portal/docs?id=1780154666312706) tags: - Audience x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.body.advertiser_id type: number - children: - type: number is_expand: true name: saved_audience_ids required: true source: $.http.body.saved_audience_ids sub_type: number type: array - children: - name: core_user_id required: false source: $.context.core_user_id type: number is_expand: true name: context_info required: false type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id context_info: core_user_id: $.context.core_user_id saved_audience_ids: $.http.body.saved_audience_ids response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /dmp/saved_audience/list/: get: operationId: Dmp Saved_audience List parameters: - description: Advertiser ID. in: query name: advertiser_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 - content: application/json: schema: items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) maxItems: 100 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false description: 'IDs of Saved Audiences. Max size: 100. To create Saved Audiences and obtain the Saved Audience IDs, use /dmp/saved_audience/create/.' in: query name: saved_audience_ids required: false x-open-field-id: 2 - description: '' in: query name: page required: false schema: default: 1 format: int32 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 3 - description: '' in: query name: page_size required: false schema: default: 10 format: int32 maximum: 100 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get the details of Saved Audiences [Dmp Saved_audience List](https://business-api.tiktok.com/portal/docs?id=1780154619404290) tags: - Audience x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - children: - type: number is_expand: true name: saved_audience_ids required: false source: $.http.query.saved_audience_ids[] sub_type: number type: array - name: page required: false source: $.http.query.page type: number - name: page_size required: false source: $.http.query.page_size type: number - children: - name: core_user_id required: false source: $.context.core_user_id type: number is_expand: true name: context_info required: false type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id context_info: core_user_id: $.context.core_user_id page: $.http.query.page page_size: $.http.query.page_size saved_audience_ids: $.http.query.saved_audience_ids[] response_cookie: [] response_header: [] response_rule: page_info: page: $.rpc.output.page_info.page page_size: $.rpc.output.page_info.page_size total_number: $.rpc.output.page_info.total_number total_page: $.rpc.output.page_info.total_page saved_audiences[][]: - actions[][]: - action_category_ids: $.rpc.output.saved_audiences[].actions[].action_category_ids action_period: $.rpc.output.saved_audiences[].actions[].action_period action_scene: $.rpc.output.saved_audiences[].actions[].action_scene video_user_actions: $.rpc.output.saved_audiences[].actions[].video_user_actions age_groups: $.rpc.output.saved_audiences[].age_groups audience_ids: $.rpc.output.saved_audiences[].audience_ids carrier_ids: $.rpc.output.saved_audiences[].carrier_ids device_model_ids: $.rpc.output.saved_audiences[].device_model_ids device_price_ranges: $.rpc.output.saved_audiences[].device_price_ranges excluded_audience_ids: $.rpc.output.saved_audiences[].excluded_audience_ids gender: $.rpc.output.saved_audiences[].gender interest_category_ids: $.rpc.output.saved_audiences[].interest_category_ids interest_keyword_ids: $.rpc.output.saved_audiences[].interest_keyword_ids languages: $.rpc.output.saved_audiences[].languages location_ids: $.rpc.output.saved_audiences[].location_ids min_android_version: $.rpc.output.saved_audiences[].min_android_version min_ios_version: $.rpc.output.saved_audiences[].min_ios_version network_types: $.rpc.output.saved_audiences[].network_types operating_systems: $.rpc.output.saved_audiences[].operating_systems saved_audience_id: $.rpc.output.saved_audiences[].saved_audience_id saved_audience_name: $.rpc.output.saved_audiences[].saved_audience_name x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /gmv_max/bid/recommend/: get: operationId: Gmv_max Bid Recommend parameters: - description: '' in: query name: advertiser_id required: true schema: nullable: false 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: nullable: false 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: nullable: false 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: nullable: false 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: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) maxItems: 50 minItems: 1 nullable: false 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: nullable: false 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string 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 nullable: false 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 nullable: false 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: nullable: false properties: identity_info: description: '' nullable: false properties: identity_authorized_bc_id: description: '' nullable: false 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: '' nullable: false 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: '' nullable: false 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: '' nullable: false 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: '' nullable: false 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: '' nullable: false 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: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 1 minItems: 1 nullable: false 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 nullable: false 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string 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/exclusive_authorization/create/: post: operationId: Gmv_max Exclusive_authorization 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: '' nullable: false 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 store_authorized_bc_id: description: '' nullable: false 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.bc_id store_id: description: '' nullable: false 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.store_id required: - advertiser_id - store_id - store_authorized_bc_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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Create GMV Max exclusive authorization [Smart Plus GMV Max Exclusive Authorization Create](https://business-api.tiktok.com/portal/docs?id=1822001200356354) tags: - Store 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: store_id required: true source: $.http.body.store_id type: number - name: mutex_asset_id required: false source: $.http.body.mutex_asset_id type: string - name: bc_id required: true source: $.http.body.store_authorized_bc_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id bc_id: $.http.body.store_authorized_bc_id mutex_asset_id: $.http.body.mutex_asset_id store_id: $.http.body.store_id response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /gmv_max/exclusive_authorization/get/: get: operationId: Gmv_max Exclusive_authorization Get parameters: - description: '' in: query name: advertiser_id required: true schema: nullable: false 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: nullable: false 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: store_authorized_bc_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.bc_id 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get GMV Max exclusive authorization [Smart Plus GMV Max Exclusive Authorization Get](https://business-api.tiktok.com/portal/docs?id=1822001184635905) tags: - Store 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: bc_id required: true source: $.http.query.store_authorized_bc_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 bc_id: $.http.query.store_authorized_bc_id context_info: $.http.query.context_info store_id: $.http.query.store_id response_cookie: [] response_header: [] response_rule: advertiser_id: $.rpc.output.advertiser_id advertiser_name: $.rpc.output.advertiser_name advertiser_status: $.rpc.output.advertiser_status authorization_status: $.rpc.output.authorization_status identity_id: $.rpc.output.mutex_asset_id store_id: $.rpc.output.store_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /gmv_max/identity/get/: get: operationId: Gmv_max Identity Get parameters: - description: '' in: query name: advertiser_id required: true schema: nullable: false 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: nullable: false 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: store_authorized_bc_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.bc_id 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get GMV Max identity info [Smart Plus GMV Max Identity Get](https://business-api.tiktok.com/portal/docs?id=1822001101474882) tags: - Identity 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: - 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 - name: store_authorized_bc_id required: true source: $.http.query.store_authorized_bc_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id context_info: $.http.query.context_info store_authorized_bc_id: $.http.query.store_authorized_bc_id store_id: $.http.query.store_id response_cookie: [] response_header: [] response_rule: identity_list[][]: - display_name: $.rpc.output.identity_list[].name identity_authorized_bc_id: $.rpc.output.identity_list[].identity_authorized_bc_id identity_authorized_shop_id: $.rpc.output.identity_list[].identity_authorized_shop_id identity_id: $.rpc.output.identity_list[].identity_id identity_type: $.rpc.output.identity_list[].identity_type is_running_custom_shop_ads: $.rpc.output.identity_list[].has_roi1_ads live_gmv_max_available: $.rpc.output.identity_list[].available_for_live product_gmv_max_available: $.rpc.output.identity_list[].available_for_product profile_image: $.rpc.output.identity_list[].avatar_url store_id: $.rpc.output.identity_list[].store_id unavailable_reason: $.rpc.output.identity_list[].unavailable_reason_for_live user_name: $.rpc.output.identity_list[].user_name 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: nullable: false 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: nullable: false 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: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: 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: nullable: false 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string 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 /gmv_max/report/get/: get: operationId: Gmv_max Report Get parameters: - description: '' in: query name: advertiser_id required: true schema: nullable: false 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: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) maxItems: 1 minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.store_ids description: '' in: query name: store_ids required: true x-open-field-id: 2 - content: application/json: schema: items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 3 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.dimensions description: '' in: query name: dimensions required: true x-open-field-id: 3 - content: application/json: schema: items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 100 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.metrics description: '' in: query name: metrics required: true x-open-field-id: 4 - description: '' in: query name: enable_total_metrics required: false schema: default: false nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.enable_total_metrics x-open-field-id: 5 - description: '' in: query name: start_date required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.start_date x-open-field-id: 6 - description: '' in: query name: end_date required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.end_date x-open-field-id: 7 - content: application/json: schema: nullable: false properties: campaign_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) maxItems: 100 nullable: false 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: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.query.filtering.campaign_name campaign_statuses: description: '' items: nullable: false 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: 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 maxItems: 4 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.query.filtering.campaign_statuses creative_delivery_statuses: description: '' items: nullable: false 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: IN_QUEUE value: '1' - description: '' is_valid: true key: LEARNING value: '2' - description: '' is_valid: true key: DELIVERING value: '3' - description: '' is_valid: true key: NOT_DELIVERYING value: '4' - description: '' is_valid: true key: AUTHORIZATION_NEEDED value: '5' - description: '' is_valid: true key: EXCLUDED value: '6' - description: '' is_valid: true key: UNAVAILABLE value: '7' - description: '' is_valid: true key: REJECTED value: '9' - description: '' is_valid: true key: NOT_ACTIVE value: '10' key_format: string strict: true use_part: false validate_only: false value_format: int32 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 10 creative_types: description: '' items: nullable: false 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: ADS_AND_ORGANIC value: '1' - description: '' is_valid: true key: ORGANIC value: '2' - description: '' is_valid: true key: REMOVED value: '3' key_format: string strict: true use_part: false validate_only: false value_format: int32 maxItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.query.filtering.creative_types gmv_max_promotion_types: description: '' items: nullable: false 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: PRODUCT value: '0' - description: '' is_valid: true key: LIVE value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 maxItems: 2 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.query.filtering.gmv_max_promotion_types item_group_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 100 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.query.filtering.item_group_ids item_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 100 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 x-open-source: $.http.query.filtering.item_ids room_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 100 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 8 x-open-source: $.http.query.filtering.room_ids search_word: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 9 x-open-source: $.http.query.filtering.search_word 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: 8 - description: '' in: query name: sort_field required: false schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.sort_field x-open-field-id: 9 - description: '' in: query name: sort_type required: false schema: default: DESC nullable: false 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: ASC value: '0' - description: '' is_valid: true key: DESC value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.sort_type x-open-field-id: 10 - description: '' in: query name: page required: false schema: default: 1 format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page x-open-field-id: 11 - description: '' in: query name: page_size required: false schema: default: 10 format: int64 maximum: 1000 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page_size x-open-field-id: 12 - content: application/json: schema: nullable: false properties: app_id: description: '' format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.query.context_info.app_id core_user_id: description: '' format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.query.context_info.core_user_id developer_id: description: '' format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.query.context_info.developer_id referer: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 x-open-source: $.http.query.context_info.referer user_agent: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.query.context_info.user_agent x_forwarded_for: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.query.context_info.x_forwarded_for x_real_ip: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.query.context_info.x_real_ip type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.context_info description: '' in: query name: context_info required: false x-open-field-id: 13 - 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get GMV Max report [Smart Plus GMV Max Report Get](https://business-api.tiktok.com/portal/docs?id=1824721673497601) tags: - Reporting x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - children: - type: number is_expand: true name: store_ids required: true source: $.http.query.store_ids sub_type: number type: array - children: - type: string is_expand: true name: dimensions required: true source: $.http.query.dimensions sub_type: string type: array - children: - type: string is_expand: true name: metrics required: false source: $.http.query.metrics sub_type: string type: array - name: enable_total_metrics required: false source: $.http.query.enable_total_metrics type: boolean - name: start_date required: true source: $.http.query.start_date type: string - name: end_date required: true source: $.http.query.end_date type: string - children: - children: - type: number is_expand: true name: campaign_ids required: false source: $.http.query.filtering.campaign_ids sub_type: number type: array - name: campaign_name required: false source: $.http.query.filtering.campaign_name type: string - children: - type: string is_expand: true name: campaign_statuses required: false source: $.http.query.filtering.campaign_statuses sub_type: string type: array - children: - type: string is_expand: true name: item_group_ids required: false source: $.http.query.filtering.item_group_ids sub_type: string type: array - children: - type: number is_expand: true name: gmv_max_promotion_types required: false source: $.http.query.filtering.gmv_max_promotion_types sub_type: number type: array - children: - type: number is_expand: true name: creative_types required: false source: $.http.query.filtering.creative_types sub_type: number type: array - children: - type: string is_expand: true name: item_ids required: false source: $.http.query.filtering.item_ids sub_type: string type: array - children: - type: string is_expand: true name: room_ids required: false source: $.http.query.filtering.room_ids sub_type: string type: array - name: search_word required: false source: $.http.query.filtering.search_word type: string - children: - is_expand: false source: undefined type: number is_expand: false name: creative_delivery_statuses required: false source: $.http.query.filtering.creative_delivery_statuses sub_type: number type: array is_expand: true name: filtering required: false type: object - name: sort_field required: false source: $.http.query.sort_field type: string - name: sort_type required: false source: $.http.query.sort_type type: number - name: page required: false source: $.http.query.page type: number - name: page_size required: false source: $.http.query.page_size type: number - children: - name: app_id required: false source: $.context.app_id type: number - name: core_user_id required: false source: $.context.core_user_id type: number - name: developer_id required: false source: $.context.developer_id type: number - name: x_forwarded_for required: false source: $.context.source_ip type: string - name: x_real_ip required: false source: $.context.source_ip type: string - name: user_agent required: false source: $.context.is_same_identity type: string - name: referer required: false source: $.context.is_same_identity type: string is_expand: true name: context_info required: true type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id context_info: app_id: $.context.app_id core_user_id: $.context.core_user_id developer_id: $.context.developer_id referer: $.context.is_same_identity user_agent: $.context.is_same_identity x_forwarded_for: $.context.source_ip x_real_ip: $.context.source_ip dimensions: $.http.query.dimensions enable_total_metrics: $.http.query.enable_total_metrics end_date: $.http.query.end_date filtering: campaign_ids: $.http.query.filtering.campaign_ids campaign_name: $.http.query.filtering.campaign_name campaign_statuses: $.http.query.filtering.campaign_statuses creative_delivery_statuses: $.http.query.filtering.creative_delivery_statuses creative_types: $.http.query.filtering.creative_types gmv_max_promotion_types: $.http.query.filtering.gmv_max_promotion_types item_group_ids: $.http.query.filtering.item_group_ids item_ids: $.http.query.filtering.item_ids room_ids: $.http.query.filtering.room_ids search_word: $.http.query.filtering.search_word metrics: $.http.query.metrics page: $.http.query.page page_size: $.http.query.page_size sort_field: $.http.query.sort_field sort_type: $.http.query.sort_type start_date: $.http.query.start_date store_ids: $.http.query.store_ids response_cookie: [] response_header: [] response_rule: list: $.rpc.output.stats page_info: $.rpc.output.page_info total_metrics: $.rpc.output.total_metrics x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /gmv_max/store/list/: get: operationId: Gmv_max Store List parameters: - description: '' in: query name: advertiser_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.advertiser_id x-open-field-id: 1 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get GMV Max store list [Smart Plus GMV Max Store List](https://business-api.tiktok.com/portal/docs?id=1822001044479041) tags: - Store x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - children: - name: 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 context_info: $.http.query.context_info response_cookie: [] response_header: [] response_rule: store_list[][]: - exclusive_authorized_advertiser_info: $.rpc.output.store_list[].exclusive_authorized_adv_info is_gmv_max_available: $.rpc.output.store_list[].is_gmv_max_available is_owner_bc: $.rpc.output.store_list[].is_owner_bc store_authorized_bc_id: $.rpc.output.store_list[].store_authorized_bc_id store_authorized_bc_info: $.rpc.output.store_list[].store_authorized_bc_info store_code: $.rpc.output.store_list[].store_code store_id: $.rpc.output.store_list[].store_id store_name: $.rpc.output.store_list[].store_name store_role: $.rpc.output.store_list[].store_user_role store_status: $.rpc.output.store_list[].shop_status targeting_region_codes: $.rpc.output.store_list[].targeting_region_codes thumbnail_url: $.rpc.output.store_list[].thumbnail_url x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /gmv_max/store/shop_ad_usage_check/: get: operationId: Gmv_max Store Shop_ad_usage_check parameters: - description: '' in: query name: advertiser_id required: true schema: nullable: false 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: nullable: false 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: 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Check GMV Max shop ad usage [Smart Plus GMV Max Shop Ad Usage Check](https://business-api.tiktok.com/portal/docs?id=1822001084174338) tags: - Store 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: - 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 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 context_info: $.http.query.context_info store_id: $.http.query.store_id response_cookie: [] response_header: [] response_rule: is_running_custom_shop_ads: $.rpc.output.has_roi1_ads promote_all_products_allowed: $.rpc.output.allow_create_roi2_ad x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /gmv_max/video/get/: get: operationId: Gmv_max Video Get parameters: - description: '' in: query name: advertiser_id required: true schema: nullable: false 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: nullable: false 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: store_authorized_bc_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.bc_id x-open-field-id: 3 - content: application/json: schema: items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.spu_list description: '' in: query name: spu_id_list required: false x-open-field-id: 4 - content: application/json: schema: items: nullable: false properties: identity_authorized_bc_id: description: '' nullable: false 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.query.identity_list[].identity_authorized_bc_id identity_authorized_shop_id: description: '' nullable: false 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.query.identity_list[].identity_authorized_shop_id identity_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.query.identity_list[].identity_id identity_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800331041544193 enum_package_name: IdentityType enums: - description: '' is_valid: false key: AUTH_CODE value: '2' - description: '' is_valid: true key: BC_AUTH_TT value: '5' - description: '' is_valid: false key: BC_SELF_TT value: '4' - description: '' is_valid: false key: CUSTOMIZED_USER value: '1' - description: TTS 授权来源TT账号 is_valid: 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.identity_list[].identity_type store_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 5 required: - identity_id - identity_type type: object x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 20 minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.identity_list description: '' in: query name: identity_list required: false x-open-field-id: 5 - description: '' in: query name: need_auth_code_video required: false schema: nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.need_auth_code_video x-open-field-id: 6 - description: '' in: query name: page required: false schema: default: 1 format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page x-open-field-id: 7 - description: '' in: query name: page_size required: false schema: default: 10 format: int64 maximum: 50 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page_size x-open-field-id: 8 - description: '' in: query name: custom_posts_eligible required: false schema: nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 9 - description: '' in: query name: sort_field required: false schema: nullable: false 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: GMV value: '1' - description: '' is_valid: true key: VIDEO_VIEWS value: '2' - description: '' is_valid: true key: VIDEO_LIKES value: '3' - description: '' is_valid: true key: CLICK_THROUGH_RATE value: '4' - description: '' is_valid: true key: ORDER_RATE value: '5' - description: '' is_valid: true key: POST_TIME value: '6' - description: '' is_valid: true key: PRODUCT_CLICKS value: '7' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 10 - description: '' in: query name: sort_type required: false schema: default: DESC nullable: false 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: ASC value: '1' - description: '' is_valid: true key: DESC value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 11 - description: '' in: query name: keyword required: false schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 12 - 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get GMV Max video info [Smart Plus GMV Max Video Get](https://business-api.tiktok.com/portal/docs?id=1822001168512129) tags: - Video 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: spu_list required: false source: $.http.query.spu_id_list sub_type: string type: array - children: - children: - name: identity_id required: true source: $.http.query.identity_list[].identity_id type: string - name: identity_type required: true source: $.http.query.identity_list[].identity_type type: number - name: identity_authorized_bc_id required: false source: $.http.query.identity_list[].identity_authorized_bc_id type: number - name: store_id required: false source: $.http.query.identity_list[].store_id type: number - name: avatar_url required: false source: $.http.query.identity_list[].avatar_url type: string - name: name required: false source: $.http.query.identity_list[].name type: string - name: identity_authorized_shop_id required: false source: $.http.query.identity_list[].identity_authorized_shop_id type: number - name: has_roi1_ads required: false source: $.http.query.identity_list[].has_roi1_ads type: boolean - name: available_for_product required: false source: $.http.query.identity_list[].available_for_product type: boolean - name: available_for_live required: false source: $.http.query.identity_list[].available_for_live type: boolean - name: unavailable_reason_for_live required: false source: $.http.query.identity_list[].unavailable_reason_for_live type: number - name: user_name required: false source: $.http.query.identity_list[].user_name type: string is_expand: true type: object is_expand: false name: identity_list required: false source: $.http.query.identity_list sub_type: object type: array - name: need_auth_code_video required: false source: $.http.query.need_auth_code_video type: boolean - name: page required: true source: $.http.query.page type: number - name: page_size required: true source: $.http.query.page_size 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 - name: store_authorized_bc_id required: true source: $.http.query.store_authorized_bc_id type: number - name: sort_field required: false source: $.http.query.sort_field type: number - name: custom_posts_eligible required: false source: $.http.query.custom_posts_eligible type: boolean - name: keyword required: false source: $.http.query.keyword type: string - name: sort_order required: false source: $.http.query.sort_type type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id context_info: $.http.query.context_info custom_posts_eligible: $.http.query.custom_posts_eligible identity_list: $.http.query.identity_list keyword: $.http.query.keyword need_auth_code_video: $.http.query.need_auth_code_video page: $.http.query.page page_size: $.http.query.page_size sort_field: $.http.query.sort_field sort_order: $.http.query.sort_type spu_list: $.http.query.spu_id_list store_authorized_bc_id: $.http.query.store_authorized_bc_id store_id: $.http.query.store_id response_cookie: [] response_header: [] response_rule: item_list[][]: - can_change_anchor: $.rpc.output.item_list[].can_change_anchor identity_info[]: - display_name: $.rpc.output.item_list[].identity_info.name identity_authorized_bc_id: $.rpc.output.item_list[].identity_info.identity_authorized_bc_id identity_authorized_shop_id: $.rpc.output.item_list[].identity_info.identity_authorized_shop_id identity_id: $.rpc.output.item_list[].identity_info.identity_id identity_type: $.rpc.output.item_list[].identity_info.identity_type profile_image: $.rpc.output.item_list[].identity_info.avatar_url store_id: $.rpc.output.item_list[].identity_info.store_id item_id: $.rpc.output.item_list[].item_id spu_id_list: $.rpc.output.item_list[].spu_id_list text: $.rpc.output.item_list[].title video_info[]: - bit_rate: $.rpc.output.item_list[].video_info.bitrate definition: $.rpc.output.item_list[].video_info.definition duration: $.rpc.output.item_list[].video_info.duration format: $.rpc.output.item_list[].video_info.format fps: $.rpc.output.item_list[].video_info.fps height: $.rpc.output.item_list[].video_info.height preview_url: $.rpc.output.item_list[].video_info.play_url signature: $.rpc.output.item_list[].video_info.file_md5 size: $.rpc.output.item_list[].video_info.file_size video_cover_url: $.rpc.output.item_list[].video_info.cover_url video_id: $.rpc.output.item_list[].video_info.video_id width: $.rpc.output.item_list[].video_info.width page_info: $.rpc.output.page_info x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /offline/create/: post: operationId: Offline 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: '' nullable: false 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.AdvertiserID auto_tracking: default: false description: '' nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.AutoTracking description: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.Description name: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.Name required: - advertiser_id - name - description 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Create a new Offline Event set. [Offline Create](https://business-api.tiktok.com/portal/docs?id=1758427576470529) tags: - Measurement x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: AdvertiserID required: true source: $.http.body.advertiser_id type: number - name: CoreUserID required: true source: $.context.core_user_id type: number - name: Name required: true source: $.http.body.name type: string - name: Description required: true source: $.http.body.description type: string - name: AutoTracking required: true source: $.http.body.auto_tracking type: boolean plugins: after_response: [] before_request: [] request_query_rule: null request_rule: AdvertiserID: $.http.body.advertiser_id AutoTracking: $.http.body.auto_tracking CoreUserID: $.context.core_user_id Description: $.http.body.description Name: $.http.body.name response_cookie: [] response_header: [] response_rule: event_set_id: $.rpc.output.OfflineEventSet.ID x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /offline/delete/: post: operationId: Offline 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: '' nullable: false 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.AdvertiserID event_set_id: description: '' nullable: false 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.EventSetID required: - advertiser_id - event_set_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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Delete an Offline Event set. [Offline Delete](https://business-api.tiktok.com/portal/docs?id=1765596790860802) tags: - Measurement x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: AdvertiserID required: true source: $.http.body.advertiser_id type: number - name: CoreUserID required: true source: $.context.core_user_id type: number - name: EventSetID required: true source: $.http.body.event_set_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: AdvertiserID: $.http.body.advertiser_id CoreUserID: $.context.core_user_id EventSetID: $.http.body.event_set_id response_cookie: [] response_header: [] response_rule: test: $.resp x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /offline/get/: get: operationId: Offline Get parameters: - description: '' in: query name: advertiser_id required: false schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.AdvertiserID x-open-field-id: 1 - content: application/json: schema: items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.EventSetIDs description: '' in: query name: event_set_ids required: false x-open-field-id: 2 - description: '' in: query name: name required: false schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.Name 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get Offline Event sets. [Offline Get](https://business-api.tiktok.com/portal/docs?id=1765596808589313) tags: - Measurement x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: AdvertiserID required: false source: $.http.query.advertiser_id type: number - children: - type: number is_expand: true name: EventSetIDs required: false source: $.http.query.event_set_ids[] sub_type: number type: array - name: Name required: false source: $.http.query.name type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: AdvertiserID: $.http.query.advertiser_id EventSetIDs: $.http.query.event_set_ids[] Name: $.http.query.name response_cookie: [] response_header: [] response_rule: event_set_list[][]: - advertiser_id: $.rpc.output.OfflineEventSets[].AdvertiserID auto_tracking: $.rpc.output.OfflineEventSets[].AutoTracking create_time: $.rpc.output.OfflineEventSets[].CreatedAt description: $.rpc.output.OfflineEventSets[].Description event_set_id: $.rpc.output.OfflineEventSets[].ID name: $.rpc.output.OfflineEventSets[].Name update_time: $.rpc.output.OfflineEventSets[].UpdatedAt x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /offline/update/: post: operationId: Offline 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: '' nullable: false 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.AdvertiserID auto_tracking: description: '' nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.AutoTracking event_set_id: description: '' nullable: false 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.EventSetID name: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.EventSetName required: - advertiser_id - event_set_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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Update an Offline Event set. [Offline Update](https://business-api.tiktok.com/portal/docs?id=1765596741157889) tags: - Measurement x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: AdvertiserID required: true source: $.http.body.advertiser_id type: number - name: CoreUserID required: true source: $.context.core_user_id type: number - name: EventSetID required: true source: $.http.body.event_set_id type: number - name: EventSetName required: false source: $.http.body.name type: string - name: AutoTracking required: false source: $.http.body.auto_tracking type: boolean plugins: after_response: [] before_request: [] request_query_rule: null request_rule: AdvertiserID: $.http.body.advertiser_id AutoTracking: $.http.body.auto_tracking CoreUserID: $.context.core_user_id EventSetID: $.http.body.event_set_id EventSetName: $.http.body.name response_cookie: [] response_header: [] response_rule: advertiser_id: $.rpc.output.OfflineEventSet.AdvertiserID auto_tracking: $.rpc.output.OfflineEventSet.AutoTracking create_time: $.rpc.output.OfflineEventSet.CreatedAt description: $.rpc.output.OfflineEventSet.Description event_set_id: $.rpc.output.OfflineEventSet.ID name: $.rpc.output.OfflineEventSet.Name update_time: $.rpc.output.OfflineEventSet.UpdatedAt x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /optimizer/rule/batch_bind/: post: operationId: Optimizer Rule Batch_bind 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: '' nullable: false 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 bind_info: description: '' items: nullable: false properties: bind_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804046212921409 enum_package_name: AutoRuleBindType enums: - description: '' is_valid: true key: BIND value: '1' - description: '' is_valid: true key: UNBIND 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.bind_info[].bind_type dimension: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803155537096705 enum_package_name: AutoRuleDimension enums: - description: '' is_valid: true key: AD value: '3' - description: '' is_valid: true key: ADGROUP value: '2' - description: '' is_valid: true key: CAMPAIGN value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 2 x-open-source: $.http.body.bind_info[].dimension dimension_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.bind_info[].dimension_ids rule_id: description: '' nullable: false 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.bind_info[].rule_id required: - rule_id - dimension - dimension_ids - bind_type type: object x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.bind_info lang: default: EN description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.lang required: - advertiser_id - bind_info 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Bind objects to rules. [Optimizer Rule Batch Bind](https://business-api.tiktok.com/portal/docs?id=1738769164954626) tags: - Automated_Rules 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: - children: - name: rule_id required: true type: number - name: dimension required: true type: number - children: - type: number is_expand: true name: dimension_ids required: true sub_type: number type: array - name: bind_type required: true type: number is_expand: true type: object is_expand: true name: bind_info required: true source: $.http.body.bind_info[] sub_type: object type: array - name: lang required: false source: $.http.body.lang type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id bind_info: $.http.body.bind_info[] lang: $.http.body.lang response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /optimizer/rule/create/: post: operationId: Optimizer Rule 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: '' nullable: false 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 lang: default: EN description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.lang rules: description: '' items: nullable: false properties: actions: description: '' items: nullable: false properties: action_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804143435530241 enum_package_name: AutoRuleActionType enums: - description: '' is_valid: true key: ADJUST_TO value: '3' - description: '' is_valid: true key: DECREASE value: '2' - description: '' is_valid: true key: DEFAULT value: '0' - description: '' is_valid: true key: INCREASE value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 2 x-open-source: $.http.body.rules[].actions[].action_type frequency_info: description: '' nullable: false properties: count: description: '' format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.rules[].actions[].frequency_info.count custom_frequency_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804143747245057 enum_package_name: AutoRuleActionCustomFreType enums: - description: '' is_valid: true key: N_DAY_Y_TIMES value: '3' - description: '' is_valid: true key: N_HOUR_Y_TIMES value: '2' - description: '' is_valid: true key: N_MINTUE_Y_TIMES value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 2 x-open-source: $.http.body.rules[].actions[].frequency_info.custom_frequency_type time: description: '' format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.rules[].actions[].frequency_info.time type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804143659529218 enum_package_name: AutoRuleActionFreType enums: - description: '' is_valid: true key: CUSTOM value: '5' - description: '' is_valid: true key: ONCE_IN_1_W value: '4' - description: '' is_valid: true key: ONCE_IN_24_H value: '2' - description: '' is_valid: true key: ONCE_IN_48_H value: '3' - description: '' is_valid: true key: ONLY_ONCE value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 1 x-open-source: $.http.body.rules[].actions[].frequency_info.type required: - type type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.body.rules[].actions[].frequency_info subject_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804143361340417 enum_package_name: AutoRuleActionSubType enums: - description: '' is_valid: true key: BID value: '6' - description: '' is_valid: true key: DAILY_BUDGET value: '4' - description: '' is_valid: true key: LIFETIME_BUDGET value: '5' - description: '' is_valid: true key: MESSAGE value: '3' - description: '' is_valid: true key: TURN_OFF value: '2' - description: '' is_valid: true key: TURN_ON value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 1 x-open-source: $.http.body.rules[].actions[].subject_type value: description: '' nullable: false properties: limit: description: '' format: float nullable: false type: number x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.rules[].actions[].value.limit use_limit: description: '' nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.rules[].actions[].value.use_limit value: description: '' format: float nullable: false type: number x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.rules[].actions[].value.value type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.rules[].actions[].value value_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804143484688450 enum_package_name: AutoRuleActionValType enums: - description: '' is_valid: true key: EXACT value: '0' - description: '' is_valid: true key: PERCENT 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.rules[].actions[].value_type required: - subject_type type: object x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.rules[].actions apply_objects: description: '' items: nullable: false properties: bind_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804046212921409 enum_package_name: AutoRuleBindType enums: - description: '' is_valid: true key: BIND value: '1' - description: '' is_valid: true key: UNBIND value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 4 dimension: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803155537096705 enum_package_name: AutoRuleDimension enums: - description: '' is_valid: true key: AD value: '3' - description: '' is_valid: true key: ADGROUP value: '2' - description: '' is_valid: true key: CAMPAIGN value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 1 x-open-source: $.http.body.rules[].apply_objects[].dimension dimension_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.rules[].apply_objects[].dimension_ids pre_condition_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804046697548801 enum_package_name: AutoRulePreCondition enums: - description: '' is_valid: true key: ALL_ACTIVE_AD value: '3' - description: '' is_valid: true key: ALL_ACTIVE_AD_GROUP value: '2' - description: '' is_valid: true key: ALL_ACTIVE_AD_GROUP_UNDER_SELECTED value: '4' - description: '' is_valid: true key: ALL_ACTIVE_AD_UNDER_SELECTED value: '5' - description: '' is_valid: true key: ALL_ACTIVE_CAMPAIGN value: '1' - description: '' is_valid: true key: ALL_INACTIVE_AD value: '8' - description: '' is_valid: true key: ALL_INACTIVE_AD_GROUP value: '7' - description: '' is_valid: true key: ALL_INACTIVE_AD_GROUP_UNDER_SELECTED value: '9' - description: '' is_valid: true key: ALL_INACTIVE_AD_UNDER_SELECTED value: '10' - description: '' is_valid: true key: ALL_INACTIVE_CAMPAIGN value: '6' - description: '' is_valid: true key: SELECTED value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 3 x-open-source: $.http.body.rules[].apply_objects[].pre_condition_type required: - dimension - pre_condition_type type: object x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.rules[].apply_objects conditions: description: '' items: nullable: false properties: calculation_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804138653195266 enum_package_name: AutoRuleConCalType enums: - description: '' is_valid: true key: ALL_OBJECTS value: '1' - description: '' is_valid: true key: DEFAULT value: '0' - description: '' is_valid: true key: OF_EACH_OBJECT 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.rules[].conditions[].calculation_type match_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804138589004802 enum_package_name: AutoRuleConMatchType enums: - description: '' is_valid: true key: BETWEEN value: '3' - description: '' is_valid: true key: CONTAINS value: '5' - description: '' is_valid: true key: DEFAULT value: '0' - description: '' is_valid: true key: END_WITH value: '8' - description: '' is_valid: true key: GT value: '1' - description: '' is_valid: true key: LT value: '2' - description: '' is_valid: true key: MATCH value: '4' - description: '' is_valid: true key: NOT_CONTAINS value: '6' - description: '' is_valid: true key: START_WITH value: '7' - description: '' is_valid: true key: STRING_EQUAL value: '9' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 3 x-open-source: $.http.body.rules[].conditions[].match_type range_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804138466724866 enum_package_name: AutoRuleConRangeType enums: - description: '' is_valid: true key: DEFAULT value: '0' - description: '' is_valid: true key: LAST_HOUR value: '3' - description: '' is_valid: true key: LIFETIME value: '7' - description: '' is_valid: true key: PAST_FIVE_DAYS value: '5' - description: '' is_valid: true key: PAST_SEVEN_DAYS value: '6' - description: '' is_valid: true key: PAST_THREE_DAYS value: '4' - description: '' is_valid: true key: TODAY value: '1' - description: '' is_valid: true key: YESTERDAY value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 2 x-open-source: $.http.body.rules[].conditions[].range_type subject_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804138278373442 enum_package_name: AutoRuleConSubjectType enums: - description: '' is_valid: true key: BID_STRATEGY value: '17' - description: '' is_valid: true key: CLICK value: '5' - description: '' is_valid: true key: CONVERSION value: '6' - description: '' is_valid: true key: CONVERSION_SKAN value: '7' - description: '' is_valid: true key: COST value: '1' - description: '' is_valid: true key: COST_PER_RESULT value: '14' - description: '' is_valid: true key: CPA value: '10' - description: '' is_valid: true key: CPC value: '12' - description: '' is_valid: true key: CPM value: '11' - description: '' is_valid: true key: CTR value: '13' - description: '' is_valid: true key: CVR value: '8' - description: '' is_valid: true key: CVR_IMPRESSION value: '31' - description: '' is_valid: true key: CVR_SKAN value: '9' - description: '' is_valid: true key: DAILY_BUDGET_SPENDING_RATE value: '2' - description: '' is_valid: true key: DAYS_SINCE_CREATION value: '21' - description: '' is_valid: true key: IMPRESSION value: '4' - description: '' is_valid: true key: LIFETIME_BUDGET_SPENDING_RATE value: '3' - description: '' is_valid: true key: NAME value: '20' - description: '' is_valid: true key: NOT_REAL_TIME_CONVERSION value: '29' - description: '' is_valid: true key: NOT_REAL_TIME_CPA value: '28' - description: '' is_valid: true key: NOT_REAL_TIME_CVR value: '30' - description: '' is_valid: true key: NO_CONDITION value: '22' - description: '' is_valid: true key: OBJECTIVE value: '19' - description: '' is_valid: true key: OPTIMIZATION_GOAL value: '18' - description: '' is_valid: true key: REAL_TIME_CVR_IMPRESSION value: '32' - description: '' is_valid: true key: RESULT value: '15' - description: '' is_valid: true key: RESULT_RATE value: '16' - description: '' is_valid: true key: ROAS_COMPLETE_PAYMENT value: '26' - description: '' is_valid: true key: ROAS_IMPRESSION_ADS value: '24' - description: '' is_valid: true key: ROAS_PURCHASE value: '23' - description: '' is_valid: true key: ROAS_PURCHASES_ONSITE value: '27' - description: '' is_valid: true key: ROAS_PURCHASE_SKAN value: '25' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 1 x-open-source: $.http.body.rules[].conditions[].subject_type values: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.rules[].conditions[].values required: - subject_type type: object x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.rules[].conditions name: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 x-open-source: $.http.body.rules[].name notification: description: '' nullable: false properties: email_setting: description: '' nullable: false properties: email_exec_time: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.rules[].notification.email_setting.email_exec_time mute_option: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804145270824961 enum_package_name: AutoRuleNotificationMute enums: - description: '' is_valid: true key: MUTE value: '1' - description: '' is_valid: true key: UNMUTE 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.rules[].notification.email_setting.mute_option no_result_notification: description: '' nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.rules[].notification.email_setting.no_result_notification notification_period: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804145204444161 enum_package_name: AutoRuleNotificationPeriod enums: - description: '' is_valid: true key: EVERY_TIME value: '0' - description: '' is_valid: true key: TIME_SCHEDULE value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 1 x-open-source: $.http.body.rules[].notification.email_setting.notification_period type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.rules[].notification.email_setting notification_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804145138016257 enum_package_name: AutoRuleNotificationType enums: - description: '' is_valid: true key: ANY_CHANGES value: '2' - description: '' is_valid: true key: NOT_NOTIFICATION value: '0' - description: '' is_valid: true key: TASK_FINISH value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 1 x-open-source: $.http.body.rules[].notification.notification_type required: - notification_type type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.rules[].notification rule_exec_info: description: '' nullable: false properties: exec_time: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.rules[].rule_exec_info.exec_time exec_time_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804144962966529 enum_package_name: AutoRuleExeTimeType enums: - description: '' is_valid: true key: CUSTOM value: '2' - description: '' is_valid: true key: HALF_HOUR_IN_SPECIFIC_TIME_PERIOD value: '3' - description: '' is_valid: true key: PER_HALF_HOUR value: '1' - description: '' is_valid: true key: SPECIFIC_TIME_ACCURATE_ONCE value: '5' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 1 x-open-source: $.http.body.rules[].rule_exec_info.exec_time_type time_period_info: description: '' items: nullable: false properties: date_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804145051616258 enum_package_name: AutoRuleDateType enums: - description: '' is_valid: true key: DAY value: '1' - description: '' is_valid: true key: MONTH value: '3' - description: '' is_valid: true key: WEEK 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.rules[].rule_exec_info.time_period_info[].date_type end_time: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.rules[].rule_exec_info.time_period_info[].end_time num: description: '' items: format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.rules[].rule_exec_info.time_period_info[].num start_time: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.rules[].rule_exec_info.time_period_info[].start_time required: - num - start_time - end_time - date_type type: object x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.rules[].rule_exec_info.time_period_info required: - exec_time_type type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.body.rules[].rule_exec_info tzone: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.body.rules[].timezone required: - apply_objects - conditions - actions - notification - rule_exec_info - name type: object x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.rules required: - advertiser_id - rules 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Create an automated rule. [Optimizer Rule Create](https://business-api.tiktok.com/portal/docs?id=1738767670852610) tags: - Automated_Rules 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: lang required: false source: $.http.body.lang type: string - children: - children: - children: - children: - name: dimension required: true type: number - children: - type: number is_expand: true name: dimension_ids required: false sub_type: number type: array - name: pre_condition_type required: true type: number is_expand: true type: object is_expand: true name: apply_objects required: true source: $.http.body.rules[].apply_objects[] sub_type: object type: array - children: - children: - name: subject_type required: true type: number - name: range_type required: false type: number - name: match_type required: false type: number - children: - type: string is_expand: true name: values required: false sub_type: string type: array - name: calculation_type required: false type: number is_expand: true type: object is_expand: false name: conditions required: true source: $.http.body.rules[].conditions[] sub_type: object type: array - children: - children: - name: subject_type required: true type: number - name: action_type required: false type: number - name: value_type required: false type: number - children: - name: value required: false type: number - name: use_limit required: false type: boolean - name: limit required: false type: number is_expand: true name: value required: false type: object - children: - name: type required: true type: number - name: custom_frequency_type required: false type: number - name: time required: false type: number - name: count required: false type: number is_expand: true name: frequency_info required: false type: object is_expand: true type: object is_expand: false name: actions required: true source: $.http.body.rules[].actions[] sub_type: object type: array - children: - name: notification_type required: true type: number - children: - name: notification_period required: false type: number - children: - type: string is_expand: true name: email_exec_time required: false sub_type: string type: array - name: no_result_notification required: false type: boolean - name: mute_option required: false type: number is_expand: true name: email_setting required: false type: object is_expand: false name: notification required: true source: $.http.body.rules[].notification type: object - children: - name: exec_time_type required: true type: number - name: exec_time required: false type: string - children: - children: - children: - type: number is_expand: true name: num required: true sub_type: number type: array - name: start_time required: true type: string - name: end_time required: true type: string - name: date_type required: true type: number is_expand: true type: object is_expand: true name: time_period_info required: false sub_type: object type: array is_expand: false name: rule_exec_info required: true source: $.http.body.rules[].rule_exec_info type: object - name: timezone required: false source: $.http.body.rules[].tzone type: string - name: name required: true source: $.http.body.rules[].name type: string is_expand: true type: object is_expand: true name: rules required: true source: $.http.body.rules[] sub_type: object type: array plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id lang: $.http.body.lang rules: $.http.body.rules[] response_cookie: [] response_header: [] response_rule: rule_ids: $.rpc.output.rule_ids x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /optimizer/rule/get/: get: operationId: Optimizer Rule Get parameters: - description: '' in: query name: advertiser_id required: true schema: nullable: false 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: rule_ids required: true schema: items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.rule_ids 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get rules by rule IDs. [Optimizer Rule Get](https://business-api.tiktok.com/portal/docs?id=1738768750822466) tags: - Automated_Rules x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - children: - type: string is_expand: true name: rule_ids required: true source: $.http.query.rule_ids[] sub_type: string type: array plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id rule_ids: $.http.query.rule_ids[] response_cookie: [] response_header: [] response_rule: page_info: $.rpc.output.page_info rules: $.rpc.output.rules x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /optimizer/rule/list/: get: operationId: Optimizer Rule 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: filtering required: false schema: $ref: ./openapi.yaml#/definitions/FilteringOptimizerRuleList x-open-field-id: 2 - description: '' in: query name: tzone required: false schema: default: UTC nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.tzone x-open-field-id: 3 - description: '' in: query name: page required: false schema: default: 1 format: int64 nullable: false 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 nullable: false 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get rules based on the values of certain filters. [Optimizer Rule List](https://business-api.tiktok.com/portal/docs?id=1738768861976578) tags: - Automated_Rules x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - children: - name: status required: false type: string - children: - type: string is_expand: true name: rule_info required: false sub_type: string type: array - name: data_dimension required: false type: string - name: action required: false type: string - children: - type: string is_expand: true name: time required: false sub_type: string type: array is_expand: true name: filtering required: false source: $.http.query.filtering type: object - name: tzone required: false source: $.http.query.tzone type: string - name: page required: false source: $.http.query.page type: number - name: page_size required: false source: $.http.query.page_size type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id filtering: $.http.query.filtering page: $.http.query.page page_size: $.http.query.page_size tzone: $.http.query.tzone response_cookie: [] response_header: [] response_rule: page_info: $.rpc.output.page_info rules: $.rpc.output.rules x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /optimizer/rule/result/get/: get: operationId: Optimizer Rule Result Get parameters: - description: '' in: query name: advertiser_id required: true schema: nullable: false 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: result_detail required: true schema: items: nullable: false properties: exec_id: description: '' nullable: false 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.query.result_detail[].exec_id rule_id: description: '' nullable: false 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.result_detail[].rule_id required: - rule_id - exec_id type: object x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.result_detail x-open-field-id: 2 - description: '' in: query name: lang required: false schema: default: EN nullable: false 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: EN value: EN - description: '' is_valid: true key: ZH value: ZH - description: '' is_valid: true key: JA value: JA key_format: string strict: true use_part: false validate_only: false value_format: string x-open-source: $.http.query.lang 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get result details. [Optimizer Rule Result Get](https://business-api.tiktok.com/portal/docs?id=1738769098314754) tags: - Automated_Rules 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: lang required: false source: $.http.query.lang type: string - children: - children: - name: rule_id required: true type: number - name: exec_id required: true type: number is_expand: true type: object is_expand: true name: result_detail required: true source: $.http.query.result_detail[] sub_type: object type: array plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id lang: $.http.query.lang result_detail: $.http.query.result_detail[] response_cookie: [] response_header: [] response_rule: result_details: $.rpc.output.result_details x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /optimizer/rule/result/list/: get: operationId: Optimizer Rule Result 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: filtering required: false schema: $ref: ./openapi.yaml#/definitions/FilteringOptimizerRuleResultList x-open-field-id: 2 - description: '' in: query name: lang required: false schema: default: EN nullable: false 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: EN value: EN - description: '' is_valid: true key: ZH value: ZH - description: '' is_valid: true key: JA value: JA key_format: string strict: true use_part: false validate_only: false value_format: string x-open-source: $.http.query.lang x-open-field-id: 3 - description: '' in: query name: page required: false schema: default: 1 format: int64 nullable: false 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 nullable: false 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get rule results. [Optimizer Rule Result List](https://business-api.tiktok.com/portal/docs?id=1738769076676609) tags: - Automated_Rules x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - children: - name: status required: false type: string - children: - type: string is_expand: true name: rule_info required: false sub_type: string type: array - name: data_dimension required: false type: string - name: action required: false type: string - children: - type: string is_expand: true name: time required: false sub_type: string type: array is_expand: true name: filtering required: false source: $.http.query.filtering type: object - name: lang required: false source: $.http.query.lang type: string - name: page required: false source: $.http.query.page type: number - name: page_size required: false source: $.http.query.page_size type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id filtering: $.http.query.filtering lang: $.http.query.lang page: $.http.query.page page_size: $.http.query.page_size response_cookie: [] response_header: [] response_rule: page_info: $.rpc.output.page_info rules: $.rpc.output.rules x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /optimizer/rule/update/: post: operationId: Optimizer Rule 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: '' nullable: false 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 lang: default: EN description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.lang rules: description: '' items: nullable: false properties: actions: description: '' items: nullable: false properties: action_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804143435530241 enum_package_name: AutoRuleActionType enums: - description: '' is_valid: true key: ADJUST_TO value: '3' - description: '' is_valid: true key: DECREASE value: '2' - description: '' is_valid: true key: DEFAULT value: '0' - description: '' is_valid: true key: INCREASE value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 2 x-open-source: $.http.body.rules[].actions[].action_type frequency_info: description: '' nullable: false properties: count: description: '' format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.rules[].actions[].frequency_info.count custom_frequency_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804143747245057 enum_package_name: AutoRuleActionCustomFreType enums: - description: '' is_valid: true key: N_DAY_Y_TIMES value: '3' - description: '' is_valid: true key: N_HOUR_Y_TIMES value: '2' - description: '' is_valid: true key: N_MINTUE_Y_TIMES value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 2 x-open-source: $.http.body.rules[].actions[].frequency_info.custom_frequency_type time: description: '' format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.rules[].actions[].frequency_info.time type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804143659529218 enum_package_name: AutoRuleActionFreType enums: - description: '' is_valid: true key: CUSTOM value: '5' - description: '' is_valid: true key: ONCE_IN_1_W value: '4' - description: '' is_valid: true key: ONCE_IN_24_H value: '2' - description: '' is_valid: true key: ONCE_IN_48_H value: '3' - description: '' is_valid: true key: ONLY_ONCE value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 1 x-open-source: $.http.body.rules[].actions[].frequency_info.type required: - type type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.body.rules[].actions[].frequency_info subject_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804143361340417 enum_package_name: AutoRuleActionSubType enums: - description: '' is_valid: true key: BID value: '6' - description: '' is_valid: true key: DAILY_BUDGET value: '4' - description: '' is_valid: true key: LIFETIME_BUDGET value: '5' - description: '' is_valid: true key: MESSAGE value: '3' - description: '' is_valid: true key: TURN_OFF value: '2' - description: '' is_valid: true key: TURN_ON value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 1 x-open-source: $.http.body.rules[].actions[].subject_type value: description: '' nullable: false properties: limit: description: '' format: float nullable: false type: number x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.rules[].actions[].value.limit use_limit: description: '' nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.rules[].actions[].value.use_limit value: description: '' format: float nullable: false type: number x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.rules[].actions[].value.value type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.rules[].actions[].value value_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804143484688450 enum_package_name: AutoRuleActionValType enums: - description: '' is_valid: true key: EXACT value: '0' - description: '' is_valid: true key: PERCENT 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.rules[].actions[].value_type required: - subject_type type: object x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.rules[].actions apply_objects: description: '' items: nullable: false properties: bind_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804046212921409 enum_package_name: AutoRuleBindType enums: - description: '' is_valid: true key: BIND value: '1' - description: '' is_valid: true key: UNBIND value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 4 dimension: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803155537096705 enum_package_name: AutoRuleDimension enums: - description: '' is_valid: true key: AD value: '3' - description: '' is_valid: true key: ADGROUP value: '2' - description: '' is_valid: true key: CAMPAIGN value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 1 x-open-source: $.http.body.rules[].apply_objects[].dimension dimension_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.rules[].apply_objects[].dimension_ids pre_condition_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804046697548801 enum_package_name: AutoRulePreCondition enums: - description: '' is_valid: true key: ALL_ACTIVE_AD value: '3' - description: '' is_valid: true key: ALL_ACTIVE_AD_GROUP value: '2' - description: '' is_valid: true key: ALL_ACTIVE_AD_GROUP_UNDER_SELECTED value: '4' - description: '' is_valid: true key: ALL_ACTIVE_AD_UNDER_SELECTED value: '5' - description: '' is_valid: true key: ALL_ACTIVE_CAMPAIGN value: '1' - description: '' is_valid: true key: ALL_INACTIVE_AD value: '8' - description: '' is_valid: true key: ALL_INACTIVE_AD_GROUP value: '7' - description: '' is_valid: true key: ALL_INACTIVE_AD_GROUP_UNDER_SELECTED value: '9' - description: '' is_valid: true key: ALL_INACTIVE_AD_UNDER_SELECTED value: '10' - description: '' is_valid: true key: ALL_INACTIVE_CAMPAIGN value: '6' - description: '' is_valid: true key: SELECTED value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 3 x-open-source: $.http.body.rules[].apply_objects[].pre_condition_type required: - dimension - pre_condition_type type: object x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.rules[].apply_objects conditions: description: '' items: nullable: false properties: calculation_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804138653195266 enum_package_name: AutoRuleConCalType enums: - description: '' is_valid: true key: ALL_OBJECTS value: '1' - description: '' is_valid: true key: DEFAULT value: '0' - description: '' is_valid: true key: OF_EACH_OBJECT 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.rules[].conditions[].calculation_type match_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804138589004802 enum_package_name: AutoRuleConMatchType enums: - description: '' is_valid: true key: BETWEEN value: '3' - description: '' is_valid: true key: CONTAINS value: '5' - description: '' is_valid: true key: DEFAULT value: '0' - description: '' is_valid: true key: END_WITH value: '8' - description: '' is_valid: true key: GT value: '1' - description: '' is_valid: true key: LT value: '2' - description: '' is_valid: true key: MATCH value: '4' - description: '' is_valid: true key: NOT_CONTAINS value: '6' - description: '' is_valid: true key: START_WITH value: '7' - description: '' is_valid: true key: STRING_EQUAL value: '9' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 3 x-open-source: $.http.body.rules[].conditions[].match_type range_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804138466724866 enum_package_name: AutoRuleConRangeType enums: - description: '' is_valid: true key: DEFAULT value: '0' - description: '' is_valid: true key: LAST_HOUR value: '3' - description: '' is_valid: true key: LIFETIME value: '7' - description: '' is_valid: true key: PAST_FIVE_DAYS value: '5' - description: '' is_valid: true key: PAST_SEVEN_DAYS value: '6' - description: '' is_valid: true key: PAST_THREE_DAYS value: '4' - description: '' is_valid: true key: TODAY value: '1' - description: '' is_valid: true key: YESTERDAY value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 2 x-open-source: $.http.body.rules[].conditions[].range_type subject_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804138278373442 enum_package_name: AutoRuleConSubjectType enums: - description: '' is_valid: true key: BID_STRATEGY value: '17' - description: '' is_valid: true key: CLICK value: '5' - description: '' is_valid: true key: CONVERSION value: '6' - description: '' is_valid: true key: CONVERSION_SKAN value: '7' - description: '' is_valid: true key: COST value: '1' - description: '' is_valid: true key: COST_PER_RESULT value: '14' - description: '' is_valid: true key: CPA value: '10' - description: '' is_valid: true key: CPC value: '12' - description: '' is_valid: true key: CPM value: '11' - description: '' is_valid: true key: CTR value: '13' - description: '' is_valid: true key: CVR value: '8' - description: '' is_valid: true key: CVR_IMPRESSION value: '31' - description: '' is_valid: true key: CVR_SKAN value: '9' - description: '' is_valid: true key: DAILY_BUDGET_SPENDING_RATE value: '2' - description: '' is_valid: true key: DAYS_SINCE_CREATION value: '21' - description: '' is_valid: true key: IMPRESSION value: '4' - description: '' is_valid: true key: LIFETIME_BUDGET_SPENDING_RATE value: '3' - description: '' is_valid: true key: NAME value: '20' - description: '' is_valid: true key: NOT_REAL_TIME_CONVERSION value: '29' - description: '' is_valid: true key: NOT_REAL_TIME_CPA value: '28' - description: '' is_valid: true key: NOT_REAL_TIME_CVR value: '30' - description: '' is_valid: true key: NO_CONDITION value: '22' - description: '' is_valid: true key: OBJECTIVE value: '19' - description: '' is_valid: true key: OPTIMIZATION_GOAL value: '18' - description: '' is_valid: true key: REAL_TIME_CVR_IMPRESSION value: '32' - description: '' is_valid: true key: RESULT value: '15' - description: '' is_valid: true key: RESULT_RATE value: '16' - description: '' is_valid: true key: ROAS_COMPLETE_PAYMENT value: '26' - description: '' is_valid: true key: ROAS_IMPRESSION_ADS value: '24' - description: '' is_valid: true key: ROAS_PURCHASE value: '23' - description: '' is_valid: true key: ROAS_PURCHASES_ONSITE value: '27' - description: '' is_valid: true key: ROAS_PURCHASE_SKAN value: '25' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 1 x-open-source: $.http.body.rules[].conditions[].subject_type values: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.rules[].conditions[].values required: - subject_type type: object x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.rules[].conditions name: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 x-open-source: $.http.body.rules[].name notification: description: '' nullable: false properties: email_setting: description: '' nullable: false properties: email_exec_time: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.rules[].notification.email_setting.email_exec_time mute_option: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804145270824961 enum_package_name: AutoRuleNotificationMute enums: - description: '' is_valid: true key: MUTE value: '1' - description: '' is_valid: true key: UNMUTE 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.rules[].notification.email_setting.mute_option no_result_notification: description: '' nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.rules[].notification.email_setting.no_result_notification notification_period: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804145204444161 enum_package_name: AutoRuleNotificationPeriod enums: - description: '' is_valid: true key: EVERY_TIME value: '0' - description: '' is_valid: true key: TIME_SCHEDULE value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 1 x-open-source: $.http.body.rules[].notification.email_setting.notification_period type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.rules[].notification.email_setting notification_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804145138016257 enum_package_name: AutoRuleNotificationType enums: - description: '' is_valid: true key: ANY_CHANGES value: '2' - description: '' is_valid: true key: NOT_NOTIFICATION value: '0' - description: '' is_valid: true key: TASK_FINISH value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 1 x-open-source: $.http.body.rules[].notification.notification_type required: - notification_type type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.rules[].notification rule_exec_info: description: '' nullable: false properties: exec_time: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.rules[].rule_exec_info.exec_time exec_time_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804144962966529 enum_package_name: AutoRuleExeTimeType enums: - description: '' is_valid: true key: CUSTOM value: '2' - description: '' is_valid: true key: HALF_HOUR_IN_SPECIFIC_TIME_PERIOD value: '3' - description: '' is_valid: true key: PER_HALF_HOUR value: '1' - description: '' is_valid: true key: SPECIFIC_TIME_ACCURATE_ONCE value: '5' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 1 x-open-source: $.http.body.rules[].rule_exec_info.exec_time_type time_period_info: description: '' items: nullable: false properties: date_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804145051616258 enum_package_name: AutoRuleDateType enums: - description: '' is_valid: true key: DAY value: '1' - description: '' is_valid: true key: MONTH value: '3' - description: '' is_valid: true key: WEEK 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.rules[].rule_exec_info.time_period_info[].date_type end_time: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.rules[].rule_exec_info.time_period_info[].end_time num: description: '' items: format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.rules[].rule_exec_info.time_period_info[].num start_time: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.rules[].rule_exec_info.time_period_info[].start_time required: - num - start_time - end_time - date_type type: object x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.rules[].rule_exec_info.time_period_info required: - exec_time_type type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.body.rules[].rule_exec_info rule_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 8 x-open-source: $.http.body.rules[].rule_id tzone: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.body.rules[].timezone required: - apply_objects - conditions - actions - notification - rule_exec_info - name - rule_id type: object x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.rules required: - advertiser_id - rules 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Update an automated rule. [Optimizer Rule Update](https://business-api.tiktok.com/portal/docs?id=1738769123170306) tags: - Automated_Rules 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: lang required: false source: $.http.body.lang type: string - children: - children: - children: - children: - name: dimension required: true type: number - children: - type: number is_expand: true name: dimension_ids required: false sub_type: number type: array - name: pre_condition_type required: true type: number is_expand: true type: object is_expand: true name: apply_objects required: true sub_type: object type: array - children: - children: - name: subject_type required: true type: number - name: range_type required: false type: number - name: match_type required: false type: number - children: - type: string is_expand: true name: values required: false sub_type: string type: array - name: calculation_type required: false type: number is_expand: true type: object is_expand: true name: conditions required: true sub_type: object type: array - children: - children: - name: subject_type required: true type: number - name: action_type required: false type: number - name: value_type required: false type: number - children: - name: value required: false type: number - name: use_limit required: false type: boolean - name: limit required: false type: number is_expand: true name: value required: false type: object - children: - name: type required: true type: number - name: custom_frequency_type required: false type: number - name: time required: false type: number - name: count required: false type: number is_expand: true name: frequency_info required: false type: object is_expand: true type: object is_expand: true name: actions required: true sub_type: object type: array - children: - name: notification_type required: true type: number - children: - name: notification_period required: false type: number - children: - type: string is_expand: true name: email_exec_time required: false sub_type: string type: array - name: no_result_notification required: false type: boolean - name: mute_option required: false type: number is_expand: true name: email_setting required: false type: object is_expand: true name: notification required: true type: object - children: - name: exec_time_type required: true type: number - name: exec_time required: false type: string - children: - children: - children: - type: number is_expand: true name: num required: true sub_type: number type: array - name: start_time required: true type: string - name: end_time required: true type: string - name: date_type required: true type: number is_expand: true type: object is_expand: true name: time_period_info required: false sub_type: object type: array is_expand: true name: rule_exec_info required: true type: object - name: timezone required: false type: string - name: name required: true type: string - name: rule_id required: false type: string is_expand: true type: object is_expand: true name: rules required: true source: $.http.body.rules[] sub_type: object type: array plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id lang: $.http.body.lang rules: $.http.body.rules[] response_cookie: [] response_header: [] response_rule: rule_ids: $.rpc.output.rule_ids x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /pangle_audience_package/get/: get: operationId: Pangle_audience_package Get parameters: - description: '' in: query name: advertiser_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get the Pangle audience packages. [Pangle Audience Package Get](https://business-api.tiktok.com/portal/docs?id=1740040177229826) tags: - Account Management x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id response_cookie: [] response_header: [] response_rule: packages[][]: - bind_type: $.rpc.output.packages[].bind_type package_id: $.rpc.output.packages[].package_id package_name: $.rpc.output.packages[].package_name x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /pangle_block_list/get/: get: operationId: Pangle_block_list Get parameters: - description: '' in: query name: advertiser_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.advertiser_id x-open-field-id: 1 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get the Pangle block list. [Pangle Block List Get](https://business-api.tiktok.com/portal/docs?id=1740039957181441) tags: - Account Management x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id response_cookie: [] response_header: [] response_rule: app_list: $.rpc.output.app_list app_package_id: $.rpc.output.app_package_id modify_time: $.rpc.output.modify_time x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /pangle_block_list/update/: post: operationId: Pangle_block_list 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: add_app_list: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 advertiser_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 clear_old_app: default: 'False' description: '' nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 delete_app_list: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 required: - advertiser_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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Update the Pangle block list. [Pangle Block List Update](https://business-api.tiktok.com/portal/docs?id=1740040139110466) tags: - Account Management 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: string is_expand: true name: add_app_list required: false source: $.http.body.add_app_list[] sub_type: string type: array - children: - type: string is_expand: true name: delete_app_list required: false source: $.http.body.delete_app_list[] sub_type: string type: array - name: clear_old_app required: false source: $.http.body.clear_old_app type: boolean plugins: after_response: [] before_request: [] request_query_rule: null request_rule: add_app_list: $.http.body.add_app_list[] advertiser_id: $.http.body.advertiser_id clear_old_app: $.http.body.clear_old_app delete_app_list: $.http.body.delete_app_list[] response_cookie: [] response_header: [] response_rule: success_count: $.rpc.output.success_count x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /pixel/create/: post: operationId: Pixel 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: '' nullable: false 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 partner_name: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.partner_name pixel_category: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1802417609811970 enum_package_name: PixelCategory enums: - description: '' is_valid: true key: CONTACTS value: '3' - description: '' is_valid: true key: CUSTOMIZE_EVENTS value: '5' - description: '' is_valid: true key: FILLING_FORM value: '2' - description: '' is_valid: true key: LANDING_PAGE value: '4' - description: '' is_valid: true key: ONLINE_STORE 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.pixel_category pixel_name: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.pixel_name x-open-validate: - error_msg: pixel_name cannot be empty. expr: len(%s) > 0 required: - advertiser_id - pixel_name 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Create a Pixel. [Pixel Create](https://business-api.tiktok.com/portal/docs?id=1740858779758593) tags: - Measurement 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: pixel_name required: true source: $.http.body.pixel_name type: string - name: pixel_category required: false source: $.http.body.pixel_category type: number - name: partner_name required: false source: $.http.body.partner_name type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id partner_name: $.http.body.partner_name pixel_category: $.http.body.pixel_category pixel_name: $.http.body.pixel_name response_cookie: [] response_header: [] response_rule: advanced_matching_fields: $.rpc.output.advanced_matching_fields partner_name: $.rpc.output.partner_name pixel_category: $.rpc.output.pixel_category pixel_code: $.rpc.output.pixel_code pixel_id: $.rpc.output.pixel_id pixel_name: $.rpc.output.pixel_name x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /pixel/event/create/: post: operationId: Pixel Event 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: '' nullable: false 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.AdvID pixel_events: description: '' items: nullable: false properties: currency: description: '' nullable: false 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: USD value: '0' - description: '' is_valid: true key: JPY value: '1' - description: '' is_valid: true key: INR value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 6 x-open-source: $.http.body.Events[].Currency currency_value: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 x-open-source: $.http.body.Events[].CurrencyValue event_code: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.Events[].PixelEventCode event_id: description: '' nullable: false 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.Events[].PixelEventID event_name: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 8 x-open-source: $.http.body.Events[].EventName event_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1803595545929730 enum_package_name: PixelEventType enums: - description: '' is_valid: true key: ADD_BILLING value: '266' - description: '' is_valid: true key: BUTTON value: '5' - description: '' is_valid: true key: CONSULT value: '97' - description: '[DEPRECATED] use button instead' is_valid: true key: DOWNLOAD_BUTTON value: '155' - description: '[DEPRECATED] use on_web_detail instead' is_valid: true key: DOWNLOAD_DETAIL value: '154' - description: '' is_valid: true key: DOWNLOAD_START value: '9' - description: '' is_valid: true key: FORM value: '2' - description: '[DEPRECATED] use button instead' is_valid: true key: FORM_BUTTON value: '151' - description: '[DEPRECATED] use on_web_detail instead' is_valid: true key: FORM_DETAIL value: '150' - description: '' is_valid: true key: INITIATE_ORDER value: '267' - description: '' is_valid: true key: ON_WEB_ADD_TO_WISHLIST value: '269' - description: '' is_valid: true key: ON_WEB_CART value: '147' - description: '' is_valid: true key: ON_WEB_DETAIL value: '146' - description: '' is_valid: true key: ON_WEB_ORDER value: '148' - description: '' is_valid: true key: ON_WEB_REGISTER value: '145' - description: '' is_valid: true key: ON_WEB_SEARCH value: '268' - description: '' is_valid: true key: ON_WEB_SUBSCRIBE value: '270' - description: '' is_valid: true key: PAGE_VIEW value: '93' - description: '[DEPRECATED] use consult insteam' is_valid: true key: PHONE value: '1' - description: '[DEPRECATED] use button instead' is_valid: true key: PHONE_BUTTON value: '153' - description: '[DEPRECATED] use on_web_detail instead' is_valid: true key: PHONE_DETAIL value: '152' - description: '' is_valid: true key: SHOPPING value: '96' - description: '' is_valid: true key: VIEW value: '7' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 3 x-open-source: $.http.body.Events[].EventType rules: description: '' items: nullable: false properties: operator: description: '' nullable: false 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: OPERATORTYPE_CONTAINS value: '0' - description: '' is_valid: true key: OPERATORTYPE_EQUALS value: '1' - description: '' is_valid: true key: OPERATORTYPE_DOES_NOT_EQUAL value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 1 x-open-source: $.http.body.Events[].PixelRules[].Operator trigger: description: '' nullable: false 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: TRIGGERTYPE_CLICK value: '0' - description: '' is_valid: true key: TRIGGERTYPE_PAGEVIEW value: '1' - description: '' is_valid: true key: TRIGGERTYPE_ELEMENT_SHOW value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 2 x-open-source: $.http.body.Events[].PixelRules[].Trigger value: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.Events[].PixelRules[].Value variable: description: '' nullable: false 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: PAGE_URL value: '9' - description: '' is_valid: true key: PAGE_HOSTNAME value: '10' - description: '' is_valid: true key: PAGE_PATH value: '11' - description: '' is_valid: true key: ELEMENT value: '13' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 4 x-open-source: $.http.body.Events[].PixelRules[].Variable required: - operator - trigger - value - variable type: object x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.body.Events[].PixelRules statistic_type: description: '' nullable: false 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: ONCE value: '2' - description: '' is_valid: true key: EVERY_TIME value: '4' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 4 x-open-source: $.http.body.Events[].PixelEventStatisticType type: object x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.Events pixel_id: description: '' nullable: false 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.PixelID required: - advertiser_id - pixel_id - pixel_events 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Choose either an industry or custom template to define your events. [Pixel Event Create](https://business-api.tiktok.com/portal/docs?id=1740858807646209) tags: - Measurement x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: AdvID required: true source: $.http.body.advertiser_id type: number - name: PixelID required: true source: $.http.body.pixel_id type: number - children: - children: - name: PixelEventID required: false source: $.http.body.pixel_events[].event_id type: number - name: PixelEventCode required: false source: $.http.body.pixel_events[].event_code type: string - name: EventType required: false source: $.http.body.pixel_events[].event_type type: number - name: PixelEventStatisticType required: false source: $.http.body.pixel_events[].statistic_type type: number - children: - children: - name: Operator required: true source: $.http.body.pixel_events[].rules[].operator type: number - name: Trigger required: true source: $.http.body.pixel_events[].rules[].trigger type: number - name: Value required: true source: $.http.body.pixel_events[].rules[].value type: string - name: Variable required: true source: $.http.body.pixel_events[].rules[].variable type: number is_expand: true type: object is_expand: true name: PixelRules required: false source: '' sub_type: object type: array - name: Currency required: false source: $.http.body.pixel_events[].currency type: number - name: CurrencyValue required: false source: $.http.body.pixel_events[].currency_value type: string - name: EventName required: false source: $.http.body.pixel_events[].event_name type: string is_expand: true type: object is_expand: true name: Events required: true source: '' sub_type: object type: array plugins: after_response: [] before_request: [] request_query_rule: null request_rule: AdvID: $.http.body.advertiser_id Events[][]: - Currency: $.http.body.pixel_events[].currency CurrencyValue: $.http.body.pixel_events[].currency_value EventName: $.http.body.pixel_events[].event_name EventType: $.http.body.pixel_events[].event_type PixelEventCode: $.http.body.pixel_events[].event_code PixelEventID: $.http.body.pixel_events[].event_id PixelEventStatisticType: $.http.body.pixel_events[].statistic_type PixelRules[][]: - Operator: $.http.body.pixel_events[].rules[].operator Trigger: $.http.body.pixel_events[].rules[].trigger Value: $.http.body.pixel_events[].rules[].value Variable: $.http.body.pixel_events[].rules[].variable PixelID: $.http.body.pixel_id response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /pixel/event/delete/: post: operationId: Pixel Event 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: '' nullable: false 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.AdvID event_id: description: '' nullable: false 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.PixelEventID required: - advertiser_id - event_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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Delete Pixel events. [Pixel Event Delete](https://business-api.tiktok.com/portal/docs?id=1740858862104578) tags: - Measurement x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: AdvID required: true source: $.http.body.advertiser_id type: number - name: PixelEventID required: true source: $.http.body.event_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: AdvID: $.http.body.advertiser_id PixelEventID: $.http.body.event_id response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /pixel/event/stats/: get: operationId: Pixel Event Stats parameters: - description: '' in: query name: advertiser_id required: true schema: nullable: false 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: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.pixel_ids description: '' in: query name: pixel_ids required: true x-open-field-id: 2 - content: application/json: schema: nullable: false properties: end_date: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.query.date_range.end_date start_date: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.query.date_range.start_date required: - start_date - end_date type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.date_range description: '' in: query name: date_range 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: View statistics of an event data over a period of time. [Pixel Event Stats](https://business-api.tiktok.com/portal/docs?id=1740858904557570) tags: - Measurement x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - children: - type: number is_expand: true name: pixel_ids required: true source: $.http.query.pixel_ids[] sub_type: number type: array - children: - name: start_date required: true source: $.http.query.date_range.start_date type: string - name: end_date required: true source: $.http.query.date_range.end_date type: string is_expand: true name: date_range required: true source: $.http.query.date_range type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id date_range: $.http.query.date_range pixel_ids: $.http.query.pixel_ids[] response_cookie: [] response_header: [] response_rule: list: $.rpc.output.data x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /pixel/event/update/: post: operationId: Pixel Event 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: '' nullable: false 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.AdvID currency: description: '' nullable: false 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: USD value: '0' - description: '' is_valid: true key: JPY value: '1' - description: '' is_valid: true key: INR 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.Currency currency_value: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.body.CurrencyValue event_id: description: '' nullable: false 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.PixelEventID event_name: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.PixelEventName required: - advertiser_id - event_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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Update the name of a Pixel event and the conversion value. [Pixel Event Update](https://business-api.tiktok.com/portal/docs?id=1740858823774210) tags: - Measurement x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: AdvID required: true source: $.http.body.advertiser_id type: number - name: PixelEventID required: true source: $.http.body.event_id type: number - name: PixelEventName required: false source: $.http.body.event_name type: string - name: Currency required: false source: $.http.body.currency type: number - name: CurrencyValue required: false source: $.http.body.currency_value type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: AdvID: $.http.body.advertiser_id Currency: $.http.body.currency CurrencyValue: $.http.body.currency_value PixelEventID: $.http.body.event_id PixelEventName: $.http.body.event_name response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /pixel/list/: get: operationId: Pixel List parameters: - description: '' in: query name: advertiser_id required: true schema: nullable: false 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: pixel_id required: false schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.pixel_id x-open-field-id: 2 - description: '' in: query name: code required: false schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.code x-open-field-id: 3 - description: '' in: query name: name required: false schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.name x-open-field-id: 4 - description: '' in: query name: order_by required: false schema: default: EARLIEST_CREATE nullable: false 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: LATEST_CREATE value: '0' - description: '' is_valid: true key: EARLIEST_CREATE value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.order_by x-open-field-id: 5 - content: application/json: schema: nullable: false properties: available_for_catalog_only: default: false description: '' nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.query.filtering.available_for_catalog_only 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: 6 - description: '' in: query name: page required: false schema: format: int64 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page x-open-field-id: 7 - description: '' in: query name: page_size required: false schema: format: int64 maximum: 20 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page_size x-open-field-id: 8 - 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Obtain a list of Pixel information. [Pixel List](https://business-api.tiktok.com/portal/docs?id=1740858697598978) tags: - Measurement 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: pixel_id required: false source: $.http.query.pixel_id type: number - name: code required: false source: $.http.query.code type: string - name: name required: false source: $.http.query.name type: string - name: order_by required: false source: $.http.query.order_by type: number - children: - name: available_for_catalog_only required: false source: $.http.query.filtering.available_for_catalog_only type: boolean name: filtering required: false source: $.http.query.filtering type: object - name: page required: false source: $.http.query.page type: number - name: page_size required: false source: $.http.query.page_size type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id code: $.http.query.code filtering: $.http.query.filtering name: $.http.query.name order_by: $.http.query.order_by page: $.http.query.page page_size: $.http.query.page_size pixel_id: $.http.query.pixel_id response_cookie: [] response_header: [] response_rule: page_info: $.rpc.output.page_info pixels: $.rpc.output.pixels x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /pixel/update/: post: operationId: Pixel 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: advanced_matching_fields: description: '' nullable: false properties: email: default: true description: '' nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 phone_number: default: true description: '' nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - '%s["phone_number"] ? %s["email"] ? {"2": true, "1": true} : {"2": true, "1": false} : %s["email"] ? {"2": false, "1": true} : {"2": false, "1": false}' x-open-field-id: 4 x-open-source: $.http.body.AMStatus advertiser_id: description: '' nullable: false 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.AdvID pixel_id: description: '' nullable: false 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.PixelID pixel_name: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.Name required: - advertiser_id - pixel_id - pixel_name 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Update a Pixel. [Pixel Update](https://business-api.tiktok.com/portal/docs?id=1740858799524865) tags: - Measurement x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: AdvID required: true source: $.http.body.advertiser_id type: number - name: PixelID required: true source: $.http.body.pixel_id type: number - name: Name required: true source: $.http.body.pixel_name type: string - children: - type: boolean is_expand: true name: AMStatus required: false source: $.http.body.advanced_matching_fields sub_type: boolean type: dict - name: CoreUserID required: false source: $.context.core_user_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: AMStatus: $.http.body.advanced_matching_fields AdvID: $.http.body.advertiser_id CoreUserID: $.context.core_user_id Name: $.http.body.pixel_name PixelID: $.http.body.pixel_id response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /playable/delete/: post: operationId: Playable 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: '' nullable: false 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 playable_id: description: '' nullable: false 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.playable_id required: - advertiser_id - playable_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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Delete a playable ad. [Playable Delete](https://business-api.tiktok.com/portal/docs?id=1737733368940546) tags: - Creative Management 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: playable_id required: true source: $.http.body.playable_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id playable_id: $.http.body.playable_id response_cookie: [] response_header: [] response_rule: playable_id: $.rpc.output.playable_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /playable/get/: get: operationId: Playable Get parameters: - description: '' in: query name: advertiser_id required: true schema: nullable: false 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: playable_id required: false schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.playable_id x-open-field-id: 2 - description: '' in: query name: playable_url required: false schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.playable_url x-open-field-id: 3 - description: '' in: query name: playable_name required: false schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.playable_name x-open-field-id: 4 - description: '' in: query name: status required: false schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1801609276794881 enum_package_name: PlayableStatus enums: - description: '' is_valid: true key: AUDIT_FAIL value: '3' - description: '' is_valid: true key: AUDIT_SUCCESS value: '4' - description: '' is_valid: true key: VALIDATE_FAIL value: '1' - description: '' is_valid: true key: VALIDATE_SUCCESS value: '2' - description: '' is_valid: true key: VALIDATING value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.status x-open-field-id: 5 - description: '' in: query name: operation_status required: false schema: default: SAVED nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1801609323127810 enum_package_name: PlayableOperateStatus enums: - description: '' is_valid: true key: DELETED value: '2' - description: '' is_valid: true key: SAVED value: '1' - description: '' is_valid: true key: UPLOADED value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.operation_status x-open-field-id: 6 - description: '' in: query name: page required: false schema: default: 1 format: int64 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page x-open-field-id: 7 - description: '' in: query name: page_size required: false schema: default: 10 format: int64 maximum: 500 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page_size x-open-field-id: 8 - 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Use this endpoint to get a list of playables. [Playable Get](https://business-api.tiktok.com/portal/docs?id=1737732758495234) tags: - Creative Management 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: playable_id required: false source: $.http.query.playable_id type: number - name: playable_url required: false source: $.http.query.playable_url type: string - name: playable_name required: false source: $.http.query.playable_name type: string - name: status required: false source: $.http.query.status type: number - name: operation_status required: false source: $.http.query.operation_status type: number - name: page required: false source: $.http.query.page type: number - name: page_size required: false source: $.http.query.page_size type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id operation_status: $.http.query.operation_status page: $.http.query.page page_size: $.http.query.page_size playable_id: $.http.query.playable_id playable_name: $.http.query.playable_name playable_url: $.http.query.playable_url status: $.http.query.status response_cookie: [] response_header: [] response_rule: list: $.rpc.output.playable_list page_info: $.rpc.output.page_info x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /playable/save/: post: operationId: Playable Save 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: '' nullable: false 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 playable_id: description: '' nullable: false 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.playable_id playable_name: description: '' maxLength: 20 minLength: 1 nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.playable_name required: - advertiser_id - playable_id - playable_name 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Use this endpoint to save a playable. [Playable Save](https://business-api.tiktok.com/portal/docs?id=1737732203851777) tags: - Creative Management 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: playable_id required: true source: $.http.body.playable_id type: number - name: playable_name required: true source: $.http.body.playable_name type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id playable_id: $.http.body.playable_id playable_name: $.http.body.playable_name response_cookie: [] response_header: [] response_rule: playable_id: $.rpc.output.playable_id playable_name: $.rpc.output.playable_name playable_orientation: $.rpc.output.playable_orientation playable_url: $.rpc.output.playable_url status: $.rpc.output.status x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /playable/upload/: post: operationId: Playable Upload 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: multipart/form-data: schema: properties: advertiser_id: description: '' nullable: false 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 file_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.file_id playable_package: description: '' format: binary nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.playable_package upload_type: description: '' nullable: false 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: UPLOAD_BY_FILE value: UPLOAD_BY_FILE - description: '' is_valid: true key: UPLOAD_BY_URL value: UPLOAD_BY_URL - description: '' is_valid: true key: UPLOAD_BY_FILE_ID value: UPLOAD_BY_FILE_ID - description: '' is_valid: true key: UPLOAD_BY_VIDEO_ID value: UPLOAD_BY_VIDEO_ID - description: '' is_valid: true key: UPLOAD_BY_TIKTOK_ITEM_ID value: UPLOAD_BY_TIKTOK_ITEM_ID key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 2 x-open-source: $.http.body.upload_type required: - advertiser_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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: You can use this endpoint to upload Playable Ad contents. [Playable Upload](https://business-api.tiktok.com/portal/docs?id=1737730926765057) tags: - Creative Management 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: upload_type required: false source: $.http.body.upload_type type: string - name: playable_package required: false source: $.http.body.playable_package type: string - name: file_id required: false source: $.http.body.file_id type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id file_id: $.http.body.file_id playable_package: $.http.body.playable_package upload_type: $.http.body.upload_type response_cookie: [] response_header: [] response_rule: task_id: $.rpc.output.task_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /playable/validate/: get: operationId: Playable Validate parameters: - description: '' in: query name: advertiser_id required: true schema: nullable: false 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: playable_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.playable_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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Check the status of the playable. [Playable Validate](https://business-api.tiktok.com/portal/docs?id=1737732054892545) tags: - Creative Management 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: playable_id required: true source: $.http.query.playable_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id playable_id: $.http.query.playable_id response_cookie: [] response_header: [] response_rule: fail_message: $.rpc.output.fail_message playable_id: $.rpc.output.playable_id playable_orientation: $.rpc.output.playable_orientation playable_url: $.rpc.output.playable_url status: $.rpc.output.status x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /report/integrated/get/: get: operationId: Report Integrated Get parameters: - description: '' in: query name: page required: false schema: default: 1 format: int64 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page x-open-field-id: 1 - description: '' in: query name: page_size required: false schema: default: 10 format: int64 maximum: 1000 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page_size x-open-field-id: 2 - description: '' in: query name: enable_total_metrics required: false schema: default: false nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.enable_total_metrics x-open-field-id: 3 - description: '' in: query name: multi_adv_report_in_utc_time required: false schema: default: false nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.multi_adv_report_in_utc_time x-open-field-id: 4 - description: '' in: query name: query_mode required: false schema: nullable: false 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: REGULAR value: REGULAR - description: '' is_valid: true key: CHUNK value: CHUNK key_format: string strict: true use_part: false validate_only: false value_format: string x-open-source: $.http.query.query_mode x-open-field-id: 5 - description: '' in: query name: advertiser_id required: false schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 6 - content: application/json: schema: items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false description: '' in: query name: advertiser_ids required: false x-open-field-id: 7 - description: '' in: query name: bc_id required: false schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 8 - description: '' in: query name: service_type required: false schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1805686420337666 enum_package_name: ReportServiceType enums: - description: '' is_valid: true key: AUCTION value: AUCTION - description: '' is_valid: true key: RESERVATION value: RESERVATION key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 9 - description: '' in: query name: report_type required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1807850604796929 enum_package_name: SyncReportType enums: - description: '' is_valid: true key: AUDIENCE value: AUDIENCE - description: '' is_valid: true key: BASIC value: BASIC - description: '' is_valid: true key: BC value: BC - description: '' is_valid: true key: CATALOG value: CATALOG - description: '' is_valid: true key: PLAYABLE_MATERIAL value: PLAYABLE_MATERIAL - description: '' is_valid: true key: TT_SHOP value: TT_SHOP key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 10 - description: '' in: query name: data_level required: false schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1805686341322753 enum_package_name: ReportDataLevel enums: - description: '' is_valid: true key: AUCTION_AD value: AD - description: '' is_valid: true key: AUCTION_ADGROUP value: ADGROUP - description: '' is_valid: true key: AUCTION_ADVERTISER value: ADVERTISER - description: '' is_valid: true key: AUCTION_CAMPAIGN value: CAMPAIGN - description: '' is_valid: true key: RESERVATION_AD value: AD - description: '' is_valid: true key: RESERVATION_ADGROUP value: ADGROUP - description: '' is_valid: true key: RESERVATION_ADVERTISER value: ADVERTISER - description: '' is_valid: true key: RESERVATION_CAMPAIGN value: CAMPAIGN key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 11 - content: application/json: schema: items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false description: '' in: query name: dimensions required: false x-open-field-id: 12 - content: application/json: schema: items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false description: '' in: query name: metrics required: false x-open-field-id: 13 - description: '' in: query name: start_date required: false schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 14 - description: '' in: query name: end_date required: false schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 15 - description: '' in: query name: query_lifetime required: false schema: nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 16 - description: '' in: query name: order_field required: false schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 17 - description: '' in: query name: order_type required: false schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1807850809935874 enum_package_name: ReportOrderType enums: - description: '' is_valid: true key: ASC value: '1' - description: '' is_valid: true key: DESC value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 18 - content: application/json: schema: items: nullable: false properties: field_name: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 filter_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1805686981203970 enum_package_name: ReportFilterType enums: - description: '' is_valid: true key: BETWEEN value: '1' - description: '' is_valid: true key: GREATER_EQUAL value: '8' - description: '' is_valid: true key: GREATER_THAN value: '6' - description: '' is_valid: true key: IN value: '0' - description: '' is_valid: true key: LOWER_EQUAL value: '7' - description: '' is_valid: true key: LOWER_THAN value: '5' - description: '' is_valid: true key: MATCH value: '9' - description: '' is_valid: true key: RANGE value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int64 x-open-field-id: 2 filter_value: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 required: - field_name - filter_type - filter_value type: object x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false description: '' in: query name: filtering required: false x-open-field-id: 19 - 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Run a synchronous report. [Report Integrated Get](https://business-api.tiktok.com/portal/docs?id=1740302848100353) tags: - Reporting x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - children: - name: service_type required: true source: $.http.query.service_type type: string - name: report_type required: true source: $.http.query.report_type type: string - name: data_level required: false source: $.http.query.data_level type: string - children: - type: string is_expand: true name: dimensions required: false source: $.http.query.dimensions[] sub_type: string type: array - children: - type: string is_expand: true name: metrics required: false source: $.http.query.metrics[] sub_type: string type: array - name: start_date required: false source: $.http.query.start_date type: string - name: end_date required: false source: $.http.query.end_date type: string - name: query_lifetime required: false source: $.http.query.query_lifetime type: boolean - name: order_type required: false source: $.http.query.order_type type: number - name: order_field required: false source: $.http.query.order_field type: string - children: - children: - name: field_name required: false source: $.http.query.common_report_query.filtering[].field_name type: string - name: filter_type required: false source: $.http.query.common_report_query.filtering[].filter_type type: number - name: filter_value required: false source: $.http.query.common_report_query.filtering[].filter_value type: string is_expand: true type: object is_expand: true name: filtering required: false source: $.http.query.filtering[] sub_type: object type: array - name: advertiser_id required: false source: $.http.query.advertiser_id type: number - name: bc_id required: false source: $.http.query.bc_id type: number - children: - type: number is_expand: true name: advertiser_ids required: false source: $.http.query.advertiser_ids[] sub_type: number type: array is_expand: true name: common_report_query required: true type: object - name: page required: true source: $.http.query.page type: number - name: page_size required: true source: $.http.query.page_size type: number - name: enable_total_metrics required: false source: $.http.query.enable_total_metrics type: boolean - name: multi_adv_report_in_utc_time required: false source: $.http.query.multi_adv_report_in_utc_time type: boolean - name: query_mode required: false source: $.http.query.query_mode type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: common_report_query: advertiser_id: $.http.query.advertiser_id advertiser_ids: $.http.query.advertiser_ids[] bc_id: $.http.query.bc_id data_level: $.http.query.data_level dimensions: $.http.query.dimensions[] end_date: $.http.query.end_date filtering: $.http.query.filtering[] metrics: $.http.query.metrics[] order_field: $.http.query.order_field order_type: $.http.query.order_type query_lifetime: $.http.query.query_lifetime report_type: $.http.query.report_type service_type: $.http.query.service_type start_date: $.http.query.start_date enable_total_metrics: $.http.query.enable_total_metrics multi_adv_report_in_utc_time: $.http.query.multi_adv_report_in_utc_time page: $.http.query.page page_size: $.http.query.page_size query_mode: $.http.query.query_mode response_cookie: [] response_header: [] response_rule: list: $.rpc.output.stats_data page_info: $.rpc.output.page_info total_metrics: $.rpc.output.total_metrics x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /report/task/cancel/: post: operationId: Report Task Cancel 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: '' nullable: false 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 task_id: description: '' nullable: false 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.task_id required: - task_id - advertiser_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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Cancel an asynchronous report task. [Report Task Cancel](https://business-api.tiktok.com/portal/docs?id=1803615367145537) tags: - Reporting x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: task_id required: true source: $.http.body.task_id type: number - name: advertiser_id required: false source: $.http.body.advertiser_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id task_id: $.http.body.task_id response_cookie: [] response_header: [] response_rule: message: $.rpc.output.message status: $.rpc.output.status x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /report/task/check/: get: operationId: Report Task Check parameters: - description: '' in: query name: task_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.task_id x-open-field-id: 1 - description: '' in: query name: advertiser_id required: true schema: nullable: false 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get the status of an async report task. [Report Task Check](https://business-api.tiktok.com/portal/docs?id=1740302781443073) tags: - Reporting x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: task_id required: true source: $.http.query.task_id type: number - name: advertiser_id required: false source: $.http.query.advertiser_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id task_id: $.http.query.task_id response_cookie: [] response_header: [] response_rule: message: $.rpc.output.message status: $.rpc.output.status x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /report/task/create/: post: operationId: Report Task 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: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 4 advertiser_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) maxItems: 5 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 data_level: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1805686341322753 enum_package_name: ReportDataLevel enums: - description: '' is_valid: true key: AUCTION_AD value: AUCTION_AD - description: '' is_valid: true key: AUCTION_ADGROUP value: AUCTION_ADGROUP - description: '' is_valid: true key: AUCTION_ADVERTISER value: AUCTION_ADVERTISER - description: '' is_valid: true key: AUCTION_CAMPAIGN value: AUCTION_CAMPAIGN - description: '' is_valid: true key: RESERVATION_AD value: RESERVATION_AD - description: '' is_valid: true key: RESERVATION_ADGROUP value: RESERVATION_ADGROUP - description: '' is_valid: true key: RESERVATION_ADVERTISER value: RESERVATION_ADVERTISER - description: '' is_valid: true key: RESERVATION_CAMPAIGN value: RESERVATION_CAMPAIGN key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 8 dimensions: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 9 enable_report_title_translation: default: true description: '' nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.enable_report_title_translation end_date: description: '' format: date nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 12 file_name: default: ' ' description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.file_name filtering: description: '' items: nullable: false properties: field_name: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 filter_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1805686981203970 enum_package_name: ReportFilterType enums: - description: '' is_valid: true key: BETWEEN value: '1' - description: '' is_valid: true key: GREATER_EQUAL value: '8' - description: '' is_valid: true key: GREATER_THAN value: '6' - description: '' is_valid: true key: IN value: '0' - description: '' is_valid: true key: LOWER_EQUAL value: '7' - description: '' is_valid: true key: LOWER_THAN value: '5' - description: '' is_valid: true key: MATCH value: '9' - description: '' is_valid: true key: RANGE value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int64 x-open-field-id: 2 filter_value: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 type: object x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 16 metrics: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 10 order_field: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 14 order_type: default: DESC description: '' nullable: false 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: ASC value: '0' - description: '' is_valid: true key: DESC value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int64 x-open-field-id: 15 output_format: default: CSV_STRING description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1805686656427009 enum_package_name: AsyncReportFormat enums: - description: '' is_valid: true key: CSV_DOWNLOAD value: CSV_DOWNLOAD - description: '' is_valid: true key: CSV_STRING value: CSV_STRING - description: '' is_valid: true key: XLSX_DOWNLOAD value: XLSX_DOWNLOAD key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 2 x-open-source: $.http.body.output_format query_lifetime: default: false description: '' nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 13 report_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1805686395142145 enum_package_name: AsyncReportType enums: - description: '' is_valid: true key: AUDIENCE value: AUDIENCE - description: '' is_valid: true key: BASIC value: BASIC - description: '' is_valid: true key: CATALOG value: CATALOG - description: '' is_valid: false key: PLAYABLE_MATERIAL value: PLAYABLE_MATERIAL key_format: string strict: true use_part: true validate_only: false value_format: string x-open-field-id: 7 service_type: default: AUCTION description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1805686420337666 enum_package_name: ReportServiceType enums: - description: '' is_valid: true key: AUCTION value: AUCTION - description: '' is_valid: true key: RESERVATION value: RESERVATION key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 6 start_date: description: '' format: date nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 11 required: - report_type - dimensions 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: null tags: - Reporting x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - children: - name: service_type required: true source: $.http.body.service_type type: string - name: report_type required: true source: $.http.body.report_type type: string - name: data_level required: false source: $.http.body.data_level type: string - children: - type: string is_expand: true name: dimensions required: false source: $.http.body.dimensions[] sub_type: string type: array - children: - type: string is_expand: true name: metrics required: false source: $.http.body.metrics[] sub_type: string type: array - name: start_date required: false source: $.http.body.start_date type: string - name: end_date required: false source: $.http.body.end_date type: string - name: query_lifetime required: false source: $.http.body.query_lifetime type: boolean - name: order_type required: false source: $.http.body.order_type type: number - name: order_field required: false source: $.http.body.order_field type: string - children: - children: - name: field_name required: false source: $.http.body.filtering[].field_name type: string - name: filter_type required: false source: $.http.body.filtering[].filter_type type: number - name: filter_value required: false source: $.http.body.filtering[].filter_value type: string is_expand: true type: object is_expand: true name: filtering required: false sub_type: object type: array - name: advertiser_id required: false source: $.http.body.advertiser_id type: number - children: - type: number is_expand: false name: advertiser_ids required: false source: $.http.body.advertiser_ids[] sub_type: number type: array is_expand: true name: common_report_query required: true type: object - name: enable_report_title_translation required: false source: $.http.body.enable_report_title_translation type: boolean - name: output_format required: false source: $.http.body.output_format type: string - name: file_name required: false source: $.http.body.file_name type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: common_report_query: advertiser_id: $.http.body.advertiser_id advertiser_ids: $.http.body.advertiser_ids[] data_level: $.http.body.data_level dimensions: $.http.body.dimensions[] end_date: $.http.body.end_date filtering[][]: - field_name: $.http.body.filtering[].field_name filter_type: $.http.body.filtering[].filter_type filter_value: $.http.body.filtering[].filter_value metrics: $.http.body.metrics[] order_field: $.http.body.order_field order_type: $.http.body.order_type query_lifetime: $.http.body.query_lifetime report_type: $.http.body.report_type service_type: $.http.body.service_type start_date: $.http.body.start_date enable_report_title_translation: $.http.body.enable_report_title_translation file_name: $.http.body.file_name output_format: $.http.body.output_format response_cookie: [] response_header: [] response_rule: task_id: $.rpc.output.task_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /search/region/: get: operationId: Search Region parameters: - description: Advertiser ID. in: query name: advertiser_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 - description: 'The language you want the returned region name to be translated into. Default value: en Currently, we only support zh, fr, es, ko, vi, en, hi, it, tr, ru, ja, id, de, ms, ar, and th Note: If you do not pass in one of the supported values above, it will return as the default en.' in: query name: language required: false schema: default: en nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get available locations by advertiser ID [Search Region](https://ads.tiktok.com/marketing_api/docs?id=1773644763581441) tags: - Tool x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - name: language required: false source: $.http.query.language type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id language: $.http.query.language response_cookie: [] response_header: [] response_rule: region_list[][]: - area_type: $.rpc.output.region_list[].area_type country_code: $.rpc.output.region_list[].country_code parent_id: $.rpc.output.region_list[].parent_id region_id: $.rpc.output.region_list[].region_id region_level: $.rpc.output.region_list[].region_level region_name: $.rpc.output.region_list[].region_name support_below_18: $.rpc.output.region_list[].support_below_18 x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /smart_plus/ad/appeal/: post: operationId: Smart_plus Ad Appeal 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: '' nullable: false 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 appeal_reason: description: '' maxLength: 512 nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.appeal_reason attachment_list: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.attachment_list smart_plus_ad_id: description: '' nullable: false 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.creative_id required: - advertiser_id - smart_plus_ad_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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Submit ad appeal [Smart Plus Ad Appeal] tags: - Ad 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: creative_id required: true source: $.http.body.smart_plus_ad_id type: number - name: appeal_reason required: false source: $.http.body.appeal_reason type: string - children: - type: string name: attachment_list required: false source: $.http.body.attachment_list sub_type: string type: array plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id appeal_reason: $.http.body.appeal_reason attachment_list: $.http.body.attachment_list creative_id: $.http.body.smart_plus_ad_id response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /smart_plus/ad/create/: post: operationId: Smart_plus Ad 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: ad_configuration: description: '' nullable: false properties: auto_disclaimer_types: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1827620303506497 enum_package_name: AutoDisclaimerType enums: - description: 汽车折扣 is_valid: true key: DISCOUNT value: '2' - description: 汽车排放 is_valid: true key: EMISSION value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 11 call_to_action_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 8 x-open-source: $.http.body.common_material.call_to_action_id catalog_creative_toggle: description: '' nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.body.common_material.catalog_creative_toggle dark_post_status: default: 'OFF' description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1843735142813698 enum_package_name: DarkPostStatus enums: - description: '' is_valid: true key: 'OFF' value: '2' - description: '' is_valid: true key: 'ON' value: '1' - description: '' is_valid: false key: Partly value: '3' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 15 end_card_cta: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1824616467253313 enum_package_name: EndCardCTA enums: - description: '' is_valid: true key: BOOK_NOW value: book_now - description: '' is_valid: true key: CONTACT_US value: contact_us - description: '' is_valid: true key: LEARN_MORE value: learn_more - description: '' is_valid: true key: ORDER_NOW value: order_now - description: '' is_valid: true key: READ_MORE value: read_more - description: '' is_valid: true key: SEARCH_INVENTORY value: search_inventory - description: '' is_valid: true key: SHOP_NOW value: shop_now - description: '' is_valid: true key: SIGN_UP value: sign_up - description: '' is_valid: true key: VIEW_MORE value: cta_view_more key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 9 fallback_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1810699520231426 enum_package_name: FallbackType enums: - description: '' is_valid: true key: APP_INSTALL value: '1' - description: '' is_valid: true key: UNSET value: '0' - description: '' is_valid: true key: WEBSITE value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 14 identity_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.common_material.identity_id identity_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800331041544193 enum_package_name: IdentityType enums: - description: '' is_valid: false key: AUTH_CODE value: '2' - description: '' is_valid: false key: BC_AUTH_TT value: '5' - description: '' is_valid: false key: BC_SELF_TT value: '4' - description: '' is_valid: true key: CUSTOMIZED_USER value: '1' - description: TTS 授权来源TT账号 is_valid: false key: TTS_TT value: '8' - description: '' is_valid: false 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: 1 x-open-source: $.http.body.common_material.identity_type phone_info: description: '' nullable: false properties: phone_number: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 phone_region_calling_code: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 phone_region_code: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 13 product_display_field_list: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1824616319490050 enum_package_name: ProductDisplayField enums: - description: dealer所处的城市 is_valid: true key: ADDRESS_CITY value: '10' - description: '' is_valid: false key: AREA_SIZE value: '14' - description: dealer名称 is_valid: true key: DEALER_NAME value: '1' - description: '' is_valid: false key: ESTATE_PRICE value: '17' - description: 外表颜色 is_valid: true key: EXTERIOR_COLOR value: '8' - description: 品牌 is_valid: true key: MAKE value: '2' - description: 已跑公里数 is_valid: true key: MILEAGE value: '5' - description: 型号 is_valid: true key: MODEL value: '3' - description: '' is_valid: false key: NUM_BED_AND_BATH value: '18' - description: 价格 is_valid: true key: PRICE value: '6' - description: '' is_valid: false key: PROPERTY_TYPE value: '15' - description: '' is_valid: false key: REAL_ESTATE_TITLE value: '19' - description: 折扣价格 is_valid: true key: SALE_PRICE value: '7' - description: 汽车配置 is_valid: true key: TRIM value: '9' - description: 汽车状态 is_valid: true key: VEHICLE_STATE value: '11' - description: 上市年份 is_valid: true key: YEAR value: '4' - description: '' is_valid: false key: YEAR_BUILT value: '16' key_format: string strict: true use_part: true validate_only: false value_format: int32 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 10 product_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.body.common_material.product_ids product_set_id: description: '' nullable: false 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.common_material.product_set_id product_specific_type: description: '' nullable: false 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: true 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: 3 x-open-source: $.http.body.common_material.product_specific_type tracking_info: description: '' nullable: false properties: click_tracking_url: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.common_material.tracking_info.action_track_url impression_tracking_url: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.common_material.tracking_info.track_url tracking_app_id: description: '' nullable: false 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.common_material.tracking_info.tracking_app_id tracking_message_event_set_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 4 type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 12 x-open-source: $.http.body.common_material.tracking_info utm_params: description: '' items: nullable: false properties: key: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.common_material.utms[].field value: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.common_material.utms[].value type: object x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 14 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 x-open-source: $.http.body.common_material.utms type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 13 x-open-source: $.http.body.common_material ad_name: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.ad_name ad_text_list: description: '' items: nullable: false properties: ad_text: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.title_list[].title required: - ad_text type: object x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 5 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.body.title_list adgroup_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 2 x-open-source: $.http.body.adgroup_id advertiser_id: description: '' nullable: false 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 auto_message_list: description: '' items: nullable: false properties: auto_message_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 type: object x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 12 call_to_action_list: description: '' items: nullable: false properties: call_to_action: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1807533165224961 enum_package_name: CallToAction enums: - description: '' is_valid: true key: APPLY_NOW value: apply_now - description: '' is_valid: true key: BOOK_NOW value: book_now - description: '' is_valid: true key: CALL_NOW value: call_to_action_call - description: '' is_valid: true key: CHECK_AVAILABILITY value: cta_check_availability - description: '' is_valid: true key: CONTACT_US value: contact_us - description: '' is_valid: true key: DOWNLOAD_NOW value: download_now - description: '' is_valid: true key: EXPERIENCE_NOW value: experience_now - description: '' is_valid: true key: GET_QUOTE value: get_quote - description: '' is_valid: true key: GET_SHOWTIMES value: get_showtimes - description: '' is_valid: true key: GET_TICKETS_NOW value: get_tickets_now - description: '' is_valid: true key: INSTALL_NOW value: install_now - description: '' is_valid: true key: INTERESTED value: interested - description: '' is_valid: true key: JOIN_THIS_HASHTAG value: join_this_hashtag - description: '' is_valid: true key: LEARN_MORE value: learn_more - description: '' is_valid: true key: LISTEN_NOW value: listen_now - description: '' is_valid: true key: ORDER_NOW value: order_now - description: '' is_valid: true key: PLAY_GAME value: play_game_cta - description: '' is_valid: true key: PREORDER_NOW value: preorder_now - description: '' is_valid: true key: READ_MORE value: read_more - description: '' is_valid: true key: SEND_MESSAGE value: Promote_more_messages_send_message - description: '' is_valid: true key: SHOOT_WITH_THIS_EFFECT value: shoot_with_this_effect - description: '' is_valid: true key: SHOP_NOW value: shop_now - description: '' is_valid: true key: SIGN_UP value: sign_up - description: '' is_valid: true key: SUBSCRIBE value: subscribe - description: '' is_valid: true key: VIEW_NOW value: view_now - description: '' is_valid: true key: VIEW_PROFILE value: view_profile - description: '' is_valid: true key: VIEW_VIDEO_WITH_THIS_EFFECT value: view_video_with_this_effect - description: '' is_valid: true key: VISIT_STORE value: visit_store - description: '' is_valid: true key: WATCH_LIVE value: watch_live - description: '' is_valid: true key: WATCH_NOW value: watch_now key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 1 x-open-source: $.http.body.call_to_action_list[].call_to_action required: - call_to_action type: object x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 3 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 11 x-open-source: $.http.body.call_to_action_list creative_list: description: '' items: nullable: false properties: creative_info: description: '' nullable: false properties: ad_format: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1818582044296193 enum_package_name: AdFormat enums: - description: '' is_valid: false key: CAROUSEL value: '2' - description: '' is_valid: true key: CAROUSEL_ADS value: '4' - description: '' is_valid: true key: CATALOG_CAROUSEL value: '5' - description: '' is_valid: false key: LIVE_CONTENT value: '3' - description: '' is_valid: false key: SINGLE_IMAGE value: '0' - description: '' is_valid: true key: SINGLE_VIDEO value: '1' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 9 aigc_disclosure_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1807533197774914 enum_package_name: AigcDisclosureType enums: - description: '' is_valid: true key: NOT_DECLARED value: '1' - description: '' is_valid: true key: SELF_DISCLOSURE value: '2' - description: '' is_valid: true key: UNSET value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 8 x-open-source: $.http.body.media_info_list[].media_info.aigc_disclosure_type identity_authorized_bc_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 7 x-open-source: $.http.body.media_info_list[].media_info.identity_bc_id identity_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.media_info_list[].media_info.identity_id identity_type: description: '' nullable: false 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: true key: CUSTOMIZED_USER value: '1' - description: TTS 授权来源TT账号 is_valid: false key: TTS_TT value: '8' - description: '' is_valid: true key: TT_USER value: '3' - description: '' is_valid: false key: UNSET value: '0' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 5 x-open-source: $.http.body.media_info_list[].media_info.identity_type image_info: description: '' items: nullable: false properties: web_uri: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.media_info_list[].media_info.image_info[].web_uri required: - web_uri type: object x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 35 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.media_info_list[].media_info.image_info music_info: description: '' nullable: false properties: music_id: description: '' nullable: false 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.media_info_list[].media_info.music_info.music_id required: - music_id type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.body.media_info_list[].media_info.music_info tiktok_item_id: description: '' nullable: false 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.media_info_list[].media_info.aweme_item_id video_info: description: '' nullable: false properties: file_name: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.media_info_list[].media_info.video_info.file_name video_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.media_info_list[].media_info.video_info.video_id required: - video_id type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.media_info_list[].media_info.video_info required: - ad_format type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.media_info_list[].media_info required: - creative_info type: object x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 31 minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.body.media_info_list deeplink_list: description: '' items: nullable: false properties: deeplink: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.open_url_list[].open_url deeplink_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1810700429234178 enum_package_name: DeeplinkType enums: - description: '' is_valid: true key: DEFERRED_DEEPLINK value: '2' - description: '' is_valid: true key: NORMAL value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 2 x-open-source: $.http.body.open_url_list[].auto_open type: object x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 10 x-open-source: $.http.body.open_url_list interactive_add_on_list: description: '' items: nullable: false properties: card_id: description: '' nullable: false 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.card_list[].card_id required: - card_id type: object x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 8 x-open-source: $.http.body.card_list landing_page_url_list: description: '' items: nullable: false properties: landing_page_url: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.external_url_list[].external_url type: object x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 9 x-open-source: $.http.body.external_url_list operation_status: default: ENABLE description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804192764187649 enum_package_name: OptStatus enums: - description: 暂停 is_valid: true key: DISABLE value: '1' - description: 启用 is_valid: true key: ENABLE value: '0' - description: 终止,不能再次被启用 is_valid: false key: FROZEN value: '2' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 4 x-open-source: $.http.body.opt_status page_list: description: '' items: nullable: false properties: page_id: description: '' nullable: false 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.page_list[].page_id required: - page_id type: object x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 3 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 x-open-source: $.http.body.page_list required: - advertiser_id - adgroup_id - ad_name 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Create a new ad [Smart Plus Ad Create] tags: - Ad x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.body.advertiser_id type: number - name: adgroup_id required: false source: $.http.body.adgroup_id type: number - name: ad_name required: false source: $.http.body.ad_name type: string - name: opt_status required: false source: $.http.body.operation_status type: number - children: - children: - children: - children: - children: - name: web_uri required: true source: $.http.body.creative_list[].creative_info.image_info[].web_uri type: string is_expand: true type: object is_expand: true name: image_info required: false sub_type: object type: array - children: - name: video_id required: true source: $.http.body.creative_list[].creative_info.video_info.video_id type: string - name: file_name required: false source: $.http.body.creative_list[].creative_info.video_info.file_name type: string is_expand: true name: video_info required: false type: object - name: aweme_item_id required: false source: $.http.body.creative_list[].creative_info.tiktok_item_id type: number - name: identity_id required: false source: $.http.body.creative_list[].creative_info.identity_id type: string - name: identity_type required: false source: $.http.body.creative_list[].creative_info.identity_type type: number - children: - name: music_id required: true source: $.http.body.creative_list[].creative_info.music_info.music_id type: number is_expand: true name: music_info required: false type: object - name: identity_bc_id required: false source: $.http.body.creative_list[].creative_info.identity_authorized_bc_id type: number - name: aigc_disclosure_type required: false source: $.http.body.creative_list[].creative_info.aigc_disclosure_type type: number - name: ad_format required: true source: $.http.body.creative_list[].creative_info.ad_format type: number is_expand: true name: media_info required: true type: object is_expand: true type: object is_expand: false name: media_info_list required: false sub_type: object type: array - children: - children: - name: title required: true source: $.http.body.ad_text_list[].ad_text type: string is_expand: true type: object is_expand: false name: title_list required: false sub_type: object type: array - children: - children: - name: page_id required: true source: $.http.body.page_list[].page_id type: number is_expand: true type: object is_expand: false name: page_list required: false source: $.http.body.page_list sub_type: object type: array - children: - children: - name: card_id required: true source: $.http.body.card_list[].card_id type: number is_expand: true type: object is_expand: false name: card_list required: false source: $.http.body.interactive_add_on_list sub_type: object type: array - children: - children: - name: external_url required: false source: $.http.body.landing_page_url_list[].landing_page_url type: string is_expand: true type: object is_expand: false name: external_url_list required: false sub_type: object type: array - children: - children: - name: open_url required: false source: $.http.body.deeplink_list[].deeplink type: string - name: auto_open required: false source: $.http.body.deeplink_list[].deeplink_type type: number is_expand: true type: object is_expand: false name: open_url_list required: false sub_type: object type: array - children: - children: - name: call_to_action required: true source: $.http.body.call_to_action_list[].call_to_action type: string is_expand: true type: object is_expand: false name: call_to_action_list required: false source: $.http.body.call_to_action_list sub_type: object type: array - children: - name: identity_type required: false source: $.http.body.ad_configuration.identity_type type: number - name: identity_id required: false source: $.http.body.ad_configuration.identity_id type: string - name: product_specific_type required: false source: $.http.body.ad_configuration.product_specific_type type: number - name: product_set_id required: false source: $.http.body.ad_configuration.product_set_id type: number - children: - type: number is_expand: false name: product_ids required: false source: $.http.body.ad_configuration.product_ids[] sub_type: number type: array - name: catalog_creative_toggle required: false source: $.http.body.ad_configuration.catalog_creative_toggle type: boolean - children: - children: - name: field required: false source: $.http.body.ad_configuration.utm_params[].key type: string - name: value required: false source: $.http.body.ad_configuration.utm_params[].value type: string is_expand: true type: object is_expand: false name: utms required: false sub_type: object type: array - name: call_to_action_id required: false source: $.http.body.ad_configuration.call_to_action_id type: number - is_expand: false name: end_card_cta required: false source: $.http.body.ad_configuration.end_card_cta type: string - children: - is_expand: false source: undefined type: number is_expand: false name: auto_disclaimer_type_list required: false source: $.http.body.ad_configuration.auto_disclaimer_types[] sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: false name: product_display_field_list required: false source: $.http.body.ad_configuration.product_display_field_list[] sub_type: number type: array - children: - is_expand: false name: track_url required: false source: $.http.body.ad_configuration.tracking_info.impression_tracking_url type: string - is_expand: false name: action_track_url required: false source: $.http.body.ad_configuration.tracking_info.click_tracking_url type: string - is_expand: false name: tracking_app_id required: false source: $.http.body.ad_configuration.tracking_info.tracking_app_id type: number - is_expand: false name: tracking_message_event_set_id required: false source: $.http.body.ad_configuration.tracking_info.tracking_message_event_set_id type: number is_expand: true name: tracking_info required: false type: object - is_expand: false name: phone_number required: false source: $.http.body.ad_configuration.phone_info.phone_number type: string - is_expand: false name: phone_country_code required: false source: $.http.body.ad_configuration.phone_info.phone_region_code type: string - is_expand: false name: phone_zip_code required: false source: $.http.body.ad_configuration.phone_info.phone_region_calling_code type: string - is_expand: false name: fallback_type required: false source: $.http.body.ad_configuration.fallback_type type: number - is_expand: false name: dark_post_status required: false source: $.http.body.ad_configuration.dark_post_status type: number is_expand: true name: common_material required: false type: object - children: - children: - name: auto_message_id required: true source: $.http.body.auto_message_list[].auto_message_id type: number is_expand: true type: object is_expand: true name: auto_message_list required: false sub_type: object type: array plugins: after_response: [] before_request: [] request_query_rule: null request_rule: ad_name: $.http.body.ad_name adgroup_id: $.http.body.adgroup_id advertiser_id: $.http.body.advertiser_id auto_message_list[][]: - auto_message_id: $.http.body.auto_message_list[].auto_message_id call_to_action_list: $.http.body.call_to_action_list card_list: $.http.body.interactive_add_on_list common_material: auto_disclaimer_type_list: $.http.body.ad_configuration.auto_disclaimer_types[] call_to_action_id: $.http.body.ad_configuration.call_to_action_id catalog_creative_toggle: $.http.body.ad_configuration.catalog_creative_toggle dark_post_status: $.http.body.ad_configuration.dark_post_status end_card_cta: $.http.body.ad_configuration.end_card_cta fallback_type: $.http.body.ad_configuration.fallback_type identity_id: $.http.body.ad_configuration.identity_id identity_type: $.http.body.ad_configuration.identity_type phone_country_code: $.http.body.ad_configuration.phone_info.phone_region_code phone_number: $.http.body.ad_configuration.phone_info.phone_number phone_zip_code: $.http.body.ad_configuration.phone_info.phone_region_calling_code product_display_field_list: $.http.body.ad_configuration.product_display_field_list[] product_ids: $.http.body.ad_configuration.product_ids[] product_set_id: $.http.body.ad_configuration.product_set_id product_specific_type: $.http.body.ad_configuration.product_specific_type tracking_info: action_track_url: $.http.body.ad_configuration.tracking_info.click_tracking_url track_url: $.http.body.ad_configuration.tracking_info.impression_tracking_url tracking_app_id: $.http.body.ad_configuration.tracking_info.tracking_app_id tracking_message_event_set_id: $.http.body.ad_configuration.tracking_info.tracking_message_event_set_id utms[][]: - field: $.http.body.ad_configuration.utm_params[].key value: $.http.body.ad_configuration.utm_params[].value external_url_list[][]: - external_url: $.http.body.landing_page_url_list[].landing_page_url media_info_list[][]: - media_info[]: - ad_format: $.http.body.creative_list[].creative_info.ad_format aigc_disclosure_type: $.http.body.creative_list[].creative_info.aigc_disclosure_type aweme_item_id: $.http.body.creative_list[].creative_info.tiktok_item_id identity_bc_id: $.http.body.creative_list[].creative_info.identity_authorized_bc_id identity_id: $.http.body.creative_list[].creative_info.identity_id identity_type: $.http.body.creative_list[].creative_info.identity_type image_info[][]: - web_uri: $.http.body.creative_list[].creative_info.image_info[].web_uri music_info[]: - music_id: $.http.body.creative_list[].creative_info.music_info.music_id video_info[]: - file_name: $.http.body.creative_list[].creative_info.video_info.file_name video_id: $.http.body.creative_list[].creative_info.video_info.video_id open_url_list[][]: - auto_open: $.http.body.deeplink_list[].deeplink_type open_url: $.http.body.deeplink_list[].deeplink opt_status: $.http.body.operation_status page_list: $.http.body.page_list title_list[][]: - title: $.http.body.ad_text_list[].ad_text response_cookie: [] response_header: [] response_rule: ad_configuration: auto_disclaimer_types: $.rpc.output.asset_group_data.common_material.auto_disclaimer_type_list call_to_action_id: $.rpc.output.asset_group_data.common_material.call_to_action_id catalog_creative_toggle: $.rpc.output.asset_group_data.common_material.catalog_creative_toggle dark_post_status: $.rpc.output.asset_group_data.common_material.dark_post_status end_card_cta: $.rpc.output.asset_group_data.common_material.end_card_cta fallback_type: $.rpc.output.asset_group_data.common_material.fallback_type identity_id: $.rpc.output.asset_group_data.common_material.identity_id identity_type: $.rpc.output.asset_group_data.common_material.identity_type phone_info: phone_number: $.rpc.output.asset_group_data.common_material.phone_number phone_region_calling_code: $.rpc.output.asset_group_data.common_material.phone_zip_code phone_region_code: $.rpc.output.asset_group_data.common_material.phone_country_code product_display_field_list: $.rpc.output.asset_group_data.common_material.product_display_field_list product_ids: $.rpc.output.asset_group_data.common_material.product_ids product_set_id: $.rpc.output.asset_group_data.common_material.product_set_id product_specific_type: $.rpc.output.asset_group_data.common_material.product_specific_type tracking_info: click_tracking_url: $.rpc.output.asset_group_data.common_material.tracking_info.action_track_url impression_tracking_url: $.rpc.output.asset_group_data.common_material.tracking_info.track_url tracking_app_id: $.rpc.output.asset_group_data.common_material.tracking_info.tracking_app_id tracking_message_event_set_id: $.rpc.output.asset_group_data.common_material.tracking_info.tracking_message_event_set_id utm_params[][]: - key: $.rpc.output.asset_group_data.common_material.utms[].field value: $.rpc.output.asset_group_data.common_material.utms[].value ad_name: $.rpc.output.asset_group_data.ad_name ad_text_list[][]: - ad_text: $.rpc.output.asset_group_data.title_list[].title adgroup_id: $.rpc.output.asset_group_data.adgroup_id adgroup_name: $.rpc.output.asset_group_data.adgroup_name advertiser_id: $.rpc.output.asset_group_data.advertiser_id auto_message_list[][]: - auto_message_id: $.rpc.output.asset_group_data.auto_message_list[].auto_message_id call_to_action_list[][]: - call_to_action: $.rpc.output.asset_group_data.call_to_action_list[].call_to_action campaign_id: $.rpc.output.asset_group_data.campaign_id campaign_name: $.rpc.output.asset_group_data.campaign_name create_time: $.rpc.output.asset_group_data.create_time creative_list[][]: - ad_material_id: $.rpc.output.asset_group_data.media_info_list[].id creative_info[]: - ad_format: $.rpc.output.asset_group_data.media_info_list[].media_info.ad_format aigc_disclosure_type: $.rpc.output.asset_group_data.media_info_list[].media_info.aigc_disclosure_type identity_authorized_bc_id: $.rpc.output.asset_group_data.media_info_list[].media_info.identity_bc_id identity_id: $.rpc.output.asset_group_data.media_info_list[].media_info.identity_id identity_type: $.rpc.output.asset_group_data.media_info_list[].media_info.identity_type image_info[][]: - web_uri: $.rpc.output.asset_group_data.media_info_list[].media_info.image_info[].web_uri material_name: $.rpc.output.asset_group_data.media_info_list[].media_info.material_name music_info[]: - music_id: $.rpc.output.asset_group_data.media_info_list[].media_info.music_info.music_id tiktok_item_id: $.rpc.output.asset_group_data.media_info_list[].media_info.aweme_item_id video_info[]: - file_name: $.rpc.output.asset_group_data.media_info_list[].media_info.video_info.file_name video_id: $.rpc.output.asset_group_data.media_info_list[].media_info.video_info.video_id material_operation_status: $.rpc.output.asset_group_data.media_info_list[].aco_opt_status deeplink_list[][]: - deeplink: $.rpc.output.asset_group_data.open_url_list[].open_url deeplink_type: $.rpc.output.asset_group_data.open_url_list[].auto_open interactive_add_on_list[][]: - card_id: $.rpc.output.asset_group_data.card_list[].card_id landing_page_url_list[][]: - landing_page_url: $.rpc.output.asset_group_data.external_url_list[].external_url modify_time: $.rpc.output.asset_group_data.modify_time operation_status: $.rpc.output.asset_group_data.opt_status page_list[][]: - page_id: $.rpc.output.asset_group_data.page_list[].page_id secondary_status: $.rpc.output.asset_group_data.secondary_status smart_plus_ad_id: $.rpc.output.asset_group_data.ad_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /smart_plus/ad/get/: get: operationId: Smart_plus Ad Get parameters: - description: '' in: query name: advertiser_id required: true schema: nullable: false 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: nullable: false properties: adgroup_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.query.filtering.adgroup_ids campaign_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.query.filtering.campaign_ids creation_filter_end_time: description: '' format: datetime nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 8 x-open-source: $.http.query.filtering.creation_filter_end_time creation_filter_start_time: description: '' format: datetime nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 x-open-source: $.http.query.filtering.creation_filter_start_time modified_after: description: '' format: datetime nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 10 objective_type: description: '' nullable: false 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: 4 x-open-source: $.http.query.filtering.objective_type optimization_goal: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804192692022273 enum_package_name: OptimizeGoalFilter enums: - description: '' is_valid: true key: ANCHOR_CLICK_PURCHASE value: '17' - description: '' is_valid: true key: CLICK value: '2' - description: '' is_valid: true key: CONVERSATION value: '28' - description: '' is_valid: true key: CONVERSION_LEADS value: '25' - description: '' is_valid: true key: CONVERT value: '1' - description: '' is_valid: true key: DESTINATION_VISIT value: '27' - description: '' is_valid: true key: ENGAGED_VIEW value: '18' - description: '' is_valid: true key: ENGAGED_VIEW_FIFTEEN value: '20' - description: '' is_valid: true key: FOLLOWERS value: '9' - description: '' is_valid: true key: GMV value: '22' - description: '' is_valid: true key: INITIATE_CHECKOUTS value: '24' - description: '' is_valid: true key: INSTALL value: '6' - description: '' is_valid: true key: IN_APP_EVENT value: '7' - description: '' is_valid: true key: LEAD_GENERATION value: '8' - description: '' is_valid: true key: MESSAGE value: '19' - description: '' is_valid: true key: MT_LIVE_ROOM value: '13' - description: '' is_valid: true key: MT_LIVE_SHOPPING value: '16' - description: '' is_valid: true key: PAGE_VISIT value: '26' - description: '' is_valid: true key: POST_ENGAGEMENT value: '11' - description: '' is_valid: true key: PRODUCT_CLICK_IN_LIVE value: '14' - description: '' is_valid: true key: PROFILE_VIEWS value: '10' - description: '' is_valid: true key: PURCHASES value: '23' - description: '' is_valid: true key: REACH value: '4' - description: '' is_valid: true key: SHOW value: '3' - description: '' is_valid: true key: TRAFFIC_LANDING_PAGE_VIEW value: '15' - description: '' is_valid: true key: VALUE value: '12' - description: '' is_valid: true key: VIDEO_VIEW value: '5' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 9 x-open-source: $.http.query.filtering.optimization_goal primary_status: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1836329574229121 enum_package_name: PrimaryStatus enums: - description: '' is_valid: true key: STATUS_ALL value: all - description: '' is_valid: true key: STATUS_CLOSED value: rf_closed - description: '' is_valid: true key: STATUS_DELETE value: delete - description: '' is_valid: true key: STATUS_DELIVERY_OK value: delivery_ok - description: '' is_valid: true key: STATUS_DISABLE value: disable - description: '' is_valid: true key: STATUS_FROZEN value: frozen - description: '' is_valid: true key: STATUS_NOT_DELETE value: no_delete - description: '' is_valid: true key: STATUS_NOT_DELIVERY value: not_delivery - description: '' is_valid: true key: STATUS_RF_CLOSED value: rf_closed - description: '' is_valid: true key: STATUS_TIME_DONE value: time_done key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 6 x-open-source: $.http.query.filtering.primary_status secondary_status: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1836329884603521 enum_package_name: CreativeStatus enums: - description: '' is_valid: true key: ADGROUP_STATUS_FROZEN value: ad_frozen - 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: AD_STATUS_ADGROUP_ASSET_AUTHORIZATION_LOST value: ad_asset_authorization_lost - description: '' is_valid: true key: AD_STATUS_ADGROUP_AUDIT_DENY value: creative_ad_offline_audit - description: '' is_valid: false key: AD_STATUS_ADGROUP_CLOSED value: rf_ad_has_closed - description: '' is_valid: true key: AD_STATUS_ADGROUP_DELETE value: ad_delete - description: '' is_valid: true key: AD_STATUS_ADGROUP_DISABLE value: ad_disable - description: '' is_valid: true key: AD_STATUS_ADGROUP_INDUSTRY_QUALIFICATION_DENY value: creative_ad_industry_qualification_rejected - description: '' is_valid: true key: AD_STATUS_ADGROUP_INDUSTRY_QUALIFICATION_EXPIRED value: creative_ad_industry_qualification_expired - description: '' is_valid: true key: AD_STATUS_ADGROUP_INDUSTRY_QUALIFICATION_MISSING value: creative_ad_industry_qualification_missing - description: '' is_valid: true key: AD_STATUS_ADGROUP_PARTIAL_AUDIT_NO_DELIVERY value: ad_partial_audit_but_no_delivery - description: '' is_valid: true key: AD_STATUS_ADVERTISER_AUDIT value: advertiser_audit - description: '' is_valid: true key: AD_STATUS_ADVERTISER_AUDIT_DENY value: advertiser_offline_audit - description: '' is_valid: false key: AD_STATUS_AD_PRE_ONLINE value: ad_pre_online - description: '' is_valid: false key: AD_STATUS_AD_QUOTA_LIMIT value: creative_quota_limit - description: '' is_valid: true key: AD_STATUS_ALL value: creative_all - description: '' is_valid: true key: AD_STATUS_ANCHOR_UNAVAILABLE value: anchor_unavailable - description: '' is_valid: true key: AD_STATUS_ASSET_AUTHORIZATION_LOST value: creative_asset_authorization_lost - description: '' is_valid: true key: AD_STATUS_AUDIT value: creative_audit - description: '' is_valid: true key: AD_STATUS_AUDIT_DENY value: creative_offline_audit - description: '' is_valid: true key: AD_STATUS_BAD value: creative_bad - description: '' is_valid: true key: AD_STATUS_BALANCE_EXCEED value: ad_offline_balance - description: '' is_valid: true key: AD_STATUS_BUDGET_EXCEED value: ad_offline_budget - description: '' is_valid: true key: AD_STATUS_CAMPAIGN_DELETE value: campaign_delete - description: '' is_valid: true key: AD_STATUS_CAMPAIGN_DISABLE value: campaign_disable - description: '' is_valid: true key: AD_STATUS_CAMPAIGN_EXCEED value: campaign_offline_budget - description: '' is_valid: false key: AD_STATUS_CLOSED_OTHERS value: rf_closed_others - description: '' is_valid: true key: AD_STATUS_COLLECTION_TOGGLED_OFF value: creative_collection_toggled_off - description: '' is_valid: true key: AD_STATUS_DELETE value: creative_delete - description: '' is_valid: true key: AD_STATUS_DELIVERY_AND_REAUDIT value: creative_delivery_and_reaudit - description: '' is_valid: true key: AD_STATUS_DELIVERY_AND_TRANSCODING_FAIL value: creative_delivery_and_transcoding_fail - description: '' is_valid: true key: AD_STATUS_DELIVERY_OK value: creative_delivery_ok - description: '' is_valid: true key: AD_STATUS_DISABLE value: creative_disable - description: '' is_valid: true key: AD_STATUS_DONE value: creative_ad_time_done - description: '' is_valid: true key: AD_STATUS_EXPLORING value: creative_exploring - description: '' is_valid: true key: AD_STATUS_GOOD value: creative_good - description: '' is_valid: true key: AD_STATUS_LIVE_OFFLINE value: live_offline - description: '' is_valid: true key: AD_STATUS_MUSIC_AUTHORIZATION_MISSING value: creative_music_authorization_missing - description: '' is_valid: true key: AD_STATUS_NOT_DELETE value: no_delete - description: '' is_valid: true key: AD_STATUS_NOT_START value: creative_ad_time_no_reach - description: '' is_valid: true key: AD_STATUS_OK value: creative_ok - description: '' is_valid: true key: AD_STATUS_PARTIAL_AUDIT_DELIVERY_OK value: creative_partial_audit_and_delivery_ok - description: '' is_valid: true key: AD_STATUS_PIXEL_UNBIND value: creative_pixel_unbind - description: '' is_valid: true key: AD_STATUS_PRIVACY_POLICY_AUDIT value: creative_privacy_policy_audit - description: '' is_valid: true key: AD_STATUS_PRIVACY_POLICY_REJECTED value: creative_privacy_policy_rejected - description: '' is_valid: true key: AD_STATUS_PROCESS_AUDIO value: creative_process_audio - description: '' is_valid: true key: AD_STATUS_PRODUCT_UNAVAILABLE value: product_unavailable - description: '' is_valid: true key: AD_STATUS_PROMOTE_ADGROUP_CLOSED value: promote_ad_has_closed - description: '' is_valid: true key: AD_STATUS_PROMOTE_AD_OFFLINE_AUDIT value: promote_creative_offline_audit - description: '' is_valid: true key: AD_STATUS_REAUDIT value: creative_reaudit - description: '' is_valid: true key: AD_STATUS_REVIEW_PARTIALLY_APPROVED value: creative_review_partially_approved - description: '' is_valid: false key: AD_STATUS_RF_ADGROUP_CLOSED value: rf_ad_has_closed - description: '' is_valid: true key: AD_STATUS_SHOWCASE_AUTHORIZATION_LOST value: no_authorization_of_showcase - description: '' is_valid: false key: AD_STATUS_TRANSCODING_FAIL value: creative_transcoding_fail - description: '' is_valid: true key: AD_STATUS_UNEXPLORED value: creative_unexplored - description: '' is_valid: false key: STATUS_ALL value: all - description: '' is_valid: false key: STATUS_CLOSED value: rf_closed - description: '' is_valid: false key: STATUS_DELETE value: delete - description: '' is_valid: false key: STATUS_DELIVERY_OK value: delivery_ok - description: '' is_valid: false key: STATUS_DISABLE value: disable - description: '' is_valid: false key: STATUS_FROZEN value: frozen - description: '' is_valid: false key: STATUS_NOT_DELETE value: no_delete - description: '' is_valid: false key: STATUS_NOT_DELIVERY value: not_delivery - description: '' is_valid: false key: STATUS_RF_CLOSED value: rf_closed - description: '' is_valid: false key: STATUS_TIME_DONE value: time_done key_format: string strict: true use_part: true validate_only: false value_format: string x-open-field-id: 5 x-open-source: $.http.query.filtering.secondary_status smart_plus_ad_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.query.filtering.ad_ids type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.filtering description: '' in: query name: filtering required: false x-open-field-id: 2 - description: '' in: query name: page required: false schema: default: 1 format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page x-open-field-id: 3 - description: '' in: query name: page_size required: false schema: default: 10 format: int64 maximum: 100 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page_size x-open-field-id: 4 - content: application/json: schema: items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.fields description: '' in: query name: fields required: false x-open-field-id: 5 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Retrieve ad details [Smart Plus Ad Get] tags: - Ad x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - children: - children: - type: number is_expand: true name: ad_ids required: false source: $.http.query.filtering.smart_plus_ad_ids sub_type: number type: array - children: - type: number is_expand: true name: adgroup_ids required: false source: $.http.query.filtering.adgroup_ids sub_type: number type: array - 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: creation_filter_start_time required: false source: $.http.query.filtering.creation_filter_start_time type: string - name: creation_filter_end_time required: false source: $.http.query.filtering.creation_filter_end_time type: string - name: optimization_goal required: false source: $.http.query.filtering.optimization_goal type: number - is_expand: false name: modified_after required: false source: $.http.query.filtering.modified_after type: string is_expand: true name: filtering required: false type: object - name: page required: true source: $.http.query.page type: number - name: page_size required: true source: $.http.query.page_size type: number - children: - type: string is_expand: true name: fields required: false source: $.http.query.fields sub_type: string type: array plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id fields: $.http.query.fields filtering: ad_ids: $.http.query.filtering.smart_plus_ad_ids adgroup_ids: $.http.query.filtering.adgroup_ids campaign_ids: $.http.query.filtering.campaign_ids creation_filter_end_time: $.http.query.filtering.creation_filter_end_time creation_filter_start_time: $.http.query.filtering.creation_filter_start_time modified_after: $.http.query.filtering.modified_after objective_type: $.http.query.filtering.objective_type optimization_goal: $.http.query.filtering.optimization_goal primary_status: $.http.query.filtering.primary_status secondary_status: $.http.query.filtering.secondary_status page: $.http.query.page page_size: $.http.query.page_size response_cookie: [] response_header: [] response_rule: list[][]: - ad_configuration[]: - auto_disclaimer_types: $.rpc.output.asset_group_list[].common_material.auto_disclaimer_type_list call_to_action_id: $.rpc.output.asset_group_list[].common_material.call_to_action_id catalog_creative_toggle: $.rpc.output.asset_group_list[].common_material.catalog_creative_toggle dark_post_status: $.rpc.output.asset_group_list[].common_material.dark_post_status end_card_cta: $.rpc.output.asset_group_list[].common_material.end_card_cta fallback_type: $.rpc.output.asset_group_list[].common_material.fallback_type identity_id: $.rpc.output.asset_group_list[].common_material.identity_id identity_type: $.rpc.output.asset_group_list[].common_material.identity_type phone_info[]: - phone_number: $.rpc.output.asset_group_list[].common_material.phone_number phone_region_calling_code: $.rpc.output.asset_group_list[].common_material.phone_zip_code phone_region_code: $.rpc.output.asset_group_list[].common_material.phone_country_code product_display_field_list: $.rpc.output.asset_group_list[].common_material.product_display_field_list product_ids: $.rpc.output.asset_group_list[].common_material.product_ids product_set_id: $.rpc.output.asset_group_list[].common_material.product_set_id product_specific_type: $.rpc.output.asset_group_list[].common_material.product_specific_type tracking_info[]: - click_tracking_url: $.rpc.output.asset_group_list[].common_material.tracking_info.action_track_url impression_tracking_url: $.rpc.output.asset_group_list[].common_material.tracking_info.track_url tracking_app_id: $.rpc.output.asset_group_list[].common_material.tracking_info.tracking_app_id tracking_message_event_set_id: $.rpc.output.asset_group_list[].common_material.tracking_info.tracking_message_event_set_id utm_params[][]: - key: $.rpc.output.asset_group_list[].common_material.utms[].field value: $.rpc.output.asset_group_list[].common_material.utms[].value ad_name: $.rpc.output.asset_group_list[].ad_name ad_text_list[][]: - ad_text: $.rpc.output.asset_group_list[].title_list[].title adgroup_id: $.rpc.output.asset_group_list[].adgroup_id adgroup_name: $.rpc.output.asset_group_list[].adgroup_name advertiser_id: $.rpc.output.asset_group_list[].advertiser_id auto_message_list[][]: - auto_message_id: $.rpc.output.asset_group_list[].auto_message_list[].auto_message_id call_to_action_list[][]: - call_to_action: $.rpc.output.asset_group_list[].call_to_action_list[].call_to_action campaign_id: $.rpc.output.asset_group_list[].campaign_id campaign_name: $.rpc.output.asset_group_list[].campaign_name create_time: $.rpc.output.asset_group_list[].create_time creative_list[][]: - ad_material_id: $.rpc.output.asset_group_list[].media_info_list[].id creative_info[]: - ad_format: $.rpc.output.asset_group_list[].media_info_list[].media_info.ad_format aigc_disclosure_type: $.rpc.output.asset_group_list[].media_info_list[].media_info.aigc_disclosure_type identity_authorized_bc_id: $.rpc.output.asset_group_list[].media_info_list[].media_info.identity_bc_id identity_id: $.rpc.output.asset_group_list[].media_info_list[].media_info.identity_id identity_type: $.rpc.output.asset_group_list[].media_info_list[].media_info.identity_type image_info[][]: - web_uri: $.rpc.output.asset_group_list[].media_info_list[].media_info.image_info[].web_uri material_name: $.rpc.output.asset_group_list[].media_info_list[].media_info.material_name music_info[]: - music_id: $.rpc.output.asset_group_list[].media_info_list[].media_info.music_info.music_id tiktok_item_id: $.rpc.output.asset_group_list[].media_info_list[].media_info.aweme_item_id video_info[]: - file_name: $.rpc.output.asset_group_list[].media_info_list[].media_info.video_info.file_name video_id: $.rpc.output.asset_group_list[].media_info_list[].media_info.video_info.video_id material_operation_status: $.rpc.output.asset_group_list[].media_info_list[].aco_opt_status deeplink_list[][]: - deeplink: $.rpc.output.asset_group_list[].open_url_list[].open_url deeplink_type: $.rpc.output.asset_group_list[].open_url_list[].auto_open interactive_add_on_list[][]: - card_id: $.rpc.output.asset_group_list[].card_list[].card_id landing_page_url_list[][]: - landing_page_url: $.rpc.output.asset_group_list[].external_url_list[].external_url modify_time: $.rpc.output.asset_group_list[].modify_time operation_status: $.rpc.output.asset_group_list[].opt_status page_list[][]: - page_id: $.rpc.output.asset_group_list[].page_list[].page_id secondary_status: $.rpc.output.asset_group_list[].secondary_status smart_plus_ad_id: $.rpc.output.asset_group_list[].ad_id page_info: page: $.rpc.output.page_info.page page_size: $.rpc.output.page_info.page_size total_number: $.rpc.output.page_info.total_number total_page: $.rpc.output.page_info.total_page x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /smart_plus/ad/material_status/update/: post: operationId: Smart_plus Ad Material_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: ad_material_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) maxItems: 20 minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.material_ids advertiser_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 x-open-source: $.http.body.advertiser_id operation_status: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1836026089521154 enum_package_name: ACOStatusOptType enums: - description: '' is_valid: true key: DISABLE value: '9' - description: '' is_valid: true key: ENABLE value: '8' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 4 x-open-source: $.http.body.operation_status smart_plus_ad_id: description: '' nullable: false 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.ad_id required: - advertiser_id - smart_plus_ad_id - ad_material_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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Update ad material status [Smart Plus Ad Material Status Update] tags: - Ad 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: ad_id required: true source: $.http.body.smart_plus_ad_id type: number - children: - type: number name: material_ids required: true source: $.http.body.ad_material_ids sub_type: number type: array - name: operation_status required: true source: $.http.body.operation_status type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: ad_id: $.http.body.smart_plus_ad_id advertiser_id: $.http.body.advertiser_id material_ids: $.http.body.ad_material_ids operation_status: $.http.body.operation_status response_cookie: [] response_header: [] response_rule: ad_material_ids: $.rpc.output.material_ids operation_status: $.rpc.output.operation_status smart_plus_ad_id: $.rpc.output.ad_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /smart_plus/ad/review_info/: get: operationId: Smart_plus Ad Review_info parameters: - description: '' in: query name: advertiser_id required: true schema: nullable: false 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: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) maxItems: 100 minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.asset_group_ids description: '' in: query name: smart_plus_ad_ids required: true x-open-field-id: 2 - content: application/json: schema: nullable: false properties: include_reject_info: default: false description: '' nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.query.need_optional_info.need_reason include_violation_frame: default: false description: '' nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.query.need_optional_info.need_violation_frames type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.need_optional_info description: '' in: query name: extra_info_setting required: false x-open-field-id: 3 - description: '' in: query name: lang required: false schema: default: '""' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.lang x-open-field-id: 4 - content: application/json: schema: nullable: false properties: app_id: description: '' format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.query.context_info.app_id core_user_id: description: '' format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.query.context_info.core_user_id developer_id: description: '' format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.query.context_info.developer_id developer_region: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.query.context_info.developer_region referer: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 8 x-open-source: $.http.query.context_info.referer user_agent: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 x-open-source: $.http.query.context_info.user_agent x_forwarded_for: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.query.context_info.x_forwarded_for x_real_ip: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.query.context_info.x_real_ip type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.context_info description: '' in: query name: context_info required: false x-open-field-id: 5 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get ad review info [Smart Plus Ad Review Info] tags: - Ad x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - children: - type: number is_expand: true name: asset_group_ids required: true source: $.http.query.smart_plus_ad_ids[] sub_type: number type: array - children: - name: need_reason required: false source: $.http.query.extra_info_setting.include_reject_info type: boolean - name: need_violation_frames required: false source: $.http.query.extra_info_setting.include_violation_frame type: boolean is_expand: true name: need_optional_info required: false type: object - name: lang required: true source: $.http.query.lang type: string - 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: developer_region required: false source: $.http.query.context_info.developer_region type: string - 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: true name: context_info required: true 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_group_ids: $.http.query.smart_plus_ad_ids[] context_info: $.http.query.context_info lang: $.http.query.lang need_optional_info: need_reason: $.http.query.extra_info_setting.include_reject_info need_violation_frames: $.http.query.extra_info_setting.include_violation_frame response_cookie: [] response_header: [] response_rule: material_review_infos[][]: - ad_material_id: $.rpc.output.material_review_infos[].id passed_locations: $.rpc.output.material_review_infos[].passed_countries reject_info[][]: - content_info[]: - carousel_music_info: $.rpc.output.material_review_infos[].reasons[].content_info.carousel_music_info content_type: $.rpc.output.material_review_infos[].reasons[].content_info.content_value_type image_content[]: - image_id: $.rpc.output.material_review_infos[].reasons[].content_info.value_image.web_uri text_content: $.rpc.output.material_review_infos[].reasons[].content_info.value_str video_content: $.rpc.output.material_review_infos[].reasons[].content_info.value_video forbidden_ages: $.rpc.output.material_review_infos[].reasons[].forbidden_ages forbidden_locations: $.rpc.output.material_review_infos[].reasons[].forbidden_countries forbidden_placements: $.rpc.output.material_review_infos[].reasons[].forbidden_inventory_flows reasons: $.rpc.output.material_review_infos[].reasons[].value specification: $.rpc.output.material_review_infos[].reasons[].specification suggestion: $.rpc.output.material_review_infos[].reasons[].suggestion violation_frames[][]: - type: $.rpc.output.material_review_infos[].reasons[].violation_frames[].type video_id: $.rpc.output.material_review_infos[].reasons[].violation_frames[].vid video_violation_frames: $.rpc.output.material_review_infos[].reasons[].violation_frames[].video_violation_frames_v2 violation_frame_material_type: $.rpc.output.material_review_infos[].reasons[].violation_frames[].violation_frame_material_type web_url_list: $.rpc.output.material_review_infos[].reasons[].violation_frames[].web_url_list review_status: $.rpc.output.material_review_infos[].audit_result_type smart_plus_ad_id: $.rpc.output.material_review_infos[].creative_id smart_plus_ad_review_infos[][]: - appeal_reject_reasons: $.rpc.output.smart_plus_ad_review_infos[].appeal_reject_reasons appeal_status: $.rpc.output.smart_plus_ad_review_infos[].appeal_status passed_locations: $.rpc.output.smart_plus_ad_review_infos[].passed_countries reject_info[][]: - content_info[]: - carousel_music_info: $.rpc.output.smart_plus_ad_review_infos[].reasons[].content_info.carousel_music_info content_type: $.rpc.output.smart_plus_ad_review_infos[].reasons[].content_info.content_value_type image_content[]: - image_id: $.rpc.output.smart_plus_ad_review_infos[].reasons[].content_info.value_image.web_uri text_content: $.rpc.output.smart_plus_ad_review_infos[].reasons[].content_info.value_str video_content: $.rpc.output.smart_plus_ad_review_infos[].reasons[].content_info.value_video forbidden_ages: $.rpc.output.smart_plus_ad_review_infos[].reasons[].forbidden_ages forbidden_locations: $.rpc.output.smart_plus_ad_review_infos[].reasons[].forbidden_countries forbidden_placements: $.rpc.output.smart_plus_ad_review_infos[].reasons[].forbidden_inventory_flows reasons: $.rpc.output.smart_plus_ad_review_infos[].reasons[].value specification: $.rpc.output.smart_plus_ad_review_infos[].reasons[].specification suggestion: $.rpc.output.smart_plus_ad_review_infos[].reasons[].suggestion violation_frames[][]: - type: $.rpc.output.smart_plus_ad_review_infos[].reasons[].violation_frames[].type video_id: $.rpc.output.smart_plus_ad_review_infos[].reasons[].violation_frames[].vid video_violation_frames: $.rpc.output.smart_plus_ad_review_infos[].reasons[].violation_frames[].video_violation_frames_v2 violation_frame_material_type: $.rpc.output.smart_plus_ad_review_infos[].reasons[].violation_frames[].violation_frame_material_type web_url_list: $.rpc.output.smart_plus_ad_review_infos[].reasons[].violation_frames[].web_url_list review_status: $.rpc.output.smart_plus_ad_review_infos[].audit_result_type smart_plus_ad_id: $.rpc.output.smart_plus_ad_review_infos[].id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /smart_plus/ad/status/update/: post: operationId: Smart_plus Ad 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: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 x-open-source: $.http.body.advertiser_id operation_status: description: '' nullable: false 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 smart_plus_ad_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) maxItems: 20 minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.ad_ids required: - advertiser_id - smart_plus_ad_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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Update ad status [Smart Plus Ad Status Update] tags: - Ad 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: ad_ids required: false source: $.http.body.smart_plus_ad_ids sub_type: number type: array - name: operation_status required: true source: $.http.body.operation_status type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: ad_ids: $.http.body.smart_plus_ad_ids advertiser_id: $.http.body.advertiser_id operation_status: $.http.body.operation_status response_cookie: [] response_header: [] response_rule: smart_plus_ad_ids: $.rpc.output.ad_ids status: $.rpc.output.status x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /smart_plus/ad/update/: post: operationId: Smart_plus Ad 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: ad_configuration: description: '' nullable: false properties: auto_disclaimer_types: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1827620303506497 enum_package_name: AutoDisclaimerType enums: - description: 汽车折扣 is_valid: true key: DISCOUNT value: '2' - description: 汽车排放 is_valid: true key: EMISSION value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 11 call_to_action_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 7 x-open-source: $.http.body.common_material.call_to_action_id catalog_creative_toggle: description: '' nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.body.common_material.catalog_creative_toggle dark_post_status: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1843735142813698 enum_package_name: DarkPostStatus enums: - description: '' is_valid: true key: 'OFF' value: '2' - description: '' is_valid: true key: 'ON' value: '1' - description: '' is_valid: false key: Partly value: '3' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 14 end_card_cta: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1824616467253313 enum_package_name: EndCardCTA enums: - description: '' is_valid: true key: BOOK_NOW value: book_now - description: '' is_valid: true key: CONTACT_US value: contact_us - description: '' is_valid: true key: LEARN_MORE value: learn_more - description: '' is_valid: true key: ORDER_NOW value: order_now - description: '' is_valid: true key: READ_MORE value: read_more - description: '' is_valid: true key: SEARCH_INVENTORY value: search_inventory - description: '' is_valid: true key: SHOP_NOW value: shop_now - description: '' is_valid: true key: SIGN_UP value: sign_up - description: '' is_valid: true key: VIEW_MORE value: cta_view_more key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 10 fallback_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1810699520231426 enum_package_name: FallbackType enums: - description: '' is_valid: true key: APP_INSTALL value: '1' - description: '' is_valid: true key: UNSET value: '0' - description: '' is_valid: true key: WEBSITE value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 13 identity_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.common_material.identity_id identity_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800331041544193 enum_package_name: IdentityType enums: - description: '' is_valid: false key: AUTH_CODE value: '2' - description: '' is_valid: false key: BC_AUTH_TT value: '5' - description: '' is_valid: false key: BC_SELF_TT value: '4' - description: '' is_valid: true key: CUSTOMIZED_USER value: '1' - description: TTS 授权来源TT账号 is_valid: false key: TTS_TT value: '8' - description: '' is_valid: false 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: 1 x-open-source: $.http.body.common_material.identity_type phone_info: description: '' nullable: false properties: phone_number: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 phone_region_calling_code: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 phone_region_code: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 12 product_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.body.common_material.product_ids product_set_id: description: '' nullable: false 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.common_material.product_set_id product_specific_type: description: '' nullable: false 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: true 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: 3 x-open-source: $.http.body.common_material.product_specific_type tracking_info: description: '' nullable: false properties: click_tracking_url: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.common_material.tracking_info.action_track_url impression_tracking_url: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.common_material.tracking_info.track_url tracking_app_id: description: '' nullable: false 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.common_material.tracking_info.tracking_app_id type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 8 x-open-source: $.http.body.common_material.tracking_info utm_params: description: '' items: nullable: false properties: key: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 value: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 type: object x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 9 type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 11 x-open-source: $.http.body.common_material ad_name: description: '' minLength: 1 nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.ad_name ad_text_list: description: '' items: nullable: false properties: ad_text: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.title_list[].title required: - ad_text type: object x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 5 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.body.title_list advertiser_id: description: '' nullable: false 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 call_to_action_list: description: '' items: nullable: false properties: call_to_action: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1807533165224961 enum_package_name: CallToAction enums: - description: '' is_valid: true key: APPLY_NOW value: apply_now - description: '' is_valid: true key: BOOK_NOW value: book_now - description: '' is_valid: true key: CALL_NOW value: call_to_action_call - description: '' is_valid: true key: CHECK_AVAILABILITY value: cta_check_availability - description: '' is_valid: true key: CONTACT_US value: contact_us - description: '' is_valid: true key: DOWNLOAD_NOW value: download_now - description: '' is_valid: true key: EXPERIENCE_NOW value: experience_now - description: '' is_valid: true key: GET_QUOTE value: get_quote - description: '' is_valid: true key: GET_SHOWTIMES value: get_showtimes - description: '' is_valid: true key: GET_TICKETS_NOW value: get_tickets_now - description: '' is_valid: true key: INSTALL_NOW value: install_now - description: '' is_valid: true key: INTERESTED value: interested - description: '' is_valid: true key: JOIN_THIS_HASHTAG value: join_this_hashtag - description: '' is_valid: true key: LEARN_MORE value: learn_more - description: '' is_valid: true key: LISTEN_NOW value: listen_now - description: '' is_valid: true key: ORDER_NOW value: order_now - description: '' is_valid: true key: PLAY_GAME value: play_game_cta - description: '' is_valid: true key: PREORDER_NOW value: preorder_now - description: '' is_valid: true key: READ_MORE value: read_more - description: '' is_valid: true key: SEND_MESSAGE value: Promote_more_messages_send_message - description: '' is_valid: true key: SHOOT_WITH_THIS_EFFECT value: shoot_with_this_effect - description: '' is_valid: true key: SHOP_NOW value: shop_now - description: '' is_valid: true key: SIGN_UP value: sign_up - description: '' is_valid: true key: SUBSCRIBE value: subscribe - description: '' is_valid: true key: VIEW_NOW value: view_now - description: '' is_valid: true key: VIEW_PROFILE value: view_profile - description: '' is_valid: true key: VIEW_VIDEO_WITH_THIS_EFFECT value: view_video_with_this_effect - description: '' is_valid: true key: VISIT_STORE value: visit_store - description: '' is_valid: true key: WATCH_LIVE value: watch_live - description: '' is_valid: true key: WATCH_NOW value: watch_now key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 1 x-open-source: $.http.body.call_to_action_list[].call_to_action required: - call_to_action type: object x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 3 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 10 x-open-source: $.http.body.call_to_action_list creative_list: description: '' items: nullable: false properties: creative_info: description: '' nullable: false properties: ad_format: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1818582044296193 enum_package_name: AdFormat enums: - description: '' is_valid: false key: CAROUSEL value: '2' - description: '' is_valid: true key: CAROUSEL_ADS value: '4' - description: '' is_valid: true key: CATALOG_CAROUSEL value: '5' - description: '' is_valid: false key: LIVE_CONTENT value: '3' - description: '' is_valid: false key: SINGLE_IMAGE value: '0' - description: '' is_valid: true key: SINGLE_VIDEO value: '1' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 9 aigc_disclosure_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1807533197774914 enum_package_name: AigcDisclosureType enums: - description: '' is_valid: true key: NOT_DECLARED value: '1' - description: '' is_valid: true key: SELF_DISCLOSURE 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.media_info_list[].media_info.aigc_disclosure_type identity_authorized_bc_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 7 x-open-source: $.http.body.media_info_list[].media_info.identity_bc_id identity_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.media_info_list[].media_info.identity_id identity_type: description: '' nullable: false 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: true key: CUSTOMIZED_USER value: '1' - description: TTS 授权来源TT账号 is_valid: false key: TTS_TT value: '8' - description: '' is_valid: true key: TT_USER value: '3' - description: '' is_valid: false key: UNSET value: '0' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 5 x-open-source: $.http.body.media_info_list[].media_info.identity_type image_info: description: '' items: nullable: false properties: web_uri: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.media_info_list[].media_info.image_info[].web_uri required: - web_uri type: object x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.media_info_list[].media_info.image_info music_info: description: '' nullable: false properties: music_id: description: '' nullable: false 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.media_info_list[].media_info.music_info.music_id required: - music_id type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.body.media_info_list[].media_info.music_info tiktok_item_id: description: '' nullable: false 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.media_info_list[].media_info.aweme_item_id video_info: description: '' nullable: false properties: file_name: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.media_info_list[].media_info.video_info.file_name video_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.media_info_list[].media_info.video_info.video_id required: - video_id type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.media_info_list[].media_info.video_info required: - ad_format type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.media_info_list[].media_info required: - creative_info type: object x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 31 minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.media_info_list deeplink_list: description: '' items: nullable: false properties: deeplink: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.open_url_list[].open_url deeplink_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1810700429234178 enum_package_name: DeeplinkType enums: - description: '' is_valid: true key: DEFERRED_DEEPLINK value: '2' - description: '' is_valid: true key: NORMAL value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 2 x-open-source: $.http.body.open_url_list[].auto_open type: object x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 9 x-open-source: $.http.body.open_url_list interactive_add_on_list: description: '' items: nullable: false properties: card_id: description: '' nullable: false 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.card_list[].card_id required: - card_id type: object x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 2 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 x-open-source: $.http.body.card_list landing_page_url_list: description: '' items: nullable: false properties: landing_page_url: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.external_url_list[].external_url type: object x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 8 x-open-source: $.http.body.external_url_list page_list: description: '' items: nullable: false properties: page_id: description: '' nullable: false 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.page_list[].page_id required: - page_id type: object x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 3 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.body.page_list smart_plus_ad_id: description: '' nullable: false 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.ad_id required: - advertiser_id - smart_plus_ad_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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Update an ad [Smart Plus Ad Update] tags: - Ad 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: ad_id required: false source: $.http.body.smart_plus_ad_id type: number - name: ad_name required: false source: $.http.body.ad_name type: string - children: - children: - children: - children: - children: - name: web_uri required: true source: $.http.body.creative_list[].creative_info.image_info[].web_uri type: string is_expand: true type: object is_expand: true name: image_info required: false sub_type: object type: array - children: - name: video_id required: true source: $.http.body.creative_list[].creative_info.video_info.video_id type: string - name: file_name required: false source: $.http.body.creative_list[].creative_info.video_info.file_name type: string is_expand: true name: video_info required: false type: object - name: aweme_item_id required: false source: $.http.body.creative_list[].creative_info.tiktok_item_id type: number - name: identity_id required: false source: $.http.body.creative_list[].creative_info.identity_id type: string - name: identity_type required: false source: $.http.body.creative_list[].creative_info.identity_type type: number - children: - name: music_id required: true source: $.http.body.creative_list[].creative_info.music_info.music_id type: number is_expand: true name: music_info required: false type: object - name: identity_bc_id required: false source: $.http.body.creative_list[].creative_info.identity_authorized_bc_id type: number - name: aigc_disclosure_type required: false source: $.http.body.creative_list[].creative_info.aigc_disclosure_type type: number - name: ad_format required: true source: $.http.body.creative_list[].creative_info.ad_format type: number is_expand: true name: media_info required: true type: object is_expand: true type: object is_expand: false name: media_info_list required: false sub_type: object type: array - children: - children: - name: title required: true source: $.http.body.ad_text_list[].ad_text type: string is_expand: true type: object is_expand: false name: title_list required: false sub_type: object type: array - children: - children: - name: page_id required: true source: $.http.body.page_list[].page_id type: number is_expand: true type: object is_expand: false name: page_list required: false source: $.http.body.page_list sub_type: object type: array - children: - children: - name: card_id required: true source: $.http.body.card_list[].card_id type: number is_expand: true type: object is_expand: false name: card_list required: false source: $.http.body.interactive_add_on_list sub_type: object type: array - children: - children: - name: external_url required: false source: $.http.body.landing_page_url_list[].landing_page_url type: string is_expand: true type: object is_expand: true name: external_url_list required: false sub_type: object type: array - children: - children: - name: open_url required: false source: $.http.body.deeplink_list[].deeplink type: string - name: auto_open required: false source: $.http.body.deeplink_list[].deeplink_type type: number is_expand: true type: object is_expand: true name: open_url_list required: false sub_type: object type: array - children: - children: - name: call_to_action required: true source: $.http.body.call_to_action_list[].call_to_action type: string is_expand: true type: object is_expand: true name: call_to_action_list required: false source: $.http.body.call_to_action_list sub_type: object type: array - children: - name: identity_type required: false source: $.http.body.ad_configuration.identity_type type: number - name: identity_id required: false source: $.http.body.ad_configuration.identity_id type: string - name: product_specific_type required: false source: $.http.body.ad_configuration.product_specific_type type: number - name: product_set_id required: false source: $.http.body.ad_configuration.product_set_id type: number - children: - type: number is_expand: true name: product_ids required: false source: $.http.body.ad_configuration.product_ids[] sub_type: number type: array - name: catalog_creative_toggle required: false source: $.http.body.ad_configuration.catalog_creative_toggle type: boolean - name: call_to_action_id required: false source: $.http.body.ad_configuration.call_to_action_id type: number - children: - name: track_url required: false source: $.http.body.ad_configuration.tracking_info.impression_tracking_url type: string - name: action_track_url required: false source: $.http.body.ad_configuration.tracking_info.click_tracking_url type: string - name: tracking_app_id required: false source: $.http.body.ad_configuration.tracking_info.tracking_app_id type: number is_expand: true name: tracking_info required: false type: object - children: - children: - is_expand: false name: field required: false source: $.http.body.ad_configuration.utm_params[].key type: string - is_expand: false name: value required: false source: $.http.body.ad_configuration.utm_params[].value type: string is_expand: true source: undefined type: object is_expand: true name: utms required: false sub_type: object type: array - is_expand: false name: end_card_cta required: false source: $.http.body.ad_configuration.end_card_cta type: string - children: - is_expand: false source: undefined type: number is_expand: false name: auto_disclaimer_type_list required: false source: $.http.body.ad_configuration.auto_disclaimer_types[] sub_type: number type: array - is_expand: false name: phone_number required: false source: $.http.body.ad_configuration.phone_info.phone_number type: string - is_expand: false name: phone_zip_code required: false source: $.http.body.ad_configuration.phone_info.phone_region_calling_code type: string - is_expand: false name: phone_country_code required: false source: $.http.body.ad_configuration.phone_info.phone_region_code type: string - is_expand: false name: fallback_type required: false source: $.http.body.ad_configuration.fallback_type type: number - is_expand: false name: dark_post_status required: false source: $.http.body.ad_configuration.dark_post_status type: number is_expand: true name: common_material required: false type: object - children: - name: is_update_media_info_list required: false source: $.is_creative_list type: boolean - name: is_update_title_list required: false source: $.is_ad_text_list type: boolean - name: is_update_page_list required: false source: $.is_page_list type: boolean - name: is_update_card_list required: false source: $.is_interactive_add_on_list type: boolean - name: is_update_external_url_list required: false source: $.is_landing_page_url_list type: boolean - name: is_update_open_url_list required: false source: $.is_deeplink_list type: boolean - name: is_update_call_to_action_list required: false source: $.is_call_to_action_list type: boolean - is_expand: false name: is_update_utms required: false source: $.is_utms type: boolean is_expand: false name: object_list_update_info required: false type: object plugins: after_response: [] before_request: - Plugin_SpAdUpdate_2854274: - description: is list update - request_params: - $.http.body.creative_list - $.http.body.ad_text_list - $.http.body.page_list - $.http.body.interactive_add_on_list - $.http.body.landing_page_url_list - $.http.body.deeplink_list - $.http.body.call_to_action_list - $.http.body.ad_configuration.utm_params - result_params: - $.is_creative_list - $.is_ad_text_list - $.is_page_list - $.is_interactive_add_on_list - $.is_landing_page_url_list - $.is_deeplink_list - $.is_call_to_action_list - $.is_utms - version: 77790591ccc10eb44e434cff0aecd697 request_query_rule: null request_rule: ad_id: $.http.body.smart_plus_ad_id ad_name: $.http.body.ad_name advertiser_id: $.http.body.advertiser_id call_to_action_list: $.http.body.call_to_action_list card_list: $.http.body.interactive_add_on_list common_material: auto_disclaimer_type_list: $.http.body.ad_configuration.auto_disclaimer_types[] call_to_action_id: $.http.body.ad_configuration.call_to_action_id catalog_creative_toggle: $.http.body.ad_configuration.catalog_creative_toggle dark_post_status: $.http.body.ad_configuration.dark_post_status end_card_cta: $.http.body.ad_configuration.end_card_cta fallback_type: $.http.body.ad_configuration.fallback_type identity_id: $.http.body.ad_configuration.identity_id identity_type: $.http.body.ad_configuration.identity_type phone_country_code: $.http.body.ad_configuration.phone_info.phone_region_code phone_number: $.http.body.ad_configuration.phone_info.phone_number phone_zip_code: $.http.body.ad_configuration.phone_info.phone_region_calling_code product_ids: $.http.body.ad_configuration.product_ids[] product_set_id: $.http.body.ad_configuration.product_set_id product_specific_type: $.http.body.ad_configuration.product_specific_type tracking_info: action_track_url: $.http.body.ad_configuration.tracking_info.click_tracking_url track_url: $.http.body.ad_configuration.tracking_info.impression_tracking_url tracking_app_id: $.http.body.ad_configuration.tracking_info.tracking_app_id utms[][]: - field: $.http.body.ad_configuration.utm_params[].key value: $.http.body.ad_configuration.utm_params[].value external_url_list[][]: - external_url: $.http.body.landing_page_url_list[].landing_page_url media_info_list[][]: - media_info[]: - ad_format: $.http.body.creative_list[].creative_info.ad_format aigc_disclosure_type: $.http.body.creative_list[].creative_info.aigc_disclosure_type aweme_item_id: $.http.body.creative_list[].creative_info.tiktok_item_id identity_bc_id: $.http.body.creative_list[].creative_info.identity_authorized_bc_id identity_id: $.http.body.creative_list[].creative_info.identity_id identity_type: $.http.body.creative_list[].creative_info.identity_type image_info[][]: - web_uri: $.http.body.creative_list[].creative_info.image_info[].web_uri music_info[]: - music_id: $.http.body.creative_list[].creative_info.music_info.music_id video_info[]: - file_name: $.http.body.creative_list[].creative_info.video_info.file_name video_id: $.http.body.creative_list[].creative_info.video_info.video_id object_list_update_info: is_update_call_to_action_list: $.is_call_to_action_list is_update_card_list: $.is_interactive_add_on_list is_update_external_url_list: $.is_landing_page_url_list is_update_media_info_list: $.is_creative_list is_update_open_url_list: $.is_deeplink_list is_update_page_list: $.is_page_list is_update_title_list: $.is_ad_text_list is_update_utms: $.is_utms open_url_list[][]: - auto_open: $.http.body.deeplink_list[].deeplink_type open_url: $.http.body.deeplink_list[].deeplink page_list: $.http.body.page_list title_list[][]: - title: $.http.body.ad_text_list[].ad_text response_cookie: [] response_header: [] response_rule: ad_configuration: auto_disclaimer_types: $.rpc.output.asset_group_data.common_material.auto_disclaimer_type_list call_to_action_id: $.rpc.output.asset_group_data.common_material.call_to_action_id catalog_creative_toggle: $.rpc.output.asset_group_data.common_material.catalog_creative_toggle dark_post_status: $.rpc.output.asset_group_data.common_material.dark_post_status end_card_cta: $.rpc.output.asset_group_data.common_material.end_card_cta fallback_type: $.rpc.output.asset_group_data.common_material.fallback_type identity_id: $.rpc.output.asset_group_data.common_material.identity_id identity_type: $.rpc.output.asset_group_data.common_material.identity_type phone_number: $.rpc.output.asset_group_data.common_material.phone_number phone_region_calling_code: $.rpc.output.asset_group_data.common_material.phone_zip_code phone_region_code: $.rpc.output.asset_group_data.common_material.phone_country_code product_display_field_list: $.rpc.output.asset_group_data.common_material.product_display_field_list product_ids: $.rpc.output.asset_group_data.common_material.product_ids product_set_id: $.rpc.output.asset_group_data.common_material.product_set_id product_specific_type: $.rpc.output.asset_group_data.common_material.product_specific_type tracking_info: click_tracking_url: $.rpc.output.asset_group_data.common_material.tracking_info.action_track_url impression_tracking_url: $.rpc.output.asset_group_data.common_material.tracking_info.track_url tracking_app_id: $.rpc.output.asset_group_data.common_material.tracking_info.tracking_app_id tracking_message_event_set_id: $.rpc.output.asset_group_data.common_material.tracking_info.tracking_message_event_set_id utm_params[][]: - key: $.rpc.output.asset_group_data.common_material.utms[].field value: $.rpc.output.asset_group_data.common_material.utms[].value ad_name: $.rpc.output.asset_group_data.ad_name ad_text_list[][]: - ad_text: $.rpc.output.asset_group_data.title_list[].title adgroup_id: $.rpc.output.asset_group_data.adgroup_id adgroup_name: $.rpc.output.asset_group_data.adgroup_name advertiser_id: $.rpc.output.asset_group_data.advertiser_id auto_message_list[][]: - auto_message_id: $.rpc.output.asset_group_data.auto_message_list[].auto_message_id call_to_action_list[][]: - call_to_action: $.rpc.output.asset_group_data.call_to_action_list[].call_to_action campaign_id: $.rpc.output.asset_group_data.campaign_id campaign_name: $.rpc.output.asset_group_data.campaign_name create_time: $.rpc.output.asset_group_data.create_time creative_list[][]: - ad_material_id: $.rpc.output.asset_group_data.media_info_list[].id creative_info[]: - ad_format: $.rpc.output.asset_group_data.media_info_list[].media_info.ad_format aigc_disclosure_type: $.rpc.output.asset_group_data.media_info_list[].media_info.aigc_disclosure_type identity_authorized_bc_id: $.rpc.output.asset_group_data.media_info_list[].media_info.identity_bc_id identity_id: $.rpc.output.asset_group_data.media_info_list[].media_info.identity_id identity_type: $.rpc.output.asset_group_data.media_info_list[].media_info.identity_type image_info[][]: - web_uri: $.rpc.output.asset_group_data.media_info_list[].media_info.image_info[].web_uri material_name: $.rpc.output.asset_group_data.media_info_list[].media_info.material_name music_info[]: - music_id: $.rpc.output.asset_group_data.media_info_list[].media_info.music_info.music_id tiktok_item_id: $.rpc.output.asset_group_data.media_info_list[].media_info.aweme_item_id video_info[]: - file_name: $.rpc.output.asset_group_data.media_info_list[].media_info.video_info.file_name video_id: $.rpc.output.asset_group_data.media_info_list[].media_info.video_info.video_id material_operation_status: $.rpc.output.asset_group_data.media_info_list[].aco_opt_status deeplink_list[][]: - deeplink: $.rpc.output.asset_group_data.open_url_list[].open_url deeplink_type: $.rpc.output.asset_group_data.open_url_list[].auto_open interactive_add_on_list[][]: - card_id: $.rpc.output.asset_group_data.card_list[].card_id landing_page_url_list[][]: - landing_page_url: $.rpc.output.asset_group_data.external_url_list[].external_url modify_time: $.rpc.output.asset_group_data.modify_time operation_status: $.rpc.output.asset_group_data.opt_status page_list[][]: - page_id: $.rpc.output.asset_group_data.page_list[].page_id secondary_status: $.rpc.output.asset_group_data.secondary_status smart_plus_ad_id: $.rpc.output.asset_group_data.ad_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /smart_plus/adgroup/create/: post: operationId: Smart_plus Adgroup Create parameters: - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string requestBody: content: application/json: schema: properties: adgroup_name: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.name advertiser_id: description: '' nullable: false 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: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 6 x-open-source: $.http.body.ad_ref_app_id attribution_event_count: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1807532923759682 enum_package_name: AttributionStatisticType enums: - description: '' is_valid: true key: EVERY value: '2' - description: '' is_valid: true key: ONCE value: '1' - description: '' is_valid: true key: UNSET value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 41 x-open-source: $.http.body.attribution_statistic_type bid_price: description: '' format: double nullable: false type: number x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 31 x-open-source: $.http.body.bid bid_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804193278233601 enum_package_name: SmartBidType enums: - description: 手动出价 is_valid: true key: BID_TYPE_CUSTOM value: '0' - description: '' is_valid: true key: BID_TYPE_MAX_CONVERSION value: '3' - description: 国际化no-bid出价 is_valid: true key: BID_TYPE_NO_BID value: '7' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 29 x-open-source: $.http.body.smart_bid_type billing_event: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1807532822255618 enum_package_name: PricingType enums: - description: '' is_valid: true key: CPA value: '7' - description: '' is_valid: true key: CPC value: '2' - description: '' is_valid: true key: CPM value: '1' - description: '' is_valid: true key: CPV value: '10' - description: '' is_valid: true key: GD value: '6' - description: '' is_valid: true key: OCPM value: '9' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 30 x-open-source: $.http.body.pricing budget: description: '' format: double nullable: false type: number x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 14 x-open-source: $.http.body.budget budget_mode: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804191062647810 enum_package_name: BudgetMode enums: - description: '' is_valid: true key: BUDGET_MODE_DAY value: '0' - description: '' is_valid: true key: BUDGET_MODE_DYNAMIC_DAILY_BUDGET value: '3' - description: '' is_valid: true key: BUDGET_MODE_INFINITE value: '-1' - description: '' is_valid: true key: BUDGET_MODE_TOTAL value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 15 x-open-source: $.http.body.budget_mode campaign_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 3 x-open-source: $.http.body.campaign_id catalog_authorized_bc_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 34 x-open-source: $.http.body.catalog_authorized_bc catalog_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 33 x-open-source: $.http.body.product_platform_id click_attribution_window: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1807532889086018 enum_package_name: AttributionWindow enums: - description: '' is_valid: true key: FOURTEEN_DAYS value: '14' - description: '' is_valid: true key: 'OFF' value: '-1' - description: '' is_valid: true key: ONE_DAY value: '1' - description: '' is_valid: true key: SEVEN_DAYS value: '7' - description: '' is_valid: true key: TWENTY_EIGHT_DAYS value: '28' - description: '' is_valid: true key: UNSET value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 38 x-open-source: $.http.body.attribution_window_click comment_disabled: default: false description: '' nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int32(%s) x-open-field-id: 12 x-open-source: $.http.body.is_comment_disable conversion_bid_price: description: '' format: double nullable: false type: number x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 32 x-open-source: $.http.body.cpa_bid custom_conversion_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 49 dayparting: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 19 x-open-source: $.http.body.dayparting deep_bid_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804193389572097 enum_package_name: DeepBidType enums: - description: AEO直投出价 is_valid: true key: AEO value: '101' - description: 标准出价 is_valid: true key: DEFAULT value: '0' - description: 自定义出价 is_valid: true key: MIN value: '1' - description: 动态出价 is_valid: true key: PACING value: '2' - description: 非中VO highest value is_valid: true key: VO_HIGHEST_VALUE value: '109' - description: ROI自动出价，非中含义为VO target CPA is_valid: true key: VO_MIN value: '7' - description: 非中VO minRoas is_valid: true key: VO_MIN_ROAS value: '108' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 26 x-open-source: $.http.body.deep_bid_type deep_cpabid: description: '' format: double nullable: false type: number x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 27 x-open-source: $.http.body.deep_cpabid deep_funnel_event_source: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1829411592902721 enum_package_name: EventSourceIdType enums: - description: '' is_valid: true key: CRM value: '5' - description: '' is_valid: true key: OFFLINE value: '4' - description: '' is_valid: true key: PIXEL value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 45 x-open-source: $.http.body.deep_funnel_event_source deep_funnel_event_source_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 46 x-open-source: $.http.body.deep_funnel_event_source_id deep_funnel_optimization_event: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1799795326256129 enum_package_name: ExternalAction enums: - description: '' is_valid: true key: ACTIVE value: '8' - description: '' is_valid: true key: ACTIVE_PAY value: '14' - description: '' is_valid: true key: ACTIVE_REGISTER value: '13' - description: '' is_valid: true key: ADD_BILLING value: '266' - description: '' is_valid: true key: ADD_BOOKSHELF value: '116' - description: '' is_valid: true key: ADD_PAYMENT_INFO value: '127' - description: '' is_valid: true key: ADD_TO_WISHLIST value: '128' - description: '' is_valid: true key: ANCHOR_CLICK value: '308' - description: '' is_valid: true key: APPLET_DEAL value: '126' - description: application approval is_valid: true key: APPLICATION_APPROVAL value: '321' - description: '' is_valid: true key: APPOINTMENT_DOWNLOAD_BUTTON value: '173' - description: '' is_valid: true key: ASCRIPTION_PHONE value: '161' - description: '' is_valid: true key: AUTHORIZATION value: '121' - description: '' is_valid: true key: BANKCARD_INFORMATION value: '107' - description: '' is_valid: true key: BOOST value: '124' - description: '' is_valid: true key: BUTTON value: '5' - description: '' is_valid: true key: CERTIFICATION_INFORMATION value: '109' - description: '' is_valid: true key: CLICK_CALL_DY value: '69' - description: '' is_valid: true key: CLICK_DOWNLOAD value: '68' - description: '' is_valid: true key: CLICK_LANDING_PAGE value: '66' - description: '' is_valid: true key: CLICK_SHOPWINDow value: '67' - description: '' is_valid: true key: CLICK_WEBSITE value: '70' - description: '' is_valid: true key: CLUE_CONFIRM value: '194' - description: '' is_valid: true key: CLUE_HIGH_INTENTION value: '196' - description: '' is_valid: true key: CLUE_INTERFLOW value: '195' - description: '' is_valid: true key: CLUE_PAY_SUCCEED value: '218' - description: '' is_valid: true key: COMMENT_ACTION value: '47' - description: '' is_valid: true key: COMMODITY_CLICK value: '122' - description: '' is_valid: true key: COMPLETE_TUTORIAL value: '131' - description: '' is_valid: true key: CONSULT value: '97' - description: '' is_valid: true key: CONSULT_CLUE value: '123' - description: '' is_valid: true key: CONSULT_EFFECTIVE value: '19' - description: '' is_valid: true key: CONVERSION_LEADS value: '313' - description: '' is_valid: true key: COUPON value: '28' - description: '' is_valid: true key: CREATE_GAMEROLE value: '38' - description: '' is_valid: true key: CUSTOMER_EFFECTIVE value: '26' - description: customize product is_valid: true key: CUSTOMIZE_PRODUCT value: '318' - description: '' is_valid: true key: DEEP_PURCHASE value: '52' - description: '' is_valid: true key: DESTINATION_VISIT value: '272' - description: '' is_valid: true key: DIALBACK value: '33' - description: '' is_valid: true key: DIALBACK_CONFIRM value: '34' - description: '' is_valid: true key: DIALBACK_CONNECT value: '35' - description: '' is_valid: true key: DOWNLOAD_BUTTON value: '155' - description: '' is_valid: true key: DOWNLOAD_DETAIL value: '154' - description: '' is_valid: true key: DOWNLOAD_FINISH value: '4' - description: '' is_valid: true key: DOWNLOAD_START value: '9' - description: '' is_valid: true key: EC_CLICK_BUY value: '175' - description: '' is_valid: true key: EC_CLICK_PRODUCT value: '179' - description: '' is_valid: true key: EC_CONFRIM_DEAL value: '214' - description: '' is_valid: true key: EC_LIVE_CART value: '210' - description: '' is_valid: true key: EC_LIVE_CLICK_PRODUCT_ACTION value: '208' - description: '' is_valid: true key: EC_LIVE_COMMENT_ACTION value: '205' - description: '' is_valid: true key: EC_LIVE_ENTER_ACTION value: '202' - description: '' is_valid: true key: EC_LIVE_FOLLOW_ACTION value: '204' - description: '' is_valid: true key: EC_LIVE_GIFT_ACTION value: '206' - description: '' is_valid: true key: EC_LIVE_NATIVE_ACTION value: '203' - description: '' is_valid: true key: EC_LIVE_ORDER value: '211' - description: '' is_valid: true key: EC_LIVE_REDIRECT_TO_STORE_ACTION value: '209' - description: '' is_valid: true key: EC_LIVE_SLIDECART_CLICK_ACTION value: '207' - description: '' is_valid: true key: EC_SUBMIT_ORDER value: '176' - description: '' is_valid: true key: EFFECTIVE_COPY value: '27' - description: '' is_valid: true key: ENGAGED_SESSION value: '319' - description: '' is_valid: true key: ENGAGED_VIEW value: '309' - description: '' is_valid: true key: ENGAGED_VIEW_FIFTEEN value: '311' - description: '' is_valid: true key: ENTER_HOMEPAGE value: '181' - description: '' is_valid: true key: FEED_LIVE_HOMEPAGE value: '120' - description: find location is_valid: true key: FIND_LOCATION value: '316' - description: '' is_valid: true key: FOLLOW_ACTION value: '46' - description: '' is_valid: true key: FOLLOW_LIVE_ENTER value: '250' - description: '' is_valid: true key: FOLLOW_VIDEO_PLAY_FINISH value: '252' - description: '' is_valid: true key: FORM value: '2' - description: '' is_valid: true key: FORM_ANSWER value: '32' - description: '' is_valid: true key: FORM_BUTTON value: '151' - description: '' is_valid: true key: FORM_CONNECT value: '31' - description: '' is_valid: true key: FORM_DEEP value: '36' - description: '' is_valid: true key: FORM_DETAIL value: '150' - description: '' is_valid: true key: GAME_ADDICTION value: '25' - description: '' is_valid: true key: HIGHVALUE_CLUE value: '42' - description: '' is_valid: true key: IDCARD_INFORMATION value: '106' - description: '' is_valid: true key: IMPRESSION_LEVEL_AD_REVENUE value: '312' - description: '' is_valid: true key: INITIATE_ORDER value: '267' - description: '' is_valid: true key: INSTALL_FINISH value: '15' - description: '' is_valid: true key: INTENTION_CLUE value: '41' - description: '' is_valid: true key: INVALID_CLUE value: '40' - description: '' is_valid: true key: IN_APP_AD_CLICK value: '132' - description: '' is_valid: true key: IN_APP_AD_IMPR value: '133' - description: '' is_valid: true key: IN_APP_CART value: '22' - description: '' is_valid: true key: IN_APP_DETAIL_UV value: '29' - description: '' is_valid: true key: IN_APP_ORDER value: '20' - description: '' is_valid: true key: IN_APP_PAY value: '23' - description: '' is_valid: true key: IN_APP_UV value: '21' - description: '' is_valid: true key: LANDING_PAGE_VIEW value: '271' - description: '' is_valid: true key: LAUNCH_APP value: '129' - description: '' is_valid: true key: LIKE_ACTION value: '45' - description: '' is_valid: true key: LINK_ACTION value: '51' - description: '' is_valid: true key: LIVE_APPOINTMENT value: '249' - description: '' is_valid: true key: LIVE_CARD_CLICK value: '215' - description: '' is_valid: true key: LIVE_CLICK_PRODUCT_ACTION value: '167' - description: '' is_valid: true key: LIVE_COMMENT_ACTION value: '164' - description: '' is_valid: true key: LIVE_ENTER_ACTION value: '171' - description: '' is_valid: true key: LIVE_FOLLOW_ACTION value: '163' - description: '' is_valid: true key: LIVE_GIFT_ACTION value: '165' - description: '' is_valid: true key: LIVE_HOMEPAGE value: '111' - description: '' is_valid: true key: LIVE_JOIN_GROUP value: '248' - description: '' is_valid: true key: LIVE_NATIVE_ACTION value: '162' - description: '' is_valid: true key: LIVE_REDIRECT_TO_STORE_ACTION value: '168' - description: '' is_valid: true key: LIVE_ROOM_ACTION value: '254' - description: '' is_valid: true key: LIVE_SLIDECART_CLICK_ACTION value: '166' - description: '' is_valid: true key: LIVE_STAY_TIME value: '186' - description: '' is_valid: true key: LIVE_SUCCESSORDER_ACTION value: '172' - description: '' is_valid: true key: LIVE_SUCESSORDER_PAY value: '169' - description: '' is_valid: true key: LOAN value: '119' - description: '' is_valid: true key: LOAN_APPLY value: '118' - description: '' is_valid: true key: LOAN_COMPLETION value: '103' - description: '' is_valid: true key: LOAN_CREDIT value: '105' - description: '' is_valid: true key: LOCATION_ACTION value: '48' - description: '' is_valid: true key: LOGIN value: '114' - description: '' is_valid: true key: LOGIN_ACTION value: '136' - description: '' is_valid: true key: LONGTERM_CUSTOMER value: '130' - description: '' is_valid: true key: LOTTERY value: '11' - description: '' is_valid: true key: LT_ROI value: '110' - description: '' is_valid: true key: MAP_SEARCH value: '3' - description: '' is_valid: true key: MESSAGE value: '94' - description: '' is_valid: true key: MESSAGE_ACTION value: '63' - description: '' is_valid: true key: MESSAGE_CLICK value: '177' - description: '' is_valid: true key: MESSAGE_CLUE value: '192' - description: '' is_valid: true key: MESSAGE_JOIN_GROUP value: '247' - description: '' is_valid: true key: MESSAGE_SELF_SERVICE value: '188' - description: '' is_valid: true key: MESSAGE_SEND value: '310' - description: '' is_valid: true key: MULTIPLE value: '100' - description: '' is_valid: true key: MULTI_NATIVE_ACTION value: '102' - description: '' is_valid: true key: NATIVE_ACTION value: '44' - description: '' is_valid: true key: NAV_BAR value: '149' - description: '' is_valid: true key: NEW_FOLLOW_ACTION value: '187' - description: '' is_valid: true key: NEXT_DAY_OPEN value: '39' - description: '' is_valid: true key: NOVEL_CHAPTER value: '115' - description: add to wishlist is_valid: true key: ON_WEB_ADD_TO_WISHLIST value: '269' - description: '' is_valid: true key: ON_WEB_CART value: '147' - description: '' is_valid: true key: ON_WEB_DETAIL value: '146' - description: '' is_valid: true key: ON_WEB_ORDER value: '148' - description: '' is_valid: true key: ON_WEB_REGISTER value: '145' - description: search is_valid: true key: ON_WEB_SEARCH value: '268' - description: subscribe is_valid: true key: ON_WEB_SUBSCRIBE value: '270' - description: '' is_valid: true key: OTHER value: '99' - description: '' is_valid: true key: OTO_PAY value: '229' - description: '' is_valid: true key: OTO_STAY_TIME value: '228' - description: '' is_valid: true key: PAGE_VIEW value: '93' - description: '' is_valid: true key: PAGE_VISIT value: '314' - description: '' is_valid: true key: PAID_CLUE value: '43' - description: '' is_valid: true key: PAY_ACTION value: '137' - description: '' is_valid: true key: PERSONAL_INFORMATION value: '108' - description: '' is_valid: true key: PHONE value: '1' - description: '' is_valid: true key: PHONE_BUTTON value: '153' - description: '' is_valid: true key: PHONE_CONFIRM value: '16' - description: '' is_valid: true key: PHONE_CONNECT value: '17' - description: '' is_valid: true key: PHONE_DETAIL value: '152' - description: '' is_valid: true key: PHONE_EFFECTIVE value: '18' - description: '' is_valid: true key: PREFERRED_LEAD value: '315' - description: '' is_valid: true key: PREMIUM_PAYMENT value: '174' - description: '' is_valid: true key: PRE_LOAN_CREDIT value: '104' - description: '' is_valid: true key: PURCHASE_OF_GOODS value: '156' - description: '' is_valid: true key: PURCHASE_ROI value: '160' - description: '' is_valid: true key: QQ value: '10' - description: '' is_valid: true key: RATE value: '138' - description: '' is_valid: true key: READING_TIME value: '117' - description: '' is_valid: true key: REDIRECT value: '95' - description: '' is_valid: true key: REDIRECT_TO_SHOP value: '50' - description: '' is_valid: true key: REDIRECT_TO_STORE value: '113' - description: '' is_valid: true key: REGISTER_ACTION value: '139' - description: '' is_valid: true key: RESERVATION value: '62' - description: '' is_valid: true key: RSS value: '30' - description: '' is_valid: true key: SALES_LEAD value: '24' - description: schedule is_valid: true key: SCHEDULE value: '317' - description: '' is_valid: true key: SEARCH value: '140' - description: '' is_valid: true key: SEVEN_DAY_OPEN value: '227' - description: '' is_valid: true key: SHARE_ACTION value: '65' - description: '' is_valid: true key: SHOPPING value: '96' - description: '' is_valid: true key: SHOPPING_ACTION value: '49' - description: '' is_valid: true key: SHOPPING_CART value: '182' - description: '' is_valid: true key: START_TRIAL value: '142' - description: '' is_valid: true key: STAY_TIME value: '125' - description: submit application is_valid: true key: SUBMIT_APPLICATION value: '320' - description: '' is_valid: true key: SUBSCRIBE value: '143' - description: '' is_valid: true key: SUCCESSORDER_ACTION value: '53' - description: '' is_valid: true key: SUCCESSORDER_PAY value: '112' - description: '' is_valid: true key: UG_EFFECTIVE_ACTION value: '245' - description: '' is_valid: true key: UG_EFFECTIVE_DEAL value: '244' - description: '' is_valid: true key: UG_EFFECTIVE_SHARE value: '246' - description: '' is_valid: true key: UG_EFFECTIVE_SPEECH value: '243' - description: '' is_valid: true key: UG_ROI value: '178' - description: '' is_valid: true key: UNLOCK_ACHIEVEMENT value: '144' - description: '' is_valid: true key: UPDATE_LEVEL value: '37' - description: '' is_valid: true key: VIEW value: '7' - description: '' is_valid: true key: VOTE value: '12' - description: '' is_valid: true key: XPATH value: '6' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 47 x-open-source: $.http.body.deep_funnel_optimization_event deep_funnel_optimization_status: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1829411517862913 enum_package_name: DeepFunnelToggle enums: - description: '' is_valid: true key: 'OFF' value: '2' - description: '' is_valid: true key: 'ON' value: '1' - description: '' is_valid: true key: UNSET value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 44 x-open-source: $.http.body.deep_funnel_toggle engaged_view_attribution_window: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1807532889086018 enum_package_name: AttributionWindow enums: - description: '' is_valid: true key: FOURTEEN_DAYS value: '14' - description: '' is_valid: true key: 'OFF' value: '-1' - description: '' is_valid: true key: ONE_DAY value: '1' - description: '' is_valid: true key: SEVEN_DAYS value: '7' - description: '' is_valid: true key: TWENTY_EIGHT_DAYS value: '28' - description: '' is_valid: true key: UNSET value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 39 x-open-source: $.http.body.attribution_window_engaged_view identity_authorized_bc_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 52 identity_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 50 identity_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800331041544193 enum_package_name: IdentityType enums: - description: '' is_valid: false key: AUTH_CODE value: '2' - description: '' is_valid: true key: BC_AUTH_TT value: '5' - description: '' is_valid: false key: BC_SELF_TT value: '4' - description: '' is_valid: false key: CUSTOMIZED_USER value: '1' - description: TTS 授权来源TT账号 is_valid: false key: TTS_TT value: '8' - description: '' is_valid: true key: TT_USER value: '3' - description: '' is_valid: false key: UNSET value: '0' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 51 message_event_set_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 57 x-open-source: $.http.body.ad_ref_message_event_set_id messaging_app_account_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 54 x-open-source: $.http.body.ima_account_id messaging_app_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1842138255512577 enum_package_name: ImaType enums: - description: '' is_valid: true key: IM_URL value: '0' - description: '' is_valid: true key: LINE value: '3' - description: '' is_valid: true key: MESSENGER value: '1' - description: '' is_valid: false key: TikTok value: '5' - description: '' is_valid: true key: WHATSAPP value: '2' - description: '' is_valid: true key: ZALO value: '4' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 53 x-open-source: $.http.body.ima_type min_budget: description: '' format: double nullable: false type: number x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 13 movie_premiere_date: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - datetime_to_timestamp(%s, "date", "utc") x-open-field-id: 48 open_api_partner: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 22 x-open-source: $.http.body.open_api_partner operation_status: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804192764187649 enum_package_name: OptStatus enums: - description: 暂停 is_valid: true key: DISABLE value: '1' - description: 启用 is_valid: true key: ENABLE value: '0' - description: 终止,不能再次被启用 is_valid: false key: FROZEN value: '2' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 23 x-open-source: $.http.body.operation_status optimization_event: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1799795326256129 enum_package_name: ExternalAction enums: - description: '' is_valid: true key: ACTIVE value: '8' - description: '' is_valid: true key: ACTIVE_PAY value: '14' - description: '' is_valid: true key: ACTIVE_REGISTER value: '13' - description: '' is_valid: true key: ADD_BILLING value: '266' - description: '' is_valid: true key: ADD_BOOKSHELF value: '116' - description: '' is_valid: true key: ADD_PAYMENT_INFO value: '127' - description: '' is_valid: true key: ADD_TO_WISHLIST value: '128' - description: '' is_valid: true key: ANCHOR_CLICK value: '308' - description: '' is_valid: true key: APPLET_DEAL value: '126' - description: application approval is_valid: true key: APPLICATION_APPROVAL value: '321' - description: '' is_valid: true key: APPOINTMENT_DOWNLOAD_BUTTON value: '173' - description: '' is_valid: true key: ASCRIPTION_PHONE value: '161' - description: '' is_valid: true key: AUTHORIZATION value: '121' - description: '' is_valid: true key: BANKCARD_INFORMATION value: '107' - description: '' is_valid: true key: BOOST value: '124' - description: '' is_valid: true key: BUTTON value: '5' - description: '' is_valid: true key: CERTIFICATION_INFORMATION value: '109' - description: '' is_valid: true key: CLICK_CALL_DY value: '69' - description: '' is_valid: true key: CLICK_DOWNLOAD value: '68' - description: '' is_valid: true key: CLICK_LANDING_PAGE value: '66' - description: '' is_valid: true key: CLICK_SHOPWINDow value: '67' - description: '' is_valid: true key: CLICK_WEBSITE value: '70' - description: '' is_valid: true key: CLUE_CONFIRM value: '194' - description: '' is_valid: true key: CLUE_HIGH_INTENTION value: '196' - description: '' is_valid: true key: CLUE_INTERFLOW value: '195' - description: '' is_valid: true key: CLUE_PAY_SUCCEED value: '218' - description: '' is_valid: true key: COMMENT_ACTION value: '47' - description: '' is_valid: true key: COMMODITY_CLICK value: '122' - description: '' is_valid: true key: COMPLETE_TUTORIAL value: '131' - description: '' is_valid: true key: CONSULT value: '97' - description: '' is_valid: true key: CONSULT_CLUE value: '123' - description: '' is_valid: true key: CONSULT_EFFECTIVE value: '19' - description: '' is_valid: true key: CONVERSION_LEADS value: '313' - description: '' is_valid: true key: COUPON value: '28' - description: '' is_valid: true key: CREATE_GAMEROLE value: '38' - description: '' is_valid: true key: CUSTOMER_EFFECTIVE value: '26' - description: customize product is_valid: true key: CUSTOMIZE_PRODUCT value: '318' - description: '' is_valid: true key: DEEP_PURCHASE value: '52' - description: '' is_valid: true key: DESTINATION_VISIT value: '272' - description: '' is_valid: true key: DIALBACK value: '33' - description: '' is_valid: true key: DIALBACK_CONFIRM value: '34' - description: '' is_valid: true key: DIALBACK_CONNECT value: '35' - description: '' is_valid: true key: DOWNLOAD_BUTTON value: '155' - description: '' is_valid: true key: DOWNLOAD_DETAIL value: '154' - description: '' is_valid: true key: DOWNLOAD_FINISH value: '4' - description: '' is_valid: true key: DOWNLOAD_START value: '9' - description: '' is_valid: true key: EC_CLICK_BUY value: '175' - description: '' is_valid: true key: EC_CLICK_PRODUCT value: '179' - description: '' is_valid: true key: EC_CONFRIM_DEAL value: '214' - description: '' is_valid: true key: EC_LIVE_CART value: '210' - description: '' is_valid: true key: EC_LIVE_CLICK_PRODUCT_ACTION value: '208' - description: '' is_valid: true key: EC_LIVE_COMMENT_ACTION value: '205' - description: '' is_valid: true key: EC_LIVE_ENTER_ACTION value: '202' - description: '' is_valid: true key: EC_LIVE_FOLLOW_ACTION value: '204' - description: '' is_valid: true key: EC_LIVE_GIFT_ACTION value: '206' - description: '' is_valid: true key: EC_LIVE_NATIVE_ACTION value: '203' - description: '' is_valid: true key: EC_LIVE_ORDER value: '211' - description: '' is_valid: true key: EC_LIVE_REDIRECT_TO_STORE_ACTION value: '209' - description: '' is_valid: true key: EC_LIVE_SLIDECART_CLICK_ACTION value: '207' - description: '' is_valid: true key: EC_SUBMIT_ORDER value: '176' - description: '' is_valid: true key: EFFECTIVE_COPY value: '27' - description: '' is_valid: true key: ENGAGED_SESSION value: '319' - description: '' is_valid: true key: ENGAGED_VIEW value: '309' - description: '' is_valid: true key: ENGAGED_VIEW_FIFTEEN value: '311' - description: '' is_valid: true key: ENTER_HOMEPAGE value: '181' - description: '' is_valid: true key: FEED_LIVE_HOMEPAGE value: '120' - description: find location is_valid: true key: FIND_LOCATION value: '316' - description: '' is_valid: true key: FOLLOW_ACTION value: '46' - description: '' is_valid: true key: FOLLOW_LIVE_ENTER value: '250' - description: '' is_valid: true key: FOLLOW_VIDEO_PLAY_FINISH value: '252' - description: '' is_valid: true key: FORM value: '2' - description: '' is_valid: true key: FORM_ANSWER value: '32' - description: '' is_valid: true key: FORM_BUTTON value: '151' - description: '' is_valid: true key: FORM_CONNECT value: '31' - description: '' is_valid: true key: FORM_DEEP value: '36' - description: '' is_valid: true key: FORM_DETAIL value: '150' - description: '' is_valid: true key: GAME_ADDICTION value: '25' - description: '' is_valid: true key: HIGHVALUE_CLUE value: '42' - description: '' is_valid: true key: IDCARD_INFORMATION value: '106' - description: '' is_valid: true key: IMPRESSION_LEVEL_AD_REVENUE value: '312' - description: '' is_valid: true key: INITIATE_ORDER value: '267' - description: '' is_valid: true key: INSTALL_FINISH value: '15' - description: '' is_valid: true key: INTENTION_CLUE value: '41' - description: '' is_valid: true key: INVALID_CLUE value: '40' - description: '' is_valid: true key: IN_APP_AD_CLICK value: '132' - description: '' is_valid: true key: IN_APP_AD_IMPR value: '133' - description: '' is_valid: true key: IN_APP_CART value: '22' - description: '' is_valid: true key: IN_APP_DETAIL_UV value: '29' - description: '' is_valid: true key: IN_APP_ORDER value: '20' - description: '' is_valid: true key: IN_APP_PAY value: '23' - description: '' is_valid: true key: IN_APP_UV value: '21' - description: '' is_valid: true key: LANDING_PAGE_VIEW value: '271' - description: '' is_valid: true key: LAUNCH_APP value: '129' - description: '' is_valid: true key: LIKE_ACTION value: '45' - description: '' is_valid: true key: LINK_ACTION value: '51' - description: '' is_valid: true key: LIVE_APPOINTMENT value: '249' - description: '' is_valid: true key: LIVE_CARD_CLICK value: '215' - description: '' is_valid: true key: LIVE_CLICK_PRODUCT_ACTION value: '167' - description: '' is_valid: true key: LIVE_COMMENT_ACTION value: '164' - description: '' is_valid: true key: LIVE_ENTER_ACTION value: '171' - description: '' is_valid: true key: LIVE_FOLLOW_ACTION value: '163' - description: '' is_valid: true key: LIVE_GIFT_ACTION value: '165' - description: '' is_valid: true key: LIVE_HOMEPAGE value: '111' - description: '' is_valid: true key: LIVE_JOIN_GROUP value: '248' - description: '' is_valid: true key: LIVE_NATIVE_ACTION value: '162' - description: '' is_valid: true key: LIVE_REDIRECT_TO_STORE_ACTION value: '168' - description: '' is_valid: true key: LIVE_ROOM_ACTION value: '254' - description: '' is_valid: true key: LIVE_SLIDECART_CLICK_ACTION value: '166' - description: '' is_valid: true key: LIVE_STAY_TIME value: '186' - description: '' is_valid: true key: LIVE_SUCCESSORDER_ACTION value: '172' - description: '' is_valid: true key: LIVE_SUCESSORDER_PAY value: '169' - description: '' is_valid: true key: LOAN value: '119' - description: '' is_valid: true key: LOAN_APPLY value: '118' - description: '' is_valid: true key: LOAN_COMPLETION value: '103' - description: '' is_valid: true key: LOAN_CREDIT value: '105' - description: '' is_valid: true key: LOCATION_ACTION value: '48' - description: '' is_valid: true key: LOGIN value: '114' - description: '' is_valid: true key: LOGIN_ACTION value: '136' - description: '' is_valid: true key: LONGTERM_CUSTOMER value: '130' - description: '' is_valid: true key: LOTTERY value: '11' - description: '' is_valid: true key: LT_ROI value: '110' - description: '' is_valid: true key: MAP_SEARCH value: '3' - description: '' is_valid: true key: MESSAGE value: '94' - description: '' is_valid: true key: MESSAGE_ACTION value: '63' - description: '' is_valid: true key: MESSAGE_CLICK value: '177' - description: '' is_valid: true key: MESSAGE_CLUE value: '192' - description: '' is_valid: true key: MESSAGE_JOIN_GROUP value: '247' - description: '' is_valid: true key: MESSAGE_SELF_SERVICE value: '188' - description: '' is_valid: true key: MESSAGE_SEND value: '310' - description: '' is_valid: true key: MULTIPLE value: '100' - description: '' is_valid: true key: MULTI_NATIVE_ACTION value: '102' - description: '' is_valid: true key: NATIVE_ACTION value: '44' - description: '' is_valid: true key: NAV_BAR value: '149' - description: '' is_valid: true key: NEW_FOLLOW_ACTION value: '187' - description: '' is_valid: true key: NEXT_DAY_OPEN value: '39' - description: '' is_valid: true key: NOVEL_CHAPTER value: '115' - description: add to wishlist is_valid: true key: ON_WEB_ADD_TO_WISHLIST value: '269' - description: '' is_valid: true key: ON_WEB_CART value: '147' - description: '' is_valid: true key: ON_WEB_DETAIL value: '146' - description: '' is_valid: true key: ON_WEB_ORDER value: '148' - description: '' is_valid: true key: ON_WEB_REGISTER value: '145' - description: search is_valid: true key: ON_WEB_SEARCH value: '268' - description: subscribe is_valid: true key: ON_WEB_SUBSCRIBE value: '270' - description: '' is_valid: true key: OTHER value: '99' - description: '' is_valid: true key: OTO_PAY value: '229' - description: '' is_valid: true key: OTO_STAY_TIME value: '228' - description: '' is_valid: true key: PAGE_VIEW value: '93' - description: '' is_valid: true key: PAGE_VISIT value: '314' - description: '' is_valid: true key: PAID_CLUE value: '43' - description: '' is_valid: true key: PAY_ACTION value: '137' - description: '' is_valid: true key: PERSONAL_INFORMATION value: '108' - description: '' is_valid: true key: PHONE value: '1' - description: '' is_valid: true key: PHONE_BUTTON value: '153' - description: '' is_valid: true key: PHONE_CONFIRM value: '16' - description: '' is_valid: true key: PHONE_CONNECT value: '17' - description: '' is_valid: true key: PHONE_DETAIL value: '152' - description: '' is_valid: true key: PHONE_EFFECTIVE value: '18' - description: '' is_valid: true key: PREFERRED_LEAD value: '315' - description: '' is_valid: true key: PREMIUM_PAYMENT value: '174' - description: '' is_valid: true key: PRE_LOAN_CREDIT value: '104' - description: '' is_valid: true key: PURCHASE_OF_GOODS value: '156' - description: '' is_valid: true key: PURCHASE_ROI value: '160' - description: '' is_valid: true key: QQ value: '10' - description: '' is_valid: true key: RATE value: '138' - description: '' is_valid: true key: READING_TIME value: '117' - description: '' is_valid: true key: REDIRECT value: '95' - description: '' is_valid: true key: REDIRECT_TO_SHOP value: '50' - description: '' is_valid: true key: REDIRECT_TO_STORE value: '113' - description: '' is_valid: true key: REGISTER_ACTION value: '139' - description: '' is_valid: true key: RESERVATION value: '62' - description: '' is_valid: true key: RSS value: '30' - description: '' is_valid: true key: SALES_LEAD value: '24' - description: schedule is_valid: true key: SCHEDULE value: '317' - description: '' is_valid: true key: SEARCH value: '140' - description: '' is_valid: true key: SEVEN_DAY_OPEN value: '227' - description: '' is_valid: true key: SHARE_ACTION value: '65' - description: '' is_valid: true key: SHOPPING value: '96' - description: '' is_valid: true key: SHOPPING_ACTION value: '49' - description: '' is_valid: true key: SHOPPING_CART value: '182' - description: '' is_valid: true key: START_TRIAL value: '142' - description: '' is_valid: true key: STAY_TIME value: '125' - description: submit application is_valid: true key: SUBMIT_APPLICATION value: '320' - description: '' is_valid: true key: SUBSCRIBE value: '143' - description: '' is_valid: true key: SUCCESSORDER_ACTION value: '53' - description: '' is_valid: true key: SUCCESSORDER_PAY value: '112' - description: '' is_valid: true key: UG_EFFECTIVE_ACTION value: '245' - description: '' is_valid: true key: UG_EFFECTIVE_DEAL value: '244' - description: '' is_valid: true key: UG_EFFECTIVE_SHARE value: '246' - description: '' is_valid: true key: UG_EFFECTIVE_SPEECH value: '243' - description: '' is_valid: true key: UG_ROI value: '178' - description: '' is_valid: true key: UNLOCK_ACHIEVEMENT value: '144' - description: '' is_valid: true key: UPDATE_LEVEL value: '37' - description: '' is_valid: true key: VIEW value: '7' - description: '' is_valid: true key: VOTE value: '12' - description: '' is_valid: true key: XPATH value: '6' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 25 x-open-source: $.http.body.external_action optimization_goal: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804193306612737 enum_package_name: OptimizeGoal enums: - description: '' is_valid: true key: ANCHOR_CLICK value: '112' - description: '' is_valid: true key: ANCHOR_CLICK_PURCHASE value: '117' - description: '' is_valid: true key: AUTOMATED_VALUE value: '125' - description: '' is_valid: true key: CLICK value: '101' - description: '' is_valid: true key: CONVERSATION value: '124' - description: '' is_valid: true key: CONVERSION_LEADS value: '121' - description: '' is_valid: true key: CONVERT value: '100' - description: '' is_valid: true key: DESTINATION_VISIT value: '123' - description: '' is_valid: true key: ENGAGED_VIEW value: '118' - description: '' is_valid: true key: ENGAGED_VIEW_FIFTEEM value: '120' - description: '' is_valid: true key: FOLLOWERS value: '108' - description: '' is_valid: true key: INSTALL value: '105' - description: '' is_valid: true key: IN_APP_EVENT value: '106' - description: '' is_valid: true key: LEAD_GENERATION value: '107' - description: '' is_valid: true key: MESSAGE value: '119' - description: '' is_valid: true key: MT_LIVE_FOLLOW value: '126' - description: '' is_valid: true key: MT_LIVE_ROOM value: '113' - description: '' is_valid: true key: MT_LIVE_SHOPPING value: '116' - description: '' is_valid: true key: PAGE_VISIT value: '122' - description: '' is_valid: true key: POST_ENGAGEMNT value: '110' - description: '' is_valid: true key: PREFERRED_LEAD value: '127' - description: '' is_valid: true key: PRODUCT_CLICK_IN_LIVE value: '114' - description: '' is_valid: true key: PROFILE_VIEWS value: '109' - description: '' is_valid: true key: REACH value: '103' - description: '' is_valid: true key: SHOW value: '102' - description: '' is_valid: true key: TRAFFIC_LANDING_PAGE_VIEW value: '115' - description: '' is_valid: true key: VALUE value: '111' - description: '' is_valid: true key: VIDEO_VIEW value: '104' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 24 x-open-source: $.http.body.optimize_goal phone_info: description: '' nullable: false properties: phone_number: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 phone_region_calling_code: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 phone_region_code: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 56 pixel_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 8 x-open-source: $.http.body.ad_ref_pixel_id placement_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1807532513532929 enum_package_name: InventoryFlowType enums: - description: '' is_valid: true key: PLACEMENT_TYPE_AUTOMATIC value: '0' - description: '' is_valid: true key: PLACEMENT_TYPE_NORMAL value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 5 placements: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800966528747521 enum_package_name: InventoryFlow enums: - description: '' is_valid: true key: PLACEMENT_GLOBAL_APP_BUNDLE value: '1000' - description: '' is_valid: false key: PLACEMENT_HELO value: '4000' - description: '' is_valid: true key: PLACEMENT_PANGLE value: '9000' - description: '' is_valid: true key: PLACEMENT_TIKTOK value: '3000' - description: '' is_valid: false key: PLACEMENT_VIGO value: '2000' key_format: string strict: true use_part: true validate_only: false value_format: int32 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 product_source: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1807533400732674 enum_package_name: ProductSource enums: - description: '' is_valid: true key: CATALOG value: '1' - description: '' is_valid: true key: SHOWCASE value: '3' - description: '' is_valid: true key: STORE value: '2' - description: '' is_valid: true key: UNSET value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 35 x-open-source: $.http.body.product_source promotion_target_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800967779549186 enum_package_name: PromotionTargetType enums: - description: '' is_valid: true key: EXTERNAL_WEBSITE value: '2' - description: '' is_valid: true key: INSTANT_PAGE value: '1' - description: '' is_valid: true key: UNSET value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 37 x-open-source: $.http.body.promotion_target_type promotion_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1799795775493121 enum_package_name: ExternalType enums: - description: '' is_valid: true key: AEO_APK value: '204' - description: '' is_valid: true key: APP_ANDROID value: '201' - description: '' is_valid: true key: APP_IOS value: '202' - description: '' is_valid: true key: LEAD_GENERATION value: '601' - description: '' is_valid: true key: LEAD_GEN_CLICK_TO_CALL value: '603' - description: '' is_valid: true key: LEAD_GEN_CLICK_TO_SOCIAL_MEDIA_APP_MESSAGE value: '605' - description: '' is_valid: true key: LEAD_GEN_CLICK_TO_TT_DIRECT_MESSAGE value: '604' - description: '' is_valid: true key: LIVE_SHOPPING value: '305' - description: '' is_valid: true key: MINI_APP value: '701' - description: '' is_valid: true key: PRODUCT_SHOPPING value: '307' - description: '' is_valid: true key: TIKTOK_SHOP value: '11' - description: '' is_valid: true key: VIDEO_SHOPPING value: '304' - description: '' is_valid: true key: WEBSITE value: '102' - description: '' is_valid: true key: WEBSITE_OR_DISPLAY value: '602' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 7 x-open-source: $.http.body.external_type promotion_website_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1807532535882754 enum_package_name: PromotionWebsiteType enums: - description: '' is_valid: true key: TIKTOK_NATIVE_PAGE value: '1' - description: '' is_valid: true key: UNSET value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 21 x-open-source: $.http.body.promotion_website_type request_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 36 x-open-source: $.http.body.dedup_token roas_bid: description: '' format: double nullable: false type: number x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 28 x-open-source: $.http.body.roas_bid schedule_end_time: description: '' format: datetime nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - datetime_to_timestamp(%s,"date-time","utc") x-open-field-id: 18 x-open-source: $.http.body.end_time_stamp schedule_start_time: description: '' format: datetime nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - datetime_to_timestamp(%s,"date-time","utc") x-open-field-id: 17 x-open-source: $.http.body.start_time_stamp schedule_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1807532710001665 enum_package_name: ScheduleType enums: - description: '' is_valid: true key: SCHEDULE_FROM_NOW value: '1' - description: '' is_valid: true key: SCHEDULE_START_END value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 16 x-open-source: $.http.body.schedule_type share_disabled: description: '' nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 42 x-open-source: $.http.body.is_share_disable suggestion_audience_enabled: description: '' nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 10 targeting_optimization_mode: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1838600430487746 enum_package_name: SpcTargetingSwitch enums: - description: '' is_valid: true key: AUTOMATIC value: '0' - description: '' is_valid: true key: MANUAL value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 9 targeting_spec: description: '' nullable: false properties: actions: description: '' items: nullable: false properties: action_category_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 action_period: description: '' format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 action_scene: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800966577028098 enum_package_name: ActionScene enums: - description: '' is_valid: true key: CREATOR_RELATED value: '11' - description: '' is_valid: true key: HASHTAG_RELATED value: '13' - description: '' is_valid: true key: VIDEO_RELATED value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 1 video_user_actions: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804237663605761 enum_package_name: VideoAction enums: - description: '' is_valid: true key: COMMENTED value: '2' - description: '' is_valid: true key: FOLLOWING value: '4' - description: '' is_valid: true key: LIKED value: '1' - description: '' is_valid: true key: SHARED value: '3' - description: '' is_valid: true key: VIEW_HASHTAG value: '6' - description: '' is_valid: true key: VIEW_HOMEPAGE value: '5' - description: '' is_valid: true key: WATCHED_TO_END value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 type: object x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 15 age_groups: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804615806530625 enum_package_name: AgeType enums: - description: '' is_valid: true key: AGE_13_17 value: '30' - description: '' is_valid: true key: AGE_18_24 value: '42' - description: '' is_valid: true key: AGE_25_34 value: '59' - description: '' is_valid: true key: AGE_35_44 value: '79' - description: '' is_valid: true key: AGE_45_54 value: '99' - description: '' is_valid: true key: AGE_55_100 value: '155' key_format: string strict: true use_part: false validate_only: false value_format: int32 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.audience.age_groups app_targeting_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1844135134496898 enum_package_name: DpaLocalAudience enums: - description: '' is_valid: true key: PROSPECT value: '0' - description: '' is_valid: true key: RETARGETING value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int64 x-open-field-id: 29 audience_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 blocked_pangle_app_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 28 carrier_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 23 device_model_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 26 device_price_ranges: description: '' items: format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 25 excluded_audience_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.body.audience.retargeting_tags_exclude excluded_pangle_audience_package_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 9 gender: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804229882527745 enum_package_name: AudienceGenderType enums: - description: '' is_valid: true key: GENDER_FEMALE value: '2' - description: '' is_valid: true key: GENDER_MALE value: '1' - description: '' is_valid: true key: GENDER_UNLIMITED value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 2 x-open-source: $.http.body.audience.gender household_income: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1810164011458562 enum_package_name: HHILabel enums: - description: 默认值，代表没有hhi标签，不会使用到 is_valid: false key: Default value: '0' - description: top10% is_valid: true key: TOP10 value: '2' - description: top10%~top25% is_valid: true key: TOP10_25 value: '3' - description: top25%~top50% is_valid: true key: TOP25_50 value: '4' - description: top5% is_valid: true key: TOP5 value: '1' key_format: string strict: true use_part: true validate_only: false value_format: int32 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 19 included_pangle_audience_package_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 8 interest_category_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 12 interest_keyword_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 13 isp_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 24 languages: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.audience.language_list location_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 10 x-open-source: $.http.body.audience.particle_locations min_android_version: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 20 min_ios_version: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 21 network_types: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1810160639116290 enum_package_name: AccessType enums: - description: '' is_valid: true key: 2G value: '2' - description: '' is_valid: true key: 3G value: '3' - description: '' is_valid: true key: 4G value: '4' - description: '' is_valid: true key: 5G value: '5' - description: '' is_valid: true key: WIFI value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 22 operating_systems: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800967646681090 enum_package_name: PlatformType enums: - description: '' is_valid: true key: ANDROID value: '1' - description: '' is_valid: true key: IOS value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 purchase_intention_keyword_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 14 saved_audience_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 27 smart_audience_enabled: description: '' nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 17 smart_interest_behavior_enabled: description: '' nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 16 spc_audience_age: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1836070828374017 enum_package_name: ExcludeAgeUnder18Type enums: - description: '' is_valid: true key: OVER_EIGHTEEN value: '1' - description: '' is_valid: true key: OVER_TWENTY_FIVE value: '2' - description: '' is_valid: false key: UNSET value: '0' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 5 x-open-source: $.http.body.audience.exclude_age_under_eighteen spending_power: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1810164182046722 enum_package_name: SpendingPowerType enums: - description: '' is_valid: true key: ALL value: ALL - description: '' is_valid: true key: HIGH value: HIGH key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 18 zipcode_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 11 x-open-source: $.http.body.audience.zipcode_ids type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 11 x-open-source: $.http.body.audience vbo_window: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1810159503625218 enum_package_name: VboDateType enums: - description: '' is_valid: true key: SEVEN_DAYS value: '0' - description: '' is_valid: true key: ZERO_DAY value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 43 x-open-source: $.http.body.vbo_date_type video_download_disabled: description: '' nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int32(%s) x-open-field-id: 20 x-open-source: $.http.body.ad_download_status view_attribution_window: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1807532889086018 enum_package_name: AttributionWindow enums: - description: '' is_valid: true key: FOURTEEN_DAYS value: '14' - description: '' is_valid: true key: 'OFF' value: '-1' - description: '' is_valid: true key: ONE_DAY value: '1' - description: '' is_valid: true key: SEVEN_DAYS value: '7' - description: '' is_valid: true key: TWENTY_EIGHT_DAYS value: '28' - description: '' is_valid: true key: UNSET value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 40 x-open-source: $.http.body.attribution_window_view zalo_id_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1842138458252290 enum_package_name: ImaIdType enums: - description: string is_valid: true key: ZALO_OFFICIAL_ACCOUNT value: '1' - description: phone number is_valid: true key: ZALO_PHONE_ACCOUNT value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 55 x-open-source: $.http.body.ima_id_type required: - advertiser_id - adgroup_name - campaign_id - promotion_type - targeting_spec - schedule_type - schedule_start_time - optimization_goal - billing_event - request_id type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Create a new ad group [Smart Plus AdGroup Create] tags: - Adgroup x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.body.advertiser_id type: number - name: name required: true source: $.http.body.adgroup_name type: string - name: campaign_id required: true source: $.http.body.campaign_id type: number - name: ad_ref_app_id required: false source: $.http.body.app_id type: number - name: external_type required: false source: $.http.body.promotion_type type: number - name: ad_ref_pixel_id required: false source: $.http.body.pixel_id type: number - children: - children: - type: string is_expand: false name: language_list required: false source: $.http.body.targeting_spec.languages[] sub_type: string type: array - name: gender required: false source: $.http.body.targeting_spec.gender type: number - children: - type: number is_expand: false name: age_groups required: false source: $.http.body.targeting_spec.age_groups[] sub_type: number type: array - name: exclude_age_under_eighteen required: false source: $.http.body.targeting_spec.spc_audience_age type: number - children: - type: number is_expand: false name: retargeting_tags_exclude required: false source: $.http.body.targeting_spec.excluded_audience_ids[] sub_type: number type: array - children: - type: number is_expand: false name: particle_locations required: false source: $.http.body.targeting_spec.location_ids[] sub_type: number type: array - children: - type: number is_expand: false name: zipcode_ids required: false source: $.http.body.targeting_spec.zipcode_ids[] sub_type: number type: array - is_expand: false name: min_android_version required: false source: $.http.body.targeting_spec.min_android_version type: string - is_expand: false name: min_ios_version required: false source: $.http.body.targeting_spec.min_ios_version type: string - children: - is_expand: false source: undefined type: number is_expand: false name: ac required: false source: $.http.body.targeting_spec.network_types[] sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: false name: platform required: false source: $.http.body.targeting_spec.operating_systems[] sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: false name: launch_price required: false source: $.http.body.targeting_spec.device_price_ranges[] sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: false name: retargeting_tags required: false source: $.http.body.targeting_spec.audience_ids[] sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: false name: ad_tag_v2 required: false source: $.http.body.targeting_spec.interest_category_ids[] sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: false name: carriers required: false source: $.http.body.targeting_spec.carrier_ids[] sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: false name: household_income required: false source: $.http.body.targeting_spec.household_income[] sub_type: number type: array - children: - is_expand: false source: undefined type: string is_expand: false name: internet_service_providers required: false source: $.http.body.targeting_spec.isp_ids[] sub_type: string type: array - is_expand: false name: saved_audience_id required: false source: $.http.body.targeting_spec.saved_audience_id type: number - is_expand: false name: spending_power required: false source: $.http.body.targeting_spec.spending_power type: string - is_expand: false name: smart_interest_behavior_enabled required: false source: $.http.body.targeting_spec.smart_interest_behavior_enabled type: boolean - is_expand: false name: smart_audience_enabled required: false source: $.http.body.targeting_spec.smart_audience_enabled type: boolean - children: - is_expand: false source: undefined type: number is_expand: false name: exclude_app_package_id required: false source: $.http.body.targeting_spec.blocked_pangle_app_ids[] sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: true name: flow_package_include required: false source: $.http.body.targeting_spec.included_pangle_audience_package_ids[] sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: false name: flow_package_exclude required: false source: $.http.body.targeting_spec.excluded_pangle_audience_package_ids[] sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: false name: in_market_tags required: false source: $.http.body.targeting_spec.purchase_intention_keyword_ids[] sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: false name: interest_keywords_i18n required: false source: $.http.body.targeting_spec.interest_keyword_ids[] sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: false name: device_models required: false source: $.http.body.targeting_spec.device_model_ids[] sub_type: number type: array - children: - children: - is_expand: false name: action_scene required: false source: $.http.body.targeting_spec.actions[].action_scene type: number - is_expand: false name: action_period required: false source: $.http.body.targeting_spec.actions[].action_period type: number - children: - is_expand: false source: undefined type: number is_expand: false name: video_user_actions required: false source: $.http.body.targeting_spec.actions[].video_user_actions sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: false name: action_category_ids required: false source: $.http.body.targeting_spec.actions[].action_category_ids sub_type: number type: array is_expand: true source: undefined type: object is_expand: false name: action_v2 required: false source: $.http.body.targeting_spec.actions[] sub_type: object type: array - is_expand: false name: dpa_local_audience required: false source: $.http.body.targeting_spec.app_targeting_type type: number is_expand: true name: audience required: false type: object - name: is_comment_disable required: false source: $.http.body.comment_disabled type: number - name: budget required: false source: $.http.body.budget type: number - name: budget_mode required: false source: $.http.body.budget_mode type: number - name: schedule_type required: true source: $.http.body.schedule_type type: number - name: start_time_stamp required: true source: $.http.body.schedule_start_time type: number - name: end_time_stamp required: false source: $.http.body.schedule_end_time type: number - name: dayparting required: false source: $.http.body.dayparting type: string - name: ad_download_status required: false source: $.http.body.video_download_disabled type: number - name: promotion_website_type required: false source: $.http.body.promotion_website_type type: number - name: open_api_partner required: false source: $.http.body.open_api_partner type: string - name: operation_status required: false source: $.http.body.operation_status type: number - name: optimize_goal required: false source: $.http.body.optimization_goal type: number - name: external_action required: false source: $.http.body.optimization_event type: number - name: deep_bid_type required: false source: $.http.body.deep_bid_type type: number - name: deep_cpabid required: false source: $.http.body.deep_cpabid type: number - name: roas_bid required: false source: $.http.body.roas_bid type: number - name: smart_bid_type required: false source: $.http.body.bid_type type: number - name: pricing required: false source: $.http.body.billing_event type: number - name: bid required: false source: $.http.body.bid_price type: number - name: cpa_bid required: false source: $.http.body.conversion_bid_price type: number - name: product_platform_id required: false source: $.http.body.catalog_id type: number - name: catalog_authorized_bc required: false source: $.http.body.catalog_authorized_bc_id type: number - name: product_source required: false source: $.http.body.product_source type: number - name: dedup_token required: false source: $.http.body.request_id type: number - name: promotion_target_type required: false source: $.http.body.promotion_target_type type: number - name: attribution_window_click required: false source: $.http.body.click_attribution_window type: number - name: attribution_window_engaged_view required: false source: $.http.body.engaged_view_attribution_window type: number - name: attribution_window_view required: false source: $.http.body.view_attribution_window type: number - name: attribution_statistic_type required: false source: $.http.body.attribution_event_count type: number - name: is_share_disable required: false source: $.http.body.share_disabled type: number - name: vbo_date_type required: false source: $.http.body.vbo_window type: number - name: deep_funnel_toggle required: false source: $.http.body.deep_funnel_optimization_status type: number - name: deep_funnel_event_source required: false source: $.http.body.deep_funnel_event_source type: number - name: deep_funnel_event_source_id required: false source: $.http.body.deep_funnel_event_source_id type: string - name: deep_funnel_optimization_event required: false source: $.http.body.deep_funnel_optimization_event type: number - name: spc_targeting_switch required: false source: $.http.body.targeting_optimization_mode type: number - children: - type: number is_expand: false name: inventory_flow required: false source: $.http.body.placements[] sub_type: number type: array - name: inventory_flow_type required: false source: $.http.body.placement_type type: number - name: min_budget required: false source: $.http.body.min_budget type: number - name: suggestion_audience_enabled required: false source: $.http.body.suggestion_audience_enabled type: boolean - name: movie_premiere_date required: false source: $.http.body.movie_premiere_date type: number - name: custom_conversion_id required: false source: $.http.body.custom_conversion_id type: number - name: ima_type required: false source: $.http.body.messaging_app_type type: number - name: ima_account_id required: false source: $.http.body.messaging_app_account_id type: string - name: ima_id_type required: false source: $.http.body.zalo_id_type type: number - name: identity_id required: false source: $.http.body.identity_id type: string - name: identity_type required: false source: $.http.body.identity_type type: number - name: identity_bc_id required: false source: $.http.body.identity_authorized_bc_id type: number - name: phone_zip_code required: false source: $.http.body.phone_info.phone_region_calling_code type: string - name: phone_number required: false source: $.http.body.phone_info.phone_number type: string - name: phone_country_code required: false source: $.http.body.phone_info.phone_region_code type: string - name: ad_ref_message_event_set_id required: false source: $.http.body.message_event_set_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: ad_download_status: $.http.body.video_download_disabled ad_ref_app_id: $.http.body.app_id ad_ref_message_event_set_id: $.http.body.message_event_set_id ad_ref_pixel_id: $.http.body.pixel_id advertiser_id: $.http.body.advertiser_id attribution_statistic_type: $.http.body.attribution_event_count attribution_window_click: $.http.body.click_attribution_window attribution_window_engaged_view: $.http.body.engaged_view_attribution_window attribution_window_view: $.http.body.view_attribution_window audience: ac: $.http.body.targeting_spec.network_types[] action_v2: $.http.body.targeting_spec.actions[] ad_tag_v2: $.http.body.targeting_spec.interest_category_ids[] age_groups: $.http.body.targeting_spec.age_groups[] carriers: $.http.body.targeting_spec.carrier_ids[] device_models: $.http.body.targeting_spec.device_model_ids[] dpa_local_audience: $.http.body.targeting_spec.app_targeting_type exclude_age_under_eighteen: $.http.body.targeting_spec.spc_audience_age exclude_app_package_id: $.http.body.targeting_spec.blocked_pangle_app_ids[] flow_package_exclude: $.http.body.targeting_spec.excluded_pangle_audience_package_ids[] flow_package_include: $.http.body.targeting_spec.included_pangle_audience_package_ids[] gender: $.http.body.targeting_spec.gender household_income: $.http.body.targeting_spec.household_income[] in_market_tags: $.http.body.targeting_spec.purchase_intention_keyword_ids[] interest_keywords_i18n: $.http.body.targeting_spec.interest_keyword_ids[] internet_service_providers: $.http.body.targeting_spec.isp_ids[] language_list: $.http.body.targeting_spec.languages[] launch_price: $.http.body.targeting_spec.device_price_ranges[] min_android_version: $.http.body.targeting_spec.min_android_version min_ios_version: $.http.body.targeting_spec.min_ios_version particle_locations: $.http.body.targeting_spec.location_ids[] platform: $.http.body.targeting_spec.operating_systems[] retargeting_tags: $.http.body.targeting_spec.audience_ids[] retargeting_tags_exclude: $.http.body.targeting_spec.excluded_audience_ids[] saved_audience_id: $.http.body.targeting_spec.saved_audience_id smart_audience_enabled: $.http.body.targeting_spec.smart_audience_enabled smart_interest_behavior_enabled: $.http.body.targeting_spec.smart_interest_behavior_enabled spending_power: $.http.body.targeting_spec.spending_power zipcode_ids: $.http.body.targeting_spec.zipcode_ids[] bid: $.http.body.bid_price budget: $.http.body.budget budget_mode: $.http.body.budget_mode campaign_id: $.http.body.campaign_id catalog_authorized_bc: $.http.body.catalog_authorized_bc_id cpa_bid: $.http.body.conversion_bid_price custom_conversion_id: $.http.body.custom_conversion_id dayparting: $.http.body.dayparting dedup_token: $.http.body.request_id deep_bid_type: $.http.body.deep_bid_type deep_cpabid: $.http.body.deep_cpabid deep_funnel_event_source: $.http.body.deep_funnel_event_source deep_funnel_event_source_id: $.http.body.deep_funnel_event_source_id deep_funnel_optimization_event: $.http.body.deep_funnel_optimization_event deep_funnel_toggle: $.http.body.deep_funnel_optimization_status end_time_stamp: $.http.body.schedule_end_time external_action: $.http.body.optimization_event external_type: $.http.body.promotion_type identity_bc_id: $.http.body.identity_authorized_bc_id identity_id: $.http.body.identity_id identity_type: $.http.body.identity_type ima_account_id: $.http.body.messaging_app_account_id ima_id_type: $.http.body.zalo_id_type ima_type: $.http.body.messaging_app_type inventory_flow: $.http.body.placements[] inventory_flow_type: $.http.body.placement_type is_comment_disable: $.http.body.comment_disabled is_share_disable: $.http.body.share_disabled min_budget: $.http.body.min_budget movie_premiere_date: $.http.body.movie_premiere_date name: $.http.body.adgroup_name open_api_partner: $.http.body.open_api_partner operation_status: $.http.body.operation_status optimize_goal: $.http.body.optimization_goal phone_country_code: $.http.body.phone_info.phone_region_code phone_number: $.http.body.phone_info.phone_number phone_zip_code: $.http.body.phone_info.phone_region_calling_code pricing: $.http.body.billing_event product_platform_id: $.http.body.catalog_id product_source: $.http.body.product_source promotion_target_type: $.http.body.promotion_target_type promotion_website_type: $.http.body.promotion_website_type roas_bid: $.http.body.roas_bid schedule_type: $.http.body.schedule_type smart_bid_type: $.http.body.bid_type spc_targeting_switch: $.http.body.targeting_optimization_mode start_time_stamp: $.http.body.schedule_start_time suggestion_audience_enabled: $.http.body.suggestion_audience_enabled vbo_date_type: $.http.body.vbo_window response_cookie: [] response_header: [] response_rule: adgroup_id: $.rpc.output.adgroup_data.adgroup_id adgroup_name: $.rpc.output.adgroup_data.name advertiser_id: $.rpc.output.adgroup_data.advertiser_id app_id: $.rpc.output.adgroup_data.ad_ref_app_id attribution_event_count: $.rpc.output.adgroup_data.attribution_statistic_type bid_price: $.rpc.output.adgroup_data.bid bid_type: $.rpc.output.adgroup_data.smart_bid_type billing_event: $.rpc.output.adgroup_data.pricing budget: $.rpc.output.adgroup_data.budget budget_mode: $.rpc.output.adgroup_data.budget_mode campaign_id: $.rpc.output.adgroup_data.campaign_id campaign_name: $.rpc.output.adgroup_data.campaign_name catalog_authorized_bc_id: $.rpc.output.adgroup_data.catalog_authorized_bc catalog_id: $.rpc.output.adgroup_data.product_platform_id click_attribution_window: $.rpc.output.adgroup_data.attribution_window_click comment_disabled: $.rpc.output.adgroup_data.is_comment_disable conversion_bid_price: $.rpc.output.adgroup_data.cpa_bid create_time: $.rpc.output.adgroup_data.display_create_time custom_conversion_id: $.rpc.output.adgroup_data.custom_conversion_id dayparting: $.rpc.output.adgroup_data.dayparting deep_bid_type: $.rpc.output.adgroup_data.deep_bid_type deep_cpabid: $.rpc.output.adgroup_data.deep_cpabid deep_funnel_event_source: $.rpc.output.adgroup_data.deep_funnel_event_source deep_funnel_event_source_id: $.rpc.output.adgroup_data.deep_funnel_event_source_id deep_funnel_optimization_event: $.rpc.output.adgroup_data.deep_funnel_optimization_event deep_funnel_optimization_status: $.rpc.output.adgroup_data.deep_funnel_toggle engaged_view_attribution_window: $.rpc.output.adgroup_data.attribution_window_engaged_view identity_authorized_bc_id: $.rpc.output.adgroup_data.identity_bc_id identity_id: $.rpc.output.adgroup_data.identity_id identity_type: $.rpc.output.adgroup_data.identity_type incentive_offer_type: $.rpc.output.adgroup_data.compensation_activity message_event_set_id: $.rpc.output.adgroup_data.ad_ref_message_event_set_id messaging_app_account_id: $.rpc.output.adgroup_data.ima_account_id messaging_app_type: $.rpc.output.adgroup_data.ima_type min_budget: $.rpc.output.adgroup_data.min_budget modify_time: $.rpc.output.adgroup_data.display_modify_time movie_premiere_date: $.rpc.output.adgroup_data.movie_premiere_date operation_status: $.rpc.output.adgroup_data.operation_status optimization_event: $.rpc.output.adgroup_data.external_action optimization_goal: $.rpc.output.adgroup_data.optimize_goal pacing: $.rpc.output.adgroup_data.flow_control_mode phone_info: phone_number: $.rpc.output.adgroup_data.phone_number phone_region_calling_code: $.rpc.output.adgroup_data.phone_zip_code phone_region_code: $.rpc.output.adgroup_data.phone_country_code pixel_id: $.rpc.output.adgroup_data.ad_ref_pixel_id placement_type: $.rpc.output.adgroup_data.inventory_flow_type placements: $.rpc.output.adgroup_data.inventory_flow product_set_id: $.rpc.output.adgroup_data.product_set_id product_source: $.rpc.output.adgroup_data.product_source promotion_target_type: $.rpc.output.adgroup_data.promotion_target_type promotion_type: $.rpc.output.adgroup_data.external_type promotion_website_type: $.rpc.output.adgroup_data.promotion_website_type roas_bid: $.rpc.output.adgroup_data.roas_bid schedule_end_time: $.rpc.output.adgroup_data.end_time_stamp schedule_start_time: $.rpc.output.adgroup_data.start_time_stamp schedule_type: $.rpc.output.adgroup_data.schedule_type scheduled_budget: $.rpc.output.adgroup_data.scheduled_budget search_result_enabled: $.rpc.output.adgroup_data.search_result_enabled secondary_optimization_event: $.rpc.output.adgroup_data.deep_external_action secondary_status: $.rpc.output.adgroup_data.secondary_status share_disabled: $.rpc.output.adgroup_data.is_share_disable skip_learning_phase: $.rpc.output.adgroup_data.cpa_skip_first_phrase suggestion_audience_enabled: $.rpc.output.adgroup_data.suggestion_audience_enabled targeting_optimization_mode: $.rpc.output.adgroup_data.spc_targeting_switch targeting_spec: actions[][]: - action_category_ids: $.rpc.output.adgroup_data.audience.action_v2[].action_category_ids action_period: $.rpc.output.adgroup_data.audience.action_v2[].action_period action_scene: $.rpc.output.adgroup_data.audience.action_v2[].action_scene video_user_actions: $.rpc.output.adgroup_data.audience.action_v2[].video_user_actions age_groups: $.rpc.output.adgroup_data.audience.age_groups app_targeting_type: $.rpc.output.adgroup_data.audience.dpa_local_audience audience_ids: $.rpc.output.adgroup_data.audience.retargeting_tags blocked_pangle_app_ids: $.rpc.output.adgroup_data.audience.exclude_app_package_id brand_safety_type: $.rpc.output.adgroup_data.audience.brand_safety carrier_ids: $.rpc.output.adgroup_data.audience.carriers category_exclusion_ids: $.rpc.output.adgroup_data.audience.category_exclusion_ids device_model_ids: $.rpc.output.adgroup_data.audience.device_models device_price_ranges: $.rpc.output.adgroup_data.audience.launch_price excluded_audience_ids: $.rpc.output.adgroup_data.audience.retargeting_tags_exclude excluded_pangle_audience_package_ids: $.rpc.output.adgroup_data.audience.flow_package_exclude gender: $.rpc.output.adgroup_data.audience.gender household_income: $.rpc.output.adgroup_data.audience.household_income included_pangle_audience_package_ids: $.rpc.output.adgroup_data.audience.flow_package_include interest_category_ids: $.rpc.output.adgroup_data.audience.ad_tag_v2 interest_keyword_ids: $.rpc.output.adgroup_data.audience.interest_keywords_i18n isp_ids: $.rpc.output.adgroup_data.audience.internet_service_providers languages: $.rpc.output.adgroup_data.audience.language_list location_ids: $.rpc.output.adgroup_data.audience.particle_locations min_android_version: $.rpc.output.adgroup_data.audience.min_android_version min_ios_version: $.rpc.output.adgroup_data.audience.min_ios_version network_types: $.rpc.output.adgroup_data.audience.ac operating_systems: $.rpc.output.adgroup_data.audience.platform purchase_intention_keyword_ids: $.rpc.output.adgroup_data.audience.in_market_tags saved_audience_id: $.rpc.output.adgroup_data.audience.saved_audience_id smart_audience_enabled: $.rpc.output.adgroup_data.audience.smart_audience_enabled smart_interest_behavior_enabled: $.rpc.output.adgroup_data.audience.smart_interest_behavior_enabled spc_audience_age: $.rpc.output.adgroup_data.audience.exclude_age_under_eighteen spending_power: $.rpc.output.adgroup_data.audience.spending_power zipcode_ids: $.rpc.output.adgroup_data.audience.zipcode_ids vbo_window: $.rpc.output.adgroup_data.vbo_date_type video_download_disabled: $.rpc.output.adgroup_data.ad_download_status view_attribution_window: $.rpc.output.adgroup_data.attribution_window_view zalo_id_type: $.rpc.output.adgroup_data.ima_id_type x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /smart_plus/adgroup/get/: get: operationId: Smart_plus Adgroup Get parameters: - description: '' in: query name: advertiser_id required: true schema: type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.advertiser_id x-open-field-id: 1 - content: application/json: schema: nullable: false properties: adgroup_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.query.filtering.adgroup_ids adgroup_name: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.query.filtering.adgroup_name campaign_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.query.filtering.campaign_ids creation_filter_end_time: description: '' format: datetime nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 8 x-open-source: $.http.query.filtering.creation_filter_end_time creation_filter_start_time: description: '' format: datetime nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 x-open-source: $.http.query.filtering.creation_filter_start_time objective_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1799789194562626 enum_package_name: CampaignObjectiveType enums: - description: '' is_valid: false key: APP_INSTALL value: '2' - description: '' is_valid: true key: APP_PROMOTION value: '16' - description: '' is_valid: false key: BRAND_AD value: '50' - description: '' is_valid: false key: CATALOG_SALES value: '6' - description: '' is_valid: false key: CONVERSIONS value: '3' - description: '' is_valid: false key: ENGAGEMENT value: '9' - description: '' is_valid: false key: EST_AD value: '51' - description: '' is_valid: true key: LEAD_GENERATION value: '8' - description: '' is_valid: false key: NONE_TYPE value: '0' - description: '' is_valid: false key: PRODUCT_SALES value: '15' - description: '' is_valid: false key: REACH value: '5' - description: '' is_valid: false key: RF_APP_INSTALL value: '13' - description: '' is_valid: false key: RF_ENGAGEMENT value: '12' - description: '' is_valid: false key: RF_REACH value: '7' - description: '' is_valid: false key: RF_TRAFFIC value: '11' - description: '' is_valid: false key: RF_VIDEO_VIEW value: '10' - description: '' is_valid: false key: SHOP value: '14' - description: '' is_valid: false key: SS_HTC_AD value: '52' - description: '' is_valid: false key: TOPVIEW_REACH value: '50' - description: '' is_valid: false key: TRAFFIC value: '1' - description: '' is_valid: false key: VIDEO_VIEWS value: '4' - description: '' is_valid: true key: WEB_CONVERSIONS value: '1003' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 3 x-open-source: $.http.query.filtering.objective_type optimization_goal: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804192692022273 enum_package_name: OptimizeGoalFilter enums: - description: '' is_valid: true key: ANCHOR_CLICK_PURCHASE value: '17' - description: '' is_valid: true key: CLICK value: '2' - description: '' is_valid: true key: CONVERSATION value: '28' - description: '' is_valid: true key: CONVERSION_LEADS value: '25' - description: '' is_valid: true key: CONVERT value: '1' - description: '' is_valid: true key: DESTINATION_VISIT value: '27' - description: '' is_valid: true key: ENGAGED_VIEW value: '18' - description: '' is_valid: true key: ENGAGED_VIEW_FIFTEEN value: '20' - description: '' is_valid: true key: FOLLOWERS value: '9' - description: '' is_valid: true key: GMV value: '22' - description: '' is_valid: true key: INITIATE_CHECKOUTS value: '24' - description: '' is_valid: true key: INSTALL value: '6' - description: '' is_valid: true key: IN_APP_EVENT value: '7' - description: '' is_valid: true key: LEAD_GENERATION value: '8' - description: '' is_valid: true key: MESSAGE value: '19' - description: '' is_valid: true key: MT_LIVE_ROOM value: '13' - description: '' is_valid: true key: MT_LIVE_SHOPPING value: '16' - description: '' is_valid: true key: PAGE_VISIT value: '26' - description: '' is_valid: true key: POST_ENGAGEMENT value: '11' - description: '' is_valid: true key: PRODUCT_CLICK_IN_LIVE value: '14' - description: '' is_valid: true key: PROFILE_VIEWS value: '10' - description: '' is_valid: true key: PURCHASES value: '23' - description: '' is_valid: true key: REACH value: '4' - description: '' is_valid: true key: SHOW value: '3' - description: '' is_valid: true key: TRAFFIC_LANDING_PAGE_VIEW value: '15' - description: '' is_valid: true key: VALUE value: '12' - description: '' is_valid: true key: VIDEO_VIEW value: '5' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 10 x-open-source: $.http.query.filtering.optimization_goal primary_status: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1827747639725058 enum_package_name: AdgPrimaryStatus enums: - description: '' is_valid: true key: STATUS_ALL value: None - description: '' is_valid: true key: STATUS_DELETE value: delete - description: '' is_valid: true key: STATUS_DELIVERY_OK value: delivery_ok - description: '' is_valid: true key: STATUS_DISABLE value: disable - description: '' is_valid: true key: STATUS_FROZEN value: frozen - description: '' is_valid: true key: STATUS_NOT_DELETE value: no_delete - description: '' is_valid: true key: STATUS_NOT_DELIVERY value: not_delivery - description: '' is_valid: true key: STATUS_RF_CLOSED value: rf_closed - description: '' is_valid: true key: STATUS_TIME_DONE value: time_done key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 5 x-open-source: $.http.query.filtering.primary_status promotion_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1827830268475394 enum_package_name: PromotionTypeFilter enums: - description: '' is_valid: true key: APP value: '1' - description: '' is_valid: true key: INSTANT_FORM value: '5' - description: '' is_valid: true key: LEAD_GEN_CLICK_TO_CALL value: '8' - description: '' is_valid: true key: LEAD_GEN_CLICK_TO_SOCIAL_MEDIA_APP_MESSAGE value: '7' - description: '' is_valid: true key: LEAD_GEN_CLICK_TO_TT_DIRECT_MESSAGE value: '6' - description: '' is_valid: false key: LIVE value: '4' - description: '' is_valid: true key: OTHERS value: '11' - description: '' is_valid: false key: SHORT_VIDEO value: '3' - description: '' is_valid: true key: WEBSITE value: '2' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 9 x-open-source: $.http.query.filtering.promotion_type secondary_status: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1836707190790321 enum_package_name: AdgroupSecondaryStatus enums: - description: '' is_valid: false key: ADGROUP_STATUS_ADGROUP_PRE_ONLINE value: ad_pre_online - description: '' is_valid: false key: ADGROUP_STATUS_ADGROUP_QUOTA_LIMIT value: ad_quota_limit - description: '' is_valid: true key: ADGROUP_STATUS_ADVERTISER_AUDIT value: advertiser_audit - description: '' is_valid: true key: ADGROUP_STATUS_ADVERTISER_AUDIT_DENY value: advertiser_offline_audit - description: '' is_valid: true key: ADGROUP_STATUS_ALL value: None - description: '' is_valid: false key: ADGROUP_STATUS_ASSET_AUTHORIZATION_LOST value: ad_asset_authorization_lost - description: '' is_valid: true key: ADGROUP_STATUS_AUDIT value: ad_audit - description: '' is_valid: true key: ADGROUP_STATUS_AUDIT_DENY value: ad_offline_audit - description: '' is_valid: true key: ADGROUP_STATUS_BALANCE_EXCEED value: ad_offline_balance - description: '' is_valid: true key: ADGROUP_STATUS_BUDGET_EXCEED value: ad_offline_budget - description: '' is_valid: true key: ADGROUP_STATUS_CAMPAIGN_DELETE value: campaign_delete - description: '' is_valid: true key: ADGROUP_STATUS_CAMPAIGN_DISABLE value: campaign_disable - description: '' is_valid: true key: ADGROUP_STATUS_CAMPAIGN_EXCEED value: campaign_offline_budget - description: '' is_valid: false key: ADGROUP_STATUS_CLOSED value: rf_closed_others - description: '' is_valid: true key: ADGROUP_STATUS_CREATE value: ad_create - description: '' is_valid: true key: ADGROUP_STATUS_DELETE value: ad_delete - description: '' is_valid: true key: ADGROUP_STATUS_DELIVERY_OK value: ad_delivery_ok - description: '' is_valid: true key: ADGROUP_STATUS_DISABLE value: ad_disable - description: '' is_valid: true key: ADGROUP_STATUS_FROZEN value: ad_frozen - description: '' is_valid: true key: ADGROUP_STATUS_IDENTITY_USED_BY_GMV_MAX_AD value: roi2_mutex_enable - description: '' is_valid: true key: ADGROUP_STATUS_INDUSTRY_QUALIFICATION_DENY value: ad_industry_qualification_rejected - description: '' is_valid: true key: ADGROUP_STATUS_INDUSTRY_QUALIFICATION_EXPIRED value: ad_industry_qualification_expired - description: '' is_valid: true key: ADGROUP_STATUS_INDUSTRY_QUALIFICATION_MISSING value: ad_industry_qualification_missing - description: '' is_valid: true key: ADGROUP_STATUS_LIVE_NOT_START value: ad_live_not_start - description: '' is_valid: false key: ADGROUP_STATUS_LIVE_OFFLINE value: live_offline - description: '' is_valid: true key: ADGROUP_STATUS_NOT_DELETE value: no_delete - description: '' is_valid: true key: ADGROUP_STATUS_NOT_START value: ad_time_no_reach - description: '' is_valid: true key: ADGROUP_STATUS_PARTIAL_AUDIT_DELIVERY_OK value: ad_partial_audit_and_delivery_ok - description: '' is_valid: true key: ADGROUP_STATUS_PARTIAL_AUDIT_NO_DELIVERY value: ad_partial_audit_but_no_delivery - description: '' is_valid: true key: ADGROUP_STATUS_PIXEL_UNBIND value: ad_pixel_unbind - description: '' is_valid: true key: ADGROUP_STATUS_PROMOTE_AD_NOT_APPROVED value: promote_creative_not_approved - description: '' is_valid: true key: ADGROUP_STATUS_PROMOTE_WITHDRAW_ORDER value: promote_withdraw_order - description: '' is_valid: true key: ADGROUP_STATUS_REAUDIT value: ad_reaudit - description: '' is_valid: false key: ADGROUP_STATUS_REVIEW_PARTIALLY_APPROVED value: ads_review_partially_approved - description: '' is_valid: true key: ADGROUP_STATUS_RF_ADGROUP_INVALID value: rf_no_ad_group - description: '' is_valid: true key: ADGROUP_STATUS_RF_AD_AUDIT_DENY value: rf_creative_not_approved - description: '' is_valid: true key: ADGROUP_STATUS_RF_BOOKING value: rf_booking - description: '' is_valid: true key: ADGROUP_STATUS_RF_CLOSED_OTHERS value: rf_closed_others - description: '' is_valid: true key: ADGROUP_STATUS_RF_DEDUCTION_FAILED value: rf_deduction_failed - description: '' is_valid: true key: ADGROUP_STATUS_RF_NO_DELIVERY_CREATIVE value: rf_no_delivery_creative - description: '' is_valid: true key: ADGROUP_STATUS_RF_NO_VALID_CREATIVE value: rf_no_valid_creative - description: '' is_valid: true key: ADGROUP_STATUS_RF_SCHEDULE value: rf_schedule - description: '' is_valid: true key: ADGROUP_STATUS_RF_SHORT_BALANCE value: rf_short_balance - description: '' is_valid: true key: ADGROUP_STATUS_RF_TERMINATE value: rf_terminate - description: '' is_valid: true key: ADGROUP_STATUS_RF_TIME_DONE value: ad_rf_completed - description: '' is_valid: true key: ADGROUP_STATUS_RF_WITHDRAW_ORDER value: rf_withdraw_order - description: '' is_valid: true key: ADGROUP_STATUS_SEARCH_KEYWORDS_IN_REVIEW value: keyword_in_review - description: '' is_valid: true key: ADGROUP_STATUS_SEARCH_KEYWORDS_NOT_AVAILABLE value: keyword_not_available - description: '' is_valid: true key: ADGROUP_STATUS_SEARCH_KEYWORDS_PARTIAL_APPROVED value: keyword_partial_approved - description: '' is_valid: true key: ADGROUP_STATUS_SHADOW_ADGROUP_REAUDIT value: shadow_ad_reaudit - description: '' is_valid: true key: ADGROUP_STATUS_TIME_DONE value: ad_time_done - description: '' is_valid: false key: ADGROUP_STATUS_TRANSCODING_FAIL value: ad_transcoding_fail - description: '' is_valid: true key: ADVERTISER_ACCOUNT_INVALID value: rf_account_invalid - description: '' is_valid: true key: ADVERTISER_ACCOUNT_PUNISH value: advertiser_punish - description: '' is_valid: true key: ADVERTISER_CONTRACT_PENDING value: advertiser_contract_pending - description: '' is_valid: true key: STATUS_DELETE value: delete - description: '' is_valid: true key: STATUS_DELIVERY_OK value: delivery_ok - description: '' is_valid: true key: STATUS_DISABLE value: disable - description: '' is_valid: true key: STATUS_FROZEN value: frozen - description: '' is_valid: true key: STATUS_NOT_DELIVERY value: not_delivery - description: '' is_valid: true key: STATUS_RF_CLOSED value: rf_closed - description: '' is_valid: true key: STATUS_TIME_DONE value: time_done key_format: string strict: true use_part: true validate_only: false value_format: string x-open-field-id: 4 x-open-source: $.http.query.filtering.secondary_status type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.filtering description: '' in: query name: filtering required: false x-open-field-id: 2 - description: '' in: query name: page required: false schema: default: 1 format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page x-open-field-id: 3 - description: '' in: query name: page_size required: false schema: default: 10 format: int64 maximum: 1000 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page_size x-open-field-id: 4 - content: application/json: schema: items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.fields description: '' in: query name: fields required: false x-open-field-id: 5 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Retrieve ad group details [Smart Plus AdGroup Get] tags: - Adgroup x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - children: - children: - type: number is_expand: false name: adgroup_ids required: false source: $.http.query.filtering.adgroup_ids sub_type: number type: array - children: - type: number is_expand: false name: campaign_ids required: false source: $.http.query.filtering.campaign_ids sub_type: number type: array - name: objective_type required: false source: $.http.query.filtering.objective_type type: number - name: secondary_status required: false source: $.http.query.filtering.secondary_status type: string - name: primary_status required: false source: $.http.query.filtering.primary_status type: string - name: adgroup_name required: false source: $.http.query.filtering.adgroup_name type: string - name: creation_filter_start_time required: false source: $.http.query.filtering.creation_filter_start_time type: string - name: creation_filter_end_time required: false source: $.http.query.filtering.creation_filter_end_time type: string - name: promotion_type required: false source: $.http.query.filtering.promotion_type type: number - name: optimization_goal required: false source: $.http.query.filtering.optimization_goal type: number is_expand: false name: filtering required: false source: $.http.query.filtering type: object - name: page required: true source: $.http.query.page type: number - name: page_size required: true source: $.http.query.page_size type: number - children: - type: string is_expand: true name: fields required: false source: $.http.query.fields sub_type: string type: array plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id fields: $.http.query.fields filtering: $.http.query.filtering page: $.http.query.page page_size: $.http.query.page_size response_cookie: [] response_header: [] response_rule: list[][]: - adgroup_id: $.rpc.output.adgroup_list[].adgroup_id adgroup_name: $.rpc.output.adgroup_list[].name advertiser_id: $.rpc.output.adgroup_list[].advertiser_id app_id: $.rpc.output.adgroup_list[].ad_ref_app_id attribution_event_count: $.rpc.output.adgroup_list[].attribution_statistic_type bid_price: $.rpc.output.adgroup_list[].bid bid_type: $.rpc.output.adgroup_list[].smart_bid_type billing_event: $.rpc.output.adgroup_list[].pricing budget: $.rpc.output.adgroup_list[].budget budget_mode: $.rpc.output.adgroup_list[].budget_mode campaign_id: $.rpc.output.adgroup_list[].campaign_id campaign_name: $.rpc.output.adgroup_list[].campaign_name catalog_authorized_bc_id: $.rpc.output.adgroup_list[].catalog_authorized_bc catalog_id: $.rpc.output.adgroup_list[].product_platform_id click_attribution_window: $.rpc.output.adgroup_list[].attribution_window_click comment_disabled: $.rpc.output.adgroup_list[].is_comment_disable conversion_bid_price: $.rpc.output.adgroup_list[].cpa_bid create_time: $.rpc.output.adgroup_list[].display_create_time custom_conversion_id: $.rpc.output.adgroup_list[].custom_conversion_id dayparting: $.rpc.output.adgroup_list[].dayparting deep_bid_type: $.rpc.output.adgroup_list[].deep_bid_type deep_cpabid: $.rpc.output.adgroup_list[].deep_cpabid deep_funnel_event_source: $.rpc.output.adgroup_list[].deep_funnel_event_source deep_funnel_event_source_id: $.rpc.output.adgroup_list[].deep_funnel_event_source_id deep_funnel_optimization_event: $.rpc.output.adgroup_list[].deep_funnel_optimization_event deep_funnel_toggle: $.rpc.output.adgroup_list[].deep_funnel_toggle engaged_view_attribution_window: $.rpc.output.adgroup_list[].attribution_window_engaged_view identity_authorized_bc_id: $.rpc.output.adgroup_list[].identity_bc_id identity_id: $.rpc.output.adgroup_list[].identity_id identity_type: $.rpc.output.adgroup_list[].identity_type incentive_offer_type: $.rpc.output.adgroup_list[].compensation_activity message_event_set_id: $.rpc.output.adgroup_list[].ad_ref_message_event_set_id messaging_app_account_id: $.rpc.output.adgroup_list[].ima_account_id messaging_app_type: $.rpc.output.adgroup_list[].ima_type min_budget: $.rpc.output.adgroup_list[].min_budget modify_time: $.rpc.output.adgroup_list[].display_modify_time movie_premiere_date: $.rpc.output.adgroup_list[].movie_premiere_date operation_status: $.rpc.output.adgroup_list[].operation_status optimization_event: $.rpc.output.adgroup_list[].external_action optimization_goal: $.rpc.output.adgroup_list[].optimize_goal pacing: $.rpc.output.adgroup_list[].flow_control_mode phone_info[]: - phone_number: $.rpc.output.adgroup_list[].phone_number phone_region_calling_code: $.rpc.output.adgroup_list[].phone_zip_code phone_region_code: $.rpc.output.adgroup_list[].phone_country_code pixel_id: $.rpc.output.adgroup_list[].ad_ref_pixel_id placement_type: $.rpc.output.adgroup_list[].inventory_flow_type placements: $.rpc.output.adgroup_list[].inventory_flow product_set_id: $.rpc.output.adgroup_list[].product_set_id product_source: $.rpc.output.adgroup_list[].product_source promotion_target_type: $.rpc.output.adgroup_list[].promotion_target_type promotion_type: $.rpc.output.adgroup_list[].external_type promotion_website_type: $.rpc.output.adgroup_list[].promotion_website_type roas_bid: $.rpc.output.adgroup_list[].roas_bid schedule_end_time: $.rpc.output.adgroup_list[].end_time_stamp schedule_start_time: $.rpc.output.adgroup_list[].start_time_stamp schedule_type: $.rpc.output.adgroup_list[].schedule_type scheduled_budget: $.rpc.output.adgroup_list[].scheduled_budget search_result_enabled: $.rpc.output.adgroup_list[].search_result_enabled secondary_optimization_event: $.rpc.output.adgroup_list[].deep_external_action secondary_status: $.rpc.output.adgroup_list[].secondary_status share_disabled: $.rpc.output.adgroup_list[].is_share_disable skip_learning_phase: $.rpc.output.adgroup_list[].cpa_skip_first_phrase suggestion_audience_enabled: $.rpc.output.adgroup_list[].suggestion_audience_enabled targeting_optimization_mode: $.rpc.output.adgroup_list[].spc_targeting_switch targeting_spec[]: - actions[][]: - action_category_ids: $.rpc.output.adgroup_list[].audience.action_v2[].action_category_ids action_period: $.rpc.output.adgroup_list[].audience.action_v2[].action_period action_scene: $.rpc.output.adgroup_list[].audience.action_v2[].action_scene video_user_actions: $.rpc.output.adgroup_list[].audience.action_v2[].video_user_actions age_groups: $.rpc.output.adgroup_list[].audience.age_groups app_targeting_type: $.rpc.output.adgroup_list[].audience.dpa_local_audience audience_ids: $.rpc.output.adgroup_list[].audience.retargeting_tags blocked_pangle_app_ids: $.rpc.output.adgroup_list[].audience.exclude_app_package_id brand_safety_type: $.rpc.output.adgroup_list[].audience.brand_safety carrier_ids: $.rpc.output.adgroup_list[].audience.carriers category_exclusion_ids: $.rpc.output.adgroup_list[].audience.category_exclusion_ids contextual_tags: $.rpc.output.adgroup_list[].audience.contextual_tags device_model_ids: $.rpc.output.adgroup_list[].audience.device_models device_price_ranges: $.rpc.output.adgroup_list[].audience.launch_price excluded_audience_ids: $.rpc.output.adgroup_list[].audience.retargeting_tags_exclude excluded_pangle_audience_package_ids: $.rpc.output.adgroup_list[].audience.flow_package_exclude gender: $.rpc.output.adgroup_list[].audience.gender household_income: $.rpc.output.adgroup_list[].audience.household_income included_pangle_audience_package_ids: $.rpc.output.adgroup_list[].audience.flow_package_include interest_category_ids: $.rpc.output.adgroup_list[].audience.ad_tag_v2 interest_keyword_ids: $.rpc.output.adgroup_list[].audience.interest_keywords_i18n isp_ids: $.rpc.output.adgroup_list[].audience.internet_service_providers languages: $.rpc.output.adgroup_list[].audience.language_list location_ids: $.rpc.output.adgroup_list[].audience.particle_locations min_android_version: $.rpc.output.adgroup_list[].audience.min_android_version min_ios_version: $.rpc.output.adgroup_list[].audience.min_ios_version network_types: $.rpc.output.adgroup_list[].audience.ac operating_systems: $.rpc.output.adgroup_list[].audience.platform purchase_intention_keyword_ids: $.rpc.output.adgroup_list[].audience.in_market_tags saved_audience_id: $.rpc.output.adgroup_list[].audience.saved_audience_id smart_audience_enabled: $.rpc.output.adgroup_list[].audience.smart_audience_enabled smart_interest_behavior_enabled: $.rpc.output.adgroup_list[].audience.smart_interest_behavior_enabled spc_audience_age: $.rpc.output.adgroup_list[].audience.exclude_age_under_eighteen spending_power: $.rpc.output.adgroup_list[].audience.spending_power zipcode_ids: $.rpc.output.adgroup_list[].audience.zipcode_ids vbo_window: $.rpc.output.adgroup_list[].vbo_date_type video_download_disabled: $.rpc.output.adgroup_list[].ad_download_status view_attribution_window: $.rpc.output.adgroup_list[].attribution_window_view zalo_id_type: $.rpc.output.adgroup_list[].ima_id_type page_info: $.rpc.output.page_info x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /smart_plus/adgroup/status/update/: post: operationId: Smart_plus Adgroup Status Update parameters: - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string requestBody: content: application/json: schema: properties: adgroup_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) maxItems: 20 minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.adgroup_ids advertiser_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 x-open-source: $.http.body.advertiser_id operation_status: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1811076987051010 enum_package_name: StatusOptType enums: - description: 清除 is_valid: true key: DELETE value: '3' - description: 暂停 is_valid: true key: DISABLE value: '2' - description: 启用 is_valid: true key: ENABLE value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 3 x-open-source: $.http.body.operation_status required: - advertiser_id - adgroup_ids - operation_status type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Update ad group status [Smart Plus AdGroup Status Update] tags: - Adgroup x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.body.advertiser_id type: number - children: - type: number is_expand: false name: adgroup_ids required: true source: $.http.body.adgroup_ids sub_type: number type: array - name: operation_status required: true source: $.http.body.operation_status type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: adgroup_ids: $.http.body.adgroup_ids advertiser_id: $.http.body.advertiser_id operation_status: $.http.body.operation_status response_cookie: [] response_header: [] response_rule: adgroup_list[][]: - adgroup_id: $.rpc.output.adgroup_list[].obj_id status: $.rpc.output.adgroup_list[].status error_list[][]: - adgroup_id: $.rpc.output.error_list[].obj_id error_message: $.rpc.output.error_list[].error_message x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /smart_plus/adgroup/update/: post: operationId: Smart_plus Adgroup Update parameters: - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string requestBody: content: application/json: schema: properties: adgroup_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 2 x-open-source: $.http.body.adgroup_id adgroup_name: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.name advertiser_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 x-open-source: $.http.body.advertiser_id bid_price: description: '' format: double nullable: false type: number x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 10 x-open-source: $.http.body.bid budget: description: '' format: double nullable: false type: number x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.body.budget comment_disabled: description: '' nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int32(%s) x-open-field-id: 4 x-open-source: $.http.body.is_comment_disable conversion_bid_price: description: '' format: double nullable: false type: number x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 13 dayparting: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 9 x-open-source: $.http.body.dayparting min_budget: description: '' format: double nullable: false type: number x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 11 pacing: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1810156218235905 enum_package_name: FlowControlMode enums: - description: 尽快投放 is_valid: true key: PACING_MODE_FAST value: '0' - description: 平均投放 is_valid: true key: PACING_MODE_SMOOTH value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 12 roas_bid: description: '' format: double nullable: false type: number x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 14 x-open-source: $.http.body.roas_bid schedule_end_time: description: '' format: datetime nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - datetime_to_timestamp(%s,"date-time","utc") x-open-field-id: 8 x-open-source: $.http.body.end_time_stamp schedule_start_time: description: '' format: datetime nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - datetime_to_timestamp(%s,"date-time","utc") x-open-field-id: 7 x-open-source: $.http.body.start_time_stamp schedule_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1807532710001665 enum_package_name: ScheduleType enums: - description: '' is_valid: true key: SCHEDULE_FROM_NOW value: '1' - description: '' is_valid: true key: SCHEDULE_START_END value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 6 x-open-source: $.http.body.schedule_type share_disabled: description: '' nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int32(%s) x-open-field-id: 15 x-open-source: $.http.body.is_share_disable suggestion_audience_enabled: description: '' nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 16 targeting_optimization_mode: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1838600430487746 enum_package_name: SpcTargetingSwitch enums: - description: '' is_valid: true key: AUTOMATIC value: '0' - description: '' is_valid: true key: MANUAL value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 17 targeting_spec: description: '' nullable: false properties: actions: description: '' items: nullable: false properties: action_category_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 action_period: description: '' format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 action_scene: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800966577028098 enum_package_name: ActionScene enums: - description: '' is_valid: true key: CREATOR_RELATED value: '11' - description: '' is_valid: true key: HASHTAG_RELATED value: '13' - description: '' is_valid: true key: VIDEO_RELATED value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 1 video_user_actions: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804237663605761 enum_package_name: VideoAction enums: - description: '' is_valid: true key: COMMENTED value: '2' - description: '' is_valid: true key: FOLLOWING value: '4' - description: '' is_valid: true key: LIKED value: '1' - description: '' is_valid: true key: SHARED value: '3' - description: '' is_valid: true key: VIEW_HASHTAG value: '6' - description: '' is_valid: true key: VIEW_HOMEPAGE value: '5' - description: '' is_valid: true key: WATCHED_TO_END value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 type: object x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 15 age_groups: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804615806530625 enum_package_name: AgeType enums: - description: '' is_valid: true key: AGE_13_17 value: '30' - description: '' is_valid: true key: AGE_18_24 value: '42' - description: '' is_valid: true key: AGE_25_34 value: '59' - description: '' is_valid: true key: AGE_35_44 value: '79' - description: '' is_valid: true key: AGE_45_54 value: '99' - description: '' is_valid: true key: AGE_55_100 value: '155' key_format: string strict: true use_part: false validate_only: false value_format: int32 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.audience.age_groups audience_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 blocked_pangle_app_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 28 carrier_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 23 device_model_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 26 device_price_ranges: description: '' items: format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 25 excluded_audience_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.body.audience.retargeting_tags_exclude excluded_pangle_audience_package_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 9 gender: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804229882527745 enum_package_name: AudienceGenderType enums: - description: '' is_valid: true key: GENDER_FEMALE value: '2' - description: '' is_valid: true key: GENDER_MALE value: '1' - description: '' is_valid: true key: GENDER_UNLIMITED value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 2 x-open-source: $.http.body.audience.gender household_income: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1810164011458562 enum_package_name: HHILabel enums: - description: 默认值，代表没有hhi标签，不会使用到 is_valid: false key: Default value: '0' - description: top10% is_valid: true key: TOP10 value: '2' - description: top10%~top25% is_valid: true key: TOP10_25 value: '3' - description: top25%~top50% is_valid: true key: TOP25_50 value: '4' - description: top5% is_valid: true key: TOP5 value: '1' key_format: string strict: true use_part: true validate_only: false value_format: int32 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 19 included_pangle_audience_package_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 8 interest_category_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 12 interest_keyword_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 13 isp_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 24 languages: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.audience.language_list location_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 10 x-open-source: $.http.body.audience.particle_locations min_android_version: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 20 min_ios_version: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 21 network_types: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1810160639116290 enum_package_name: AccessType enums: - description: '' is_valid: true key: 2G value: '2' - description: '' is_valid: true key: 3G value: '3' - description: '' is_valid: true key: 4G value: '4' - description: '' is_valid: true key: 5G value: '5' - description: '' is_valid: true key: WIFI value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 22 operating_systems: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800967646681090 enum_package_name: PlatformType enums: - description: '' is_valid: true key: ANDROID value: '1' - description: '' is_valid: true key: IOS value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 purchase_intention_keyword_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 14 saved_audience_id: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 27 smart_audience_enabled: description: '' nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 17 smart_interest_behavior_enabled: description: '' nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 16 spc_audience_age: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1836070828374017 enum_package_name: ExcludeAgeUnder18Type enums: - description: '' is_valid: true key: OVER_EIGHTEEN value: '1' - description: '' is_valid: true key: OVER_TWENTY_FIVE value: '2' - description: '' is_valid: false key: UNSET value: '0' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 5 x-open-source: $.http.body.audience.exclude_age_under_eighteen spending_power: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1810164182046722 enum_package_name: SpendingPowerType enums: - description: '' is_valid: true key: ALL value: ALL - description: '' is_valid: true key: HIGH value: HIGH key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 18 zipcode_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 11 x-open-source: $.http.body.audience.zipcode_ids type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 18 x-open-source: $.http.body.audience required: - advertiser_id - adgroup_id type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Update an ad group [Smart Plus AdGroup Update] tags: - Adgroup x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.body.advertiser_id type: number - name: adgroup_id required: true source: $.http.body.adgroup_id type: number - name: name required: false source: $.http.body.adgroup_name type: string - name: is_comment_disable required: false source: $.http.body.comment_disabled type: number - name: budget required: false source: $.http.body.budget type: number - name: schedule_type required: false source: $.http.body.schedule_type type: number - name: start_time_stamp required: false source: $.http.body.schedule_start_time type: number - name: end_time_stamp required: false source: $.http.body.schedule_end_time type: number - name: dayparting required: false source: $.http.body.dayparting type: string - name: bid required: false source: $.http.body.bid_price type: number - name: roas_bid required: false source: $.http.body.roas_bid type: number - children: - children: - type: string is_expand: false name: language_list required: false source: $.http.body.targeting_spec.languages[] sub_type: string type: array - name: gender required: false source: $.http.body.targeting_spec.gender type: number - children: - type: number is_expand: false name: age_groups required: false source: $.http.body.targeting_spec.age_groups[] sub_type: number type: array - name: exclude_age_under_eighteen required: false source: $.http.body.targeting_spec.spc_audience_age type: number - children: - type: number is_expand: false name: retargeting_tags_exclude required: false source: $.http.body.targeting_spec.excluded_audience_ids[] sub_type: number type: array - children: - type: number is_expand: false name: particle_locations required: false source: $.http.body.targeting_spec.location_ids[] sub_type: number type: array - children: - type: number is_expand: false name: zipcode_ids required: false source: $.http.body.targeting_spec.zipcode_ids[] sub_type: number type: array - is_expand: false name: smart_interest_behavior_enabled required: false source: $.http.body.targeting_spec.smart_interest_behavior_enabled type: boolean - is_expand: false name: smart_audience_enabled required: false source: $.http.body.targeting_spec.smart_audience_enabled type: boolean - children: - is_expand: false source: undefined type: number is_expand: false name: retargeting_tags required: false source: $.http.body.targeting_spec.audience_ids[] sub_type: number type: array - children: - is_expand: false source: undefined type: string is_expand: false name: internet_service_providers required: false source: $.http.body.targeting_spec.isp_ids[] sub_type: string type: array - is_expand: false name: saved_audience_id required: false source: $.http.body.targeting_spec.saved_audience_id type: number - children: - is_expand: false source: undefined type: number is_expand: false name: household_income required: false source: $.http.body.targeting_spec.household_income[] sub_type: number type: array - is_expand: false name: spending_power required: false source: $.http.body.targeting_spec.spending_power type: string - children: - is_expand: false source: undefined type: number is_expand: false name: in_market_tags required: false source: $.http.body.targeting_spec.purchase_intention_keyword_ids[] sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: false name: interest_keywords_i18n required: false source: $.http.body.targeting_spec.interest_keyword_ids sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: false name: ad_tag_v2 required: false source: $.http.body.targeting_spec.interest_category_ids[] sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: false name: carriers required: false source: $.http.body.targeting_spec.carrier_ids[] sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: false name: device_models required: false source: $.http.body.targeting_spec.device_model_ids[] sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: false name: flow_package_include required: false source: $.http.body.targeting_spec.included_pangle_audience_package_ids[] sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: false name: flow_package_exclude required: false source: $.http.body.targeting_spec.excluded_pangle_audience_package_ids[] sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: false name: exclude_app_package_id required: false source: $.http.body.targeting_spec.blocked_pangle_app_ids[] sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: false name: platform required: false source: $.http.body.targeting_spec.operating_systems[] sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: false name: ac required: false source: $.http.body.targeting_spec.network_types[] sub_type: number type: array - is_expand: false name: min_android_version required: false source: $.http.body.targeting_spec.min_android_version type: string - is_expand: false name: min_ios_version required: false source: $.http.body.targeting_spec.min_ios_version type: string - children: - children: - is_expand: false name: action_scene required: false source: $.http.body.targeting_spec.actions[].action_scene type: number - is_expand: false name: action_period required: false source: $.http.body.targeting_spec.actions[].action_period type: number - children: - is_expand: false source: undefined type: number is_expand: false name: video_user_actions required: false source: $.http.body.targeting_spec.actions[].video_user_actions sub_type: number type: array - children: - is_expand: false source: undefined type: number is_expand: false name: action_category_ids required: false source: $.http.body.targeting_spec.actions[].action_category_ids sub_type: number type: array is_expand: true source: undefined type: object is_expand: false name: action_v2 required: false source: $.http.body.targeting_spec.actions[] sub_type: object type: array - children: - is_expand: false source: undefined type: number is_expand: false name: launch_price required: false source: $.http.body.targeting_spec.device_price_ranges[] sub_type: number type: array is_expand: true name: audience required: false type: object - name: is_share_disable required: false source: $.http.body.share_disabled type: number - name: cpa_bid required: false source: $.http.body.conversion_bid_price type: number - name: suggestion_audience_enabled required: false source: $.http.body.suggestion_audience_enabled type: boolean - name: flow_control_mode required: false source: $.http.body.pacing type: number - name: spc_targeting_switch required: false source: $.http.body.targeting_optimization_mode type: number - name: min_budget required: false source: $.http.body.min_budget type: number - name: movie_premiere_date required: false source: $.http.body.movie_premiere_date type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: adgroup_id: $.http.body.adgroup_id advertiser_id: $.http.body.advertiser_id audience: ac: $.http.body.targeting_spec.network_types[] action_v2: $.http.body.targeting_spec.actions[] ad_tag_v2: $.http.body.targeting_spec.interest_category_ids[] age_groups: $.http.body.targeting_spec.age_groups[] carriers: $.http.body.targeting_spec.carrier_ids[] device_models: $.http.body.targeting_spec.device_model_ids[] exclude_age_under_eighteen: $.http.body.targeting_spec.spc_audience_age exclude_app_package_id: $.http.body.targeting_spec.blocked_pangle_app_ids[] flow_package_exclude: $.http.body.targeting_spec.excluded_pangle_audience_package_ids[] flow_package_include: $.http.body.targeting_spec.included_pangle_audience_package_ids[] gender: $.http.body.targeting_spec.gender household_income: $.http.body.targeting_spec.household_income[] in_market_tags: $.http.body.targeting_spec.purchase_intention_keyword_ids[] interest_keywords_i18n: $.http.body.targeting_spec.interest_keyword_ids internet_service_providers: $.http.body.targeting_spec.isp_ids[] language_list: $.http.body.targeting_spec.languages[] launch_price: $.http.body.targeting_spec.device_price_ranges[] min_android_version: $.http.body.targeting_spec.min_android_version min_ios_version: $.http.body.targeting_spec.min_ios_version particle_locations: $.http.body.targeting_spec.location_ids[] platform: $.http.body.targeting_spec.operating_systems[] retargeting_tags: $.http.body.targeting_spec.audience_ids[] retargeting_tags_exclude: $.http.body.targeting_spec.excluded_audience_ids[] saved_audience_id: $.http.body.targeting_spec.saved_audience_id smart_audience_enabled: $.http.body.targeting_spec.smart_audience_enabled smart_interest_behavior_enabled: $.http.body.targeting_spec.smart_interest_behavior_enabled spending_power: $.http.body.targeting_spec.spending_power zipcode_ids: $.http.body.targeting_spec.zipcode_ids[] bid: $.http.body.bid_price budget: $.http.body.budget cpa_bid: $.http.body.conversion_bid_price dayparting: $.http.body.dayparting end_time_stamp: $.http.body.schedule_end_time flow_control_mode: $.http.body.pacing is_comment_disable: $.http.body.comment_disabled is_share_disable: $.http.body.share_disabled min_budget: $.http.body.min_budget movie_premiere_date: $.http.body.movie_premiere_date name: $.http.body.adgroup_name roas_bid: $.http.body.roas_bid schedule_type: $.http.body.schedule_type spc_targeting_switch: $.http.body.targeting_optimization_mode start_time_stamp: $.http.body.schedule_start_time suggestion_audience_enabled: $.http.body.suggestion_audience_enabled response_cookie: [] response_header: [] response_rule: adgroup_id: $.rpc.output.adgroup_data.adgroup_id adgroup_name: $.rpc.output.adgroup_data.name advertiser_id: $.rpc.output.adgroup_data.advertiser_id app_id: $.rpc.output.adgroup_data.ad_ref_app_id attribution_event_count: $.rpc.output.adgroup_data.attribution_statistic_type bid_price: $.rpc.output.adgroup_data.bid bid_type: $.rpc.output.adgroup_data.smart_bid_type billing_event: $.rpc.output.adgroup_data.pricing budget: $.rpc.output.adgroup_data.budget budget_mode: $.rpc.output.adgroup_data.budget_mode campaign_id: $.rpc.output.adgroup_data.campaign_id campaign_name: $.rpc.output.adgroup_data.campaign_name catalog_authorized_bc_id: $.rpc.output.adgroup_data.catalog_authorized_bc catalog_id: $.rpc.output.adgroup_data.product_platform_id click_attribution_window: $.rpc.output.adgroup_data.attribution_window_click comment_disabled: $.rpc.output.adgroup_data.is_comment_disable conversion_bid_price: $.rpc.output.adgroup_data.cpa_bid create_time: $.rpc.output.adgroup_data.display_create_time custom_conversion_id: $.rpc.output.adgroup_data.custom_conversion_id dayparting: $.rpc.output.adgroup_data.dayparting deep_bid_type: $.rpc.output.adgroup_data.deep_bid_type deep_cpabid: $.rpc.output.adgroup_data.deep_cpabid deep_funnel_event_source: $.rpc.output.adgroup_data.deep_funnel_event_source deep_funnel_event_source_id: $.rpc.output.adgroup_data.deep_funnel_event_source_id deep_funnel_optimization_event: $.rpc.output.adgroup_data.deep_funnel_optimization_event deep_funnel_optimization_status: $.rpc.output.adgroup_data.deep_funnel_toggle engaged_view_attribution_window: $.rpc.output.adgroup_data.attribution_window_engaged_view identity_authorized_bc_id: $.rpc.output.adgroup_data.identity_bc_id identity_id: $.rpc.output.adgroup_data.identity_id identity_type: $.rpc.output.adgroup_data.identity_type incentive_offer_type: $.rpc.output.adgroup_data.compensation_activity message_event_set_id: $.rpc.output.adgroup_data.ad_ref_message_event_set_id messaging_app_account_id: $.rpc.output.adgroup_data.ima_account_id messaging_app_type: $.rpc.output.adgroup_data.ima_type min_budget: $.rpc.output.adgroup_data.min_budget modify_time: $.rpc.output.adgroup_data.display_modify_time movie_premiere_date: $.rpc.output.adgroup_data.movie_premiere_date operation_status: $.rpc.output.adgroup_data.operation_status optimization_event: $.rpc.output.adgroup_data.external_action optimization_goal: $.rpc.output.adgroup_data.optimize_goal pacing: $.rpc.output.adgroup_data.flow_control_mode phone_info: phone_number: $.rpc.output.adgroup_data.phone_number phone_region_calling_code: $.rpc.output.adgroup_data.phone_zip_code phone_region_code: $.rpc.output.adgroup_data.phone_country_code pixel_id: $.rpc.output.adgroup_data.ad_ref_pixel_id placement_type: $.rpc.output.adgroup_data.inventory_flow_type placements: $.rpc.output.adgroup_data.inventory_flow product_set_id: $.rpc.output.adgroup_data.product_set_id product_source: $.rpc.output.adgroup_data.product_source promotion_target_type: $.rpc.output.adgroup_data.promotion_target_type promotion_type: $.rpc.output.adgroup_data.external_type promotion_website_type: $.rpc.output.adgroup_data.promotion_website_type roas_bid: $.rpc.output.adgroup_data.roas_bid schedule_end_time: $.rpc.output.adgroup_data.end_time_stamp schedule_start_time: $.rpc.output.adgroup_data.start_time_stamp schedule_type: $.rpc.output.adgroup_data.schedule_type scheduled_budget: $.rpc.output.adgroup_data.scheduled_budget search_result_enabled: $.rpc.output.adgroup_data.search_result_enabled secondary_optimization_event: $.rpc.output.adgroup_data.deep_external_action secondary_status: $.rpc.output.adgroup_data.secondary_status share_disabled: $.rpc.output.adgroup_data.is_share_disable skip_learning_phase: $.rpc.output.adgroup_data.cpa_skip_first_phrase suggestion_audience_enabled: $.rpc.output.adgroup_data.suggestion_audience_enabled targeting_optimization_mode: $.rpc.output.adgroup_data.spc_targeting_switch targeting_spec: actions[][]: - action_category_ids: $.rpc.output.adgroup_data.audience.action_v2[].action_category_ids action_period: $.rpc.output.adgroup_data.audience.action_v2[].action_period action_scene: $.rpc.output.adgroup_data.audience.action_v2[].action_scene video_user_actions: $.rpc.output.adgroup_data.audience.action_v2[].video_user_actions age_groups: $.rpc.output.adgroup_data.audience.age_groups app_targeting_type: $.rpc.output.adgroup_data.audience.dpa_local_audience audience_ids: $.rpc.output.adgroup_data.audience.retargeting_tags blocked_pangle_app_ids: $.rpc.output.adgroup_data.audience.exclude_app_package_id brand_safety_type: $.rpc.output.adgroup_data.audience.brand_safety carrier_ids: $.rpc.output.adgroup_data.audience.carriers category_exclusion_ids: $.rpc.output.adgroup_data.audience.category_exclusion_ids device_model_ids: $.rpc.output.adgroup_data.audience.device_models device_price_ranges: $.rpc.output.adgroup_data.audience.launch_price excluded_audience_ids: $.rpc.output.adgroup_data.audience.retargeting_tags_exclude excluded_pangle_audience_package_ids: $.rpc.output.adgroup_data.audience.flow_package_exclude gender: $.rpc.output.adgroup_data.audience.gender household_income: $.rpc.output.adgroup_data.audience.household_income included_pangle_audience_package_ids: $.rpc.output.adgroup_data.audience.flow_package_include interest_category_ids: $.rpc.output.adgroup_data.audience.ad_tag_v2 interest_keyword_ids: $.rpc.output.adgroup_data.audience.interest_keywords_i18n isp_ids: $.rpc.output.adgroup_data.audience.internet_service_providers languages: $.rpc.output.adgroup_data.audience.language_list location_ids: $.rpc.output.adgroup_data.audience.particle_locations min_android_version: $.rpc.output.adgroup_data.audience.min_android_version min_ios_version: $.rpc.output.adgroup_data.audience.min_ios_version network_types: $.rpc.output.adgroup_data.audience.ac operating_systems: $.rpc.output.adgroup_data.audience.platform purchase_intention_keyword_ids: $.rpc.output.adgroup_data.audience.in_market_tags saved_audience_id: $.rpc.output.adgroup_data.audience.saved_audience_id smart_audience_enabled: $.rpc.output.adgroup_data.audience.smart_audience_enabled smart_interest_behavior_enabled: $.rpc.output.adgroup_data.audience.smart_interest_behavior_enabled spc_audience_age: $.rpc.output.adgroup_data.audience.exclude_age_under_eighteen spending_power: $.rpc.output.adgroup_data.audience.spending_power zipcode_ids: $.rpc.output.adgroup_data.audience.zipcode_ids vbo_window: $.rpc.output.adgroup_data.vbo_date_type video_download_disabled: $.rpc.output.adgroup_data.ad_download_status view_attribution_window: $.rpc.output.adgroup_data.attribution_window_view zalo_id_type: $.rpc.output.adgroup_data.ima_id_type x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /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: '' nullable: false 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: '' nullable: false 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: '' nullable: false 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: '' nullable: false 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 nullable: false 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: '' nullable: false 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: '' nullable: false 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: '' nullable: false 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: '' nullable: false 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: '' nullable: false 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: '' nullable: false 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: '' nullable: false 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: '' nullable: false 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: '' nullable: false 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: '' nullable: false 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: '' nullable: false 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: '' nullable: false 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: '' nullable: false 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: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 23 postback_window_mode: description: '' nullable: false 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: '' nullable: false 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: '' nullable: false 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: nullable: false 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 nullable: false 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string 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: nullable: false 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: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: 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: nullable: false properties: campaign_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false 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: '' nullable: false 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 nullable: false 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 nullable: false 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: '' nullable: false 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: '' nullable: false 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: '' nullable: false 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 nullable: false 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 nullable: false 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string 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: '' nullable: false 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: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) maxItems: 20 minItems: 1 nullable: false 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: '' nullable: false 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: '' nullable: false 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string 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: '' nullable: false 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 nullable: false 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: '' nullable: false 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: '' nullable: false 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: '' nullable: false 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string 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 /smart_plus/material/review_info/: get: operationId: Smart_plus Material Review_info parameters: - description: '' in: query name: advertiser_id required: true schema: nullable: false 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: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) maxItems: 100 minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.material_ids description: '' in: query name: ad_material_ids required: true x-open-field-id: 2 - content: application/json: schema: nullable: false properties: include_reject_info: default: false description: '' nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.query.need_optional_info.need_reason include_violation_frame: default: false description: '' nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.query.need_optional_info.need_violation_frames type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.need_optional_info description: '' in: query name: extra_info_setting required: false x-open-field-id: 3 - description: '' in: query name: lang required: false schema: default: '""' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.lang x-open-field-id: 4 - content: application/json: schema: nullable: false properties: app_id: description: '' format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.query.context_info.app_id core_user_id: description: '' format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.query.context_info.core_user_id developer_id: description: '' format: int64 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.query.context_info.developer_id developer_region: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.query.context_info.developer_region referer: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 8 x-open-source: $.http.query.context_info.referer user_agent: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 x-open-source: $.http.query.context_info.user_agent x_forwarded_for: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.query.context_info.x_forwarded_for x_real_ip: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.query.context_info.x_real_ip type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.context_info description: '' in: query name: context_info required: false x-open-field-id: 5 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get material review info [Smart Plus Material Review Info] tags: - Ad x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - children: - type: number is_expand: true name: material_ids required: true source: $.http.query.ad_material_ids sub_type: number type: array - children: - name: need_reason required: false source: $.http.query.extra_info_setting.include_reject_info type: boolean - name: need_violation_frames required: false source: $.http.query.extra_info_setting.include_violation_frame type: boolean is_expand: true name: need_optional_info required: false type: object - name: lang required: true source: $.http.query.lang type: string - 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: developer_region required: false source: $.http.query.context_info.developer_region type: string - 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: true name: context_info required: true source: $.http.query.context_info type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id context_info: $.http.query.context_info lang: $.http.query.lang material_ids: $.http.query.ad_material_ids need_optional_info: need_reason: $.http.query.extra_info_setting.include_reject_info need_violation_frames: $.http.query.extra_info_setting.include_violation_frame response_cookie: [] response_header: [] response_rule: material_review_infos[][]: - ad_material_id: $.rpc.output.material_rating_infos[].id passed_locations: $.rpc.output.material_rating_infos[].passed_countries reject_info[][]: - content_info[]: - carousel_music_info: $.rpc.output.material_rating_infos[].reasons[].content_info.carousel_music_info content_type: $.rpc.output.material_rating_infos[].reasons[].content_info.content_value_type image_content[]: - image_id: $.rpc.output.material_rating_infos[].reasons[].content_info.value_image.web_uri text_content: $.rpc.output.material_rating_infos[].reasons[].content_info.value_str video_content: $.rpc.output.material_rating_infos[].reasons[].content_info.value_video forbidden_ages: $.rpc.output.material_rating_infos[].reasons[].forbidden_ages forbidden_locations: $.rpc.output.material_rating_infos[].reasons[].forbidden_countries forbidden_placements: $.rpc.output.material_rating_infos[].reasons[].forbidden_inventory_flows reasons: $.rpc.output.material_rating_infos[].reasons[].value specification: $.rpc.output.material_rating_infos[].reasons[].specification suggestion: $.rpc.output.material_rating_infos[].reasons[].suggestion violation_frames[][]: - type: $.rpc.output.material_rating_infos[].reasons[].violation_frames[].type video_id: $.rpc.output.material_rating_infos[].reasons[].violation_frames[].vid video_violation_frames[][]: - hover_periods: $.rpc.output.material_rating_infos[].reasons[].violation_frames[].video_violation_frames_v2[].hover_periods thumbnail_periods: $.rpc.output.material_rating_infos[].reasons[].violation_frames[].video_violation_frames_v2[].thumbnail_periods web_url: $.rpc.output.material_rating_infos[].reasons[].violation_frames[].video_violation_frames_v2[].web_url violation_frame_material_type: $.rpc.output.material_rating_infos[].reasons[].violation_frames[].violation_frame_material_type web_url_list: $.rpc.output.material_rating_infos[].reasons[].violation_frames[].web_url_list review_status: $.rpc.output.material_rating_infos[].audit_result_type smart_plus_ad_id: $.rpc.output.material_rating_infos[].creative_id x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /smart_plus/material_report/breakdown/: get: operationId: Smart_plus Material_report Breakdown parameters: - description: '' in: query name: advertiser_id required: true schema: nullable: false 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: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1836027313923138 enum_package_name: SppReportDimension enums: - description: '' is_valid: false key: ad_id value: creative_id - description: '' is_valid: true key: ad_text_entity_id value: text_entity_id - description: '' is_valid: false key: adgroup_id value: ad_id - description: '' is_valid: false key: advertiser_id value: advertiser_id - description: '' is_valid: true key: call_to_action_entity_id value: call_to_action_entity_id - description: '' is_valid: false key: campaign_id value: campaign_id - description: '' is_valid: true key: interactive_add_on_entity_id value: add_on_entity_id - description: '' is_valid: true key: main_material_id value: main_entity_id - description: '' is_valid: true key: stat_time_day value: stat_time_day - description: '' is_valid: true key: stat_time_hour value: stat_time_hour - description: '' is_valid: true key: stat_time_month value: stat_time_month - description: '' is_valid: true key: stat_time_week value: stat_time_week key_format: string strict: true use_part: true validate_only: false value_format: string maxItems: 5 minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.dimensions description: '' in: query name: dimensions required: true x-open-field-id: 2 - content: application/json: schema: items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1837121920475138 enum_package_name: SppReportMetrics enums: - description: '' is_valid: true key: achieve_level value: time_attr_update_level - description: '' is_valid: true key: achieve_level_rate value: time_attr_update_level_per_install - description: '' is_valid: true key: ad_impression_ad_revenue_day0 value: time_attr_total_repetitive_active_pay_value_d0_iaa - description: '' is_valid: true key: ad_impression_ad_revenue_day2 value: time_attr_total_repetitive_active_pay_value_d2_iaa - description: '' is_valid: true key: ad_impression_ad_revenue_roas_day0 value: time_attr_active_pay_roas_d0_iaa - description: '' is_valid: true key: ad_impression_ad_revenue_roas_day2 value: time_attr_active_pay_roas_d2_iaa - description: '' is_valid: true key: ad_impression_ad_revenue_roas_day6 value: time_attr_active_pay_roas_d6_iaa - description: '' is_valid: false key: ad_material_id value: ad_material_draft_id - description: '' is_valid: true key: add_billing value: time_attr_add_billing_count - description: '' is_valid: true key: add_billing_rate value: time_attr_add_billing_count_per_click - description: '' is_valid: true key: add_payment_info value: time_attr_add_payment_info - description: '' is_valid: true key: add_payment_info_rate value: time_attr_add_payment_info_per_install - description: '' is_valid: true key: add_to_wishlist value: time_attr_add_to_wishlist - description: '' is_valid: true key: add_to_wishlist_rate value: time_attr_add_to_wishlist_per_install - description: '' is_valid: true key: ads_impression_events value: time_attr_repetitive_ad_revenue - description: '' is_valid: true key: anchor_click_rate value: anchor_click_rate - description: '' is_valid: true key: anchor_clicks value: anchor_click_count - description: '' is_valid: true key: app_event_add_to_cart value: time_attr_in_app_cart - description: '' is_valid: true key: app_event_add_to_cart_rate value: time_attr_in_app_cart_per_install - description: '' is_valid: true key: app_install value: time_attr_active - description: '' is_valid: true key: average_video_play value: average_video_play - description: '' is_valid: true key: avg_value_per_pageview value: time_attr_total_page_view_value - description: '' is_valid: true key: button_click value: time_attr_button_standardized - description: '' is_valid: true key: button_click_rate value: time_attr_button_standardized_per_click - description: '' is_valid: true key: checkout value: time_attr_in_app_order - description: '' is_valid: true key: checkout_rate value: time_attr_in_app_order_per_install - description: '' is_valid: true key: clicks value: click_cnt - description: '' is_valid: true key: clicks_on_hashtag_challenge value: ies_challenge_click - description: '' is_valid: true key: clicks_on_music_disc value: ies_music_click - description: '' is_valid: true key: comments value: ad_comment - description: '' is_valid: true key: complete_payment value: time_attr_shopping - description: '' is_valid: true key: complete_payment_rate value: time_attr_shopping_per_click - description: '' is_valid: true key: complete_payment_roas value: time_attr_shopping_roas - description: '' is_valid: true key: complete_tutorial value: time_attr_complete_tutorial - description: '' is_valid: true key: complete_tutorial_rate value: time_attr_complete_tutorial_per_install - description: '' is_valid: true key: conversion value: time_attr_convert_cnt - description: '' is_valid: true key: conversion_rate_v2 value: time_attr_conversion_rate_imp - description: '' is_valid: true key: cost_per_achieve_level value: time_attr_cost_per_update_level - description: '' is_valid: true key: cost_per_add_billing value: time_attr_cost_per_add_billing_count - description: '' is_valid: true key: cost_per_add_payment_info value: time_attr_cost_per_add_payment_info - description: '' is_valid: true key: cost_per_add_to_wishlist value: time_attr_cost_per_add_to_wishlist - description: '' is_valid: true key: cost_per_app_event_add_to_cart value: time_attr_cost_per_in_app_cart - description: '' is_valid: true key: cost_per_app_install value: time_attr_active_cost - description: '' is_valid: true key: cost_per_button_click value: time_attr_cost_per_button_standardized - description: '' is_valid: true key: cost_per_checkout value: time_attr_cost_per_in_app_order - description: '' is_valid: true key: cost_per_complete_payment value: time_attr_cost_per_shopping - description: '' is_valid: true key: cost_per_complete_tutorial value: time_attr_cost_per_complete_tutorial - description: '' is_valid: true key: cost_per_conversion value: time_attr_conversion_cost - description: '' is_valid: true key: cost_per_create_gamerole value: time_attr_cost_per_create_gamerole - description: '' is_valid: true key: cost_per_create_group value: time_attr_cost_per_create_group - description: '' is_valid: true key: cost_per_cta_app_install value: time_attr_active_click_cost - description: '' is_valid: true key: cost_per_cta_conversion value: time_attr_convert_cnt_click_cost - description: '' is_valid: true key: cost_per_cta_purchase value: time_attr_active_pay_click_cost - description: '' is_valid: true key: cost_per_cta_registration value: time_attr_active_register_click_cost - description: '' is_valid: true key: cost_per_custom_app_event value: time_attr_cost_per_repetitive_app_customized_events - description: '' is_valid: true key: cost_per_custom_page_event value: time_attr_cost_per_web_customized_events - description: '' is_valid: true key: cost_per_day7_retention value: time_attr_cost_per_retention_7d - description: '' is_valid: true key: cost_per_download_start value: time_attr_cost_per_download_start - description: '' is_valid: true key: cost_per_engaged_view_through_conversion value: time_attr_convert_cnt_ev_cost - description: '' is_valid: true key: cost_per_evta_app_install value: time_attr_active_ev_cost - description: '' is_valid: true key: cost_per_evta_payments_completed value: time_attr_shopping_ev_cost - description: '' is_valid: true key: cost_per_evta_purchase value: time_attr_active_pay_ev_cost - description: '' is_valid: true key: cost_per_evta_registration value: time_attr_active_register_ev_cost - description: '' is_valid: true key: cost_per_form value: time_attr_cost_per_form - description: '' is_valid: true key: cost_per_in_app_ad_click value: time_attr_cost_per_in_app_ad_click - description: '' is_valid: true key: cost_per_in_app_ad_impr value: time_attr_cost_per_in_app_ad_impr - description: '' is_valid: true key: cost_per_initiate_checkout value: time_attr_cost_per_initiate_checkout_count - description: '' is_valid: true key: cost_per_ix_button_click_count value: cost_per_ix_button_click_count - description: '' is_valid: true key: cost_per_ix_page_view_count value: cost_per_ix_page_view_count - description: '' is_valid: true key: cost_per_ix_product_click_count value: cost_per_ix_product_click_count - description: '' is_valid: true key: cost_per_join_group value: time_attr_cost_per_join_group - description: '' is_valid: true key: cost_per_landing_page_view value: time_attr_cost_per_web_landing_page_view - description: '' is_valid: true key: cost_per_launch_app value: time_attr_cost_per_launch_app - description: '' is_valid: true key: cost_per_loan_apply value: time_attr_cost_per_loan_apply - description: '' is_valid: true key: cost_per_loan_credit value: time_attr_cost_per_loan_credit - description: '' is_valid: true key: cost_per_loan_disbursement value: time_attr_cost_per_loan_completion - description: '' is_valid: true key: cost_per_login value: time_attr_cost_per_login - description: '' is_valid: true key: cost_per_next_day_open value: time_attr_cost_per_next_day_open - description: '' is_valid: true key: cost_per_offline_add_payment_info_event value: time_attr_cost_per_offline_add_billing - description: '' is_valid: true key: cost_per_offline_add_to_cart_event value: time_attr_cost_per_offline_add_to_cart - description: '' is_valid: true key: cost_per_offline_add_to_wishlist_event value: time_attr_cost_per_offline_add_to_wishlist - description: '' is_valid: true key: cost_per_offline_click_button_event value: time_attr_cost_per_offline_button - description: '' is_valid: true key: cost_per_offline_complete_registration_event value: time_attr_cost_per_offline_register - description: '' is_valid: true key: cost_per_offline_contact_event value: time_attr_cost_per_offline_contact - description: '' is_valid: true key: cost_per_offline_download_event value: time_attr_cost_per_offline_download_start - description: '' is_valid: true key: cost_per_offline_form_event value: time_attr_cost_per_offline_submit_form - description: '' is_valid: true key: cost_per_offline_initiate_checkout_event value: time_attr_cost_per_offline_initiate_checkout - description: '' is_valid: true key: cost_per_offline_place_order_event value: time_attr_cost_per_offline_order - description: '' is_valid: true key: cost_per_offline_search_event value: time_attr_cost_per_offline_search - description: '' is_valid: true key: cost_per_offline_shopping_event value: time_attr_cost_per_offline_shopping - description: '' is_valid: true key: cost_per_offline_subscribe_event value: time_attr_cost_per_offline_subscribe - description: '' is_valid: true key: cost_per_offline_view_content_event value: time_attr_cost_per_offline_detail - description: '' is_valid: true key: cost_per_on_web_add_to_wishlist value: time_attr_cost_per_on_web_add_to_wishlist - description: '' is_valid: true key: cost_per_on_web_order value: time_attr_cost_per_on_web_order - description: '' is_valid: true key: cost_per_on_web_subscribe value: time_attr_cost_per_on_web_subscribe - description: '' is_valid: true key: cost_per_online_consult value: time_attr_cost_per_consult_standardized - description: '' is_valid: true key: cost_per_onsite_add_billing value: time_attr_cost_per_onsite_add_billing - description: '' is_valid: true key: cost_per_onsite_add_to_wishlist value: time_attr_cost_per_onsite_add_to_wishlist - description: '' is_valid: true key: cost_per_onsite_destination_visit value: time_attr_cost_per_onsite_destination_visit - description: '' is_valid: true key: cost_per_onsite_download_start value: time_attr_cost_per_onsite_download_start - description: '' is_valid: true key: cost_per_onsite_form value: time_attr_cost_per_onsite_form - description: '' is_valid: true key: cost_per_onsite_initiate_checkout_count value: time_attr_cost_per_onsite_initiate_checkout_count - description: '' is_valid: true key: cost_per_onsite_on_web_cart value: time_attr_cost_per_onsite_on_web_cart - description: '' is_valid: true key: cost_per_onsite_on_web_detail value: time_attr_cost_per_onsite_on_web_detail - description: '' is_valid: true key: cost_per_onsite_shopping value: time_attr_cost_per_onsite_shopping - description: '' is_valid: true key: cost_per_page_content_view_event value: time_attr_cost_per_on_web_detail_standardized - description: '' is_valid: true key: cost_per_page_event_search value: time_attr_cost_per_search_count - description: '' is_valid: true key: cost_per_pageview value: time_attr_cost_per_page_view - description: '' is_valid: true key: cost_per_purchase value: time_attr_active_pay_cost - description: '' is_valid: true key: cost_per_ratings value: time_attr_cost_per_rate - description: '' is_valid: true key: cost_per_registration value: time_attr_active_register_cost - description: '' is_valid: true key: cost_per_sales_lead value: time_attr_cost_per_sales_lead - description: '' is_valid: true key: cost_per_search value: time_attr_cost_per_search - description: '' is_valid: true key: cost_per_spend_credits value: time_attr_cost_per_spend_credits - description: '' is_valid: true key: cost_per_start_trial value: time_attr_cost_per_start_trial - description: '' is_valid: true key: cost_per_subscribe value: time_attr_cost_per_subscribe - description: '' is_valid: true key: cost_per_total_achieve_level value: time_attr_cost_per_repetitive_update_level - description: '' is_valid: true key: cost_per_total_add_to_wishlist value: time_attr_cost_per_repetitive_add_to_wishlist - description: '' is_valid: true key: cost_per_total_app_event_add_to_cart value: time_attr_cost_per_repetitive_in_app_cart - description: '' is_valid: true key: cost_per_total_checkout value: time_attr_cost_per_repetitive_in_app_order - description: '' is_valid: true key: cost_per_total_complete_tutorial value: time_attr_cost_per_repetitive_complete_tutorial - description: '' is_valid: true key: cost_per_total_create_gamerole value: time_attr_cost_per_repetitive_create_gamerole - description: '' is_valid: true key: cost_per_total_create_group value: time_attr_cost_per_repetitive_create_group - description: '' is_valid: true key: cost_per_total_day7_retention value: time_attr_cost_per_repetitive_retention_7d - description: '' is_valid: true key: cost_per_total_in_app_ad_click value: time_attr_cost_per_repetitive_in_app_ad_click - description: '' is_valid: true key: cost_per_total_in_app_ad_impr value: time_attr_cost_per_repetitive_in_app_ad_impr - description: '' is_valid: true key: cost_per_total_join_group value: time_attr_cost_per_repetitive_join_group - description: '' is_valid: true key: cost_per_total_launch_app value: time_attr_cost_per_repetitive_launch_app - description: '' is_valid: true key: cost_per_total_loan_apply value: time_attr_cost_per_repetitive_loan_apply - description: '' is_valid: true key: cost_per_total_loan_credit value: time_attr_cost_per_repetitive_loan_credit - description: '' is_valid: true key: cost_per_total_loan_disbursement value: time_attr_cost_per_repetitive_loan_completion - description: '' is_valid: true key: cost_per_total_login value: time_attr_cost_per_repetitive_login - description: '' is_valid: true key: cost_per_total_next_day_open value: time_attr_cost_per_repetitive_next_day_open - description: '' is_valid: true key: cost_per_total_purchase value: time_attr_cost_per_repetitive_active_pay - description: '' is_valid: true key: cost_per_total_ratings value: time_attr_cost_per_repetitive_rate - description: '' is_valid: true key: cost_per_total_registration value: time_attr_cost_per_repetitive_active_register - description: '' is_valid: true key: cost_per_total_sales_lead value: time_attr_cost_per_repetitive_sales_lead - description: '' is_valid: true key: cost_per_total_search value: time_attr_cost_per_repetitive_search - description: '' is_valid: true key: cost_per_total_spend_credits value: time_attr_cost_per_repetitive_spend_credits - description: '' is_valid: true key: cost_per_total_start_trial value: time_attr_cost_per_repetitive_start_trial - description: '' is_valid: true key: cost_per_total_subscribe value: time_attr_cost_per_repetitive_subscribe - description: '' is_valid: true key: cost_per_total_unlock_achievement value: time_attr_cost_per_repetitive_unlock_achievement - description: '' is_valid: true key: cost_per_total_view_content value: time_attr_cost_per_repetitive_in_app_detail_uv - description: '' is_valid: true key: cost_per_unique_ad_impression_event value: time_attr_cost_per_ad_revenue - description: '' is_valid: true key: cost_per_unique_custom_app_event value: time_attr_cost_per_app_customized_events - description: '' is_valid: true key: cost_per_unlock_achievement value: time_attr_cost_per_unlock_achievement - description: '' is_valid: true key: cost_per_user_registration value: time_attr_cost_per_on_web_register - description: '' is_valid: true key: cost_per_view_content value: time_attr_cost_per_in_app_detail_uv - description: '' is_valid: true key: cost_per_vta_app_install value: time_attr_active_show_cost - description: '' is_valid: true key: cost_per_vta_conversion value: time_attr_convert_cnt_show_cost - description: '' is_valid: true key: cost_per_vta_payments_completed value: time_attr_cost_per_shopping_show - description: '' is_valid: true key: cost_per_vta_purchase value: time_attr_active_pay_show_cost - description: '' is_valid: true key: cost_per_vta_registration value: time_attr_active_register_show_cost - description: '' is_valid: true key: cost_per_web_event_add_to_cart value: time_attr_cost_per_on_web_cart - description: '' is_valid: true key: cost_pre_ad_impression_event value: time_attr_cost_per_repetitive_ad_revenue - description: '' is_valid: true key: cost_total_add_payment_info value: time_attr_cost_per_repetitive_add_payment_info - description: '' is_valid: true key: countdown_sticker_recall_clicks value: recall_message_click_cnt - description: '' is_valid: true key: cpc value: cpc - description: '' is_valid: true key: cpm value: cpm - description: '' is_valid: true key: create_gamerole value: time_attr_create_gamerole - description: '' is_valid: true key: create_gamerole_rate value: time_attr_create_gamerole_per_install - description: '' is_valid: true key: create_group value: time_attr_create_group - description: '' is_valid: true key: create_group_rate value: time_attr_create_group_per_install - description: '' is_valid: true key: cta_app_install value: time_attr_active_click - description: '' is_valid: true key: cta_conversion value: time_attr_convert_cnt_click - description: '' is_valid: true key: cta_purchase value: time_attr_active_pay_click - description: '' is_valid: true key: cta_registration value: time_attr_active_register_click - description: '' is_valid: true key: ctr value: ctr - description: '' is_valid: true key: custom_app_event_rate value: time_attr_app_customized_events_per_install - description: '' is_valid: true key: custom_app_events value: time_attr_repetitive_app_customized_events - description: '' is_valid: true key: custom_app_events_value value: time_attr_total_repetitive_app_customized_events_value - description: '' is_valid: true key: custom_page_event_rate value: time_attr_web_customized_events_per_click - description: '' is_valid: true key: custom_page_events value: time_attr_web_customized_events - description: '' is_valid: true key: custom_page_events_value value: time_attr_total_web_customized_events_value - description: '' is_valid: true key: customized_ad_impression_event_rate value: time_attr_ad_revenue_per_install - description: '' is_valid: true key: day7_retention value: time_attr_retention_7d - description: '' is_valid: true key: day7_retention_rate value: time_attr_retention_7d_per_install - description: '' is_valid: true key: download_start value: time_attr_download_start - description: '' is_valid: true key: download_start_rate value: time_attr_download_start_per_click - description: '' is_valid: true key: duet_clicks value: duet_click_cnt - description: '' is_valid: true key: engaged_view value: engaged_view - description: '' is_valid: true key: engaged_view_15s value: engaged_view_15s - description: '' is_valid: true key: engaged_view_through_conversions value: time_attr_convert_cnt_ev - description: '' is_valid: true key: engagement_rate value: total_engagement_rate - description: '' is_valid: true key: engagements value: total_engagement - description: '' is_valid: true key: evta_app_install value: time_attr_active_ev - description: '' is_valid: true key: evta_payments_completed value: time_attr_shopping_ev - description: '' is_valid: true key: evta_purchase value: time_attr_active_pay_ev - description: '' is_valid: true key: evta_registration value: time_attr_active_register_ev - description: '' is_valid: true key: follows value: ad_net_follow - description: '' is_valid: true key: form value: time_attr_form - description: '' is_valid: true key: form_rate value: time_attr_form_per_click - description: '' is_valid: true key: gross_impressions value: gross_show_count - description: '' is_valid: true key: impressions value: show_cnt - description: '' is_valid: true key: in_app_ad_click value: time_attr_in_app_ad_click - description: '' is_valid: true key: in_app_ad_click_rate value: time_attr_in_app_ad_click_per_install - description: '' is_valid: true key: in_app_ad_impr value: time_attr_in_app_ad_impr - description: '' is_valid: true key: in_app_ad_impr_rate value: time_attr_in_app_ad_impr_per_install - description: '' is_valid: true key: initiate_checkout value: time_attr_initiate_checkout_count - description: '' is_valid: true key: initiate_checkout_rate value: time_attr_initiate_checkout_count_per_click - description: '' is_valid: true key: interactive_add_on_activity_clicks value: additional_format_interactive_click_count - description: '' is_valid: true key: interactive_add_on_destination_clicks value: additional_format_outbound_click_count - description: '' is_valid: true key: interactive_add_on_impressions value: additional_format_show_count - description: '' is_valid: true key: interactive_add_on_option_a_clicks value: additional_format_option_a_click_count - description: '' is_valid: true key: interactive_add_on_option_b_clicks value: additional_format_option_b_click_count - description: '' is_valid: true key: ix_average_video_play value: ix_video_duration_avg - description: '' is_valid: true key: ix_button_click_count value: ix_button_click_count - description: '' is_valid: true key: ix_button_click_count_rate value: ix_button_click_count_per_click - description: '' is_valid: true key: ix_page_duration_avg value: ix_page_duration_avg - description: '' is_valid: true key: ix_page_view_count value: ix_page_view_count - description: '' is_valid: true key: ix_page_view_count_rate value: ix_page_view_count_per_click - description: '' is_valid: true key: ix_page_viewrate_avg value: ix_page_viewrate_avg - description: '' is_valid: true key: ix_product_click_count value: ix_product_click_count - description: '' is_valid: true key: ix_product_click_count_rate value: ix_product_click_count_per_click - description: '' is_valid: true key: ix_video_views value: ix_video_view_count - description: '' is_valid: true key: ix_video_views_p100 value: ix_video_view_100pct - description: '' is_valid: true key: ix_video_views_p25 value: ix_video_view_25pct - description: '' is_valid: true key: ix_video_views_p50 value: ix_video_view_50pct - description: '' is_valid: true key: ix_video_views_p75 value: ix_video_view_75pct - description: '' is_valid: true key: join_group value: time_attr_join_group - description: '' is_valid: true key: join_group_rate value: time_attr_join_group_per_install - description: '' is_valid: true key: landing_page_view_rate value: time_attr_web_landing_page_view_per_click - description: '' is_valid: true key: launch_app value: time_attr_launch_app - description: '' is_valid: true key: launch_app_rate value: time_attr_launch_app_per_install - description: '' is_valid: true key: likes value: ad_net_like - description: '' is_valid: true key: live_effective_views value: live_effective_play_count - description: '' is_valid: true key: live_product_clicks value: live_product_click_count - description: '' is_valid: true key: live_views value: live_play_count - description: '' is_valid: true key: loan_apply value: time_attr_loan_apply - description: '' is_valid: true key: loan_apply_rate value: time_attr_loan_apply_per_install - description: '' is_valid: true key: loan_credit value: time_attr_loan_credit - description: '' is_valid: true key: loan_credit_rate value: time_attr_loan_credit_per_install - description: '' is_valid: true key: loan_disbursement value: time_attr_loan_completion - description: '' is_valid: true key: loan_disbursement_rate value: time_attr_loan_completion_per_install - description: '' is_valid: true key: login value: time_attr_login - description: '' is_valid: true key: login_rate value: time_attr_login_per_install - description: '' is_valid: false key: material_primary_status value: material_primary_status - description: '' is_valid: false key: material_second_status_list value: material_second_status_list - description: '' is_valid: true key: messaging_conversation_rate_instant_messaging_app value: time_attr_ctm_ima_messaging_per_click - description: '' is_valid: true key: messaging_conversation_rate_tiktok_direct_message value: time_attr_nonshop_onsite_tt_messaging_per_click - description: '' is_valid: true key: messaging_cost_per_conversation_instant_messaging_app value: time_attr_cost_per_ctm_ima_messaging - description: '' is_valid: true key: messaging_cost_per_conversation_tiktok_direct_message value: time_attr_cost_per_nonshop_onsite_tt_messaging - description: '' is_valid: true key: messaging_total_conversation_instant_messaging_app value: time_attr_ctm_ima_messaging_count - description: '' is_valid: true key: messaging_total_conversation_tiktok_direct_message value: time_attr_nonshop_onsite_tt_messaging - description: '' is_valid: true key: next_day_open value: time_attr_next_day_open - description: '' is_valid: true key: next_day_open_rate value: time_attr_next_day_open_per_install - description: '' is_valid: true key: offline_add_payment_info_event_rate value: time_attr_offline_add_billing_per_click - description: '' is_valid: true key: offline_add_payment_info_events value: time_attr_offline_add_billing - description: '' is_valid: true key: offline_add_payment_info_events_value value: time_attr_total_offline_add_billing_value - description: '' is_valid: true key: offline_add_to_cart_event_rate value: time_attr_offline_add_to_cart_per_click - description: '' is_valid: true key: offline_add_to_cart_events value: time_attr_offline_add_to_cart - description: '' is_valid: true key: offline_add_to_cart_events_value value: time_attr_total_offline_add_to_cart_value - description: '' is_valid: true key: offline_add_to_wishlist_event_rate value: time_attr_offline_add_to_wishlist_per_click - description: '' is_valid: true key: offline_add_to_wishlist_events value: time_attr_offline_add_to_wishlist - description: '' is_valid: true key: offline_add_to_wishlist_events_value value: time_attr_total_offline_add_to_wishlist_value - description: '' is_valid: true key: offline_application_approval value: time_attr_offline_application_approval - description: '' is_valid: true key: offline_application_approval_rate value: time_attr_offline_application_approval_per_click - description: '' is_valid: true key: offline_click_button_event_rate value: time_attr_offline_button_per_click - description: '' is_valid: true key: offline_click_button_events value: time_attr_offline_button - description: '' is_valid: true key: offline_click_button_events_value value: time_attr_total_offline_button_value - description: '' is_valid: true key: offline_complete_registration_event_rate value: time_attr_offline_register_per_click - description: '' is_valid: true key: offline_complete_registration_events value: time_attr_offline_register - description: '' is_valid: true key: offline_complete_registration_events_value value: time_attr_total_offline_register_value - description: '' is_valid: true key: offline_contact_event_rate value: time_attr_offline_contact_per_click - description: '' is_valid: true key: offline_contact_events value: time_attr_offline_contact - description: '' is_valid: true key: offline_contact_events_value value: time_attr_total_offline_contact_value - description: '' is_valid: true key: offline_cost_per_application_approval value: time_attr_cost_per_offline_application_approval - description: '' is_valid: true key: offline_cost_per_crm_event value: time_attr_cost_per_crm_events - description: '' is_valid: true key: offline_cost_per_custom_event value: time_attr_cost_per_offline_customized_events - description: '' is_valid: true key: offline_cost_per_customize_product value: time_attr_cost_per_customizeproduct_offline - description: '' is_valid: true key: offline_cost_per_find_location value: time_attr_cost_per_findlocation_offline - description: '' is_valid: true key: offline_cost_per_preferred_lead value: time_attr_cost_per_preferred_leads - description: '' is_valid: true key: offline_cost_per_schedule value: time_attr_cost_per_schedule_offline - description: '' is_valid: true key: offline_cost_per_start_trial value: time_attr_offline_start_trial_per_click - description: '' is_valid: true key: offline_cost_per_submit_application value: time_attr_cost_per_offline_submit_application - description: '' is_valid: true key: offline_crm_event_rate value: time_attr_crm_events_per_click - description: '' is_valid: true key: offline_crm_event_value value: time_attr_total_crm_events_value - description: '' is_valid: true key: offline_custom_event_rate value: time_attr_offline_customized_events_per_click - description: '' is_valid: true key: offline_customize_product_rate value: time_attr_customizeproduct_per_click_offline - description: '' is_valid: true key: offline_download_event_rate value: time_attr_offline_download_start_per_click - description: '' is_valid: true key: offline_download_events value: time_attr_offline_download_start - description: '' is_valid: true key: offline_download_events_value value: time_attr_total_offline_download_start_value - description: '' is_valid: true key: offline_find_location_rate value: time_attr_findlocation_per_click_offline - description: '' is_valid: true key: offline_form_event_rate value: time_attr_offline_submit_form_per_click - description: '' is_valid: true key: offline_form_events value: time_attr_offline_submit_form - description: '' is_valid: true key: offline_form_events_value value: time_attr_total_offline_submit_form_value - description: '' is_valid: true key: offline_initiate_checkout_event_rate value: time_attr_offline_initiate_checkout_per_click - description: '' is_valid: true key: offline_initiate_checkout_events value: time_attr_offline_initiate_checkout - description: '' is_valid: true key: offline_initiate_checkout_events_value value: time_attr_total_offline_initiate_checkout_value - description: '' is_valid: true key: offline_place_order_event_rate value: time_attr_offline_order_per_click - description: '' is_valid: true key: offline_place_order_events value: time_attr_offline_order - description: '' is_valid: true key: offline_place_order_events_value value: time_attr_total_offline_order_value - description: '' is_valid: true key: offline_preferred_lead_rate value: time_attr_preferred_leads_per_click - description: '' is_valid: true key: offline_preferred_leads value: time_attr_preferred_leads_cnt - description: '' is_valid: true key: offline_schedule_rate value: time_attr_schedule_per_click_offline - description: '' is_valid: true key: offline_search_event_rate value: time_attr_offline_search_per_click - description: '' is_valid: true key: offline_search_events value: time_attr_offline_search - description: '' is_valid: true key: offline_search_events_value value: time_attr_total_offline_search_value - description: '' is_valid: true key: offline_shopping_event_rate value: time_attr_offline_shopping_per_click - description: '' is_valid: true key: offline_shopping_events value: time_attr_offline_shopping - description: '' is_valid: true key: offline_shopping_events_roas value: time_attr_offline_shopping_roas - description: '' is_valid: true key: offline_shopping_events_value value: time_attr_total_offline_shopping_value - description: '' is_valid: true key: offline_start_trial_rate value: time_attr_cost_per_offline_start_trial - description: '' is_valid: true key: offline_submit_application_rate value: time_attr_offline_submit_application_per_click - description: '' is_valid: true key: offline_subscribe_event_rate value: time_attr_offline_subscribe_per_click - description: '' is_valid: true key: offline_subscribe_events value: time_attr_offline_subscribe - description: '' is_valid: true key: offline_subscribe_events_value value: time_attr_total_offline_subscribe_value - description: '' is_valid: true key: offline_total_application_approval_value value: time_attr_total_offline_application_approval_value - description: '' is_valid: true key: offline_total_crm_events value: time_attr_crm_events - description: '' is_valid: true key: offline_total_custom_event_value value: time_attr_total_offline_customized_events_value - description: '' is_valid: true key: offline_total_custom_events value: time_attr_offline_customized_events - description: '' is_valid: true key: offline_total_customize_product value: time_attr_customizeproduct_offline - description: '' is_valid: true key: offline_total_customize_product_value value: time_attr_total_customizeproduct_value_offline - description: '' is_valid: true key: offline_total_find_location value: time_attr_findlocation_offline - description: '' is_valid: true key: offline_total_find_location_value value: time_attr_total_findlocation_value_offline - description: '' is_valid: true key: offline_total_schedule value: time_attr_schedule_offline - description: '' is_valid: true key: offline_total_schedule_value value: time_attr_total_schedule_value_offline - description: '' is_valid: true key: offline_total_start_trial value: time_attr_offline_start_trial - description: '' is_valid: true key: offline_total_start_trial_value value: time_attr_total_offline_start_trial_value - description: '' is_valid: true key: offline_total_submit_application value: time_attr_offline_submit_application - description: '' is_valid: true key: offline_total_submit_application_value value: time_attr_total_offline_submit_application_value - description: '' is_valid: true key: offline_value_per_application_approval value: time_attr_value_per_offline_application_approval - description: '' is_valid: true key: offline_value_per_crm_event value: time_attr_value_per_crm_events - description: '' is_valid: true key: offline_value_per_custom_event value: time_attr_value_per_offline_customized_events - description: '' is_valid: true key: offline_value_per_customize_product value: time_attr_value_per_customizeproduct_offline - description: '' is_valid: true key: offline_value_per_find_location value: time_attr_value_per_findlocation_offline - description: '' is_valid: true key: offline_value_per_schedule value: time_attr_value_per_schedule_offline - description: '' is_valid: true key: offline_value_per_start_trial value: time_attr_value_per_offline_start_trial - description: '' is_valid: true key: offline_value_per_submit_application value: time_attr_value_per_offline_submit_application - description: '' is_valid: true key: offline_view_content_event_rate value: time_attr_offline_detail_per_click - description: '' is_valid: true key: offline_view_content_events value: time_attr_offline_detail - description: '' is_valid: true key: offline_view_content_events_value value: time_attr_total_offline_detail_value - description: '' is_valid: true key: on_web_add_to_wishlist value: time_attr_on_web_add_to_wishlist - description: '' is_valid: true key: on_web_add_to_wishlist_per_click value: time_attr_on_web_add_to_wishlist_per_click - description: '' is_valid: true key: on_web_order value: time_attr_on_web_order - description: '' is_valid: true key: on_web_order_rate value: time_attr_on_web_order_per_click - description: '' is_valid: true key: on_web_subscribe value: time_attr_on_web_subscribe - description: '' is_valid: true key: on_web_subscribe_per_click value: time_attr_on_web_subscribe_per_click - description: '' is_valid: true key: online_consult value: time_attr_consult_standardized - description: '' is_valid: true key: online_consult_rate value: time_attr_consult_standardized_per_click - description: '' is_valid: true key: onsite_active_by_conversion_time value: nonshop_onsite_active - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_calendar_day0 value: time_attr_total_nonshop_onsite_ad_revenue_value_cald0 - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_calendar_day13 value: time_attr_total_nonshop_onsite_ad_revenue_value_cald13 - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_calendar_day6 value: time_attr_total_nonshop_onsite_ad_revenue_value_cald6 - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_day0 value: time_attr_total_nonshop_onsite_ad_revenue_value_d0 - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_day13 value: time_attr_total_nonshop_onsite_ad_revenue_value_d13 - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_day6 value: time_attr_total_nonshop_onsite_ad_revenue_value_d6 - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_roas_calendar_day0 value: time_attr_nonshop_onsite_ad_revenue_roas_cald0 - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_roas_calendar_day13 value: time_attr_nonshop_onsite_ad_revenue_roas_cald13 - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_roas_calendar_day6 value: time_attr_nonshop_onsite_ad_revenue_roas_cald6 - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_roas_day0 value: time_attr_nonshop_onsite_ad_revenue_roas_d0 - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_roas_day13 value: time_attr_nonshop_onsite_ad_revenue_roas_d13 - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_roas_day6 value: time_attr_nonshop_onsite_ad_revenue_roas_d6 - description: '' is_valid: true key: onsite_ad_impression_rate value: time_attr_nonshop_onsite_ad_revenue_per_click - description: '' is_valid: true key: onsite_add_billing value: time_attr_onsite_add_billing - description: '' is_valid: true key: onsite_add_billing_rate value: time_attr_onsite_add_billing_per_click - description: '' is_valid: true key: onsite_add_to_cart_rate value: time_attr_nonshop_onsite_on_web_cart_per_click - description: '' is_valid: true key: onsite_add_to_wishlist value: time_attr_onsite_add_to_wishlist - description: '' is_valid: true key: onsite_add_to_wishlist_rate value: time_attr_onsite_add_to_wishlist_per_click - description: '' is_valid: true key: onsite_checkout_initiation_rate value: time_attr_nonshop_onsite_initiate_checkout_count_per_click - description: '' is_valid: true key: onsite_cost_per_active value: time_attr_cost_per_nonshop_onsite_active - description: '' is_valid: true key: onsite_cost_per_active_by_conversion_time value: cost_per_nonshop_onsite_active - description: '' is_valid: true key: onsite_cost_per_add_to_cart value: time_attr_cost_per_nonshop_onsite_on_web_cart - description: '' is_valid: true key: onsite_cost_per_checkout_initiation value: time_attr_cost_per_nonshop_onsite_initiate_checkout_count - description: '' is_valid: true key: onsite_cost_per_product_details_page_view value: time_attr_cost_per_nonshop_onsite_on_web_detail - description: '' is_valid: true key: onsite_cost_per_purchase value: time_attr_cost_per_nonshop_onsite_shopping - description: '' is_valid: true key: onsite_cost_per_total_ad_impression value: time_attr_cost_per_nonshop_onsite_ad_revenue - description: '' is_valid: true key: onsite_cost_per_total_launch value: time_attr_cost_per_nonshop_onsite_launch_app - description: '' is_valid: true key: onsite_cost_per_total_registration value: time_attr_cost_per_nonshop_onsite_active_register - description: '' is_valid: true key: onsite_cost_per_unique_ad_impression value: time_attr_cost_per_unique_nonshop_onsite_ad_revenue - description: '' is_valid: true key: onsite_cost_per_unique_launch value: time_attr_cost_per_unique_nonshop_onsite_launch_app - description: '' is_valid: true key: onsite_cost_per_unique_purchase value: time_attr_cost_per_unique_nonshop_onsite_shopping - description: '' is_valid: true key: onsite_cost_per_unique_registration value: time_attr_cost_per_unique_nonshop_onsite_active_register - description: '' is_valid: true key: onsite_destination_visit_rate value: time_attr_onsite_destination_visit_per_click - description: '' is_valid: true key: onsite_destination_visits value: time_attr_onsite_destination_visit - description: '' is_valid: true key: onsite_download_start value: time_attr_onsite_download_start - description: '' is_valid: true key: onsite_download_start_rate value: time_attr_onsite_download_start_per_click - description: '' is_valid: true key: onsite_form value: time_attr_onsite_form - description: '' is_valid: true key: onsite_form_rate value: time_attr_onsite_form_per_click - description: '' is_valid: true key: onsite_initiate_checkout_count value: time_attr_onsite_initiate_checkout_count - description: '' is_valid: true key: onsite_initiate_checkout_count_rate value: time_attr_onsite_initiate_checkout_count_per_click - description: '' is_valid: true key: onsite_launch_rate value: time_attr_nonshop_onsite_launch_app_per_click - description: '' is_valid: true key: onsite_on_web_cart value: time_attr_onsite_on_web_cart - description: '' is_valid: true key: onsite_on_web_cart_rate value: time_attr_onsite_on_web_cart_per_click - description: '' is_valid: true key: onsite_on_web_detail value: time_attr_onsite_on_web_detail - description: '' is_valid: true key: onsite_on_web_detail_rate value: time_attr_onsite_on_web_detail_per_click - description: '' is_valid: true key: onsite_product_details_page_view_rate value: time_attr_nonshop_onsite_on_web_detail_per_click - description: '' is_valid: true key: onsite_purchase_rate value: time_attr_nonshop_onsite_shopping_per_click - description: '' is_valid: true key: onsite_purchase_roas_calendar_day0 value: time_attr_nonshop_onsite_shopping_roas_cald0 - description: '' is_valid: true key: onsite_purchase_roas_calendar_day13 value: time_attr_nonshop_onsite_shopping_roas_cald13 - description: '' is_valid: true key: onsite_purchase_roas_calendar_day6 value: time_attr_nonshop_onsite_shopping_roas_cald6 - description: '' is_valid: true key: onsite_purchase_roas_day0 value: time_attr_nonshop_onsite_shopping_roas_d0 - description: '' is_valid: true key: onsite_purchase_roas_day13 value: time_attr_nonshop_onsite_shopping_roas_d13 - description: '' is_valid: true key: onsite_purchase_roas_day6 value: time_attr_nonshop_onsite_shopping_roas_d6 - description: '' is_valid: true key: onsite_purchase_value_calendar_day0 value: time_attr_total_nonshop_onsite_shopping_value_cald0 - description: '' is_valid: true key: onsite_purchase_value_calendar_day13 value: time_attr_total_nonshop_onsite_shopping_value_cald13 - description: '' is_valid: true key: onsite_purchase_value_calendar_day6 value: time_attr_total_nonshop_onsite_shopping_value_cald6 - description: '' is_valid: true key: onsite_purchase_value_day0 value: time_attr_total_nonshop_onsite_shopping_value_d0 - description: '' is_valid: true key: onsite_purchase_value_day13 value: time_attr_total_nonshop_onsite_shopping_value_d13 - description: '' is_valid: true key: onsite_purchase_value_day6 value: time_attr_total_nonshop_onsite_shopping_value_d6 - description: '' is_valid: true key: onsite_purchases_roas value: time_attr_nonshop_onsite_shopping_roas - description: '' is_valid: true key: onsite_registration_rate value: time_attr_nonshop_onsite_active_register_per_click - description: '' is_valid: true key: onsite_shopping value: time_attr_onsite_shopping - description: '' is_valid: true key: onsite_shopping_rate value: time_attr_onsite_shopping_per_click - description: '' is_valid: true key: onsite_shopping_roas value: time_attr_onsite_shopping_roas - description: '' is_valid: true key: onsite_total_active value: time_attr_nonshop_onsite_active - description: '' is_valid: true key: onsite_total_ad_impression value: time_attr_nonshop_onsite_ad_revenue - description: '' is_valid: true key: onsite_total_ad_impression_value value: time_attr_nonshop_onsite_ad_revenue_value - description: '' is_valid: true key: onsite_total_add_to_cart value: time_attr_nonshop_onsite_on_web_cart - description: '' is_valid: true key: onsite_total_add_to_cart_value value: time_attr_total_nonshop_onsite_on_web_cart_value - description: '' is_valid: true key: onsite_total_checkout_initiation value: time_attr_nonshop_onsite_initiate_checkout_count - description: '' is_valid: true key: onsite_total_checkout_initiation_value value: time_attr_total_nonshop_onsite_initiate_checkout_count_value - description: '' is_valid: true key: onsite_total_filtered_out_form_submission value: ix_filtered_out_leads - description: '' is_valid: true key: onsite_total_launch value: time_attr_nonshop_onsite_launch_app - description: '' is_valid: true key: onsite_total_product_details_page_view value: time_attr_nonshop_onsite_on_web_detail - description: '' is_valid: true key: onsite_total_product_details_page_view_value value: time_attr_total_nonshop_onsite_on_web_detail_value - description: '' is_valid: true key: onsite_total_purchase value: time_attr_nonshop_onsite_shopping - description: '' is_valid: true key: onsite_total_purchase_value value: time_attr_total_nonshop_onsite_shopping_value - description: '' is_valid: true key: onsite_total_registration value: time_attr_nonshop_onsite_active_register - description: '' is_valid: true key: onsite_unique_ad_impression value: time_attr_unique_nonshop_onsite_ad_revenue - description: '' is_valid: true key: onsite_unique_launch value: time_attr_unique_nonshop_onsite_launch_app - description: '' is_valid: true key: onsite_unique_purchase value: time_attr_unique_nonshop_onsite_shopping - description: '' is_valid: true key: onsite_unique_registration value: time_attr_unique_nonshop_onsite_active_register - description: '' is_valid: true key: onsite_value_per_ad_impression_value value: time_attr_value_per_nonshop_onsite_ad_revenue - description: '' is_valid: true key: onsite_value_per_add_to_cart value: time_attr_value_per_nonshop_onsite_on_web_cart - description: '' is_valid: true key: onsite_value_per_checkout_initiation value: time_attr_value_per_nonshop_onsite_initiate_checkout_count - description: '' is_valid: true key: onsite_value_per_product_details_page_view value: time_attr_value_per_nonshop_onsite_on_web_detail - description: '' is_valid: true key: onsite_value_per_purchase value: time_attr_value_per_nonshop_onsite_shopping - description: '' is_valid: false key: operation_status value: aco_opt_status - description: '' is_valid: true key: page_content_view_event_rate value: time_attr_on_web_detail_standardized_per_click - description: '' is_valid: true key: page_content_view_events value: time_attr_on_web_detail_standardized - description: '' is_valid: true key: page_event_search value: time_attr_search_count - description: '' is_valid: true key: page_event_search_rate value: time_attr_search_count_per_click - description: '' is_valid: true key: pageview_rate value: time_attr_page_view_per_click - description: '' is_valid: true key: paid_engaged_view value: engaged_view_billed_vv - description: '' is_valid: true key: paid_engaged_view_15s value: engaged_view_15s_billed_vv - description: '' is_valid: true key: paid_engagement_engaged_view value: engaged_view_billed_engagement - description: '' is_valid: true key: paid_engagement_engaged_view_15s value: engaged_view_15s_billed_engagement - description: '' is_valid: true key: playable_download_button_click_count value: playable_cta_click - description: '' is_valid: true key: playable_first_scene_view_count value: playable_first_scene_view_count - description: '' is_valid: true key: playable_page_view_count value: playable_page_view_count - description: '' is_valid: true key: playable_second_scene_view_count value: playable_second_scene_view_count - description: '' is_valid: true key: playable_third_scene_view_count value: playable_third_scene_view_count - description: '' is_valid: true key: product_clicks value: product_click_cnt - description: '' is_valid: true key: product_cta value: stats_product_ctr - description: '' is_valid: true key: product_impressions value: product_show_cnt - description: '' is_valid: true key: profile_visits value: ad_home_visited - description: '' is_valid: true key: profile_visits_rate value: ad_home_visited_rate - description: '' is_valid: true key: purchase value: time_attr_active_pay - description: '' is_valid: true key: purchase_rate value: time_attr_active_pay_rate - description: '' is_valid: true key: ratings value: time_attr_rate - description: '' is_valid: true key: ratings_rate value: time_attr_rate_per_install - description: '' is_valid: true key: real_time_app_install value: active - description: '' is_valid: true key: real_time_app_install_cost value: active_cost - description: '' is_valid: true key: real_time_conversion value: convert_cnt - description: '' is_valid: true key: real_time_conversion_rate_v2 value: conversion_rate_imp - description: '' is_valid: true key: real_time_cost_per_conversion value: conversion_cost - description: '' is_valid: true key: registration value: time_attr_active_register - description: '' is_valid: true key: registration_rate value: time_attr_active_register_rate - description: '' is_valid: true key: sales_lead value: time_attr_sales_lead - description: '' is_valid: true key: sales_lead_rate value: time_attr_sales_lead_per_install - description: '' is_valid: true key: search value: time_attr_search - description: '' is_valid: true key: search_rate value: time_attr_search_per_install - description: '' is_valid: true key: shares value: ad_share - description: '' is_valid: true key: shop_gross_revenue_by_order_submission value: total_onsite_shopping_value - description: '' is_valid: true key: shop_total_items_purchased value: time_attr_onsite_shopping_quantity - description: '' is_valid: true key: shop_total_purchase_by_order_submission value: onsite_shopping - description: '' is_valid: true key: single_image_ctr value: single_image_ctr - description: '' is_valid: true key: single_image_impression_rate value: single_image_show_rate - description: '' is_valid: true key: single_image_impressions value: single_image_show_count - description: '' is_valid: true key: skan_achieve_level value: skan_update_level - description: '' is_valid: true key: skan_achieve_level_rate value: skan_update_level_per_install - description: '' is_valid: true key: skan_add_payment_info value: skan_add_payment_info - description: '' is_valid: true key: skan_add_payment_info_rate value: skan_add_payment_info_per_install - description: '' is_valid: true key: skan_add_to_cart value: skan_in_app_cart - description: '' is_valid: true key: skan_add_to_cart_rate value: skan_in_app_cart_per_install - description: '' is_valid: true key: skan_add_to_wishlist value: skan_add_to_wishlist - description: '' is_valid: true key: skan_add_to_wishlist_rate value: skan_add_to_wishlist_per_install - description: '' is_valid: true key: skan_app_install value: skan_active - description: '' is_valid: true key: skan_app_install_withheld value: skan_active_withheld - description: '' is_valid: true key: skan_checkout value: skan_in_app_order - description: '' is_valid: true key: skan_checkout_rate value: skan_in_app_order_per_install - description: '' is_valid: true key: skan_complete_tutorial value: skan_complete_tutorial - description: '' is_valid: true key: skan_complete_tutorial_rate value: skan_complete_tutorial_per_install - description: '' is_valid: true key: skan_conversion value: skan_convert_cnt - description: '' is_valid: true key: skan_conversion_rate_v2 value: skan_conversion_rate_imp - description: '' is_valid: true key: skan_cost_per_achieve_level value: cost_per_skan_update_level - description: '' is_valid: true key: skan_cost_per_add_payment_info value: cost_per_skan_add_payment_info - description: '' is_valid: true key: skan_cost_per_add_to_cart value: cost_per_skan_in_app_cart - description: '' is_valid: true key: skan_cost_per_add_to_wishlist value: cost_per_skan_add_to_wishlist - description: '' is_valid: true key: skan_cost_per_app_install value: cost_per_skan_active - description: '' is_valid: true key: skan_cost_per_checkout value: cost_per_skan_in_app_order - description: '' is_valid: true key: skan_cost_per_complete_tutorial value: cost_per_skan_complete_tutorial - description: '' is_valid: true key: skan_cost_per_conversion value: skan_conversion_cost - description: '' is_valid: true key: skan_cost_per_create_gamerole value: cost_per_skan_create_gamerole - description: '' is_valid: true key: skan_cost_per_create_group value: cost_per_skan_create_group - description: '' is_valid: true key: skan_cost_per_cta_app_install value: skan_active_click_cost - description: '' is_valid: true key: skan_cost_per_cta_conversion value: skan_convert_cnt_click_cost - description: '' is_valid: true key: skan_cost_per_cta_purchase value: skan_active_pay_click_cost - description: '' is_valid: true key: skan_cost_per_cta_registration value: skan_active_register_click_cost - description: '' is_valid: true key: skan_cost_per_in_app_ad_click value: cost_per_skan_in_app_ad_click - description: '' is_valid: true key: skan_cost_per_in_app_ad_impr value: cost_per_skan_in_app_ad_impr - description: '' is_valid: true key: skan_cost_per_join_group value: cost_per_skan_join_group - description: '' is_valid: true key: skan_cost_per_launch_app value: cost_per_skan_launch_app - description: '' is_valid: true key: skan_cost_per_loan_apply value: cost_per_skan_loan_apply - description: '' is_valid: true key: skan_cost_per_loan_credit value: cost_per_skan_loan_credit - description: '' is_valid: true key: skan_cost_per_loan_disbursement value: cost_per_skan_loan_completion - description: '' is_valid: true key: skan_cost_per_login value: cost_per_skan_login - description: '' is_valid: true key: skan_cost_per_purchase value: cost_per_skan_active_pay - description: '' is_valid: true key: skan_cost_per_ratings value: cost_per_skan_rate - description: '' is_valid: true key: skan_cost_per_registration value: cost_per_skan_active_register - description: '' is_valid: true key: skan_cost_per_result value: skan_effect_cost - description: '' is_valid: true key: skan_cost_per_sales_lead value: cost_per_skan_sales_lead - description: '' is_valid: true key: skan_cost_per_search value: cost_per_skan_search - description: '' is_valid: true key: skan_cost_per_spend_credits value: cost_per_skan_spend_credits - description: '' is_valid: true key: skan_cost_per_start_trial value: cost_per_skan_start_trial - description: '' is_valid: true key: skan_cost_per_subscribe value: cost_per_skan_subscribe - description: '' is_valid: true key: skan_cost_per_total_achieve_level value: cost_per_skan_repetitive_update_level - description: '' is_valid: true key: skan_cost_per_total_add_to_cart value: cost_per_skan_repetitive_in_app_cart - description: '' is_valid: true key: skan_cost_per_total_add_to_wishlist value: cost_per_skan_repetitive_add_to_wishlist - description: '' is_valid: true key: skan_cost_per_total_checkout value: cost_per_skan_repetitive_in_app_order - description: '' is_valid: true key: skan_cost_per_total_complete_tutorial value: cost_per_skan_repetitive_complete_tutorial - description: '' is_valid: true key: skan_cost_per_total_create_gamerole value: cost_per_skan_repetitive_create_gamerole - description: '' is_valid: true key: skan_cost_per_total_create_group value: cost_per_skan_repetitive_create_group - description: '' is_valid: true key: skan_cost_per_total_in_app_ad_click value: cost_per_skan_repetitive_in_app_ad_click - description: '' is_valid: true key: skan_cost_per_total_in_app_ad_impr value: cost_per_skan_repetitive_in_app_ad_impr - description: '' is_valid: true key: skan_cost_per_total_join_group value: cost_per_skan_repetitive_join_group - description: '' is_valid: true key: skan_cost_per_total_launch_app value: cost_per_skan_repetitive_launch_app - description: '' is_valid: true key: skan_cost_per_total_loan_apply value: cost_per_skan_repetitive_loan_apply - description: '' is_valid: true key: skan_cost_per_total_loan_credit value: cost_per_skan_repetitive_loan_credit - description: '' is_valid: true key: skan_cost_per_total_loan_disbursement value: cost_per_skan_repetitive_loan_completion - description: '' is_valid: true key: skan_cost_per_total_login value: cost_per_skan_repetitive_login - description: '' is_valid: true key: skan_cost_per_total_purchase value: cost_per_skan_repetitive_active_pay - description: '' is_valid: true key: skan_cost_per_total_ratings value: cost_per_skan_repetitive_rate - description: '' is_valid: true key: skan_cost_per_total_registration value: cost_per_skan_repetitive_active_register - description: '' is_valid: true key: skan_cost_per_total_sales_lead value: cost_per_skan_repetitive_sales_lead - description: '' is_valid: true key: skan_cost_per_total_search value: cost_per_skan_repetitive_search - description: '' is_valid: true key: skan_cost_per_total_spend_credits value: cost_per_skan_repetitive_spend_credits - description: '' is_valid: true key: skan_cost_per_total_start_trial value: cost_per_skan_repetitive_start_trial - description: '' is_valid: true key: skan_cost_per_total_subscribe value: cost_per_skan_repetitive_subscribe - description: '' is_valid: true key: skan_cost_per_total_unlock_achievement value: cost_per_skan_repetitive_unlock_achievement - description: '' is_valid: true key: skan_cost_per_total_view_content value: cost_per_skan_repetitive_in_app_detail_uv - description: '' is_valid: true key: skan_cost_per_unlock_achievement value: cost_per_skan_unlock_achievement - description: '' is_valid: true key: skan_cost_per_view_content value: cost_per_skan_in_app_detail_uv - description: '' is_valid: true key: skan_cost_per_vta_app_install value: skan_active_show_cost - description: '' is_valid: true key: skan_cost_per_vta_conversion value: skan_convert_cnt_show_cost - description: '' is_valid: true key: skan_cost_per_vta_purchase value: skan_active_pay_show_cost - description: '' is_valid: true key: skan_cost_per_vta_registration value: skan_active_register_show_cost - description: '' is_valid: true key: skan_cost_total_add_payment_info value: cost_per_skan_repetitive_add_payment_info - description: '' is_valid: true key: skan_create_gamerole value: skan_create_gamerole - description: '' is_valid: true key: skan_create_gamerole_rate value: skan_create_gamerole_per_install - description: '' is_valid: true key: skan_create_group value: skan_create_group - description: '' is_valid: true key: skan_create_group_rate value: skan_create_group_per_install - description: '' is_valid: true key: skan_cta_app_install value: skan_active_click - description: '' is_valid: true key: skan_cta_conversion value: skan_convert_cnt_click - description: '' is_valid: true key: skan_cta_purchase value: skan_active_pay_click - description: '' is_valid: true key: skan_cta_registration value: skan_active_register_click - description: '' is_valid: true key: skan_in_app_ad_click value: skan_in_app_ad_click - description: '' is_valid: true key: skan_in_app_ad_click_rate value: skan_in_app_ad_click_per_install - description: '' is_valid: true key: skan_in_app_ad_impr value: skan_in_app_ad_impr - description: '' is_valid: true key: skan_in_app_ad_impr_rate value: skan_in_app_ad_impr_per_install - description: '' is_valid: true key: skan_join_group value: skan_join_group - description: '' is_valid: true key: skan_join_group_rate value: skan_join_group_per_install - description: '' is_valid: true key: skan_launch_app value: skan_launch_app - description: '' is_valid: true key: skan_launch_app_rate value: skan_launch_app_per_install - description: '' is_valid: true key: skan_loan_apply value: skan_loan_apply - description: '' is_valid: true key: skan_loan_apply_rate value: skan_loan_apply_per_install - description: '' is_valid: true key: skan_loan_credit value: skan_loan_credit - description: '' is_valid: true key: skan_loan_credit_rate value: skan_loan_credit_per_install - description: '' is_valid: true key: skan_loan_disbursement value: skan_loan_completion - description: '' is_valid: true key: skan_loan_disbursement_rate value: skan_loan_completion_per_install - description: '' is_valid: true key: skan_login value: skan_login - description: '' is_valid: true key: skan_login_rate value: skan_login_per_install - description: '' is_valid: true key: skan_purchase value: skan_active_pay - description: '' is_valid: true key: skan_purchase_rate value: skan_active_pay_per_install - description: '' is_valid: true key: skan_ratings value: skan_rate - description: '' is_valid: true key: skan_ratings_rate value: skan_rate_per_install - description: '' is_valid: true key: skan_registration value: skan_active_register - description: '' is_valid: true key: skan_registration_rate value: skan_active_register_per_install - description: '' is_valid: true key: skan_result value: skan_effect_cnt - description: '' is_valid: true key: skan_result_rate value: skan_effect_rate - description: '' is_valid: true key: skan_sales_lead value: skan_sales_lead - description: '' is_valid: true key: skan_sales_lead_rate value: skan_sales_lead_per_install - description: '' is_valid: true key: skan_search value: skan_search - description: '' is_valid: true key: skan_search_rate value: skan_search_per_install - description: '' is_valid: true key: skan_spend_credits value: skan_spend_credits - description: '' is_valid: true key: skan_spend_credits_rate value: skan_spend_credits_per_install - description: '' is_valid: true key: skan_start_trial value: skan_start_trial - description: '' is_valid: true key: skan_start_trial_rate value: skan_start_trial_per_install - description: '' is_valid: true key: skan_subscribe value: skan_subscribe - description: '' is_valid: true key: skan_subscribe_rate value: skan_subscribe_per_install - description: '' is_valid: true key: skan_total_achieve_level value: skan_repetitive_update_level - description: '' is_valid: true key: skan_total_achieve_level_value value: skan_total_repetitive_update_level_value - description: '' is_valid: true key: skan_total_add_payment_info value: skan_repetitive_add_payment_info - description: '' is_valid: true key: skan_total_add_to_cart value: skan_repetitive_in_app_cart - description: '' is_valid: true key: skan_total_add_to_cart_value value: skan_total_repetitive_in_app_cart_value - description: '' is_valid: true key: skan_total_add_to_wishlist value: skan_repetitive_add_to_wishlist - description: '' is_valid: true key: skan_total_add_to_wishlist_value value: skan_total_repetitive_add_to_wishlist_value - description: '' is_valid: true key: skan_total_checkout value: skan_repetitive_in_app_order - description: '' is_valid: true key: skan_total_checkout_value value: skan_total_repetitive_in_app_order_value - description: '' is_valid: true key: skan_total_complete_tutorial value: skan_repetitive_complete_tutorial - description: '' is_valid: true key: skan_total_complete_tutorial_value value: skan_total_repetitive_complete_tutorial_value - description: '' is_valid: true key: skan_total_create_gamerole value: skan_repetitive_create_gamerole - description: '' is_valid: true key: skan_total_create_gamerole_value value: skan_total_repetitive_create_gamerole_value - description: '' is_valid: true key: skan_total_create_group value: skan_repetitive_create_group - description: '' is_valid: true key: skan_total_create_group_value value: skan_total_repetitive_create_group_value - description: '' is_valid: true key: skan_total_in_app_ad_click value: skan_repetitive_in_app_ad_click - description: '' is_valid: true key: skan_total_in_app_ad_click_value value: skan_total_repetitive_in_app_ad_click_value - description: '' is_valid: true key: skan_total_in_app_ad_impr value: skan_repetitive_in_app_ad_impr - description: '' is_valid: true key: skan_total_in_app_ad_impr_value value: skan_total_repetitive_in_app_ad_impr_value - description: '' is_valid: true key: skan_total_join_group value: skan_repetitive_join_group - description: '' is_valid: true key: skan_total_join_group_value value: skan_total_repetitive_join_group_value - description: '' is_valid: true key: skan_total_launch_app value: skan_repetitive_launch_app - description: '' is_valid: true key: skan_total_loan_apply value: skan_repetitive_loan_apply - description: '' is_valid: true key: skan_total_loan_credit value: skan_repetitive_loan_credit - description: '' is_valid: true key: skan_total_loan_disbursement value: skan_repetitive_loan_completion - description: '' is_valid: true key: skan_total_login value: skan_repetitive_login - description: '' is_valid: true key: skan_total_purchase value: skan_repetitive_active_pay - description: '' is_valid: true key: skan_total_purchase_value value: skan_total_repetitive_active_pay_value - description: '' is_valid: true key: skan_total_ratings value: skan_repetitive_rate - description: '' is_valid: true key: skan_total_ratings_value value: skan_total_repetitive_rate_value - description: '' is_valid: true key: skan_total_registration value: skan_repetitive_active_register - description: '' is_valid: true key: skan_total_repetitive_active_pay_roas value: skan_total_repetitive_active_pay_roas - description: '' is_valid: true key: skan_total_sales_lead value: skan_repetitive_sales_lead - description: '' is_valid: true key: skan_total_sales_lead_value value: skan_total_repetitive_sales_lead_value - description: '' is_valid: true key: skan_total_search value: skan_repetitive_search - description: '' is_valid: true key: skan_total_spend_credits value: skan_repetitive_spend_credits - description: '' is_valid: true key: skan_total_spend_credits_value value: skan_total_repetitive_spend_credits_value - description: '' is_valid: true key: skan_total_start_trial value: skan_repetitive_start_trial - description: '' is_valid: true key: skan_total_subscribe value: skan_repetitive_subscribe - description: '' is_valid: true key: skan_total_subscribe_value value: skan_total_repetitive_subscribe_value - description: '' is_valid: true key: skan_total_unlock_achievement value: skan_repetitive_unlock_achievement - description: '' is_valid: true key: skan_total_unlock_achievement_value value: skan_total_repetitive_unlock_achievement_value - description: '' is_valid: true key: skan_total_view_content value: skan_repetitive_in_app_detail_uv - description: '' is_valid: true key: skan_total_view_content_value value: skan_total_repetitive_in_app_detail_uv_value - description: '' is_valid: true key: skan_unlock_achievement value: skan_unlock_achievement - description: '' is_valid: true key: skan_unlock_achievement_rate value: skan_unlock_achievement_per_install - description: '' is_valid: true key: skan_view_content value: skan_in_app_detail_uv - description: '' is_valid: true key: skan_view_content_rate value: skan_in_app_detail_uv_per_install - description: '' is_valid: true key: skan_vta_app_install value: skan_active_show - description: '' is_valid: true key: skan_vta_conversion value: skan_convert_cnt_show - description: '' is_valid: true key: skan_vta_purchase value: skan_active_pay_show - description: '' is_valid: true key: skan_vta_registration value: skan_active_register_show - description: '' is_valid: true key: sound_usage_clicks value: sound_usage_button_click_cnt - description: '' is_valid: true key: spend value: stat_cost - description: '' is_valid: true key: spend_credits value: time_attr_spend_credits - description: '' is_valid: true key: spend_credits_rate value: time_attr_spend_credits_per_install - description: '' is_valid: true key: start_trial value: time_attr_start_trial - description: '' is_valid: true key: start_trial_rate value: time_attr_start_trial_per_install - description: '' is_valid: true key: stitch_clicks value: stitch_click_cnt - description: '' is_valid: true key: subscribe value: time_attr_subscribe - description: '' is_valid: true key: subscribe_rate value: time_attr_subscribe_per_install - description: '' is_valid: true key: total_achieve_level value: time_attr_repetitive_update_level - description: '' is_valid: true key: total_achieve_level_value value: time_attr_total_repetitive_update_level_value - description: '' is_valid: true key: total_active_pay_roas value: time_attr_repetitive_active_pay_roas - description: '' is_valid: true key: total_ad_impression_events_value value: time_attr_total_repetitive_ad_revenue_value - description: '' is_valid: true key: total_ad_impression_roas value: time_attr_total_repetitive_ad_revenue_roas - description: '' is_valid: true key: total_add_billing_value value: time_attr_total_add_billing_value - description: '' is_valid: true key: total_add_payment_info value: time_attr_repetitive_add_payment_info - description: '' is_valid: true key: total_add_to_wishlist value: time_attr_repetitive_add_to_wishlist - description: '' is_valid: true key: total_add_to_wishlist_value value: time_attr_total_repetitive_add_to_wishlist_value - description: '' is_valid: true key: total_app_event_add_to_cart value: time_attr_repetitive_in_app_cart - description: '' is_valid: true key: total_app_event_add_to_cart_value value: time_attr_total_repetitive_in_app_cart_value - description: '' is_valid: true key: total_button_click_value value: time_attr_total_button_value - description: '' is_valid: true key: total_checkout value: time_attr_repetitive_in_app_order - description: '' is_valid: true key: total_checkout_value value: time_attr_total_repetitive_in_app_order_value - description: '' is_valid: true key: total_complete_payment_rate value: time_attr_total_shopping_value - description: '' is_valid: true key: total_complete_tutorial value: time_attr_repetitive_complete_tutorial - description: '' is_valid: true key: total_complete_tutorial_value value: time_attr_total_repetitive_complete_tutorial_value - description: '' is_valid: true key: total_create_gamerole value: time_attr_repetitive_create_gamerole - description: '' is_valid: true key: total_create_gamerole_value value: time_attr_total_repetitive_create_gamerole_value - description: '' is_valid: true key: total_create_group value: time_attr_repetitive_create_group - description: '' is_valid: true key: total_create_group_value value: time_attr_total_repetitive_create_group_value - description: '' is_valid: true key: total_day7_retention value: time_attr_repetitive_retention_7d - description: '' is_valid: true key: total_day7_retention_value value: time_attr_total_repetitive_retention_7d_value - description: '' is_valid: true key: total_download_start_value value: time_attr_total_download_start_value - description: '' is_valid: true key: total_form_value value: time_attr_total_form_value - description: '' is_valid: true key: total_in_app_ad_click value: time_attr_repetitive_in_app_ad_click - description: '' is_valid: true key: total_in_app_ad_click_value value: time_attr_total_repetitive_in_app_ad_click_value - description: '' is_valid: true key: total_in_app_ad_impr value: time_attr_repetitive_in_app_ad_impr - description: '' is_valid: true key: total_in_app_ad_impr_value value: time_attr_total_repetitive_in_app_ad_impr_value - description: '' is_valid: true key: total_initiate_checkout_value value: time_attr_total_initiate_checkout_value - description: '' is_valid: true key: total_join_group value: time_attr_repetitive_join_group - description: '' is_valid: true key: total_join_group_value value: time_attr_total_repetitive_join_group_value - description: '' is_valid: true key: total_landing_page_view value: time_attr_web_landing_page_view - description: '' is_valid: true key: total_launch_app value: time_attr_repetitive_launch_app - description: '' is_valid: true key: total_loan_apply value: time_attr_repetitive_loan_apply - description: '' is_valid: true key: total_loan_credit value: time_attr_repetitive_loan_credit - description: '' is_valid: true key: total_loan_disbursement value: time_attr_repetitive_loan_completion - description: '' is_valid: true key: total_login value: time_attr_repetitive_login - description: '' is_valid: true key: total_next_day_open value: time_attr_repetitive_next_day_open - description: '' is_valid: true key: total_on_web_add_to_wishlist_value value: time_attr_total_on_web_add_to_wishlist_value - description: '' is_valid: true key: total_on_web_order_value value: time_attr_total_on_web_order_value - description: '' is_valid: true key: total_on_web_subscribe_value value: time_attr_total_on_web_subscribe_value - description: '' is_valid: true key: total_online_consult_value value: time_attr_total_consult_standardized_value - description: '' is_valid: true key: total_onsite_add_billing_value value: time_attr_total_onsite_add_billing_value - description: '' is_valid: true key: total_onsite_add_to_wishlist_value value: time_attr_total_onsite_add_to_wishlist_value - description: '' is_valid: true key: total_onsite_form_value value: time_attr_total_onsite_form_value - description: '' is_valid: true key: total_onsite_initiate_checkout_count_value value: time_attr_total_onsite_initiate_checkout_count_value - description: '' is_valid: true key: total_onsite_on_web_cart_value value: time_attr_total_onsite_on_web_cart_value - description: '' is_valid: true key: total_onsite_on_web_detail_value value: time_attr_total_onsite_on_web_detail_value - description: '' is_valid: true key: total_onsite_shopping_value value: time_attr_total_onsite_shopping_value - description: '' is_valid: true key: total_page_event_search_value value: time_attr_total_search_value - description: '' is_valid: true key: total_page_view_content_events_value value: time_attr_total_on_web_detail_standardized_value - description: '' is_valid: true key: total_pageview value: time_attr_page_view - description: '' is_valid: true key: total_purchase value: time_attr_repetitive_active_pay - description: '' is_valid: true key: total_purchase_roas_day0 value: time_attr_active_pay_roas_d0 - description: '' is_valid: true key: total_purchase_roas_day2 value: time_attr_active_pay_roas_d2 - description: '' is_valid: true key: total_purchase_roas_day6 value: time_attr_active_pay_roas_d6 - description: '' is_valid: true key: total_purchase_value value: time_attr_total_repetitive_active_pay_value - description: '' is_valid: true key: total_purchase_value_day0 value: time_attr_total_repetitive_active_pay_value_d0 - description: '' is_valid: true key: total_purchase_value_day2 value: time_attr_total_repetitive_active_pay_value_d2 - description: '' is_valid: true key: total_purchase_value_day6 value: time_attr_total_repetitive_active_pay_value_d6 - description: '' is_valid: true key: total_ratings value: time_attr_repetitive_rate - description: '' is_valid: true key: total_ratings_value value: time_attr_total_repetitive_rate_value - description: '' is_valid: true key: total_registration value: time_attr_repetitive_active_register - description: '' is_valid: true key: total_sales_lead value: time_attr_repetitive_sales_lead - description: '' is_valid: true key: total_sales_lead_value value: time_attr_total_repetitive_sales_lead_value - description: '' is_valid: true key: total_search value: time_attr_repetitive_search - description: '' is_valid: true key: total_spend_credits value: time_attr_repetitive_spend_credits - description: '' is_valid: true key: total_spend_credits_value value: time_attr_total_repetitive_spend_credits_value - description: '' is_valid: true key: total_start_trial value: time_attr_repetitive_start_trial - description: '' is_valid: true key: total_subscribe value: time_attr_repetitive_subscribe - description: '' is_valid: true key: total_subscribe_value value: time_attr_total_repetitive_subscribe_value - description: '' is_valid: true key: total_unlock_achievement value: time_attr_repetitive_unlock_achievement - description: '' is_valid: true key: total_unlock_achievement_value value: time_attr_total_repetitive_unlock_achievement_value - description: '' is_valid: true key: total_user_registration_value value: time_attr_total_on_web_register_value - description: '' is_valid: true key: total_value_per_pageview value: time_attr_value_per_page_view - description: '' is_valid: true key: total_view_content value: time_attr_repetitive_in_app_detail_uv - description: '' is_valid: true key: total_view_content_value value: time_attr_total_repetitive_in_app_detail_uv_value - description: '' is_valid: true key: total_web_event_add_to_cart_value value: time_attr_total_on_web_cart_value - description: '' is_valid: true key: tt_playlist_visit value: tt_playlist_visit - description: '' is_valid: true key: tt_playlist_visit_rate value: tt_playlist_visit_rate - description: '' is_valid: true key: unique_ad_impression_events value: time_attr_ad_revenue - description: '' is_valid: true key: unique_custom_app_events value: time_attr_app_customized_events - description: '' is_valid: true key: unlock_achievement value: time_attr_unlock_achievement - description: '' is_valid: true key: unlock_achievement_rate value: time_attr_unlock_achievement_per_install - description: '' is_valid: true key: user_registration value: time_attr_on_web_register - description: '' is_valid: true key: user_registration_rate value: time_attr_on_web_register_per_click - description: '' is_valid: true key: value_per_ad_impression_event value: time_attr_value_per_repetitive_ad_revenue - description: '' is_valid: true key: value_per_add_billing value: time_attr_value_per_add_billing_count - description: '' is_valid: true key: value_per_button_click value: time_attr_value_per_button - description: '' is_valid: true key: value_per_checkout value: time_attr_value_per_repetitive_in_app_order - description: '' is_valid: true key: value_per_complete_payment value: time_attr_value_per_shopping - description: '' is_valid: true key: value_per_custom_app_event value: time_attr_value_per_repetitive_app_customized_events - description: '' is_valid: true key: value_per_custom_page_event value: time_attr_value_per_web_customized_events - description: '' is_valid: true key: value_per_download_start value: time_attr_value_per_download_start - description: '' is_valid: true key: value_per_form value: time_attr_value_per_form - description: '' is_valid: true key: value_per_initiate_checkout value: time_attr_value_per_initiate_checkout_count - description: '' is_valid: true key: value_per_offline_add_payment_info_event value: time_attr_value_per_offline_add_billing - description: '' is_valid: true key: value_per_offline_add_to_cart_event value: time_attr_value_per_offline_add_to_cart - description: '' is_valid: true key: value_per_offline_add_to_wishlist_event value: time_attr_value_per_offline_add_to_wishlist - description: '' is_valid: true key: value_per_offline_click_button_event value: time_attr_value_per_offline_button - description: '' is_valid: true key: value_per_offline_complete_registration_event value: time_attr_value_per_offline_register - description: '' is_valid: true key: value_per_offline_contact_event value: time_attr_value_per_offline_contact - description: '' is_valid: true key: value_per_offline_download_event value: time_attr_value_per_offline_download_start - description: '' is_valid: true key: value_per_offline_form_event value: time_attr_value_per_offline_submit_form - description: '' is_valid: true key: value_per_offline_initiate_checkout_event value: time_attr_value_per_offline_initiate_checkout - description: '' is_valid: true key: value_per_offline_place_order_event value: time_attr_value_per_offline_order - description: '' is_valid: true key: value_per_offline_search_event value: time_attr_value_per_offline_search - description: '' is_valid: true key: value_per_offline_shopping_event value: time_attr_value_per_offline_shopping - description: '' is_valid: true key: value_per_offline_subscribe_event value: time_attr_value_per_offline_subscribe - description: '' is_valid: true key: value_per_offline_view_content_event value: time_attr_value_per_offline_detail - description: '' is_valid: true key: value_per_on_web_add_to_wishlist value: time_attr_value_per_on_web_add_to_wishlist - description: '' is_valid: true key: value_per_on_web_order value: time_attr_value_per_on_web_order - description: '' is_valid: true key: value_per_on_web_subscribe value: time_attr_value_per_on_web_subscribe - description: '' is_valid: true key: value_per_online_consult value: time_attr_value_per_consult_standardized - description: '' is_valid: true key: value_per_onsite_add_billing value: time_attr_value_per_onsite_add_billing - description: '' is_valid: true key: value_per_onsite_add_to_wishlist value: time_attr_value_per_onsite_add_to_wishlist - description: '' is_valid: true key: value_per_onsite_form value: time_attr_value_per_onsite_form - description: '' is_valid: true key: value_per_onsite_initiate_checkout_count value: time_attr_value_per_onsite_initiate_checkout_count - description: '' is_valid: true key: value_per_onsite_on_web_cart value: time_attr_value_per_onsite_on_web_cart - description: '' is_valid: true key: value_per_onsite_on_web_detail value: time_attr_value_per_onsite_on_web_detail - description: '' is_valid: true key: value_per_onsite_shopping value: time_attr_value_per_onsite_shopping - description: '' is_valid: true key: value_per_page_content_view_event value: time_attr_value_per_on_web_detail_standardized - description: '' is_valid: true key: value_per_page_event_search value: time_attr_value_per_search_count - description: '' is_valid: true key: value_per_total_achieve_level value: time_attr_value_per_repetitive_update_level - description: '' is_valid: true key: value_per_total_add_to_wishlist value: time_attr_value_per_repetitive_add_to_wishlist - description: '' is_valid: true key: value_per_total_app_event_add_to_cart value: time_attr_value_per_repetitive_in_app_cart - description: '' is_valid: true key: value_per_total_complete_tutorial value: time_attr_value_per_repetitive_complete_tutorial - description: '' is_valid: true key: value_per_total_create_gamerole value: time_attr_value_per_repetitive_create_gamerole - description: '' is_valid: true key: value_per_total_create_group value: time_attr_value_per_repetitive_create_group - description: '' is_valid: true key: value_per_total_day7_retention value: time_attr_value_per_repetitive_retention_7d - description: '' is_valid: true key: value_per_total_in_app_ad_click value: time_attr_value_per_repetitive_in_app_ad_click - description: '' is_valid: true key: value_per_total_in_app_ad_impr value: time_attr_value_per_repetitive_in_app_ad_impr - description: '' is_valid: true key: value_per_total_join_group value: time_attr_value_per_repetitive_join_group - description: '' is_valid: true key: value_per_total_purchase value: time_attr_value_per_repetitive_active_pay - description: '' is_valid: true key: value_per_total_ratings value: time_attr_value_per_repetitive_rate - description: '' is_valid: true key: value_per_total_sales_lead value: time_attr_value_per_repetitive_sales_lead - description: '' is_valid: true key: value_per_total_spend_credits value: time_attr_value_per_repetitive_spend_credits - description: '' is_valid: true key: value_per_total_subscribe value: time_attr_value_per_repetitive_subscribe - description: '' is_valid: true key: value_per_total_unlock_achievement value: time_attr_value_per_repetitive_unlock_achievement - description: '' is_valid: true key: value_per_total_view_content value: time_attr_value_per_repetitive_in_app_detail_uv - description: '' is_valid: true key: value_per_user_registration value: time_attr_value_per_on_web_register - description: '' is_valid: true key: value_per_web_event_add_to_cart value: time_attr_value_per_on_web_cart - description: '' is_valid: true key: video_play_actions value: total_play - description: '' is_valid: true key: video_views_p100 value: play_over - description: '' is_valid: true key: video_views_p25 value: play_first_quartile - description: '' is_valid: true key: video_views_p50 value: play_midpoint - description: '' is_valid: true key: video_views_p75 value: play_third_quartile - description: '' is_valid: true key: video_watched_2s value: play_duration_2s - description: '' is_valid: true key: video_watched_6s value: play_duration_6s - description: '' is_valid: true key: view_content value: time_attr_in_app_detail_uv - description: '' is_valid: true key: view_content_rate value: time_attr_in_app_detail_uv_per_install - description: '' is_valid: true key: vta_app_install value: time_attr_active_show - description: '' is_valid: true key: vta_complete_payment value: time_attr_shopping_show - description: '' is_valid: true key: vta_complete_payment_roas value: time_attr_shopping_roas_show - description: '' is_valid: true key: vta_complete_payment_value value: time_attr_total_shopping_value_show - description: '' is_valid: true key: vta_conversion value: time_attr_convert_cnt_show - description: '' is_valid: true key: vta_purchase value: time_attr_active_pay_show - description: '' is_valid: true key: vta_registration value: time_attr_active_register_show - description: '' is_valid: true key: web_event_add_to_cart value: time_attr_on_web_cart - description: '' is_valid: true key: web_event_add_to_cart_rate value: time_attr_on_web_cart_per_click - description: '' is_valid: true key: website_application_approval value: time_attr_web_application_approval - description: '' is_valid: true key: website_application_approval_rate value: time_attr_web_application_approval_per_click - description: '' is_valid: true key: website_cost_per_application_approval value: time_attr_cost_per_web_application_approval - description: '' is_valid: true key: website_cost_per_cta_purchase value: time_attr_cost_per_shopping_click - description: '' is_valid: true key: website_cost_per_customize_product value: time_attr_cost_per_customizeproduct_web - description: '' is_valid: true key: website_cost_per_engaged_session value: time_attr_cost_per_engagement_session - description: '' is_valid: true key: website_cost_per_find_location value: time_attr_cost_per_findlocation_web - description: '' is_valid: true key: website_cost_per_schedule value: time_attr_cost_per_schedule_web - description: '' is_valid: true key: website_cost_per_start_trial value: time_attr_cost_per_web_start_trial - description: '' is_valid: true key: website_cost_per_submit_application value: time_attr_web_submit_application - description: '' is_valid: true key: website_cta_purchase value: time_attr_shopping_click - description: '' is_valid: true key: website_cta_purchase_roas value: time_attr_shopping_roas_click - description: '' is_valid: true key: website_cta_purchase_value value: time_attr_total_shopping_value_click - description: '' is_valid: true key: website_customize_product_rate value: time_attr_customizeproduct_per_click_web - description: '' is_valid: true key: website_engaged_session_rate value: time_attr_engagement_session_per_click - description: '' is_valid: true key: website_find_location_rate value: time_attr_findlocation_per_click_web - description: '' is_valid: true key: website_schedule_rate value: time_attr_schedule_per_click_web - description: '' is_valid: true key: website_start_trial_rate value: time_attr_web_start_trial_per_click - description: '' is_valid: true key: website_submit_application_rate value: time_attr_web_submit_application_per_click - description: '' is_valid: true key: website_total_application_approval_value value: time_attr_total_web_application_approval_value - description: '' is_valid: true key: website_total_customize_product value: time_attr_customizeproduct_web - description: '' is_valid: true key: website_total_customize_product_value value: time_attr_total_customizeproduct_value_web - description: '' is_valid: true key: website_total_engaged_session value: time_attr_engagement_session - description: '' is_valid: true key: website_total_find_location value: time_attr_findlocation_web - description: '' is_valid: true key: website_total_find_location_value value: time_attr_total_findlocation_value_web - description: '' is_valid: true key: website_total_schedule value: time_attr_schedule_web - description: '' is_valid: true key: website_total_schedule_value value: time_attr_total_schedule_value_web - description: '' is_valid: true key: website_total_start_trial value: time_attr_web_start_trial - description: '' is_valid: true key: website_total_start_trial_value value: time_attr_total_web_start_trial_value - description: '' is_valid: true key: website_total_submit_application value: time_attr_web_submit_application - description: '' is_valid: true key: website_total_submit_application_value value: time_attr_total_web_submit_application_value - description: '' is_valid: true key: website_value_per_application_approval value: time_attr_value_per_web_application_approval - description: '' is_valid: true key: website_value_per_customize_product value: time_attr_value_per_customizeproduct_web - description: '' is_valid: true key: website_value_per_find_location value: time_attr_value_per_findlocation_web - description: '' is_valid: true key: website_value_per_schedule value: time_attr_value_per_schedule_web - description: '' is_valid: true key: website_value_per_start_trial value: time_attr_value_per_web_start_trial - description: '' is_valid: true key: website_value_per_submit_application value: time_attr_value_per_web_submit_application key_format: string strict: true use_part: true validate_only: false value_format: string minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.metrics description: '' in: query name: metrics required: false x-open-field-id: 3 - description: '' in: query name: start_date required: true schema: format: date nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.start_date x-open-field-id: 4 - description: '' in: query name: end_date required: true schema: format: date nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.end_date x-open-field-id: 5 - content: application/json: schema: nullable: false properties: ad_text_entity_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 400 minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.query.filtering.ad_text_entity_id adgroup_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) maxItems: 200 minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.query.filtering.adgroup_ids call_to_action_entity_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 400 minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 x-open-source: $.http.query.filtering.call_to_action_entity_id campaign_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) maxItems: 200 minItems: 1 nullable: false 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 interactive_add_on_entity_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 400 minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 8 x-open-source: $.http.query.filtering.interactive_add_on_entity_id main_material_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 400 minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.query.filtering.main_material_id main_material_types: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1836027820112065 enum_package_name: SppReportMaterialType enums: - description: '' is_valid: true key: CAROUSEL_NON_SPARK_ADS value: no_post_carousel - description: '' is_valid: true key: CAROUSEL_SPARK_ADS value: post_carousel - description: '' is_valid: true key: CATALOG_CAROUSEL value: catalog_tpl_carousel - description: '' is_valid: true key: CATALOG_MULTI_SHOW value: catalog_tpl_multi_show - description: '' is_valid: true key: CATALOG_VIDEO value: catalog_manual_video - description: '' is_valid: true key: CATALOG_VIDEO_TEMPLATE value: catalog_tpl_video - description: '' is_valid: true key: SINGLE_IMAGE_NON_SPARK_ADS value: no_post_single_image - description: '' is_valid: true key: VIDEO_NON_SPARK_ADS value: no_post_video - description: '' is_valid: true key: VIDEO_SPARK_ADS value: post_video key_format: string strict: true use_part: false validate_only: false value_format: string maxItems: 9 minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.query.filtering.main_material_types smart_plus_ad_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) maxItems: 200 minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.query.filtering.ad_ids 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: 6 - description: '' in: query name: sort_field required: false schema: default: spend nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1837121920475138 enum_package_name: SppReportMetrics enums: - description: '' is_valid: true key: achieve_level value: time_attr_update_level - description: '' is_valid: true key: achieve_level_rate value: time_attr_update_level_per_install - description: '' is_valid: true key: ad_impression_ad_revenue_day0 value: time_attr_total_repetitive_active_pay_value_d0_iaa - description: '' is_valid: true key: ad_impression_ad_revenue_day2 value: time_attr_total_repetitive_active_pay_value_d2_iaa - description: '' is_valid: true key: ad_impression_ad_revenue_roas_day0 value: time_attr_active_pay_roas_d0_iaa - description: '' is_valid: true key: ad_impression_ad_revenue_roas_day2 value: time_attr_active_pay_roas_d2_iaa - description: '' is_valid: true key: ad_impression_ad_revenue_roas_day6 value: time_attr_active_pay_roas_d6_iaa - description: '' is_valid: false key: ad_material_id value: ad_material_draft_id - description: '' is_valid: true key: add_billing value: time_attr_add_billing_count - description: '' is_valid: true key: add_billing_rate value: time_attr_add_billing_count_per_click - description: '' is_valid: true key: add_payment_info value: time_attr_add_payment_info - description: '' is_valid: true key: add_payment_info_rate value: time_attr_add_payment_info_per_install - description: '' is_valid: true key: add_to_wishlist value: time_attr_add_to_wishlist - description: '' is_valid: true key: add_to_wishlist_rate value: time_attr_add_to_wishlist_per_install - description: '' is_valid: true key: ads_impression_events value: time_attr_repetitive_ad_revenue - description: '' is_valid: true key: anchor_click_rate value: anchor_click_rate - description: '' is_valid: true key: anchor_clicks value: anchor_click_count - description: '' is_valid: true key: app_event_add_to_cart value: time_attr_in_app_cart - description: '' is_valid: true key: app_event_add_to_cart_rate value: time_attr_in_app_cart_per_install - description: '' is_valid: true key: app_install value: time_attr_active - description: '' is_valid: true key: average_video_play value: average_video_play - description: '' is_valid: true key: avg_value_per_pageview value: time_attr_total_page_view_value - description: '' is_valid: true key: button_click value: time_attr_button_standardized - description: '' is_valid: true key: button_click_rate value: time_attr_button_standardized_per_click - description: '' is_valid: true key: checkout value: time_attr_in_app_order - description: '' is_valid: true key: checkout_rate value: time_attr_in_app_order_per_install - description: '' is_valid: true key: clicks value: click_cnt - description: '' is_valid: true key: clicks_on_hashtag_challenge value: ies_challenge_click - description: '' is_valid: true key: clicks_on_music_disc value: ies_music_click - description: '' is_valid: true key: comments value: ad_comment - description: '' is_valid: true key: complete_payment value: time_attr_shopping - description: '' is_valid: true key: complete_payment_rate value: time_attr_shopping_per_click - description: '' is_valid: true key: complete_payment_roas value: time_attr_shopping_roas - description: '' is_valid: true key: complete_tutorial value: time_attr_complete_tutorial - description: '' is_valid: true key: complete_tutorial_rate value: time_attr_complete_tutorial_per_install - description: '' is_valid: true key: conversion value: time_attr_convert_cnt - description: '' is_valid: true key: conversion_rate_v2 value: time_attr_conversion_rate_imp - description: '' is_valid: true key: cost_per_achieve_level value: time_attr_cost_per_update_level - description: '' is_valid: true key: cost_per_add_billing value: time_attr_cost_per_add_billing_count - description: '' is_valid: true key: cost_per_add_payment_info value: time_attr_cost_per_add_payment_info - description: '' is_valid: true key: cost_per_add_to_wishlist value: time_attr_cost_per_add_to_wishlist - description: '' is_valid: true key: cost_per_app_event_add_to_cart value: time_attr_cost_per_in_app_cart - description: '' is_valid: true key: cost_per_app_install value: time_attr_active_cost - description: '' is_valid: true key: cost_per_button_click value: time_attr_cost_per_button_standardized - description: '' is_valid: true key: cost_per_checkout value: time_attr_cost_per_in_app_order - description: '' is_valid: true key: cost_per_complete_payment value: time_attr_cost_per_shopping - description: '' is_valid: true key: cost_per_complete_tutorial value: time_attr_cost_per_complete_tutorial - description: '' is_valid: true key: cost_per_conversion value: time_attr_conversion_cost - description: '' is_valid: true key: cost_per_create_gamerole value: time_attr_cost_per_create_gamerole - description: '' is_valid: true key: cost_per_create_group value: time_attr_cost_per_create_group - description: '' is_valid: true key: cost_per_cta_app_install value: time_attr_active_click_cost - description: '' is_valid: true key: cost_per_cta_conversion value: time_attr_convert_cnt_click_cost - description: '' is_valid: true key: cost_per_cta_purchase value: time_attr_active_pay_click_cost - description: '' is_valid: true key: cost_per_cta_registration value: time_attr_active_register_click_cost - description: '' is_valid: true key: cost_per_custom_app_event value: time_attr_cost_per_repetitive_app_customized_events - description: '' is_valid: true key: cost_per_custom_page_event value: time_attr_cost_per_web_customized_events - description: '' is_valid: true key: cost_per_day7_retention value: time_attr_cost_per_retention_7d - description: '' is_valid: true key: cost_per_download_start value: time_attr_cost_per_download_start - description: '' is_valid: true key: cost_per_engaged_view_through_conversion value: time_attr_convert_cnt_ev_cost - description: '' is_valid: true key: cost_per_evta_app_install value: time_attr_active_ev_cost - description: '' is_valid: true key: cost_per_evta_payments_completed value: time_attr_shopping_ev_cost - description: '' is_valid: true key: cost_per_evta_purchase value: time_attr_active_pay_ev_cost - description: '' is_valid: true key: cost_per_evta_registration value: time_attr_active_register_ev_cost - description: '' is_valid: true key: cost_per_form value: time_attr_cost_per_form - description: '' is_valid: true key: cost_per_in_app_ad_click value: time_attr_cost_per_in_app_ad_click - description: '' is_valid: true key: cost_per_in_app_ad_impr value: time_attr_cost_per_in_app_ad_impr - description: '' is_valid: true key: cost_per_initiate_checkout value: time_attr_cost_per_initiate_checkout_count - description: '' is_valid: true key: cost_per_ix_button_click_count value: cost_per_ix_button_click_count - description: '' is_valid: true key: cost_per_ix_page_view_count value: cost_per_ix_page_view_count - description: '' is_valid: true key: cost_per_ix_product_click_count value: cost_per_ix_product_click_count - description: '' is_valid: true key: cost_per_join_group value: time_attr_cost_per_join_group - description: '' is_valid: true key: cost_per_landing_page_view value: time_attr_cost_per_web_landing_page_view - description: '' is_valid: true key: cost_per_launch_app value: time_attr_cost_per_launch_app - description: '' is_valid: true key: cost_per_loan_apply value: time_attr_cost_per_loan_apply - description: '' is_valid: true key: cost_per_loan_credit value: time_attr_cost_per_loan_credit - description: '' is_valid: true key: cost_per_loan_disbursement value: time_attr_cost_per_loan_completion - description: '' is_valid: true key: cost_per_login value: time_attr_cost_per_login - description: '' is_valid: true key: cost_per_next_day_open value: time_attr_cost_per_next_day_open - description: '' is_valid: true key: cost_per_offline_add_payment_info_event value: time_attr_cost_per_offline_add_billing - description: '' is_valid: true key: cost_per_offline_add_to_cart_event value: time_attr_cost_per_offline_add_to_cart - description: '' is_valid: true key: cost_per_offline_add_to_wishlist_event value: time_attr_cost_per_offline_add_to_wishlist - description: '' is_valid: true key: cost_per_offline_click_button_event value: time_attr_cost_per_offline_button - description: '' is_valid: true key: cost_per_offline_complete_registration_event value: time_attr_cost_per_offline_register - description: '' is_valid: true key: cost_per_offline_contact_event value: time_attr_cost_per_offline_contact - description: '' is_valid: true key: cost_per_offline_download_event value: time_attr_cost_per_offline_download_start - description: '' is_valid: true key: cost_per_offline_form_event value: time_attr_cost_per_offline_submit_form - description: '' is_valid: true key: cost_per_offline_initiate_checkout_event value: time_attr_cost_per_offline_initiate_checkout - description: '' is_valid: true key: cost_per_offline_place_order_event value: time_attr_cost_per_offline_order - description: '' is_valid: true key: cost_per_offline_search_event value: time_attr_cost_per_offline_search - description: '' is_valid: true key: cost_per_offline_shopping_event value: time_attr_cost_per_offline_shopping - description: '' is_valid: true key: cost_per_offline_subscribe_event value: time_attr_cost_per_offline_subscribe - description: '' is_valid: true key: cost_per_offline_view_content_event value: time_attr_cost_per_offline_detail - description: '' is_valid: true key: cost_per_on_web_add_to_wishlist value: time_attr_cost_per_on_web_add_to_wishlist - description: '' is_valid: true key: cost_per_on_web_order value: time_attr_cost_per_on_web_order - description: '' is_valid: true key: cost_per_on_web_subscribe value: time_attr_cost_per_on_web_subscribe - description: '' is_valid: true key: cost_per_online_consult value: time_attr_cost_per_consult_standardized - description: '' is_valid: true key: cost_per_onsite_add_billing value: time_attr_cost_per_onsite_add_billing - description: '' is_valid: true key: cost_per_onsite_add_to_wishlist value: time_attr_cost_per_onsite_add_to_wishlist - description: '' is_valid: true key: cost_per_onsite_destination_visit value: time_attr_cost_per_onsite_destination_visit - description: '' is_valid: true key: cost_per_onsite_download_start value: time_attr_cost_per_onsite_download_start - description: '' is_valid: true key: cost_per_onsite_form value: time_attr_cost_per_onsite_form - description: '' is_valid: true key: cost_per_onsite_initiate_checkout_count value: time_attr_cost_per_onsite_initiate_checkout_count - description: '' is_valid: true key: cost_per_onsite_on_web_cart value: time_attr_cost_per_onsite_on_web_cart - description: '' is_valid: true key: cost_per_onsite_on_web_detail value: time_attr_cost_per_onsite_on_web_detail - description: '' is_valid: true key: cost_per_onsite_shopping value: time_attr_cost_per_onsite_shopping - description: '' is_valid: true key: cost_per_page_content_view_event value: time_attr_cost_per_on_web_detail_standardized - description: '' is_valid: true key: cost_per_page_event_search value: time_attr_cost_per_search_count - description: '' is_valid: true key: cost_per_pageview value: time_attr_cost_per_page_view - description: '' is_valid: true key: cost_per_purchase value: time_attr_active_pay_cost - description: '' is_valid: true key: cost_per_ratings value: time_attr_cost_per_rate - description: '' is_valid: true key: cost_per_registration value: time_attr_active_register_cost - description: '' is_valid: true key: cost_per_sales_lead value: time_attr_cost_per_sales_lead - description: '' is_valid: true key: cost_per_search value: time_attr_cost_per_search - description: '' is_valid: true key: cost_per_spend_credits value: time_attr_cost_per_spend_credits - description: '' is_valid: true key: cost_per_start_trial value: time_attr_cost_per_start_trial - description: '' is_valid: true key: cost_per_subscribe value: time_attr_cost_per_subscribe - description: '' is_valid: true key: cost_per_total_achieve_level value: time_attr_cost_per_repetitive_update_level - description: '' is_valid: true key: cost_per_total_add_to_wishlist value: time_attr_cost_per_repetitive_add_to_wishlist - description: '' is_valid: true key: cost_per_total_app_event_add_to_cart value: time_attr_cost_per_repetitive_in_app_cart - description: '' is_valid: true key: cost_per_total_checkout value: time_attr_cost_per_repetitive_in_app_order - description: '' is_valid: true key: cost_per_total_complete_tutorial value: time_attr_cost_per_repetitive_complete_tutorial - description: '' is_valid: true key: cost_per_total_create_gamerole value: time_attr_cost_per_repetitive_create_gamerole - description: '' is_valid: true key: cost_per_total_create_group value: time_attr_cost_per_repetitive_create_group - description: '' is_valid: true key: cost_per_total_day7_retention value: time_attr_cost_per_repetitive_retention_7d - description: '' is_valid: true key: cost_per_total_in_app_ad_click value: time_attr_cost_per_repetitive_in_app_ad_click - description: '' is_valid: true key: cost_per_total_in_app_ad_impr value: time_attr_cost_per_repetitive_in_app_ad_impr - description: '' is_valid: true key: cost_per_total_join_group value: time_attr_cost_per_repetitive_join_group - description: '' is_valid: true key: cost_per_total_launch_app value: time_attr_cost_per_repetitive_launch_app - description: '' is_valid: true key: cost_per_total_loan_apply value: time_attr_cost_per_repetitive_loan_apply - description: '' is_valid: true key: cost_per_total_loan_credit value: time_attr_cost_per_repetitive_loan_credit - description: '' is_valid: true key: cost_per_total_loan_disbursement value: time_attr_cost_per_repetitive_loan_completion - description: '' is_valid: true key: cost_per_total_login value: time_attr_cost_per_repetitive_login - description: '' is_valid: true key: cost_per_total_next_day_open value: time_attr_cost_per_repetitive_next_day_open - description: '' is_valid: true key: cost_per_total_purchase value: time_attr_cost_per_repetitive_active_pay - description: '' is_valid: true key: cost_per_total_ratings value: time_attr_cost_per_repetitive_rate - description: '' is_valid: true key: cost_per_total_registration value: time_attr_cost_per_repetitive_active_register - description: '' is_valid: true key: cost_per_total_sales_lead value: time_attr_cost_per_repetitive_sales_lead - description: '' is_valid: true key: cost_per_total_search value: time_attr_cost_per_repetitive_search - description: '' is_valid: true key: cost_per_total_spend_credits value: time_attr_cost_per_repetitive_spend_credits - description: '' is_valid: true key: cost_per_total_start_trial value: time_attr_cost_per_repetitive_start_trial - description: '' is_valid: true key: cost_per_total_subscribe value: time_attr_cost_per_repetitive_subscribe - description: '' is_valid: true key: cost_per_total_unlock_achievement value: time_attr_cost_per_repetitive_unlock_achievement - description: '' is_valid: true key: cost_per_total_view_content value: time_attr_cost_per_repetitive_in_app_detail_uv - description: '' is_valid: true key: cost_per_unique_ad_impression_event value: time_attr_cost_per_ad_revenue - description: '' is_valid: true key: cost_per_unique_custom_app_event value: time_attr_cost_per_app_customized_events - description: '' is_valid: true key: cost_per_unlock_achievement value: time_attr_cost_per_unlock_achievement - description: '' is_valid: true key: cost_per_user_registration value: time_attr_cost_per_on_web_register - description: '' is_valid: true key: cost_per_view_content value: time_attr_cost_per_in_app_detail_uv - description: '' is_valid: true key: cost_per_vta_app_install value: time_attr_active_show_cost - description: '' is_valid: true key: cost_per_vta_conversion value: time_attr_convert_cnt_show_cost - description: '' is_valid: true key: cost_per_vta_payments_completed value: time_attr_cost_per_shopping_show - description: '' is_valid: true key: cost_per_vta_purchase value: time_attr_active_pay_show_cost - description: '' is_valid: true key: cost_per_vta_registration value: time_attr_active_register_show_cost - description: '' is_valid: true key: cost_per_web_event_add_to_cart value: time_attr_cost_per_on_web_cart - description: '' is_valid: true key: cost_pre_ad_impression_event value: time_attr_cost_per_repetitive_ad_revenue - description: '' is_valid: true key: cost_total_add_payment_info value: time_attr_cost_per_repetitive_add_payment_info - description: '' is_valid: true key: countdown_sticker_recall_clicks value: recall_message_click_cnt - description: '' is_valid: true key: cpc value: cpc - description: '' is_valid: true key: cpm value: cpm - description: '' is_valid: true key: create_gamerole value: time_attr_create_gamerole - description: '' is_valid: true key: create_gamerole_rate value: time_attr_create_gamerole_per_install - description: '' is_valid: true key: create_group value: time_attr_create_group - description: '' is_valid: true key: create_group_rate value: time_attr_create_group_per_install - description: '' is_valid: true key: cta_app_install value: time_attr_active_click - description: '' is_valid: true key: cta_conversion value: time_attr_convert_cnt_click - description: '' is_valid: true key: cta_purchase value: time_attr_active_pay_click - description: '' is_valid: true key: cta_registration value: time_attr_active_register_click - description: '' is_valid: true key: ctr value: ctr - description: '' is_valid: true key: custom_app_event_rate value: time_attr_app_customized_events_per_install - description: '' is_valid: true key: custom_app_events value: time_attr_repetitive_app_customized_events - description: '' is_valid: true key: custom_app_events_value value: time_attr_total_repetitive_app_customized_events_value - description: '' is_valid: true key: custom_page_event_rate value: time_attr_web_customized_events_per_click - description: '' is_valid: true key: custom_page_events value: time_attr_web_customized_events - description: '' is_valid: true key: custom_page_events_value value: time_attr_total_web_customized_events_value - description: '' is_valid: true key: customized_ad_impression_event_rate value: time_attr_ad_revenue_per_install - description: '' is_valid: true key: day7_retention value: time_attr_retention_7d - description: '' is_valid: true key: day7_retention_rate value: time_attr_retention_7d_per_install - description: '' is_valid: true key: download_start value: time_attr_download_start - description: '' is_valid: true key: download_start_rate value: time_attr_download_start_per_click - description: '' is_valid: true key: duet_clicks value: duet_click_cnt - description: '' is_valid: true key: engaged_view value: engaged_view - description: '' is_valid: true key: engaged_view_15s value: engaged_view_15s - description: '' is_valid: true key: engaged_view_through_conversions value: time_attr_convert_cnt_ev - description: '' is_valid: true key: engagement_rate value: total_engagement_rate - description: '' is_valid: true key: engagements value: total_engagement - description: '' is_valid: true key: evta_app_install value: time_attr_active_ev - description: '' is_valid: true key: evta_payments_completed value: time_attr_shopping_ev - description: '' is_valid: true key: evta_purchase value: time_attr_active_pay_ev - description: '' is_valid: true key: evta_registration value: time_attr_active_register_ev - description: '' is_valid: true key: follows value: ad_net_follow - description: '' is_valid: true key: form value: time_attr_form - description: '' is_valid: true key: form_rate value: time_attr_form_per_click - description: '' is_valid: true key: gross_impressions value: gross_show_count - description: '' is_valid: true key: impressions value: show_cnt - description: '' is_valid: true key: in_app_ad_click value: time_attr_in_app_ad_click - description: '' is_valid: true key: in_app_ad_click_rate value: time_attr_in_app_ad_click_per_install - description: '' is_valid: true key: in_app_ad_impr value: time_attr_in_app_ad_impr - description: '' is_valid: true key: in_app_ad_impr_rate value: time_attr_in_app_ad_impr_per_install - description: '' is_valid: true key: initiate_checkout value: time_attr_initiate_checkout_count - description: '' is_valid: true key: initiate_checkout_rate value: time_attr_initiate_checkout_count_per_click - description: '' is_valid: true key: interactive_add_on_activity_clicks value: additional_format_interactive_click_count - description: '' is_valid: true key: interactive_add_on_destination_clicks value: additional_format_outbound_click_count - description: '' is_valid: true key: interactive_add_on_impressions value: additional_format_show_count - description: '' is_valid: true key: interactive_add_on_option_a_clicks value: additional_format_option_a_click_count - description: '' is_valid: true key: interactive_add_on_option_b_clicks value: additional_format_option_b_click_count - description: '' is_valid: true key: ix_average_video_play value: ix_video_duration_avg - description: '' is_valid: true key: ix_button_click_count value: ix_button_click_count - description: '' is_valid: true key: ix_button_click_count_rate value: ix_button_click_count_per_click - description: '' is_valid: true key: ix_page_duration_avg value: ix_page_duration_avg - description: '' is_valid: true key: ix_page_view_count value: ix_page_view_count - description: '' is_valid: true key: ix_page_view_count_rate value: ix_page_view_count_per_click - description: '' is_valid: true key: ix_page_viewrate_avg value: ix_page_viewrate_avg - description: '' is_valid: true key: ix_product_click_count value: ix_product_click_count - description: '' is_valid: true key: ix_product_click_count_rate value: ix_product_click_count_per_click - description: '' is_valid: true key: ix_video_views value: ix_video_view_count - description: '' is_valid: true key: ix_video_views_p100 value: ix_video_view_100pct - description: '' is_valid: true key: ix_video_views_p25 value: ix_video_view_25pct - description: '' is_valid: true key: ix_video_views_p50 value: ix_video_view_50pct - description: '' is_valid: true key: ix_video_views_p75 value: ix_video_view_75pct - description: '' is_valid: true key: join_group value: time_attr_join_group - description: '' is_valid: true key: join_group_rate value: time_attr_join_group_per_install - description: '' is_valid: true key: landing_page_view_rate value: time_attr_web_landing_page_view_per_click - description: '' is_valid: true key: launch_app value: time_attr_launch_app - description: '' is_valid: true key: launch_app_rate value: time_attr_launch_app_per_install - description: '' is_valid: true key: likes value: ad_net_like - description: '' is_valid: true key: live_effective_views value: live_effective_play_count - description: '' is_valid: true key: live_product_clicks value: live_product_click_count - description: '' is_valid: true key: live_views value: live_play_count - description: '' is_valid: true key: loan_apply value: time_attr_loan_apply - description: '' is_valid: true key: loan_apply_rate value: time_attr_loan_apply_per_install - description: '' is_valid: true key: loan_credit value: time_attr_loan_credit - description: '' is_valid: true key: loan_credit_rate value: time_attr_loan_credit_per_install - description: '' is_valid: true key: loan_disbursement value: time_attr_loan_completion - description: '' is_valid: true key: loan_disbursement_rate value: time_attr_loan_completion_per_install - description: '' is_valid: true key: login value: time_attr_login - description: '' is_valid: true key: login_rate value: time_attr_login_per_install - description: '' is_valid: false key: material_primary_status value: material_primary_status - description: '' is_valid: false key: material_second_status_list value: material_second_status_list - description: '' is_valid: true key: messaging_conversation_rate_instant_messaging_app value: time_attr_ctm_ima_messaging_per_click - description: '' is_valid: true key: messaging_conversation_rate_tiktok_direct_message value: time_attr_nonshop_onsite_tt_messaging_per_click - description: '' is_valid: true key: messaging_cost_per_conversation_instant_messaging_app value: time_attr_cost_per_ctm_ima_messaging - description: '' is_valid: true key: messaging_cost_per_conversation_tiktok_direct_message value: time_attr_cost_per_nonshop_onsite_tt_messaging - description: '' is_valid: true key: messaging_total_conversation_instant_messaging_app value: time_attr_ctm_ima_messaging_count - description: '' is_valid: true key: messaging_total_conversation_tiktok_direct_message value: time_attr_nonshop_onsite_tt_messaging - description: '' is_valid: true key: next_day_open value: time_attr_next_day_open - description: '' is_valid: true key: next_day_open_rate value: time_attr_next_day_open_per_install - description: '' is_valid: true key: offline_add_payment_info_event_rate value: time_attr_offline_add_billing_per_click - description: '' is_valid: true key: offline_add_payment_info_events value: time_attr_offline_add_billing - description: '' is_valid: true key: offline_add_payment_info_events_value value: time_attr_total_offline_add_billing_value - description: '' is_valid: true key: offline_add_to_cart_event_rate value: time_attr_offline_add_to_cart_per_click - description: '' is_valid: true key: offline_add_to_cart_events value: time_attr_offline_add_to_cart - description: '' is_valid: true key: offline_add_to_cart_events_value value: time_attr_total_offline_add_to_cart_value - description: '' is_valid: true key: offline_add_to_wishlist_event_rate value: time_attr_offline_add_to_wishlist_per_click - description: '' is_valid: true key: offline_add_to_wishlist_events value: time_attr_offline_add_to_wishlist - description: '' is_valid: true key: offline_add_to_wishlist_events_value value: time_attr_total_offline_add_to_wishlist_value - description: '' is_valid: true key: offline_application_approval value: time_attr_offline_application_approval - description: '' is_valid: true key: offline_application_approval_rate value: time_attr_offline_application_approval_per_click - description: '' is_valid: true key: offline_click_button_event_rate value: time_attr_offline_button_per_click - description: '' is_valid: true key: offline_click_button_events value: time_attr_offline_button - description: '' is_valid: true key: offline_click_button_events_value value: time_attr_total_offline_button_value - description: '' is_valid: true key: offline_complete_registration_event_rate value: time_attr_offline_register_per_click - description: '' is_valid: true key: offline_complete_registration_events value: time_attr_offline_register - description: '' is_valid: true key: offline_complete_registration_events_value value: time_attr_total_offline_register_value - description: '' is_valid: true key: offline_contact_event_rate value: time_attr_offline_contact_per_click - description: '' is_valid: true key: offline_contact_events value: time_attr_offline_contact - description: '' is_valid: true key: offline_contact_events_value value: time_attr_total_offline_contact_value - description: '' is_valid: true key: offline_cost_per_application_approval value: time_attr_cost_per_offline_application_approval - description: '' is_valid: true key: offline_cost_per_crm_event value: time_attr_cost_per_crm_events - description: '' is_valid: true key: offline_cost_per_custom_event value: time_attr_cost_per_offline_customized_events - description: '' is_valid: true key: offline_cost_per_customize_product value: time_attr_cost_per_customizeproduct_offline - description: '' is_valid: true key: offline_cost_per_find_location value: time_attr_cost_per_findlocation_offline - description: '' is_valid: true key: offline_cost_per_preferred_lead value: time_attr_cost_per_preferred_leads - description: '' is_valid: true key: offline_cost_per_schedule value: time_attr_cost_per_schedule_offline - description: '' is_valid: true key: offline_cost_per_start_trial value: time_attr_offline_start_trial_per_click - description: '' is_valid: true key: offline_cost_per_submit_application value: time_attr_cost_per_offline_submit_application - description: '' is_valid: true key: offline_crm_event_rate value: time_attr_crm_events_per_click - description: '' is_valid: true key: offline_crm_event_value value: time_attr_total_crm_events_value - description: '' is_valid: true key: offline_custom_event_rate value: time_attr_offline_customized_events_per_click - description: '' is_valid: true key: offline_customize_product_rate value: time_attr_customizeproduct_per_click_offline - description: '' is_valid: true key: offline_download_event_rate value: time_attr_offline_download_start_per_click - description: '' is_valid: true key: offline_download_events value: time_attr_offline_download_start - description: '' is_valid: true key: offline_download_events_value value: time_attr_total_offline_download_start_value - description: '' is_valid: true key: offline_find_location_rate value: time_attr_findlocation_per_click_offline - description: '' is_valid: true key: offline_form_event_rate value: time_attr_offline_submit_form_per_click - description: '' is_valid: true key: offline_form_events value: time_attr_offline_submit_form - description: '' is_valid: true key: offline_form_events_value value: time_attr_total_offline_submit_form_value - description: '' is_valid: true key: offline_initiate_checkout_event_rate value: time_attr_offline_initiate_checkout_per_click - description: '' is_valid: true key: offline_initiate_checkout_events value: time_attr_offline_initiate_checkout - description: '' is_valid: true key: offline_initiate_checkout_events_value value: time_attr_total_offline_initiate_checkout_value - description: '' is_valid: true key: offline_place_order_event_rate value: time_attr_offline_order_per_click - description: '' is_valid: true key: offline_place_order_events value: time_attr_offline_order - description: '' is_valid: true key: offline_place_order_events_value value: time_attr_total_offline_order_value - description: '' is_valid: true key: offline_preferred_lead_rate value: time_attr_preferred_leads_per_click - description: '' is_valid: true key: offline_preferred_leads value: time_attr_preferred_leads_cnt - description: '' is_valid: true key: offline_schedule_rate value: time_attr_schedule_per_click_offline - description: '' is_valid: true key: offline_search_event_rate value: time_attr_offline_search_per_click - description: '' is_valid: true key: offline_search_events value: time_attr_offline_search - description: '' is_valid: true key: offline_search_events_value value: time_attr_total_offline_search_value - description: '' is_valid: true key: offline_shopping_event_rate value: time_attr_offline_shopping_per_click - description: '' is_valid: true key: offline_shopping_events value: time_attr_offline_shopping - description: '' is_valid: true key: offline_shopping_events_roas value: time_attr_offline_shopping_roas - description: '' is_valid: true key: offline_shopping_events_value value: time_attr_total_offline_shopping_value - description: '' is_valid: true key: offline_start_trial_rate value: time_attr_cost_per_offline_start_trial - description: '' is_valid: true key: offline_submit_application_rate value: time_attr_offline_submit_application_per_click - description: '' is_valid: true key: offline_subscribe_event_rate value: time_attr_offline_subscribe_per_click - description: '' is_valid: true key: offline_subscribe_events value: time_attr_offline_subscribe - description: '' is_valid: true key: offline_subscribe_events_value value: time_attr_total_offline_subscribe_value - description: '' is_valid: true key: offline_total_application_approval_value value: time_attr_total_offline_application_approval_value - description: '' is_valid: true key: offline_total_crm_events value: time_attr_crm_events - description: '' is_valid: true key: offline_total_custom_event_value value: time_attr_total_offline_customized_events_value - description: '' is_valid: true key: offline_total_custom_events value: time_attr_offline_customized_events - description: '' is_valid: true key: offline_total_customize_product value: time_attr_customizeproduct_offline - description: '' is_valid: true key: offline_total_customize_product_value value: time_attr_total_customizeproduct_value_offline - description: '' is_valid: true key: offline_total_find_location value: time_attr_findlocation_offline - description: '' is_valid: true key: offline_total_find_location_value value: time_attr_total_findlocation_value_offline - description: '' is_valid: true key: offline_total_schedule value: time_attr_schedule_offline - description: '' is_valid: true key: offline_total_schedule_value value: time_attr_total_schedule_value_offline - description: '' is_valid: true key: offline_total_start_trial value: time_attr_offline_start_trial - description: '' is_valid: true key: offline_total_start_trial_value value: time_attr_total_offline_start_trial_value - description: '' is_valid: true key: offline_total_submit_application value: time_attr_offline_submit_application - description: '' is_valid: true key: offline_total_submit_application_value value: time_attr_total_offline_submit_application_value - description: '' is_valid: true key: offline_value_per_application_approval value: time_attr_value_per_offline_application_approval - description: '' is_valid: true key: offline_value_per_crm_event value: time_attr_value_per_crm_events - description: '' is_valid: true key: offline_value_per_custom_event value: time_attr_value_per_offline_customized_events - description: '' is_valid: true key: offline_value_per_customize_product value: time_attr_value_per_customizeproduct_offline - description: '' is_valid: true key: offline_value_per_find_location value: time_attr_value_per_findlocation_offline - description: '' is_valid: true key: offline_value_per_schedule value: time_attr_value_per_schedule_offline - description: '' is_valid: true key: offline_value_per_start_trial value: time_attr_value_per_offline_start_trial - description: '' is_valid: true key: offline_value_per_submit_application value: time_attr_value_per_offline_submit_application - description: '' is_valid: true key: offline_view_content_event_rate value: time_attr_offline_detail_per_click - description: '' is_valid: true key: offline_view_content_events value: time_attr_offline_detail - description: '' is_valid: true key: offline_view_content_events_value value: time_attr_total_offline_detail_value - description: '' is_valid: true key: on_web_add_to_wishlist value: time_attr_on_web_add_to_wishlist - description: '' is_valid: true key: on_web_add_to_wishlist_per_click value: time_attr_on_web_add_to_wishlist_per_click - description: '' is_valid: true key: on_web_order value: time_attr_on_web_order - description: '' is_valid: true key: on_web_order_rate value: time_attr_on_web_order_per_click - description: '' is_valid: true key: on_web_subscribe value: time_attr_on_web_subscribe - description: '' is_valid: true key: on_web_subscribe_per_click value: time_attr_on_web_subscribe_per_click - description: '' is_valid: true key: online_consult value: time_attr_consult_standardized - description: '' is_valid: true key: online_consult_rate value: time_attr_consult_standardized_per_click - description: '' is_valid: true key: onsite_active_by_conversion_time value: nonshop_onsite_active - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_calendar_day0 value: time_attr_total_nonshop_onsite_ad_revenue_value_cald0 - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_calendar_day13 value: time_attr_total_nonshop_onsite_ad_revenue_value_cald13 - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_calendar_day6 value: time_attr_total_nonshop_onsite_ad_revenue_value_cald6 - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_day0 value: time_attr_total_nonshop_onsite_ad_revenue_value_d0 - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_day13 value: time_attr_total_nonshop_onsite_ad_revenue_value_d13 - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_day6 value: time_attr_total_nonshop_onsite_ad_revenue_value_d6 - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_roas_calendar_day0 value: time_attr_nonshop_onsite_ad_revenue_roas_cald0 - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_roas_calendar_day13 value: time_attr_nonshop_onsite_ad_revenue_roas_cald13 - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_roas_calendar_day6 value: time_attr_nonshop_onsite_ad_revenue_roas_cald6 - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_roas_day0 value: time_attr_nonshop_onsite_ad_revenue_roas_d0 - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_roas_day13 value: time_attr_nonshop_onsite_ad_revenue_roas_d13 - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_roas_day6 value: time_attr_nonshop_onsite_ad_revenue_roas_d6 - description: '' is_valid: true key: onsite_ad_impression_rate value: time_attr_nonshop_onsite_ad_revenue_per_click - description: '' is_valid: true key: onsite_add_billing value: time_attr_onsite_add_billing - description: '' is_valid: true key: onsite_add_billing_rate value: time_attr_onsite_add_billing_per_click - description: '' is_valid: true key: onsite_add_to_cart_rate value: time_attr_nonshop_onsite_on_web_cart_per_click - description: '' is_valid: true key: onsite_add_to_wishlist value: time_attr_onsite_add_to_wishlist - description: '' is_valid: true key: onsite_add_to_wishlist_rate value: time_attr_onsite_add_to_wishlist_per_click - description: '' is_valid: true key: onsite_checkout_initiation_rate value: time_attr_nonshop_onsite_initiate_checkout_count_per_click - description: '' is_valid: true key: onsite_cost_per_active value: time_attr_cost_per_nonshop_onsite_active - description: '' is_valid: true key: onsite_cost_per_active_by_conversion_time value: cost_per_nonshop_onsite_active - description: '' is_valid: true key: onsite_cost_per_add_to_cart value: time_attr_cost_per_nonshop_onsite_on_web_cart - description: '' is_valid: true key: onsite_cost_per_checkout_initiation value: time_attr_cost_per_nonshop_onsite_initiate_checkout_count - description: '' is_valid: true key: onsite_cost_per_product_details_page_view value: time_attr_cost_per_nonshop_onsite_on_web_detail - description: '' is_valid: true key: onsite_cost_per_purchase value: time_attr_cost_per_nonshop_onsite_shopping - description: '' is_valid: true key: onsite_cost_per_total_ad_impression value: time_attr_cost_per_nonshop_onsite_ad_revenue - description: '' is_valid: true key: onsite_cost_per_total_launch value: time_attr_cost_per_nonshop_onsite_launch_app - description: '' is_valid: true key: onsite_cost_per_total_registration value: time_attr_cost_per_nonshop_onsite_active_register - description: '' is_valid: true key: onsite_cost_per_unique_ad_impression value: time_attr_cost_per_unique_nonshop_onsite_ad_revenue - description: '' is_valid: true key: onsite_cost_per_unique_launch value: time_attr_cost_per_unique_nonshop_onsite_launch_app - description: '' is_valid: true key: onsite_cost_per_unique_purchase value: time_attr_cost_per_unique_nonshop_onsite_shopping - description: '' is_valid: true key: onsite_cost_per_unique_registration value: time_attr_cost_per_unique_nonshop_onsite_active_register - description: '' is_valid: true key: onsite_destination_visit_rate value: time_attr_onsite_destination_visit_per_click - description: '' is_valid: true key: onsite_destination_visits value: time_attr_onsite_destination_visit - description: '' is_valid: true key: onsite_download_start value: time_attr_onsite_download_start - description: '' is_valid: true key: onsite_download_start_rate value: time_attr_onsite_download_start_per_click - description: '' is_valid: true key: onsite_form value: time_attr_onsite_form - description: '' is_valid: true key: onsite_form_rate value: time_attr_onsite_form_per_click - description: '' is_valid: true key: onsite_initiate_checkout_count value: time_attr_onsite_initiate_checkout_count - description: '' is_valid: true key: onsite_initiate_checkout_count_rate value: time_attr_onsite_initiate_checkout_count_per_click - description: '' is_valid: true key: onsite_launch_rate value: time_attr_nonshop_onsite_launch_app_per_click - description: '' is_valid: true key: onsite_on_web_cart value: time_attr_onsite_on_web_cart - description: '' is_valid: true key: onsite_on_web_cart_rate value: time_attr_onsite_on_web_cart_per_click - description: '' is_valid: true key: onsite_on_web_detail value: time_attr_onsite_on_web_detail - description: '' is_valid: true key: onsite_on_web_detail_rate value: time_attr_onsite_on_web_detail_per_click - description: '' is_valid: true key: onsite_product_details_page_view_rate value: time_attr_nonshop_onsite_on_web_detail_per_click - description: '' is_valid: true key: onsite_purchase_rate value: time_attr_nonshop_onsite_shopping_per_click - description: '' is_valid: true key: onsite_purchase_roas_calendar_day0 value: time_attr_nonshop_onsite_shopping_roas_cald0 - description: '' is_valid: true key: onsite_purchase_roas_calendar_day13 value: time_attr_nonshop_onsite_shopping_roas_cald13 - description: '' is_valid: true key: onsite_purchase_roas_calendar_day6 value: time_attr_nonshop_onsite_shopping_roas_cald6 - description: '' is_valid: true key: onsite_purchase_roas_day0 value: time_attr_nonshop_onsite_shopping_roas_d0 - description: '' is_valid: true key: onsite_purchase_roas_day13 value: time_attr_nonshop_onsite_shopping_roas_d13 - description: '' is_valid: true key: onsite_purchase_roas_day6 value: time_attr_nonshop_onsite_shopping_roas_d6 - description: '' is_valid: true key: onsite_purchase_value_calendar_day0 value: time_attr_total_nonshop_onsite_shopping_value_cald0 - description: '' is_valid: true key: onsite_purchase_value_calendar_day13 value: time_attr_total_nonshop_onsite_shopping_value_cald13 - description: '' is_valid: true key: onsite_purchase_value_calendar_day6 value: time_attr_total_nonshop_onsite_shopping_value_cald6 - description: '' is_valid: true key: onsite_purchase_value_day0 value: time_attr_total_nonshop_onsite_shopping_value_d0 - description: '' is_valid: true key: onsite_purchase_value_day13 value: time_attr_total_nonshop_onsite_shopping_value_d13 - description: '' is_valid: true key: onsite_purchase_value_day6 value: time_attr_total_nonshop_onsite_shopping_value_d6 - description: '' is_valid: true key: onsite_purchases_roas value: time_attr_nonshop_onsite_shopping_roas - description: '' is_valid: true key: onsite_registration_rate value: time_attr_nonshop_onsite_active_register_per_click - description: '' is_valid: true key: onsite_shopping value: time_attr_onsite_shopping - description: '' is_valid: true key: onsite_shopping_rate value: time_attr_onsite_shopping_per_click - description: '' is_valid: true key: onsite_shopping_roas value: time_attr_onsite_shopping_roas - description: '' is_valid: true key: onsite_total_active value: time_attr_nonshop_onsite_active - description: '' is_valid: true key: onsite_total_ad_impression value: time_attr_nonshop_onsite_ad_revenue - description: '' is_valid: true key: onsite_total_ad_impression_value value: time_attr_nonshop_onsite_ad_revenue_value - description: '' is_valid: true key: onsite_total_add_to_cart value: time_attr_nonshop_onsite_on_web_cart - description: '' is_valid: true key: onsite_total_add_to_cart_value value: time_attr_total_nonshop_onsite_on_web_cart_value - description: '' is_valid: true key: onsite_total_checkout_initiation value: time_attr_nonshop_onsite_initiate_checkout_count - description: '' is_valid: true key: onsite_total_checkout_initiation_value value: time_attr_total_nonshop_onsite_initiate_checkout_count_value - description: '' is_valid: true key: onsite_total_filtered_out_form_submission value: ix_filtered_out_leads - description: '' is_valid: true key: onsite_total_launch value: time_attr_nonshop_onsite_launch_app - description: '' is_valid: true key: onsite_total_product_details_page_view value: time_attr_nonshop_onsite_on_web_detail - description: '' is_valid: true key: onsite_total_product_details_page_view_value value: time_attr_total_nonshop_onsite_on_web_detail_value - description: '' is_valid: true key: onsite_total_purchase value: time_attr_nonshop_onsite_shopping - description: '' is_valid: true key: onsite_total_purchase_value value: time_attr_total_nonshop_onsite_shopping_value - description: '' is_valid: true key: onsite_total_registration value: time_attr_nonshop_onsite_active_register - description: '' is_valid: true key: onsite_unique_ad_impression value: time_attr_unique_nonshop_onsite_ad_revenue - description: '' is_valid: true key: onsite_unique_launch value: time_attr_unique_nonshop_onsite_launch_app - description: '' is_valid: true key: onsite_unique_purchase value: time_attr_unique_nonshop_onsite_shopping - description: '' is_valid: true key: onsite_unique_registration value: time_attr_unique_nonshop_onsite_active_register - description: '' is_valid: true key: onsite_value_per_ad_impression_value value: time_attr_value_per_nonshop_onsite_ad_revenue - description: '' is_valid: true key: onsite_value_per_add_to_cart value: time_attr_value_per_nonshop_onsite_on_web_cart - description: '' is_valid: true key: onsite_value_per_checkout_initiation value: time_attr_value_per_nonshop_onsite_initiate_checkout_count - description: '' is_valid: true key: onsite_value_per_product_details_page_view value: time_attr_value_per_nonshop_onsite_on_web_detail - description: '' is_valid: true key: onsite_value_per_purchase value: time_attr_value_per_nonshop_onsite_shopping - description: '' is_valid: false key: operation_status value: aco_opt_status - description: '' is_valid: true key: page_content_view_event_rate value: time_attr_on_web_detail_standardized_per_click - description: '' is_valid: true key: page_content_view_events value: time_attr_on_web_detail_standardized - description: '' is_valid: true key: page_event_search value: time_attr_search_count - description: '' is_valid: true key: page_event_search_rate value: time_attr_search_count_per_click - description: '' is_valid: true key: pageview_rate value: time_attr_page_view_per_click - description: '' is_valid: true key: paid_engaged_view value: engaged_view_billed_vv - description: '' is_valid: true key: paid_engaged_view_15s value: engaged_view_15s_billed_vv - description: '' is_valid: true key: paid_engagement_engaged_view value: engaged_view_billed_engagement - description: '' is_valid: true key: paid_engagement_engaged_view_15s value: engaged_view_15s_billed_engagement - description: '' is_valid: true key: playable_download_button_click_count value: playable_cta_click - description: '' is_valid: true key: playable_first_scene_view_count value: playable_first_scene_view_count - description: '' is_valid: true key: playable_page_view_count value: playable_page_view_count - description: '' is_valid: true key: playable_second_scene_view_count value: playable_second_scene_view_count - description: '' is_valid: true key: playable_third_scene_view_count value: playable_third_scene_view_count - description: '' is_valid: true key: product_clicks value: product_click_cnt - description: '' is_valid: true key: product_cta value: stats_product_ctr - description: '' is_valid: true key: product_impressions value: product_show_cnt - description: '' is_valid: true key: profile_visits value: ad_home_visited - description: '' is_valid: true key: profile_visits_rate value: ad_home_visited_rate - description: '' is_valid: true key: purchase value: time_attr_active_pay - description: '' is_valid: true key: purchase_rate value: time_attr_active_pay_rate - description: '' is_valid: true key: ratings value: time_attr_rate - description: '' is_valid: true key: ratings_rate value: time_attr_rate_per_install - description: '' is_valid: true key: real_time_app_install value: active - description: '' is_valid: true key: real_time_app_install_cost value: active_cost - description: '' is_valid: true key: real_time_conversion value: convert_cnt - description: '' is_valid: true key: real_time_conversion_rate_v2 value: conversion_rate_imp - description: '' is_valid: true key: real_time_cost_per_conversion value: conversion_cost - description: '' is_valid: true key: registration value: time_attr_active_register - description: '' is_valid: true key: registration_rate value: time_attr_active_register_rate - description: '' is_valid: true key: sales_lead value: time_attr_sales_lead - description: '' is_valid: true key: sales_lead_rate value: time_attr_sales_lead_per_install - description: '' is_valid: true key: search value: time_attr_search - description: '' is_valid: true key: search_rate value: time_attr_search_per_install - description: '' is_valid: true key: shares value: ad_share - description: '' is_valid: true key: shop_gross_revenue_by_order_submission value: total_onsite_shopping_value - description: '' is_valid: true key: shop_total_items_purchased value: time_attr_onsite_shopping_quantity - description: '' is_valid: true key: shop_total_purchase_by_order_submission value: onsite_shopping - description: '' is_valid: true key: single_image_ctr value: single_image_ctr - description: '' is_valid: true key: single_image_impression_rate value: single_image_show_rate - description: '' is_valid: true key: single_image_impressions value: single_image_show_count - description: '' is_valid: true key: skan_achieve_level value: skan_update_level - description: '' is_valid: true key: skan_achieve_level_rate value: skan_update_level_per_install - description: '' is_valid: true key: skan_add_payment_info value: skan_add_payment_info - description: '' is_valid: true key: skan_add_payment_info_rate value: skan_add_payment_info_per_install - description: '' is_valid: true key: skan_add_to_cart value: skan_in_app_cart - description: '' is_valid: true key: skan_add_to_cart_rate value: skan_in_app_cart_per_install - description: '' is_valid: true key: skan_add_to_wishlist value: skan_add_to_wishlist - description: '' is_valid: true key: skan_add_to_wishlist_rate value: skan_add_to_wishlist_per_install - description: '' is_valid: true key: skan_app_install value: skan_active - description: '' is_valid: true key: skan_app_install_withheld value: skan_active_withheld - description: '' is_valid: true key: skan_checkout value: skan_in_app_order - description: '' is_valid: true key: skan_checkout_rate value: skan_in_app_order_per_install - description: '' is_valid: true key: skan_complete_tutorial value: skan_complete_tutorial - description: '' is_valid: true key: skan_complete_tutorial_rate value: skan_complete_tutorial_per_install - description: '' is_valid: true key: skan_conversion value: skan_convert_cnt - description: '' is_valid: true key: skan_conversion_rate_v2 value: skan_conversion_rate_imp - description: '' is_valid: true key: skan_cost_per_achieve_level value: cost_per_skan_update_level - description: '' is_valid: true key: skan_cost_per_add_payment_info value: cost_per_skan_add_payment_info - description: '' is_valid: true key: skan_cost_per_add_to_cart value: cost_per_skan_in_app_cart - description: '' is_valid: true key: skan_cost_per_add_to_wishlist value: cost_per_skan_add_to_wishlist - description: '' is_valid: true key: skan_cost_per_app_install value: cost_per_skan_active - description: '' is_valid: true key: skan_cost_per_checkout value: cost_per_skan_in_app_order - description: '' is_valid: true key: skan_cost_per_complete_tutorial value: cost_per_skan_complete_tutorial - description: '' is_valid: true key: skan_cost_per_conversion value: skan_conversion_cost - description: '' is_valid: true key: skan_cost_per_create_gamerole value: cost_per_skan_create_gamerole - description: '' is_valid: true key: skan_cost_per_create_group value: cost_per_skan_create_group - description: '' is_valid: true key: skan_cost_per_cta_app_install value: skan_active_click_cost - description: '' is_valid: true key: skan_cost_per_cta_conversion value: skan_convert_cnt_click_cost - description: '' is_valid: true key: skan_cost_per_cta_purchase value: skan_active_pay_click_cost - description: '' is_valid: true key: skan_cost_per_cta_registration value: skan_active_register_click_cost - description: '' is_valid: true key: skan_cost_per_in_app_ad_click value: cost_per_skan_in_app_ad_click - description: '' is_valid: true key: skan_cost_per_in_app_ad_impr value: cost_per_skan_in_app_ad_impr - description: '' is_valid: true key: skan_cost_per_join_group value: cost_per_skan_join_group - description: '' is_valid: true key: skan_cost_per_launch_app value: cost_per_skan_launch_app - description: '' is_valid: true key: skan_cost_per_loan_apply value: cost_per_skan_loan_apply - description: '' is_valid: true key: skan_cost_per_loan_credit value: cost_per_skan_loan_credit - description: '' is_valid: true key: skan_cost_per_loan_disbursement value: cost_per_skan_loan_completion - description: '' is_valid: true key: skan_cost_per_login value: cost_per_skan_login - description: '' is_valid: true key: skan_cost_per_purchase value: cost_per_skan_active_pay - description: '' is_valid: true key: skan_cost_per_ratings value: cost_per_skan_rate - description: '' is_valid: true key: skan_cost_per_registration value: cost_per_skan_active_register - description: '' is_valid: true key: skan_cost_per_result value: skan_effect_cost - description: '' is_valid: true key: skan_cost_per_sales_lead value: cost_per_skan_sales_lead - description: '' is_valid: true key: skan_cost_per_search value: cost_per_skan_search - description: '' is_valid: true key: skan_cost_per_spend_credits value: cost_per_skan_spend_credits - description: '' is_valid: true key: skan_cost_per_start_trial value: cost_per_skan_start_trial - description: '' is_valid: true key: skan_cost_per_subscribe value: cost_per_skan_subscribe - description: '' is_valid: true key: skan_cost_per_total_achieve_level value: cost_per_skan_repetitive_update_level - description: '' is_valid: true key: skan_cost_per_total_add_to_cart value: cost_per_skan_repetitive_in_app_cart - description: '' is_valid: true key: skan_cost_per_total_add_to_wishlist value: cost_per_skan_repetitive_add_to_wishlist - description: '' is_valid: true key: skan_cost_per_total_checkout value: cost_per_skan_repetitive_in_app_order - description: '' is_valid: true key: skan_cost_per_total_complete_tutorial value: cost_per_skan_repetitive_complete_tutorial - description: '' is_valid: true key: skan_cost_per_total_create_gamerole value: cost_per_skan_repetitive_create_gamerole - description: '' is_valid: true key: skan_cost_per_total_create_group value: cost_per_skan_repetitive_create_group - description: '' is_valid: true key: skan_cost_per_total_in_app_ad_click value: cost_per_skan_repetitive_in_app_ad_click - description: '' is_valid: true key: skan_cost_per_total_in_app_ad_impr value: cost_per_skan_repetitive_in_app_ad_impr - description: '' is_valid: true key: skan_cost_per_total_join_group value: cost_per_skan_repetitive_join_group - description: '' is_valid: true key: skan_cost_per_total_launch_app value: cost_per_skan_repetitive_launch_app - description: '' is_valid: true key: skan_cost_per_total_loan_apply value: cost_per_skan_repetitive_loan_apply - description: '' is_valid: true key: skan_cost_per_total_loan_credit value: cost_per_skan_repetitive_loan_credit - description: '' is_valid: true key: skan_cost_per_total_loan_disbursement value: cost_per_skan_repetitive_loan_completion - description: '' is_valid: true key: skan_cost_per_total_login value: cost_per_skan_repetitive_login - description: '' is_valid: true key: skan_cost_per_total_purchase value: cost_per_skan_repetitive_active_pay - description: '' is_valid: true key: skan_cost_per_total_ratings value: cost_per_skan_repetitive_rate - description: '' is_valid: true key: skan_cost_per_total_registration value: cost_per_skan_repetitive_active_register - description: '' is_valid: true key: skan_cost_per_total_sales_lead value: cost_per_skan_repetitive_sales_lead - description: '' is_valid: true key: skan_cost_per_total_search value: cost_per_skan_repetitive_search - description: '' is_valid: true key: skan_cost_per_total_spend_credits value: cost_per_skan_repetitive_spend_credits - description: '' is_valid: true key: skan_cost_per_total_start_trial value: cost_per_skan_repetitive_start_trial - description: '' is_valid: true key: skan_cost_per_total_subscribe value: cost_per_skan_repetitive_subscribe - description: '' is_valid: true key: skan_cost_per_total_unlock_achievement value: cost_per_skan_repetitive_unlock_achievement - description: '' is_valid: true key: skan_cost_per_total_view_content value: cost_per_skan_repetitive_in_app_detail_uv - description: '' is_valid: true key: skan_cost_per_unlock_achievement value: cost_per_skan_unlock_achievement - description: '' is_valid: true key: skan_cost_per_view_content value: cost_per_skan_in_app_detail_uv - description: '' is_valid: true key: skan_cost_per_vta_app_install value: skan_active_show_cost - description: '' is_valid: true key: skan_cost_per_vta_conversion value: skan_convert_cnt_show_cost - description: '' is_valid: true key: skan_cost_per_vta_purchase value: skan_active_pay_show_cost - description: '' is_valid: true key: skan_cost_per_vta_registration value: skan_active_register_show_cost - description: '' is_valid: true key: skan_cost_total_add_payment_info value: cost_per_skan_repetitive_add_payment_info - description: '' is_valid: true key: skan_create_gamerole value: skan_create_gamerole - description: '' is_valid: true key: skan_create_gamerole_rate value: skan_create_gamerole_per_install - description: '' is_valid: true key: skan_create_group value: skan_create_group - description: '' is_valid: true key: skan_create_group_rate value: skan_create_group_per_install - description: '' is_valid: true key: skan_cta_app_install value: skan_active_click - description: '' is_valid: true key: skan_cta_conversion value: skan_convert_cnt_click - description: '' is_valid: true key: skan_cta_purchase value: skan_active_pay_click - description: '' is_valid: true key: skan_cta_registration value: skan_active_register_click - description: '' is_valid: true key: skan_in_app_ad_click value: skan_in_app_ad_click - description: '' is_valid: true key: skan_in_app_ad_click_rate value: skan_in_app_ad_click_per_install - description: '' is_valid: true key: skan_in_app_ad_impr value: skan_in_app_ad_impr - description: '' is_valid: true key: skan_in_app_ad_impr_rate value: skan_in_app_ad_impr_per_install - description: '' is_valid: true key: skan_join_group value: skan_join_group - description: '' is_valid: true key: skan_join_group_rate value: skan_join_group_per_install - description: '' is_valid: true key: skan_launch_app value: skan_launch_app - description: '' is_valid: true key: skan_launch_app_rate value: skan_launch_app_per_install - description: '' is_valid: true key: skan_loan_apply value: skan_loan_apply - description: '' is_valid: true key: skan_loan_apply_rate value: skan_loan_apply_per_install - description: '' is_valid: true key: skan_loan_credit value: skan_loan_credit - description: '' is_valid: true key: skan_loan_credit_rate value: skan_loan_credit_per_install - description: '' is_valid: true key: skan_loan_disbursement value: skan_loan_completion - description: '' is_valid: true key: skan_loan_disbursement_rate value: skan_loan_completion_per_install - description: '' is_valid: true key: skan_login value: skan_login - description: '' is_valid: true key: skan_login_rate value: skan_login_per_install - description: '' is_valid: true key: skan_purchase value: skan_active_pay - description: '' is_valid: true key: skan_purchase_rate value: skan_active_pay_per_install - description: '' is_valid: true key: skan_ratings value: skan_rate - description: '' is_valid: true key: skan_ratings_rate value: skan_rate_per_install - description: '' is_valid: true key: skan_registration value: skan_active_register - description: '' is_valid: true key: skan_registration_rate value: skan_active_register_per_install - description: '' is_valid: true key: skan_result value: skan_effect_cnt - description: '' is_valid: true key: skan_result_rate value: skan_effect_rate - description: '' is_valid: true key: skan_sales_lead value: skan_sales_lead - description: '' is_valid: true key: skan_sales_lead_rate value: skan_sales_lead_per_install - description: '' is_valid: true key: skan_search value: skan_search - description: '' is_valid: true key: skan_search_rate value: skan_search_per_install - description: '' is_valid: true key: skan_spend_credits value: skan_spend_credits - description: '' is_valid: true key: skan_spend_credits_rate value: skan_spend_credits_per_install - description: '' is_valid: true key: skan_start_trial value: skan_start_trial - description: '' is_valid: true key: skan_start_trial_rate value: skan_start_trial_per_install - description: '' is_valid: true key: skan_subscribe value: skan_subscribe - description: '' is_valid: true key: skan_subscribe_rate value: skan_subscribe_per_install - description: '' is_valid: true key: skan_total_achieve_level value: skan_repetitive_update_level - description: '' is_valid: true key: skan_total_achieve_level_value value: skan_total_repetitive_update_level_value - description: '' is_valid: true key: skan_total_add_payment_info value: skan_repetitive_add_payment_info - description: '' is_valid: true key: skan_total_add_to_cart value: skan_repetitive_in_app_cart - description: '' is_valid: true key: skan_total_add_to_cart_value value: skan_total_repetitive_in_app_cart_value - description: '' is_valid: true key: skan_total_add_to_wishlist value: skan_repetitive_add_to_wishlist - description: '' is_valid: true key: skan_total_add_to_wishlist_value value: skan_total_repetitive_add_to_wishlist_value - description: '' is_valid: true key: skan_total_checkout value: skan_repetitive_in_app_order - description: '' is_valid: true key: skan_total_checkout_value value: skan_total_repetitive_in_app_order_value - description: '' is_valid: true key: skan_total_complete_tutorial value: skan_repetitive_complete_tutorial - description: '' is_valid: true key: skan_total_complete_tutorial_value value: skan_total_repetitive_complete_tutorial_value - description: '' is_valid: true key: skan_total_create_gamerole value: skan_repetitive_create_gamerole - description: '' is_valid: true key: skan_total_create_gamerole_value value: skan_total_repetitive_create_gamerole_value - description: '' is_valid: true key: skan_total_create_group value: skan_repetitive_create_group - description: '' is_valid: true key: skan_total_create_group_value value: skan_total_repetitive_create_group_value - description: '' is_valid: true key: skan_total_in_app_ad_click value: skan_repetitive_in_app_ad_click - description: '' is_valid: true key: skan_total_in_app_ad_click_value value: skan_total_repetitive_in_app_ad_click_value - description: '' is_valid: true key: skan_total_in_app_ad_impr value: skan_repetitive_in_app_ad_impr - description: '' is_valid: true key: skan_total_in_app_ad_impr_value value: skan_total_repetitive_in_app_ad_impr_value - description: '' is_valid: true key: skan_total_join_group value: skan_repetitive_join_group - description: '' is_valid: true key: skan_total_join_group_value value: skan_total_repetitive_join_group_value - description: '' is_valid: true key: skan_total_launch_app value: skan_repetitive_launch_app - description: '' is_valid: true key: skan_total_loan_apply value: skan_repetitive_loan_apply - description: '' is_valid: true key: skan_total_loan_credit value: skan_repetitive_loan_credit - description: '' is_valid: true key: skan_total_loan_disbursement value: skan_repetitive_loan_completion - description: '' is_valid: true key: skan_total_login value: skan_repetitive_login - description: '' is_valid: true key: skan_total_purchase value: skan_repetitive_active_pay - description: '' is_valid: true key: skan_total_purchase_value value: skan_total_repetitive_active_pay_value - description: '' is_valid: true key: skan_total_ratings value: skan_repetitive_rate - description: '' is_valid: true key: skan_total_ratings_value value: skan_total_repetitive_rate_value - description: '' is_valid: true key: skan_total_registration value: skan_repetitive_active_register - description: '' is_valid: true key: skan_total_repetitive_active_pay_roas value: skan_total_repetitive_active_pay_roas - description: '' is_valid: true key: skan_total_sales_lead value: skan_repetitive_sales_lead - description: '' is_valid: true key: skan_total_sales_lead_value value: skan_total_repetitive_sales_lead_value - description: '' is_valid: true key: skan_total_search value: skan_repetitive_search - description: '' is_valid: true key: skan_total_spend_credits value: skan_repetitive_spend_credits - description: '' is_valid: true key: skan_total_spend_credits_value value: skan_total_repetitive_spend_credits_value - description: '' is_valid: true key: skan_total_start_trial value: skan_repetitive_start_trial - description: '' is_valid: true key: skan_total_subscribe value: skan_repetitive_subscribe - description: '' is_valid: true key: skan_total_subscribe_value value: skan_total_repetitive_subscribe_value - description: '' is_valid: true key: skan_total_unlock_achievement value: skan_repetitive_unlock_achievement - description: '' is_valid: true key: skan_total_unlock_achievement_value value: skan_total_repetitive_unlock_achievement_value - description: '' is_valid: true key: skan_total_view_content value: skan_repetitive_in_app_detail_uv - description: '' is_valid: true key: skan_total_view_content_value value: skan_total_repetitive_in_app_detail_uv_value - description: '' is_valid: true key: skan_unlock_achievement value: skan_unlock_achievement - description: '' is_valid: true key: skan_unlock_achievement_rate value: skan_unlock_achievement_per_install - description: '' is_valid: true key: skan_view_content value: skan_in_app_detail_uv - description: '' is_valid: true key: skan_view_content_rate value: skan_in_app_detail_uv_per_install - description: '' is_valid: true key: skan_vta_app_install value: skan_active_show - description: '' is_valid: true key: skan_vta_conversion value: skan_convert_cnt_show - description: '' is_valid: true key: skan_vta_purchase value: skan_active_pay_show - description: '' is_valid: true key: skan_vta_registration value: skan_active_register_show - description: '' is_valid: true key: sound_usage_clicks value: sound_usage_button_click_cnt - description: '' is_valid: true key: spend value: stat_cost - description: '' is_valid: true key: spend_credits value: time_attr_spend_credits - description: '' is_valid: true key: spend_credits_rate value: time_attr_spend_credits_per_install - description: '' is_valid: true key: start_trial value: time_attr_start_trial - description: '' is_valid: true key: start_trial_rate value: time_attr_start_trial_per_install - description: '' is_valid: true key: stitch_clicks value: stitch_click_cnt - description: '' is_valid: true key: subscribe value: time_attr_subscribe - description: '' is_valid: true key: subscribe_rate value: time_attr_subscribe_per_install - description: '' is_valid: true key: total_achieve_level value: time_attr_repetitive_update_level - description: '' is_valid: true key: total_achieve_level_value value: time_attr_total_repetitive_update_level_value - description: '' is_valid: true key: total_active_pay_roas value: time_attr_repetitive_active_pay_roas - description: '' is_valid: true key: total_ad_impression_events_value value: time_attr_total_repetitive_ad_revenue_value - description: '' is_valid: true key: total_ad_impression_roas value: time_attr_total_repetitive_ad_revenue_roas - description: '' is_valid: true key: total_add_billing_value value: time_attr_total_add_billing_value - description: '' is_valid: true key: total_add_payment_info value: time_attr_repetitive_add_payment_info - description: '' is_valid: true key: total_add_to_wishlist value: time_attr_repetitive_add_to_wishlist - description: '' is_valid: true key: total_add_to_wishlist_value value: time_attr_total_repetitive_add_to_wishlist_value - description: '' is_valid: true key: total_app_event_add_to_cart value: time_attr_repetitive_in_app_cart - description: '' is_valid: true key: total_app_event_add_to_cart_value value: time_attr_total_repetitive_in_app_cart_value - description: '' is_valid: true key: total_button_click_value value: time_attr_total_button_value - description: '' is_valid: true key: total_checkout value: time_attr_repetitive_in_app_order - description: '' is_valid: true key: total_checkout_value value: time_attr_total_repetitive_in_app_order_value - description: '' is_valid: true key: total_complete_payment_rate value: time_attr_total_shopping_value - description: '' is_valid: true key: total_complete_tutorial value: time_attr_repetitive_complete_tutorial - description: '' is_valid: true key: total_complete_tutorial_value value: time_attr_total_repetitive_complete_tutorial_value - description: '' is_valid: true key: total_create_gamerole value: time_attr_repetitive_create_gamerole - description: '' is_valid: true key: total_create_gamerole_value value: time_attr_total_repetitive_create_gamerole_value - description: '' is_valid: true key: total_create_group value: time_attr_repetitive_create_group - description: '' is_valid: true key: total_create_group_value value: time_attr_total_repetitive_create_group_value - description: '' is_valid: true key: total_day7_retention value: time_attr_repetitive_retention_7d - description: '' is_valid: true key: total_day7_retention_value value: time_attr_total_repetitive_retention_7d_value - description: '' is_valid: true key: total_download_start_value value: time_attr_total_download_start_value - description: '' is_valid: true key: total_form_value value: time_attr_total_form_value - description: '' is_valid: true key: total_in_app_ad_click value: time_attr_repetitive_in_app_ad_click - description: '' is_valid: true key: total_in_app_ad_click_value value: time_attr_total_repetitive_in_app_ad_click_value - description: '' is_valid: true key: total_in_app_ad_impr value: time_attr_repetitive_in_app_ad_impr - description: '' is_valid: true key: total_in_app_ad_impr_value value: time_attr_total_repetitive_in_app_ad_impr_value - description: '' is_valid: true key: total_initiate_checkout_value value: time_attr_total_initiate_checkout_value - description: '' is_valid: true key: total_join_group value: time_attr_repetitive_join_group - description: '' is_valid: true key: total_join_group_value value: time_attr_total_repetitive_join_group_value - description: '' is_valid: true key: total_landing_page_view value: time_attr_web_landing_page_view - description: '' is_valid: true key: total_launch_app value: time_attr_repetitive_launch_app - description: '' is_valid: true key: total_loan_apply value: time_attr_repetitive_loan_apply - description: '' is_valid: true key: total_loan_credit value: time_attr_repetitive_loan_credit - description: '' is_valid: true key: total_loan_disbursement value: time_attr_repetitive_loan_completion - description: '' is_valid: true key: total_login value: time_attr_repetitive_login - description: '' is_valid: true key: total_next_day_open value: time_attr_repetitive_next_day_open - description: '' is_valid: true key: total_on_web_add_to_wishlist_value value: time_attr_total_on_web_add_to_wishlist_value - description: '' is_valid: true key: total_on_web_order_value value: time_attr_total_on_web_order_value - description: '' is_valid: true key: total_on_web_subscribe_value value: time_attr_total_on_web_subscribe_value - description: '' is_valid: true key: total_online_consult_value value: time_attr_total_consult_standardized_value - description: '' is_valid: true key: total_onsite_add_billing_value value: time_attr_total_onsite_add_billing_value - description: '' is_valid: true key: total_onsite_add_to_wishlist_value value: time_attr_total_onsite_add_to_wishlist_value - description: '' is_valid: true key: total_onsite_form_value value: time_attr_total_onsite_form_value - description: '' is_valid: true key: total_onsite_initiate_checkout_count_value value: time_attr_total_onsite_initiate_checkout_count_value - description: '' is_valid: true key: total_onsite_on_web_cart_value value: time_attr_total_onsite_on_web_cart_value - description: '' is_valid: true key: total_onsite_on_web_detail_value value: time_attr_total_onsite_on_web_detail_value - description: '' is_valid: true key: total_onsite_shopping_value value: time_attr_total_onsite_shopping_value - description: '' is_valid: true key: total_page_event_search_value value: time_attr_total_search_value - description: '' is_valid: true key: total_page_view_content_events_value value: time_attr_total_on_web_detail_standardized_value - description: '' is_valid: true key: total_pageview value: time_attr_page_view - description: '' is_valid: true key: total_purchase value: time_attr_repetitive_active_pay - description: '' is_valid: true key: total_purchase_roas_day0 value: time_attr_active_pay_roas_d0 - description: '' is_valid: true key: total_purchase_roas_day2 value: time_attr_active_pay_roas_d2 - description: '' is_valid: true key: total_purchase_roas_day6 value: time_attr_active_pay_roas_d6 - description: '' is_valid: true key: total_purchase_value value: time_attr_total_repetitive_active_pay_value - description: '' is_valid: true key: total_purchase_value_day0 value: time_attr_total_repetitive_active_pay_value_d0 - description: '' is_valid: true key: total_purchase_value_day2 value: time_attr_total_repetitive_active_pay_value_d2 - description: '' is_valid: true key: total_purchase_value_day6 value: time_attr_total_repetitive_active_pay_value_d6 - description: '' is_valid: true key: total_ratings value: time_attr_repetitive_rate - description: '' is_valid: true key: total_ratings_value value: time_attr_total_repetitive_rate_value - description: '' is_valid: true key: total_registration value: time_attr_repetitive_active_register - description: '' is_valid: true key: total_sales_lead value: time_attr_repetitive_sales_lead - description: '' is_valid: true key: total_sales_lead_value value: time_attr_total_repetitive_sales_lead_value - description: '' is_valid: true key: total_search value: time_attr_repetitive_search - description: '' is_valid: true key: total_spend_credits value: time_attr_repetitive_spend_credits - description: '' is_valid: true key: total_spend_credits_value value: time_attr_total_repetitive_spend_credits_value - description: '' is_valid: true key: total_start_trial value: time_attr_repetitive_start_trial - description: '' is_valid: true key: total_subscribe value: time_attr_repetitive_subscribe - description: '' is_valid: true key: total_subscribe_value value: time_attr_total_repetitive_subscribe_value - description: '' is_valid: true key: total_unlock_achievement value: time_attr_repetitive_unlock_achievement - description: '' is_valid: true key: total_unlock_achievement_value value: time_attr_total_repetitive_unlock_achievement_value - description: '' is_valid: true key: total_user_registration_value value: time_attr_total_on_web_register_value - description: '' is_valid: true key: total_value_per_pageview value: time_attr_value_per_page_view - description: '' is_valid: true key: total_view_content value: time_attr_repetitive_in_app_detail_uv - description: '' is_valid: true key: total_view_content_value value: time_attr_total_repetitive_in_app_detail_uv_value - description: '' is_valid: true key: total_web_event_add_to_cart_value value: time_attr_total_on_web_cart_value - description: '' is_valid: true key: tt_playlist_visit value: tt_playlist_visit - description: '' is_valid: true key: tt_playlist_visit_rate value: tt_playlist_visit_rate - description: '' is_valid: true key: unique_ad_impression_events value: time_attr_ad_revenue - description: '' is_valid: true key: unique_custom_app_events value: time_attr_app_customized_events - description: '' is_valid: true key: unlock_achievement value: time_attr_unlock_achievement - description: '' is_valid: true key: unlock_achievement_rate value: time_attr_unlock_achievement_per_install - description: '' is_valid: true key: user_registration value: time_attr_on_web_register - description: '' is_valid: true key: user_registration_rate value: time_attr_on_web_register_per_click - description: '' is_valid: true key: value_per_ad_impression_event value: time_attr_value_per_repetitive_ad_revenue - description: '' is_valid: true key: value_per_add_billing value: time_attr_value_per_add_billing_count - description: '' is_valid: true key: value_per_button_click value: time_attr_value_per_button - description: '' is_valid: true key: value_per_checkout value: time_attr_value_per_repetitive_in_app_order - description: '' is_valid: true key: value_per_complete_payment value: time_attr_value_per_shopping - description: '' is_valid: true key: value_per_custom_app_event value: time_attr_value_per_repetitive_app_customized_events - description: '' is_valid: true key: value_per_custom_page_event value: time_attr_value_per_web_customized_events - description: '' is_valid: true key: value_per_download_start value: time_attr_value_per_download_start - description: '' is_valid: true key: value_per_form value: time_attr_value_per_form - description: '' is_valid: true key: value_per_initiate_checkout value: time_attr_value_per_initiate_checkout_count - description: '' is_valid: true key: value_per_offline_add_payment_info_event value: time_attr_value_per_offline_add_billing - description: '' is_valid: true key: value_per_offline_add_to_cart_event value: time_attr_value_per_offline_add_to_cart - description: '' is_valid: true key: value_per_offline_add_to_wishlist_event value: time_attr_value_per_offline_add_to_wishlist - description: '' is_valid: true key: value_per_offline_click_button_event value: time_attr_value_per_offline_button - description: '' is_valid: true key: value_per_offline_complete_registration_event value: time_attr_value_per_offline_register - description: '' is_valid: true key: value_per_offline_contact_event value: time_attr_value_per_offline_contact - description: '' is_valid: true key: value_per_offline_download_event value: time_attr_value_per_offline_download_start - description: '' is_valid: true key: value_per_offline_form_event value: time_attr_value_per_offline_submit_form - description: '' is_valid: true key: value_per_offline_initiate_checkout_event value: time_attr_value_per_offline_initiate_checkout - description: '' is_valid: true key: value_per_offline_place_order_event value: time_attr_value_per_offline_order - description: '' is_valid: true key: value_per_offline_search_event value: time_attr_value_per_offline_search - description: '' is_valid: true key: value_per_offline_shopping_event value: time_attr_value_per_offline_shopping - description: '' is_valid: true key: value_per_offline_subscribe_event value: time_attr_value_per_offline_subscribe - description: '' is_valid: true key: value_per_offline_view_content_event value: time_attr_value_per_offline_detail - description: '' is_valid: true key: value_per_on_web_add_to_wishlist value: time_attr_value_per_on_web_add_to_wishlist - description: '' is_valid: true key: value_per_on_web_order value: time_attr_value_per_on_web_order - description: '' is_valid: true key: value_per_on_web_subscribe value: time_attr_value_per_on_web_subscribe - description: '' is_valid: true key: value_per_online_consult value: time_attr_value_per_consult_standardized - description: '' is_valid: true key: value_per_onsite_add_billing value: time_attr_value_per_onsite_add_billing - description: '' is_valid: true key: value_per_onsite_add_to_wishlist value: time_attr_value_per_onsite_add_to_wishlist - description: '' is_valid: true key: value_per_onsite_form value: time_attr_value_per_onsite_form - description: '' is_valid: true key: value_per_onsite_initiate_checkout_count value: time_attr_value_per_onsite_initiate_checkout_count - description: '' is_valid: true key: value_per_onsite_on_web_cart value: time_attr_value_per_onsite_on_web_cart - description: '' is_valid: true key: value_per_onsite_on_web_detail value: time_attr_value_per_onsite_on_web_detail - description: '' is_valid: true key: value_per_onsite_shopping value: time_attr_value_per_onsite_shopping - description: '' is_valid: true key: value_per_page_content_view_event value: time_attr_value_per_on_web_detail_standardized - description: '' is_valid: true key: value_per_page_event_search value: time_attr_value_per_search_count - description: '' is_valid: true key: value_per_total_achieve_level value: time_attr_value_per_repetitive_update_level - description: '' is_valid: true key: value_per_total_add_to_wishlist value: time_attr_value_per_repetitive_add_to_wishlist - description: '' is_valid: true key: value_per_total_app_event_add_to_cart value: time_attr_value_per_repetitive_in_app_cart - description: '' is_valid: true key: value_per_total_complete_tutorial value: time_attr_value_per_repetitive_complete_tutorial - description: '' is_valid: true key: value_per_total_create_gamerole value: time_attr_value_per_repetitive_create_gamerole - description: '' is_valid: true key: value_per_total_create_group value: time_attr_value_per_repetitive_create_group - description: '' is_valid: true key: value_per_total_day7_retention value: time_attr_value_per_repetitive_retention_7d - description: '' is_valid: true key: value_per_total_in_app_ad_click value: time_attr_value_per_repetitive_in_app_ad_click - description: '' is_valid: true key: value_per_total_in_app_ad_impr value: time_attr_value_per_repetitive_in_app_ad_impr - description: '' is_valid: true key: value_per_total_join_group value: time_attr_value_per_repetitive_join_group - description: '' is_valid: true key: value_per_total_purchase value: time_attr_value_per_repetitive_active_pay - description: '' is_valid: true key: value_per_total_ratings value: time_attr_value_per_repetitive_rate - description: '' is_valid: true key: value_per_total_sales_lead value: time_attr_value_per_repetitive_sales_lead - description: '' is_valid: true key: value_per_total_spend_credits value: time_attr_value_per_repetitive_spend_credits - description: '' is_valid: true key: value_per_total_subscribe value: time_attr_value_per_repetitive_subscribe - description: '' is_valid: true key: value_per_total_unlock_achievement value: time_attr_value_per_repetitive_unlock_achievement - description: '' is_valid: true key: value_per_total_view_content value: time_attr_value_per_repetitive_in_app_detail_uv - description: '' is_valid: true key: value_per_user_registration value: time_attr_value_per_on_web_register - description: '' is_valid: true key: value_per_web_event_add_to_cart value: time_attr_value_per_on_web_cart - description: '' is_valid: true key: video_play_actions value: total_play - description: '' is_valid: true key: video_views_p100 value: play_over - description: '' is_valid: true key: video_views_p25 value: play_first_quartile - description: '' is_valid: true key: video_views_p50 value: play_midpoint - description: '' is_valid: true key: video_views_p75 value: play_third_quartile - description: '' is_valid: true key: video_watched_2s value: play_duration_2s - description: '' is_valid: true key: video_watched_6s value: play_duration_6s - description: '' is_valid: true key: view_content value: time_attr_in_app_detail_uv - description: '' is_valid: true key: view_content_rate value: time_attr_in_app_detail_uv_per_install - description: '' is_valid: true key: vta_app_install value: time_attr_active_show - description: '' is_valid: true key: vta_complete_payment value: time_attr_shopping_show - description: '' is_valid: true key: vta_complete_payment_roas value: time_attr_shopping_roas_show - description: '' is_valid: true key: vta_complete_payment_value value: time_attr_total_shopping_value_show - description: '' is_valid: true key: vta_conversion value: time_attr_convert_cnt_show - description: '' is_valid: true key: vta_purchase value: time_attr_active_pay_show - description: '' is_valid: true key: vta_registration value: time_attr_active_register_show - description: '' is_valid: true key: web_event_add_to_cart value: time_attr_on_web_cart - description: '' is_valid: true key: web_event_add_to_cart_rate value: time_attr_on_web_cart_per_click - description: '' is_valid: true key: website_application_approval value: time_attr_web_application_approval - description: '' is_valid: true key: website_application_approval_rate value: time_attr_web_application_approval_per_click - description: '' is_valid: true key: website_cost_per_application_approval value: time_attr_cost_per_web_application_approval - description: '' is_valid: true key: website_cost_per_cta_purchase value: time_attr_cost_per_shopping_click - description: '' is_valid: true key: website_cost_per_customize_product value: time_attr_cost_per_customizeproduct_web - description: '' is_valid: true key: website_cost_per_engaged_session value: time_attr_cost_per_engagement_session - description: '' is_valid: true key: website_cost_per_find_location value: time_attr_cost_per_findlocation_web - description: '' is_valid: true key: website_cost_per_schedule value: time_attr_cost_per_schedule_web - description: '' is_valid: true key: website_cost_per_start_trial value: time_attr_cost_per_web_start_trial - description: '' is_valid: true key: website_cost_per_submit_application value: time_attr_web_submit_application - description: '' is_valid: true key: website_cta_purchase value: time_attr_shopping_click - description: '' is_valid: true key: website_cta_purchase_roas value: time_attr_shopping_roas_click - description: '' is_valid: true key: website_cta_purchase_value value: time_attr_total_shopping_value_click - description: '' is_valid: true key: website_customize_product_rate value: time_attr_customizeproduct_per_click_web - description: '' is_valid: true key: website_engaged_session_rate value: time_attr_engagement_session_per_click - description: '' is_valid: true key: website_find_location_rate value: time_attr_findlocation_per_click_web - description: '' is_valid: true key: website_schedule_rate value: time_attr_schedule_per_click_web - description: '' is_valid: true key: website_start_trial_rate value: time_attr_web_start_trial_per_click - description: '' is_valid: true key: website_submit_application_rate value: time_attr_web_submit_application_per_click - description: '' is_valid: true key: website_total_application_approval_value value: time_attr_total_web_application_approval_value - description: '' is_valid: true key: website_total_customize_product value: time_attr_customizeproduct_web - description: '' is_valid: true key: website_total_customize_product_value value: time_attr_total_customizeproduct_value_web - description: '' is_valid: true key: website_total_engaged_session value: time_attr_engagement_session - description: '' is_valid: true key: website_total_find_location value: time_attr_findlocation_web - description: '' is_valid: true key: website_total_find_location_value value: time_attr_total_findlocation_value_web - description: '' is_valid: true key: website_total_schedule value: time_attr_schedule_web - description: '' is_valid: true key: website_total_schedule_value value: time_attr_total_schedule_value_web - description: '' is_valid: true key: website_total_start_trial value: time_attr_web_start_trial - description: '' is_valid: true key: website_total_start_trial_value value: time_attr_total_web_start_trial_value - description: '' is_valid: true key: website_total_submit_application value: time_attr_web_submit_application - description: '' is_valid: true key: website_total_submit_application_value value: time_attr_total_web_submit_application_value - description: '' is_valid: true key: website_value_per_application_approval value: time_attr_value_per_web_application_approval - description: '' is_valid: true key: website_value_per_customize_product value: time_attr_value_per_customizeproduct_web - description: '' is_valid: true key: website_value_per_find_location value: time_attr_value_per_findlocation_web - description: '' is_valid: true key: website_value_per_schedule value: time_attr_value_per_schedule_web - description: '' is_valid: true key: website_value_per_start_trial value: time_attr_value_per_web_start_trial - description: '' is_valid: true key: website_value_per_submit_application value: time_attr_value_per_web_submit_application key_format: string strict: true use_part: true validate_only: false value_format: string x-open-source: $.http.query.sort_field x-open-field-id: 7 - description: '' in: query name: sort_type required: false schema: default: DESC nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1807850809935874 enum_package_name: ReportOrderType enums: - description: '' is_valid: true key: ASC value: '0' - description: '' is_valid: true key: DESC value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.sort_type x-open-field-id: 8 - description: '' in: query name: page required: false schema: default: 1 format: int64 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page x-open-field-id: 9 - description: '' in: query name: page_size required: false schema: default: 10 format: int64 maximum: 100 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page_size x-open-field-id: 10 - 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get breakdown of material reports [Smart Plus Material Report Breakdown] tags: - Reporting x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - children: - type: string is_expand: true name: dimensions required: true source: $.http.query.dimensions sub_type: string type: array - children: - type: string is_expand: true name: metrics required: false source: $.http.query.metrics sub_type: string type: array - name: start_date required: false source: $.http.query.start_date type: string - name: end_date required: false source: $.http.query.end_date type: string - name: sort_field required: false source: $.http.query.sort_field type: string - name: sort_type required: false source: $.http.query.sort_type type: number - name: page required: false source: $.http.query.page type: number - name: page_size required: false source: $.http.query.page_size type: number - children: - children: - type: number is_expand: true name: campaign_ids required: false sub_type: number type: array - children: - type: number is_expand: true name: adgroup_ids required: false sub_type: number type: array - children: - type: number is_expand: true name: smart_plus_ad_ids required: false sub_type: number type: array - children: - type: string is_expand: true name: main_material_types required: false sub_type: string type: array - children: - type: string is_expand: true name: main_material_ids required: false sub_type: string type: array - children: - type: string is_expand: true name: ad_text_entity_ids required: false sub_type: string type: array - children: - type: string is_expand: true name: call_to_action_entity_ids required: false sub_type: string type: array - children: - type: string is_expand: true name: interactive_add_on_entity_ids required: false sub_type: string type: array is_expand: true name: filtering required: false source: $.http.query.filtering type: object plugins: after_response: - Plugin_post_process_stats_6371633: - description: return [] stats if empty - request_params: - $.rpc.output.stats - result_params: - $.newStats - version: b20c912d3d09b8469c1cd0c29aa6a7c1 before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id dimensions: $.http.query.dimensions end_date: $.http.query.end_date filtering: $.http.query.filtering metrics: $.http.query.metrics page: $.http.query.page page_size: $.http.query.page_size sort_field: $.http.query.sort_field sort_type: $.http.query.sort_type start_date: $.http.query.start_date response_cookie: [] response_header: [] response_rule: list: $.newStats page_info: $.rpc.output.page_info x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /smart_plus/material_report/overview/: get: operationId: Smart_plus Material_report Overview parameters: - description: '' in: query name: advertiser_id required: true schema: nullable: false 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: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1836027313923138 enum_package_name: SppReportDimension enums: - description: '' is_valid: true key: ad_text_entity_id value: text_entity_id - description: '' is_valid: true key: adgroup_id value: ad_id - description: '' is_valid: true key: advertiser_id value: advertiser_id - description: '' is_valid: true key: call_to_action_entity_id value: call_to_action_entity_id - description: '' is_valid: true key: campaign_id value: campaign_id - description: '' is_valid: true key: interactive_add_on_entity_id value: add_on_entity_id - description: '' is_valid: true key: main_material_id value: main_entity_id - description: '' is_valid: true key: smart_plus_ad_id value: creative_id - description: '' is_valid: false key: stat_time_day value: stat_time_day - description: '' is_valid: false key: stat_time_hour value: stat_time_hour - description: '' is_valid: false key: stat_time_month value: stat_time_month - description: '' is_valid: false key: stat_time_week value: stat_time_week key_format: string strict: true use_part: true validate_only: false value_format: string maxItems: 2 minItems: 2 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.dimensions description: '' in: query name: dimensions required: true x-open-field-id: 2 - content: application/json: schema: items: minLength: 1 nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1837121920475138 enum_package_name: SppReportMetrics enums: - description: '' is_valid: true key: achieve_level value: time_attr_update_level - description: '' is_valid: true key: achieve_level_rate value: time_attr_update_level_per_install - description: '' is_valid: true key: ad_impression_ad_revenue_day0 value: time_attr_total_repetitive_active_pay_value_d0_iaa - description: '' is_valid: true key: ad_impression_ad_revenue_day2 value: time_attr_total_repetitive_active_pay_value_d2_iaa - description: '' is_valid: true key: ad_impression_ad_revenue_roas_day0 value: time_attr_active_pay_roas_d0_iaa - description: '' is_valid: true key: ad_impression_ad_revenue_roas_day2 value: time_attr_active_pay_roas_d2_iaa - description: '' is_valid: true key: ad_impression_ad_revenue_roas_day6 value: time_attr_active_pay_roas_d6_iaa - description: '' is_valid: true key: ad_material_id value: ad_material_draft_id - description: '' is_valid: true key: add_billing value: time_attr_add_billing_count - description: '' is_valid: true key: add_billing_rate value: time_attr_add_billing_count_per_click - description: '' is_valid: true key: add_payment_info value: time_attr_add_payment_info - description: '' is_valid: true key: add_payment_info_rate value: time_attr_add_payment_info_per_install - description: '' is_valid: true key: add_to_wishlist value: time_attr_add_to_wishlist - description: '' is_valid: true key: add_to_wishlist_rate value: time_attr_add_to_wishlist_per_install - description: '' is_valid: true key: ads_impression_events value: time_attr_repetitive_ad_revenue - description: '' is_valid: true key: anchor_click_rate value: anchor_click_rate - description: '' is_valid: true key: anchor_clicks value: anchor_click_count - description: '' is_valid: true key: app_event_add_to_cart value: time_attr_in_app_cart - description: '' is_valid: true key: app_event_add_to_cart_rate value: time_attr_in_app_cart_per_install - description: '' is_valid: true key: app_install value: time_attr_active - description: '' is_valid: true key: average_video_play value: average_video_play - description: '' is_valid: true key: avg_value_per_pageview value: time_attr_total_page_view_value - description: '' is_valid: true key: button_click value: time_attr_button_standardized - description: '' is_valid: true key: button_click_rate value: time_attr_button_standardized_per_click - description: '' is_valid: true key: checkout value: time_attr_in_app_order - description: '' is_valid: true key: checkout_rate value: time_attr_in_app_order_per_install - description: '' is_valid: true key: clicks value: click_cnt - description: '' is_valid: true key: clicks_on_hashtag_challenge value: ies_challenge_click - description: '' is_valid: true key: clicks_on_music_disc value: ies_music_click - description: '' is_valid: true key: comments value: ad_comment - description: '' is_valid: true key: complete_payment value: time_attr_shopping - description: '' is_valid: true key: complete_payment_rate value: time_attr_shopping_per_click - description: '' is_valid: true key: complete_payment_roas value: time_attr_shopping_roas - description: '' is_valid: true key: complete_tutorial value: time_attr_complete_tutorial - description: '' is_valid: true key: complete_tutorial_rate value: time_attr_complete_tutorial_per_install - description: '' is_valid: true key: conversion value: time_attr_convert_cnt - description: '' is_valid: true key: conversion_rate_v2 value: time_attr_conversion_rate_imp - description: '' is_valid: true key: cost_per_achieve_level value: time_attr_cost_per_update_level - description: '' is_valid: true key: cost_per_add_billing value: time_attr_cost_per_add_billing_count - description: '' is_valid: true key: cost_per_add_payment_info value: time_attr_cost_per_add_payment_info - description: '' is_valid: true key: cost_per_add_to_wishlist value: time_attr_cost_per_add_to_wishlist - description: '' is_valid: true key: cost_per_app_event_add_to_cart value: time_attr_cost_per_in_app_cart - description: '' is_valid: true key: cost_per_app_install value: time_attr_active_cost - description: '' is_valid: true key: cost_per_button_click value: time_attr_cost_per_button_standardized - description: '' is_valid: true key: cost_per_checkout value: time_attr_cost_per_in_app_order - description: '' is_valid: true key: cost_per_complete_payment value: time_attr_cost_per_shopping - description: '' is_valid: true key: cost_per_complete_tutorial value: time_attr_cost_per_complete_tutorial - description: '' is_valid: true key: cost_per_conversion value: time_attr_conversion_cost - description: '' is_valid: true key: cost_per_create_gamerole value: time_attr_cost_per_create_gamerole - description: '' is_valid: true key: cost_per_create_group value: time_attr_cost_per_create_group - description: '' is_valid: true key: cost_per_cta_app_install value: time_attr_active_click_cost - description: '' is_valid: true key: cost_per_cta_conversion value: time_attr_convert_cnt_click_cost - description: '' is_valid: true key: cost_per_cta_purchase value: time_attr_active_pay_click_cost - description: '' is_valid: true key: cost_per_cta_registration value: time_attr_active_register_click_cost - description: '' is_valid: true key: cost_per_custom_app_event value: time_attr_cost_per_repetitive_app_customized_events - description: '' is_valid: true key: cost_per_custom_page_event value: time_attr_cost_per_web_customized_events - description: '' is_valid: true key: cost_per_day7_retention value: time_attr_cost_per_retention_7d - description: '' is_valid: true key: cost_per_download_start value: time_attr_cost_per_download_start - description: '' is_valid: true key: cost_per_engaged_view_through_conversion value: time_attr_convert_cnt_ev_cost - description: '' is_valid: true key: cost_per_evta_app_install value: time_attr_active_ev_cost - description: '' is_valid: true key: cost_per_evta_payments_completed value: time_attr_shopping_ev_cost - description: '' is_valid: true key: cost_per_evta_purchase value: time_attr_active_pay_ev_cost - description: '' is_valid: true key: cost_per_evta_registration value: time_attr_active_register_ev_cost - description: '' is_valid: true key: cost_per_form value: time_attr_cost_per_form - description: '' is_valid: true key: cost_per_in_app_ad_click value: time_attr_cost_per_in_app_ad_click - description: '' is_valid: true key: cost_per_in_app_ad_impr value: time_attr_cost_per_in_app_ad_impr - description: '' is_valid: true key: cost_per_initiate_checkout value: time_attr_cost_per_initiate_checkout_count - description: '' is_valid: true key: cost_per_ix_button_click_count value: cost_per_ix_button_click_count - description: '' is_valid: true key: cost_per_ix_page_view_count value: cost_per_ix_page_view_count - description: '' is_valid: true key: cost_per_ix_product_click_count value: cost_per_ix_product_click_count - description: '' is_valid: true key: cost_per_join_group value: time_attr_cost_per_join_group - description: '' is_valid: true key: cost_per_landing_page_view value: time_attr_cost_per_web_landing_page_view - description: '' is_valid: true key: cost_per_launch_app value: time_attr_cost_per_launch_app - description: '' is_valid: true key: cost_per_loan_apply value: time_attr_cost_per_loan_apply - description: '' is_valid: true key: cost_per_loan_credit value: time_attr_cost_per_loan_credit - description: '' is_valid: true key: cost_per_loan_disbursement value: time_attr_cost_per_loan_completion - description: '' is_valid: true key: cost_per_login value: time_attr_cost_per_login - description: '' is_valid: true key: cost_per_next_day_open value: time_attr_cost_per_next_day_open - description: '' is_valid: true key: cost_per_offline_add_payment_info_event value: time_attr_cost_per_offline_add_billing - description: '' is_valid: true key: cost_per_offline_add_to_cart_event value: time_attr_cost_per_offline_add_to_cart - description: '' is_valid: true key: cost_per_offline_add_to_wishlist_event value: time_attr_cost_per_offline_add_to_wishlist - description: '' is_valid: true key: cost_per_offline_click_button_event value: time_attr_cost_per_offline_button - description: '' is_valid: true key: cost_per_offline_complete_registration_event value: time_attr_cost_per_offline_register - description: '' is_valid: true key: cost_per_offline_contact_event value: time_attr_cost_per_offline_contact - description: '' is_valid: true key: cost_per_offline_download_event value: time_attr_cost_per_offline_download_start - description: '' is_valid: true key: cost_per_offline_form_event value: time_attr_cost_per_offline_submit_form - description: '' is_valid: true key: cost_per_offline_initiate_checkout_event value: time_attr_cost_per_offline_initiate_checkout - description: '' is_valid: true key: cost_per_offline_place_order_event value: time_attr_cost_per_offline_order - description: '' is_valid: true key: cost_per_offline_search_event value: time_attr_cost_per_offline_search - description: '' is_valid: true key: cost_per_offline_shopping_event value: time_attr_cost_per_offline_shopping - description: '' is_valid: true key: cost_per_offline_subscribe_event value: time_attr_cost_per_offline_subscribe - description: '' is_valid: true key: cost_per_offline_view_content_event value: time_attr_cost_per_offline_detail - description: '' is_valid: true key: cost_per_on_web_add_to_wishlist value: time_attr_cost_per_on_web_add_to_wishlist - description: '' is_valid: true key: cost_per_on_web_order value: time_attr_cost_per_on_web_order - description: '' is_valid: true key: cost_per_on_web_subscribe value: time_attr_cost_per_on_web_subscribe - description: '' is_valid: true key: cost_per_online_consult value: time_attr_cost_per_consult_standardized - description: '' is_valid: true key: cost_per_onsite_add_billing value: time_attr_cost_per_onsite_add_billing - description: '' is_valid: true key: cost_per_onsite_add_to_wishlist value: time_attr_cost_per_onsite_add_to_wishlist - description: '' is_valid: true key: cost_per_onsite_destination_visit value: time_attr_cost_per_onsite_destination_visit - description: '' is_valid: true key: cost_per_onsite_download_start value: time_attr_cost_per_onsite_download_start - description: '' is_valid: true key: cost_per_onsite_form value: time_attr_cost_per_onsite_form - description: '' is_valid: true key: cost_per_onsite_initiate_checkout_count value: time_attr_cost_per_onsite_initiate_checkout_count - description: '' is_valid: true key: cost_per_onsite_on_web_cart value: time_attr_cost_per_onsite_on_web_cart - description: '' is_valid: true key: cost_per_onsite_on_web_detail value: time_attr_cost_per_onsite_on_web_detail - description: '' is_valid: true key: cost_per_onsite_shopping value: time_attr_cost_per_onsite_shopping - description: '' is_valid: true key: cost_per_page_content_view_event value: time_attr_cost_per_on_web_detail_standardized - description: '' is_valid: true key: cost_per_page_event_search value: time_attr_cost_per_search_count - description: '' is_valid: true key: cost_per_pageview value: time_attr_cost_per_page_view - description: '' is_valid: true key: cost_per_purchase value: time_attr_active_pay_cost - description: '' is_valid: true key: cost_per_ratings value: time_attr_cost_per_rate - description: '' is_valid: true key: cost_per_registration value: time_attr_active_register_cost - description: '' is_valid: true key: cost_per_sales_lead value: time_attr_cost_per_sales_lead - description: '' is_valid: true key: cost_per_search value: time_attr_cost_per_search - description: '' is_valid: true key: cost_per_spend_credits value: time_attr_cost_per_spend_credits - description: '' is_valid: true key: cost_per_start_trial value: time_attr_cost_per_start_trial - description: '' is_valid: true key: cost_per_subscribe value: time_attr_cost_per_subscribe - description: '' is_valid: true key: cost_per_total_achieve_level value: time_attr_cost_per_repetitive_update_level - description: '' is_valid: true key: cost_per_total_add_to_wishlist value: time_attr_cost_per_repetitive_add_to_wishlist - description: '' is_valid: true key: cost_per_total_app_event_add_to_cart value: time_attr_cost_per_repetitive_in_app_cart - description: '' is_valid: true key: cost_per_total_checkout value: time_attr_cost_per_repetitive_in_app_order - description: '' is_valid: true key: cost_per_total_complete_tutorial value: time_attr_cost_per_repetitive_complete_tutorial - description: '' is_valid: true key: cost_per_total_create_gamerole value: time_attr_cost_per_repetitive_create_gamerole - description: '' is_valid: true key: cost_per_total_create_group value: time_attr_cost_per_repetitive_create_group - description: '' is_valid: true key: cost_per_total_day7_retention value: time_attr_cost_per_repetitive_retention_7d - description: '' is_valid: true key: cost_per_total_in_app_ad_click value: time_attr_cost_per_repetitive_in_app_ad_click - description: '' is_valid: true key: cost_per_total_in_app_ad_impr value: time_attr_cost_per_repetitive_in_app_ad_impr - description: '' is_valid: true key: cost_per_total_join_group value: time_attr_cost_per_repetitive_join_group - description: '' is_valid: true key: cost_per_total_launch_app value: time_attr_cost_per_repetitive_launch_app - description: '' is_valid: true key: cost_per_total_loan_apply value: time_attr_cost_per_repetitive_loan_apply - description: '' is_valid: true key: cost_per_total_loan_credit value: time_attr_cost_per_repetitive_loan_credit - description: '' is_valid: true key: cost_per_total_loan_disbursement value: time_attr_cost_per_repetitive_loan_completion - description: '' is_valid: true key: cost_per_total_login value: time_attr_cost_per_repetitive_login - description: '' is_valid: true key: cost_per_total_next_day_open value: time_attr_cost_per_repetitive_next_day_open - description: '' is_valid: true key: cost_per_total_purchase value: time_attr_cost_per_repetitive_active_pay - description: '' is_valid: true key: cost_per_total_ratings value: time_attr_cost_per_repetitive_rate - description: '' is_valid: true key: cost_per_total_registration value: time_attr_cost_per_repetitive_active_register - description: '' is_valid: true key: cost_per_total_sales_lead value: time_attr_cost_per_repetitive_sales_lead - description: '' is_valid: true key: cost_per_total_search value: time_attr_cost_per_repetitive_search - description: '' is_valid: true key: cost_per_total_spend_credits value: time_attr_cost_per_repetitive_spend_credits - description: '' is_valid: true key: cost_per_total_start_trial value: time_attr_cost_per_repetitive_start_trial - description: '' is_valid: true key: cost_per_total_subscribe value: time_attr_cost_per_repetitive_subscribe - description: '' is_valid: true key: cost_per_total_unlock_achievement value: time_attr_cost_per_repetitive_unlock_achievement - description: '' is_valid: true key: cost_per_total_view_content value: time_attr_cost_per_repetitive_in_app_detail_uv - description: '' is_valid: true key: cost_per_unique_ad_impression_event value: time_attr_cost_per_ad_revenue - description: '' is_valid: true key: cost_per_unique_custom_app_event value: time_attr_cost_per_app_customized_events - description: '' is_valid: true key: cost_per_unlock_achievement value: time_attr_cost_per_unlock_achievement - description: '' is_valid: true key: cost_per_user_registration value: time_attr_cost_per_on_web_register - description: '' is_valid: true key: cost_per_view_content value: time_attr_cost_per_in_app_detail_uv - description: '' is_valid: true key: cost_per_vta_app_install value: time_attr_active_show_cost - description: '' is_valid: true key: cost_per_vta_conversion value: time_attr_convert_cnt_show_cost - description: '' is_valid: true key: cost_per_vta_payments_completed value: time_attr_cost_per_shopping_show - description: '' is_valid: true key: cost_per_vta_purchase value: time_attr_active_pay_show_cost - description: '' is_valid: true key: cost_per_vta_registration value: time_attr_active_register_show_cost - description: '' is_valid: true key: cost_per_web_event_add_to_cart value: time_attr_cost_per_on_web_cart - description: '' is_valid: true key: cost_pre_ad_impression_event value: time_attr_cost_per_repetitive_ad_revenue - description: '' is_valid: true key: cost_total_add_payment_info value: time_attr_cost_per_repetitive_add_payment_info - description: '' is_valid: true key: countdown_sticker_recall_clicks value: recall_message_click_cnt - description: '' is_valid: true key: cpc value: cpc - description: '' is_valid: true key: cpm value: cpm - description: '' is_valid: true key: create_gamerole value: time_attr_create_gamerole - description: '' is_valid: true key: create_gamerole_rate value: time_attr_create_gamerole_per_install - description: '' is_valid: true key: create_group value: time_attr_create_group - description: '' is_valid: true key: create_group_rate value: time_attr_create_group_per_install - description: '' is_valid: true key: cta_app_install value: time_attr_active_click - description: '' is_valid: true key: cta_conversion value: time_attr_convert_cnt_click - description: '' is_valid: true key: cta_purchase value: time_attr_active_pay_click - description: '' is_valid: true key: cta_registration value: time_attr_active_register_click - description: '' is_valid: true key: ctr value: ctr - description: '' is_valid: true key: custom_app_event_rate value: time_attr_app_customized_events_per_install - description: '' is_valid: true key: custom_app_events value: time_attr_repetitive_app_customized_events - description: '' is_valid: true key: custom_app_events_value value: time_attr_total_repetitive_app_customized_events_value - description: '' is_valid: true key: custom_page_event_rate value: time_attr_web_customized_events_per_click - description: '' is_valid: true key: custom_page_events value: time_attr_web_customized_events - description: '' is_valid: true key: custom_page_events_value value: time_attr_total_web_customized_events_value - description: '' is_valid: true key: customized_ad_impression_event_rate value: time_attr_ad_revenue_per_install - description: '' is_valid: true key: day7_retention value: time_attr_retention_7d - description: '' is_valid: true key: day7_retention_rate value: time_attr_retention_7d_per_install - description: '' is_valid: true key: download_start value: time_attr_download_start - description: '' is_valid: true key: download_start_rate value: time_attr_download_start_per_click - description: '' is_valid: true key: duet_clicks value: duet_click_cnt - description: '' is_valid: true key: engaged_view value: engaged_view - description: '' is_valid: true key: engaged_view_15s value: engaged_view_15s - description: '' is_valid: true key: engaged_view_through_conversions value: time_attr_convert_cnt_ev - description: '' is_valid: true key: engagement_rate value: total_engagement_rate - description: '' is_valid: true key: engagements value: total_engagement - description: '' is_valid: true key: evta_app_install value: time_attr_active_ev - description: '' is_valid: true key: evta_payments_completed value: time_attr_shopping_ev - description: '' is_valid: true key: evta_purchase value: time_attr_active_pay_ev - description: '' is_valid: true key: evta_registration value: time_attr_active_register_ev - description: '' is_valid: true key: follows value: ad_net_follow - description: '' is_valid: true key: form value: time_attr_form - description: '' is_valid: true key: form_rate value: time_attr_form_per_click - description: '' is_valid: true key: gross_impressions value: gross_show_count - description: '' is_valid: true key: impressions value: show_cnt - description: '' is_valid: true key: in_app_ad_click value: time_attr_in_app_ad_click - description: '' is_valid: true key: in_app_ad_click_rate value: time_attr_in_app_ad_click_per_install - description: '' is_valid: true key: in_app_ad_impr value: time_attr_in_app_ad_impr - description: '' is_valid: true key: in_app_ad_impr_rate value: time_attr_in_app_ad_impr_per_install - description: '' is_valid: true key: initiate_checkout value: time_attr_initiate_checkout_count - description: '' is_valid: true key: initiate_checkout_rate value: time_attr_initiate_checkout_count_per_click - description: '' is_valid: true key: interactive_add_on_activity_clicks value: additional_format_interactive_click_count - description: '' is_valid: true key: interactive_add_on_destination_clicks value: additional_format_outbound_click_count - description: '' is_valid: true key: interactive_add_on_impressions value: additional_format_show_count - description: '' is_valid: true key: interactive_add_on_option_a_clicks value: additional_format_option_a_click_count - description: '' is_valid: true key: interactive_add_on_option_b_clicks value: additional_format_option_b_click_count - description: '' is_valid: true key: ix_average_video_play value: ix_video_duration_avg - description: '' is_valid: true key: ix_button_click_count value: ix_button_click_count - description: '' is_valid: true key: ix_button_click_count_rate value: ix_button_click_count_per_click - description: '' is_valid: true key: ix_page_duration_avg value: ix_page_duration_avg - description: '' is_valid: true key: ix_page_view_count value: ix_page_view_count - description: '' is_valid: true key: ix_page_view_count_rate value: ix_page_view_count_per_click - description: '' is_valid: true key: ix_page_viewrate_avg value: ix_page_viewrate_avg - description: '' is_valid: true key: ix_product_click_count value: ix_product_click_count - description: '' is_valid: true key: ix_product_click_count_rate value: ix_product_click_count_per_click - description: '' is_valid: true key: ix_video_views value: ix_video_view_count - description: '' is_valid: true key: ix_video_views_p100 value: ix_video_view_100pct - description: '' is_valid: true key: ix_video_views_p25 value: ix_video_view_25pct - description: '' is_valid: true key: ix_video_views_p50 value: ix_video_view_50pct - description: '' is_valid: true key: ix_video_views_p75 value: ix_video_view_75pct - description: '' is_valid: true key: join_group value: time_attr_join_group - description: '' is_valid: true key: join_group_rate value: time_attr_join_group_per_install - description: '' is_valid: true key: landing_page_view_rate value: time_attr_web_landing_page_view_per_click - description: '' is_valid: true key: launch_app value: time_attr_launch_app - description: '' is_valid: true key: launch_app_rate value: time_attr_launch_app_per_install - description: '' is_valid: true key: likes value: ad_net_like - description: '' is_valid: true key: live_effective_views value: live_effective_play_count - description: '' is_valid: true key: live_product_clicks value: live_product_click_count - description: '' is_valid: true key: live_views value: live_play_count - description: '' is_valid: true key: loan_apply value: time_attr_loan_apply - description: '' is_valid: true key: loan_apply_rate value: time_attr_loan_apply_per_install - description: '' is_valid: true key: loan_credit value: time_attr_loan_credit - description: '' is_valid: true key: loan_credit_rate value: time_attr_loan_credit_per_install - description: '' is_valid: true key: loan_disbursement value: time_attr_loan_completion - description: '' is_valid: true key: loan_disbursement_rate value: time_attr_loan_completion_per_install - description: '' is_valid: true key: login value: time_attr_login - description: '' is_valid: true key: login_rate value: time_attr_login_per_install - description: '' is_valid: true key: material_primary_status value: material_primary_status - description: '' is_valid: true key: material_second_status_list value: material_second_status_list - description: '' is_valid: true key: messaging_conversation_rate_instant_messaging_app value: time_attr_ctm_ima_messaging_per_click - description: '' is_valid: true key: messaging_conversation_rate_tiktok_direct_message value: time_attr_nonshop_onsite_tt_messaging_per_click - description: '' is_valid: true key: messaging_cost_per_conversation_instant_messaging_app value: time_attr_cost_per_ctm_ima_messaging - description: '' is_valid: true key: messaging_cost_per_conversation_tiktok_direct_message value: time_attr_cost_per_nonshop_onsite_tt_messaging - description: '' is_valid: true key: messaging_total_conversation_instant_messaging_app value: time_attr_ctm_ima_messaging_count - description: '' is_valid: true key: messaging_total_conversation_tiktok_direct_message value: time_attr_nonshop_onsite_tt_messaging - description: '' is_valid: true key: next_day_open value: time_attr_next_day_open - description: '' is_valid: true key: next_day_open_rate value: time_attr_next_day_open_per_install - description: '' is_valid: true key: offline_add_payment_info_event_rate value: time_attr_offline_add_billing_per_click - description: '' is_valid: true key: offline_add_payment_info_events value: time_attr_offline_add_billing - description: '' is_valid: true key: offline_add_payment_info_events_value value: time_attr_total_offline_add_billing_value - description: '' is_valid: true key: offline_add_to_cart_event_rate value: time_attr_offline_add_to_cart_per_click - description: '' is_valid: true key: offline_add_to_cart_events value: time_attr_offline_add_to_cart - description: '' is_valid: true key: offline_add_to_cart_events_value value: time_attr_total_offline_add_to_cart_value - description: '' is_valid: true key: offline_add_to_wishlist_event_rate value: time_attr_offline_add_to_wishlist_per_click - description: '' is_valid: true key: offline_add_to_wishlist_events value: time_attr_offline_add_to_wishlist - description: '' is_valid: true key: offline_add_to_wishlist_events_value value: time_attr_total_offline_add_to_wishlist_value - description: '' is_valid: true key: offline_application_approval value: time_attr_offline_application_approval - description: '' is_valid: true key: offline_application_approval_rate value: time_attr_offline_application_approval_per_click - description: '' is_valid: true key: offline_click_button_event_rate value: time_attr_offline_button_per_click - description: '' is_valid: true key: offline_click_button_events value: time_attr_offline_button - description: '' is_valid: true key: offline_click_button_events_value value: time_attr_total_offline_button_value - description: '' is_valid: true key: offline_complete_registration_event_rate value: time_attr_offline_register_per_click - description: '' is_valid: true key: offline_complete_registration_events value: time_attr_offline_register - description: '' is_valid: true key: offline_complete_registration_events_value value: time_attr_total_offline_register_value - description: '' is_valid: true key: offline_contact_event_rate value: time_attr_offline_contact_per_click - description: '' is_valid: true key: offline_contact_events value: time_attr_offline_contact - description: '' is_valid: true key: offline_contact_events_value value: time_attr_total_offline_contact_value - description: '' is_valid: true key: offline_cost_per_application_approval value: time_attr_cost_per_offline_application_approval - description: '' is_valid: true key: offline_cost_per_crm_event value: time_attr_cost_per_crm_events - description: '' is_valid: true key: offline_cost_per_custom_event value: time_attr_cost_per_offline_customized_events - description: '' is_valid: true key: offline_cost_per_customize_product value: time_attr_cost_per_customizeproduct_offline - description: '' is_valid: true key: offline_cost_per_find_location value: time_attr_cost_per_findlocation_offline - description: '' is_valid: true key: offline_cost_per_preferred_lead value: time_attr_cost_per_preferred_leads - description: '' is_valid: true key: offline_cost_per_schedule value: time_attr_cost_per_schedule_offline - description: '' is_valid: true key: offline_cost_per_start_trial value: time_attr_offline_start_trial_per_click - description: '' is_valid: true key: offline_cost_per_submit_application value: time_attr_cost_per_offline_submit_application - description: '' is_valid: true key: offline_crm_event_rate value: time_attr_crm_events_per_click - description: '' is_valid: true key: offline_crm_event_value value: time_attr_total_crm_events_value - description: '' is_valid: true key: offline_custom_event_rate value: time_attr_offline_customized_events_per_click - description: '' is_valid: true key: offline_customize_product_rate value: time_attr_customizeproduct_per_click_offline - description: '' is_valid: true key: offline_download_event_rate value: time_attr_offline_download_start_per_click - description: '' is_valid: true key: offline_download_events value: time_attr_offline_download_start - description: '' is_valid: true key: offline_download_events_value value: time_attr_total_offline_download_start_value - description: '' is_valid: true key: offline_find_location_rate value: time_attr_findlocation_per_click_offline - description: '' is_valid: true key: offline_form_event_rate value: time_attr_offline_submit_form_per_click - description: '' is_valid: true key: offline_form_events value: time_attr_offline_submit_form - description: '' is_valid: true key: offline_form_events_value value: time_attr_total_offline_submit_form_value - description: '' is_valid: true key: offline_initiate_checkout_event_rate value: time_attr_offline_initiate_checkout_per_click - description: '' is_valid: true key: offline_initiate_checkout_events value: time_attr_offline_initiate_checkout - description: '' is_valid: true key: offline_initiate_checkout_events_value value: time_attr_total_offline_initiate_checkout_value - description: '' is_valid: true key: offline_place_order_event_rate value: time_attr_offline_order_per_click - description: '' is_valid: true key: offline_place_order_events value: time_attr_offline_order - description: '' is_valid: true key: offline_place_order_events_value value: time_attr_total_offline_order_value - description: '' is_valid: true key: offline_preferred_lead_rate value: time_attr_preferred_leads_per_click - description: '' is_valid: true key: offline_preferred_leads value: time_attr_preferred_leads_cnt - description: '' is_valid: true key: offline_schedule_rate value: time_attr_schedule_per_click_offline - description: '' is_valid: true key: offline_search_event_rate value: time_attr_offline_search_per_click - description: '' is_valid: true key: offline_search_events value: time_attr_offline_search - description: '' is_valid: true key: offline_search_events_value value: time_attr_total_offline_search_value - description: '' is_valid: true key: offline_shopping_event_rate value: time_attr_offline_shopping_per_click - description: '' is_valid: true key: offline_shopping_events value: time_attr_offline_shopping - description: '' is_valid: true key: offline_shopping_events_roas value: time_attr_offline_shopping_roas - description: '' is_valid: true key: offline_shopping_events_value value: time_attr_total_offline_shopping_value - description: '' is_valid: true key: offline_start_trial_rate value: time_attr_cost_per_offline_start_trial - description: '' is_valid: true key: offline_submit_application_rate value: time_attr_offline_submit_application_per_click - description: '' is_valid: true key: offline_subscribe_event_rate value: time_attr_offline_subscribe_per_click - description: '' is_valid: true key: offline_subscribe_events value: time_attr_offline_subscribe - description: '' is_valid: true key: offline_subscribe_events_value value: time_attr_total_offline_subscribe_value - description: '' is_valid: true key: offline_total_application_approval_value value: time_attr_total_offline_application_approval_value - description: '' is_valid: true key: offline_total_crm_events value: time_attr_crm_events - description: '' is_valid: true key: offline_total_custom_event_value value: time_attr_total_offline_customized_events_value - description: '' is_valid: true key: offline_total_custom_events value: time_attr_offline_customized_events - description: '' is_valid: true key: offline_total_customize_product value: time_attr_customizeproduct_offline - description: '' is_valid: true key: offline_total_customize_product_value value: time_attr_total_customizeproduct_value_offline - description: '' is_valid: true key: offline_total_find_location value: time_attr_findlocation_offline - description: '' is_valid: true key: offline_total_find_location_value value: time_attr_total_findlocation_value_offline - description: '' is_valid: true key: offline_total_schedule value: time_attr_schedule_offline - description: '' is_valid: true key: offline_total_schedule_value value: time_attr_total_schedule_value_offline - description: '' is_valid: true key: offline_total_start_trial value: time_attr_offline_start_trial - description: '' is_valid: true key: offline_total_start_trial_value value: time_attr_total_offline_start_trial_value - description: '' is_valid: true key: offline_total_submit_application value: time_attr_offline_submit_application - description: '' is_valid: true key: offline_total_submit_application_value value: time_attr_total_offline_submit_application_value - description: '' is_valid: true key: offline_value_per_application_approval value: time_attr_value_per_offline_application_approval - description: '' is_valid: true key: offline_value_per_crm_event value: time_attr_value_per_crm_events - description: '' is_valid: true key: offline_value_per_custom_event value: time_attr_value_per_offline_customized_events - description: '' is_valid: true key: offline_value_per_customize_product value: time_attr_value_per_customizeproduct_offline - description: '' is_valid: true key: offline_value_per_find_location value: time_attr_value_per_findlocation_offline - description: '' is_valid: true key: offline_value_per_schedule value: time_attr_value_per_schedule_offline - description: '' is_valid: true key: offline_value_per_start_trial value: time_attr_value_per_offline_start_trial - description: '' is_valid: true key: offline_value_per_submit_application value: time_attr_value_per_offline_submit_application - description: '' is_valid: true key: offline_view_content_event_rate value: time_attr_offline_detail_per_click - description: '' is_valid: true key: offline_view_content_events value: time_attr_offline_detail - description: '' is_valid: true key: offline_view_content_events_value value: time_attr_total_offline_detail_value - description: '' is_valid: true key: on_web_add_to_wishlist value: time_attr_on_web_add_to_wishlist - description: '' is_valid: true key: on_web_add_to_wishlist_per_click value: time_attr_on_web_add_to_wishlist_per_click - description: '' is_valid: true key: on_web_order value: time_attr_on_web_order - description: '' is_valid: true key: on_web_order_rate value: time_attr_on_web_order_per_click - description: '' is_valid: true key: on_web_subscribe value: time_attr_on_web_subscribe - description: '' is_valid: true key: on_web_subscribe_per_click value: time_attr_on_web_subscribe_per_click - description: '' is_valid: true key: online_consult value: time_attr_consult_standardized - description: '' is_valid: true key: online_consult_rate value: time_attr_consult_standardized_per_click - description: '' is_valid: true key: onsite_active_by_conversion_time value: nonshop_onsite_active - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_calendar_day0 value: time_attr_total_nonshop_onsite_ad_revenue_value_cald0 - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_calendar_day13 value: time_attr_total_nonshop_onsite_ad_revenue_value_cald13 - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_calendar_day6 value: time_attr_total_nonshop_onsite_ad_revenue_value_cald6 - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_day0 value: time_attr_total_nonshop_onsite_ad_revenue_value_d0 - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_day13 value: time_attr_total_nonshop_onsite_ad_revenue_value_d13 - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_day6 value: time_attr_total_nonshop_onsite_ad_revenue_value_d6 - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_roas_calendar_day0 value: time_attr_nonshop_onsite_ad_revenue_roas_cald0 - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_roas_calendar_day13 value: time_attr_nonshop_onsite_ad_revenue_roas_cald13 - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_roas_calendar_day6 value: time_attr_nonshop_onsite_ad_revenue_roas_cald6 - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_roas_day0 value: time_attr_nonshop_onsite_ad_revenue_roas_d0 - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_roas_day13 value: time_attr_nonshop_onsite_ad_revenue_roas_d13 - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_roas_day6 value: time_attr_nonshop_onsite_ad_revenue_roas_d6 - description: '' is_valid: true key: onsite_ad_impression_rate value: time_attr_nonshop_onsite_ad_revenue_per_click - description: '' is_valid: true key: onsite_add_billing value: time_attr_onsite_add_billing - description: '' is_valid: true key: onsite_add_billing_rate value: time_attr_onsite_add_billing_per_click - description: '' is_valid: true key: onsite_add_to_cart_rate value: time_attr_nonshop_onsite_on_web_cart_per_click - description: '' is_valid: true key: onsite_add_to_wishlist value: time_attr_onsite_add_to_wishlist - description: '' is_valid: true key: onsite_add_to_wishlist_rate value: time_attr_onsite_add_to_wishlist_per_click - description: '' is_valid: true key: onsite_checkout_initiation_rate value: time_attr_nonshop_onsite_initiate_checkout_count_per_click - description: '' is_valid: true key: onsite_cost_per_active value: time_attr_cost_per_nonshop_onsite_active - description: '' is_valid: true key: onsite_cost_per_active_by_conversion_time value: cost_per_nonshop_onsite_active - description: '' is_valid: true key: onsite_cost_per_add_to_cart value: time_attr_cost_per_nonshop_onsite_on_web_cart - description: '' is_valid: true key: onsite_cost_per_checkout_initiation value: time_attr_cost_per_nonshop_onsite_initiate_checkout_count - description: '' is_valid: true key: onsite_cost_per_product_details_page_view value: time_attr_cost_per_nonshop_onsite_on_web_detail - description: '' is_valid: true key: onsite_cost_per_purchase value: time_attr_cost_per_nonshop_onsite_shopping - description: '' is_valid: true key: onsite_cost_per_total_ad_impression value: time_attr_cost_per_nonshop_onsite_ad_revenue - description: '' is_valid: true key: onsite_cost_per_total_launch value: time_attr_cost_per_nonshop_onsite_launch_app - description: '' is_valid: true key: onsite_cost_per_total_registration value: time_attr_cost_per_nonshop_onsite_active_register - description: '' is_valid: true key: onsite_cost_per_unique_ad_impression value: time_attr_cost_per_unique_nonshop_onsite_ad_revenue - description: '' is_valid: true key: onsite_cost_per_unique_launch value: time_attr_cost_per_unique_nonshop_onsite_launch_app - description: '' is_valid: true key: onsite_cost_per_unique_purchase value: time_attr_cost_per_unique_nonshop_onsite_shopping - description: '' is_valid: true key: onsite_cost_per_unique_registration value: time_attr_cost_per_unique_nonshop_onsite_active_register - description: '' is_valid: true key: onsite_destination_visit_rate value: time_attr_onsite_destination_visit_per_click - description: '' is_valid: true key: onsite_destination_visits value: time_attr_onsite_destination_visit - description: '' is_valid: true key: onsite_download_start value: time_attr_onsite_download_start - description: '' is_valid: true key: onsite_download_start_rate value: time_attr_onsite_download_start_per_click - description: '' is_valid: true key: onsite_form value: time_attr_onsite_form - description: '' is_valid: true key: onsite_form_rate value: time_attr_onsite_form_per_click - description: '' is_valid: true key: onsite_initiate_checkout_count value: time_attr_onsite_initiate_checkout_count - description: '' is_valid: true key: onsite_initiate_checkout_count_rate value: time_attr_onsite_initiate_checkout_count_per_click - description: '' is_valid: true key: onsite_launch_rate value: time_attr_nonshop_onsite_launch_app_per_click - description: '' is_valid: true key: onsite_on_web_cart value: time_attr_onsite_on_web_cart - description: '' is_valid: true key: onsite_on_web_cart_rate value: time_attr_onsite_on_web_cart_per_click - description: '' is_valid: true key: onsite_on_web_detail value: time_attr_onsite_on_web_detail - description: '' is_valid: true key: onsite_on_web_detail_rate value: time_attr_onsite_on_web_detail_per_click - description: '' is_valid: true key: onsite_product_details_page_view_rate value: time_attr_nonshop_onsite_on_web_detail_per_click - description: '' is_valid: true key: onsite_purchase_rate value: time_attr_nonshop_onsite_shopping_per_click - description: '' is_valid: true key: onsite_purchase_roas_calendar_day0 value: time_attr_nonshop_onsite_shopping_roas_cald0 - description: '' is_valid: true key: onsite_purchase_roas_calendar_day13 value: time_attr_nonshop_onsite_shopping_roas_cald13 - description: '' is_valid: true key: onsite_purchase_roas_calendar_day6 value: time_attr_nonshop_onsite_shopping_roas_cald6 - description: '' is_valid: true key: onsite_purchase_roas_day0 value: time_attr_nonshop_onsite_shopping_roas_d0 - description: '' is_valid: true key: onsite_purchase_roas_day13 value: time_attr_nonshop_onsite_shopping_roas_d13 - description: '' is_valid: true key: onsite_purchase_roas_day6 value: time_attr_nonshop_onsite_shopping_roas_d6 - description: '' is_valid: true key: onsite_purchase_value_calendar_day0 value: time_attr_total_nonshop_onsite_shopping_value_cald0 - description: '' is_valid: true key: onsite_purchase_value_calendar_day13 value: time_attr_total_nonshop_onsite_shopping_value_cald13 - description: '' is_valid: true key: onsite_purchase_value_calendar_day6 value: time_attr_total_nonshop_onsite_shopping_value_cald6 - description: '' is_valid: true key: onsite_purchase_value_day0 value: time_attr_total_nonshop_onsite_shopping_value_d0 - description: '' is_valid: true key: onsite_purchase_value_day13 value: time_attr_total_nonshop_onsite_shopping_value_d13 - description: '' is_valid: true key: onsite_purchase_value_day6 value: time_attr_total_nonshop_onsite_shopping_value_d6 - description: '' is_valid: true key: onsite_purchases_roas value: time_attr_nonshop_onsite_shopping_roas - description: '' is_valid: true key: onsite_registration_rate value: time_attr_nonshop_onsite_active_register_per_click - description: '' is_valid: true key: onsite_shopping value: time_attr_onsite_shopping - description: '' is_valid: true key: onsite_shopping_rate value: time_attr_onsite_shopping_per_click - description: '' is_valid: true key: onsite_shopping_roas value: time_attr_onsite_shopping_roas - description: '' is_valid: true key: onsite_total_active value: time_attr_nonshop_onsite_active - description: '' is_valid: true key: onsite_total_ad_impression value: time_attr_nonshop_onsite_ad_revenue - description: '' is_valid: true key: onsite_total_ad_impression_value value: time_attr_nonshop_onsite_ad_revenue_value - description: '' is_valid: true key: onsite_total_add_to_cart value: time_attr_nonshop_onsite_on_web_cart - description: '' is_valid: true key: onsite_total_add_to_cart_value value: time_attr_total_nonshop_onsite_on_web_cart_value - description: '' is_valid: true key: onsite_total_checkout_initiation value: time_attr_nonshop_onsite_initiate_checkout_count - description: '' is_valid: true key: onsite_total_checkout_initiation_value value: time_attr_total_nonshop_onsite_initiate_checkout_count_value - description: '' is_valid: true key: onsite_total_filtered_out_form_submission value: ix_filtered_out_leads - description: '' is_valid: true key: onsite_total_launch value: time_attr_nonshop_onsite_launch_app - description: '' is_valid: true key: onsite_total_product_details_page_view value: time_attr_nonshop_onsite_on_web_detail - description: '' is_valid: true key: onsite_total_product_details_page_view_value value: time_attr_total_nonshop_onsite_on_web_detail_value - description: '' is_valid: true key: onsite_total_purchase value: time_attr_nonshop_onsite_shopping - description: '' is_valid: true key: onsite_total_purchase_value value: time_attr_total_nonshop_onsite_shopping_value - description: '' is_valid: true key: onsite_total_registration value: time_attr_nonshop_onsite_active_register - description: '' is_valid: true key: onsite_unique_ad_impression value: time_attr_unique_nonshop_onsite_ad_revenue - description: '' is_valid: true key: onsite_unique_launch value: time_attr_unique_nonshop_onsite_launch_app - description: '' is_valid: true key: onsite_unique_purchase value: time_attr_unique_nonshop_onsite_shopping - description: '' is_valid: true key: onsite_unique_registration value: time_attr_unique_nonshop_onsite_active_register - description: '' is_valid: true key: onsite_value_per_ad_impression_value value: time_attr_value_per_nonshop_onsite_ad_revenue - description: '' is_valid: true key: onsite_value_per_add_to_cart value: time_attr_value_per_nonshop_onsite_on_web_cart - description: '' is_valid: true key: onsite_value_per_checkout_initiation value: time_attr_value_per_nonshop_onsite_initiate_checkout_count - description: '' is_valid: true key: onsite_value_per_product_details_page_view value: time_attr_value_per_nonshop_onsite_on_web_detail - description: '' is_valid: true key: onsite_value_per_purchase value: time_attr_value_per_nonshop_onsite_shopping - description: '' is_valid: true key: operation_status value: aco_opt_status - description: '' is_valid: true key: page_content_view_event_rate value: time_attr_on_web_detail_standardized_per_click - description: '' is_valid: true key: page_content_view_events value: time_attr_on_web_detail_standardized - description: '' is_valid: true key: page_event_search value: time_attr_search_count - description: '' is_valid: true key: page_event_search_rate value: time_attr_search_count_per_click - description: '' is_valid: true key: pageview_rate value: time_attr_page_view_per_click - description: '' is_valid: true key: paid_engaged_view value: engaged_view_billed_vv - description: '' is_valid: true key: paid_engaged_view_15s value: engaged_view_15s_billed_vv - description: '' is_valid: true key: paid_engagement_engaged_view value: engaged_view_billed_engagement - description: '' is_valid: true key: paid_engagement_engaged_view_15s value: engaged_view_15s_billed_engagement - description: '' is_valid: true key: playable_download_button_click_count value: playable_cta_click - description: '' is_valid: true key: playable_first_scene_view_count value: playable_first_scene_view_count - description: '' is_valid: true key: playable_page_view_count value: playable_page_view_count - description: '' is_valid: true key: playable_second_scene_view_count value: playable_second_scene_view_count - description: '' is_valid: true key: playable_third_scene_view_count value: playable_third_scene_view_count - description: '' is_valid: true key: product_clicks value: product_click_cnt - description: '' is_valid: true key: product_cta value: stats_product_ctr - description: '' is_valid: true key: product_impressions value: product_show_cnt - description: '' is_valid: true key: profile_visits value: ad_home_visited - description: '' is_valid: true key: profile_visits_rate value: ad_home_visited_rate - description: '' is_valid: true key: purchase value: time_attr_active_pay - description: '' is_valid: true key: purchase_rate value: time_attr_active_pay_rate - description: '' is_valid: true key: ratings value: time_attr_rate - description: '' is_valid: true key: ratings_rate value: time_attr_rate_per_install - description: '' is_valid: true key: real_time_app_install value: active - description: '' is_valid: true key: real_time_app_install_cost value: active_cost - description: '' is_valid: true key: real_time_conversion value: convert_cnt - description: '' is_valid: true key: real_time_conversion_rate_v2 value: conversion_rate_imp - description: '' is_valid: true key: real_time_cost_per_conversion value: conversion_cost - description: '' is_valid: true key: registration value: time_attr_active_register - description: '' is_valid: true key: registration_rate value: time_attr_active_register_rate - description: '' is_valid: true key: sales_lead value: time_attr_sales_lead - description: '' is_valid: true key: sales_lead_rate value: time_attr_sales_lead_per_install - description: '' is_valid: true key: search value: time_attr_search - description: '' is_valid: true key: search_rate value: time_attr_search_per_install - description: '' is_valid: true key: shares value: ad_share - description: '' is_valid: true key: shop_gross_revenue_by_order_submission value: total_onsite_shopping_value - description: '' is_valid: true key: shop_total_items_purchased value: time_attr_onsite_shopping_quantity - description: '' is_valid: true key: shop_total_purchase_by_order_submission value: onsite_shopping - description: '' is_valid: true key: single_image_ctr value: single_image_ctr - description: '' is_valid: true key: single_image_impression_rate value: single_image_show_rate - description: '' is_valid: true key: single_image_impressions value: single_image_show_count - description: '' is_valid: true key: skan_achieve_level value: skan_update_level - description: '' is_valid: true key: skan_achieve_level_rate value: skan_update_level_per_install - description: '' is_valid: true key: skan_add_payment_info value: skan_add_payment_info - description: '' is_valid: true key: skan_add_payment_info_rate value: skan_add_payment_info_per_install - description: '' is_valid: true key: skan_add_to_cart value: skan_in_app_cart - description: '' is_valid: true key: skan_add_to_cart_rate value: skan_in_app_cart_per_install - description: '' is_valid: true key: skan_add_to_wishlist value: skan_add_to_wishlist - description: '' is_valid: true key: skan_add_to_wishlist_rate value: skan_add_to_wishlist_per_install - description: '' is_valid: true key: skan_app_install value: skan_active - description: '' is_valid: true key: skan_app_install_withheld value: skan_active_withheld - description: '' is_valid: true key: skan_checkout value: skan_in_app_order - description: '' is_valid: true key: skan_checkout_rate value: skan_in_app_order_per_install - description: '' is_valid: true key: skan_complete_tutorial value: skan_complete_tutorial - description: '' is_valid: true key: skan_complete_tutorial_rate value: skan_complete_tutorial_per_install - description: '' is_valid: true key: skan_conversion value: skan_convert_cnt - description: '' is_valid: true key: skan_conversion_rate_v2 value: skan_conversion_rate_imp - description: '' is_valid: true key: skan_cost_per_achieve_level value: cost_per_skan_update_level - description: '' is_valid: true key: skan_cost_per_add_payment_info value: cost_per_skan_add_payment_info - description: '' is_valid: true key: skan_cost_per_add_to_cart value: cost_per_skan_in_app_cart - description: '' is_valid: true key: skan_cost_per_add_to_wishlist value: cost_per_skan_add_to_wishlist - description: '' is_valid: true key: skan_cost_per_app_install value: cost_per_skan_active - description: '' is_valid: true key: skan_cost_per_checkout value: cost_per_skan_in_app_order - description: '' is_valid: true key: skan_cost_per_complete_tutorial value: cost_per_skan_complete_tutorial - description: '' is_valid: true key: skan_cost_per_conversion value: skan_conversion_cost - description: '' is_valid: true key: skan_cost_per_create_gamerole value: cost_per_skan_create_gamerole - description: '' is_valid: true key: skan_cost_per_create_group value: cost_per_skan_create_group - description: '' is_valid: true key: skan_cost_per_cta_app_install value: skan_active_click_cost - description: '' is_valid: true key: skan_cost_per_cta_conversion value: skan_convert_cnt_click_cost - description: '' is_valid: true key: skan_cost_per_cta_purchase value: skan_active_pay_click_cost - description: '' is_valid: true key: skan_cost_per_cta_registration value: skan_active_register_click_cost - description: '' is_valid: true key: skan_cost_per_in_app_ad_click value: cost_per_skan_in_app_ad_click - description: '' is_valid: true key: skan_cost_per_in_app_ad_impr value: cost_per_skan_in_app_ad_impr - description: '' is_valid: true key: skan_cost_per_join_group value: cost_per_skan_join_group - description: '' is_valid: true key: skan_cost_per_launch_app value: cost_per_skan_launch_app - description: '' is_valid: true key: skan_cost_per_loan_apply value: cost_per_skan_loan_apply - description: '' is_valid: true key: skan_cost_per_loan_credit value: cost_per_skan_loan_credit - description: '' is_valid: true key: skan_cost_per_loan_disbursement value: cost_per_skan_loan_completion - description: '' is_valid: true key: skan_cost_per_login value: cost_per_skan_login - description: '' is_valid: true key: skan_cost_per_purchase value: cost_per_skan_active_pay - description: '' is_valid: true key: skan_cost_per_ratings value: cost_per_skan_rate - description: '' is_valid: true key: skan_cost_per_registration value: cost_per_skan_active_register - description: '' is_valid: true key: skan_cost_per_result value: skan_effect_cost - description: '' is_valid: true key: skan_cost_per_sales_lead value: cost_per_skan_sales_lead - description: '' is_valid: true key: skan_cost_per_search value: cost_per_skan_search - description: '' is_valid: true key: skan_cost_per_spend_credits value: cost_per_skan_spend_credits - description: '' is_valid: true key: skan_cost_per_start_trial value: cost_per_skan_start_trial - description: '' is_valid: true key: skan_cost_per_subscribe value: cost_per_skan_subscribe - description: '' is_valid: true key: skan_cost_per_total_achieve_level value: cost_per_skan_repetitive_update_level - description: '' is_valid: true key: skan_cost_per_total_add_to_cart value: cost_per_skan_repetitive_in_app_cart - description: '' is_valid: true key: skan_cost_per_total_add_to_wishlist value: cost_per_skan_repetitive_add_to_wishlist - description: '' is_valid: true key: skan_cost_per_total_checkout value: cost_per_skan_repetitive_in_app_order - description: '' is_valid: true key: skan_cost_per_total_complete_tutorial value: cost_per_skan_repetitive_complete_tutorial - description: '' is_valid: true key: skan_cost_per_total_create_gamerole value: cost_per_skan_repetitive_create_gamerole - description: '' is_valid: true key: skan_cost_per_total_create_group value: cost_per_skan_repetitive_create_group - description: '' is_valid: true key: skan_cost_per_total_in_app_ad_click value: cost_per_skan_repetitive_in_app_ad_click - description: '' is_valid: true key: skan_cost_per_total_in_app_ad_impr value: cost_per_skan_repetitive_in_app_ad_impr - description: '' is_valid: true key: skan_cost_per_total_join_group value: cost_per_skan_repetitive_join_group - description: '' is_valid: true key: skan_cost_per_total_launch_app value: cost_per_skan_repetitive_launch_app - description: '' is_valid: true key: skan_cost_per_total_loan_apply value: cost_per_skan_repetitive_loan_apply - description: '' is_valid: true key: skan_cost_per_total_loan_credit value: cost_per_skan_repetitive_loan_credit - description: '' is_valid: true key: skan_cost_per_total_loan_disbursement value: cost_per_skan_repetitive_loan_completion - description: '' is_valid: true key: skan_cost_per_total_login value: cost_per_skan_repetitive_login - description: '' is_valid: true key: skan_cost_per_total_purchase value: cost_per_skan_repetitive_active_pay - description: '' is_valid: true key: skan_cost_per_total_ratings value: cost_per_skan_repetitive_rate - description: '' is_valid: true key: skan_cost_per_total_registration value: cost_per_skan_repetitive_active_register - description: '' is_valid: true key: skan_cost_per_total_sales_lead value: cost_per_skan_repetitive_sales_lead - description: '' is_valid: true key: skan_cost_per_total_search value: cost_per_skan_repetitive_search - description: '' is_valid: true key: skan_cost_per_total_spend_credits value: cost_per_skan_repetitive_spend_credits - description: '' is_valid: true key: skan_cost_per_total_start_trial value: cost_per_skan_repetitive_start_trial - description: '' is_valid: true key: skan_cost_per_total_subscribe value: cost_per_skan_repetitive_subscribe - description: '' is_valid: true key: skan_cost_per_total_unlock_achievement value: cost_per_skan_repetitive_unlock_achievement - description: '' is_valid: true key: skan_cost_per_total_view_content value: cost_per_skan_repetitive_in_app_detail_uv - description: '' is_valid: true key: skan_cost_per_unlock_achievement value: cost_per_skan_unlock_achievement - description: '' is_valid: true key: skan_cost_per_view_content value: cost_per_skan_in_app_detail_uv - description: '' is_valid: true key: skan_cost_per_vta_app_install value: skan_active_show_cost - description: '' is_valid: true key: skan_cost_per_vta_conversion value: skan_convert_cnt_show_cost - description: '' is_valid: true key: skan_cost_per_vta_purchase value: skan_active_pay_show_cost - description: '' is_valid: true key: skan_cost_per_vta_registration value: skan_active_register_show_cost - description: '' is_valid: true key: skan_cost_total_add_payment_info value: cost_per_skan_repetitive_add_payment_info - description: '' is_valid: true key: skan_create_gamerole value: skan_create_gamerole - description: '' is_valid: true key: skan_create_gamerole_rate value: skan_create_gamerole_per_install - description: '' is_valid: true key: skan_create_group value: skan_create_group - description: '' is_valid: true key: skan_create_group_rate value: skan_create_group_per_install - description: '' is_valid: true key: skan_cta_app_install value: skan_active_click - description: '' is_valid: true key: skan_cta_conversion value: skan_convert_cnt_click - description: '' is_valid: true key: skan_cta_purchase value: skan_active_pay_click - description: '' is_valid: true key: skan_cta_registration value: skan_active_register_click - description: '' is_valid: true key: skan_in_app_ad_click value: skan_in_app_ad_click - description: '' is_valid: true key: skan_in_app_ad_click_rate value: skan_in_app_ad_click_per_install - description: '' is_valid: true key: skan_in_app_ad_impr value: skan_in_app_ad_impr - description: '' is_valid: true key: skan_in_app_ad_impr_rate value: skan_in_app_ad_impr_per_install - description: '' is_valid: true key: skan_join_group value: skan_join_group - description: '' is_valid: true key: skan_join_group_rate value: skan_join_group_per_install - description: '' is_valid: true key: skan_launch_app value: skan_launch_app - description: '' is_valid: true key: skan_launch_app_rate value: skan_launch_app_per_install - description: '' is_valid: true key: skan_loan_apply value: skan_loan_apply - description: '' is_valid: true key: skan_loan_apply_rate value: skan_loan_apply_per_install - description: '' is_valid: true key: skan_loan_credit value: skan_loan_credit - description: '' is_valid: true key: skan_loan_credit_rate value: skan_loan_credit_per_install - description: '' is_valid: true key: skan_loan_disbursement value: skan_loan_completion - description: '' is_valid: true key: skan_loan_disbursement_rate value: skan_loan_completion_per_install - description: '' is_valid: true key: skan_login value: skan_login - description: '' is_valid: true key: skan_login_rate value: skan_login_per_install - description: '' is_valid: true key: skan_purchase value: skan_active_pay - description: '' is_valid: true key: skan_purchase_rate value: skan_active_pay_per_install - description: '' is_valid: true key: skan_ratings value: skan_rate - description: '' is_valid: true key: skan_ratings_rate value: skan_rate_per_install - description: '' is_valid: true key: skan_registration value: skan_active_register - description: '' is_valid: true key: skan_registration_rate value: skan_active_register_per_install - description: '' is_valid: true key: skan_result value: skan_effect_cnt - description: '' is_valid: true key: skan_result_rate value: skan_effect_rate - description: '' is_valid: true key: skan_sales_lead value: skan_sales_lead - description: '' is_valid: true key: skan_sales_lead_rate value: skan_sales_lead_per_install - description: '' is_valid: true key: skan_search value: skan_search - description: '' is_valid: true key: skan_search_rate value: skan_search_per_install - description: '' is_valid: true key: skan_spend_credits value: skan_spend_credits - description: '' is_valid: true key: skan_spend_credits_rate value: skan_spend_credits_per_install - description: '' is_valid: true key: skan_start_trial value: skan_start_trial - description: '' is_valid: true key: skan_start_trial_rate value: skan_start_trial_per_install - description: '' is_valid: true key: skan_subscribe value: skan_subscribe - description: '' is_valid: true key: skan_subscribe_rate value: skan_subscribe_per_install - description: '' is_valid: true key: skan_total_achieve_level value: skan_repetitive_update_level - description: '' is_valid: true key: skan_total_achieve_level_value value: skan_total_repetitive_update_level_value - description: '' is_valid: true key: skan_total_add_payment_info value: skan_repetitive_add_payment_info - description: '' is_valid: true key: skan_total_add_to_cart value: skan_repetitive_in_app_cart - description: '' is_valid: true key: skan_total_add_to_cart_value value: skan_total_repetitive_in_app_cart_value - description: '' is_valid: true key: skan_total_add_to_wishlist value: skan_repetitive_add_to_wishlist - description: '' is_valid: true key: skan_total_add_to_wishlist_value value: skan_total_repetitive_add_to_wishlist_value - description: '' is_valid: true key: skan_total_checkout value: skan_repetitive_in_app_order - description: '' is_valid: true key: skan_total_checkout_value value: skan_total_repetitive_in_app_order_value - description: '' is_valid: true key: skan_total_complete_tutorial value: skan_repetitive_complete_tutorial - description: '' is_valid: true key: skan_total_complete_tutorial_value value: skan_total_repetitive_complete_tutorial_value - description: '' is_valid: true key: skan_total_create_gamerole value: skan_repetitive_create_gamerole - description: '' is_valid: true key: skan_total_create_gamerole_value value: skan_total_repetitive_create_gamerole_value - description: '' is_valid: true key: skan_total_create_group value: skan_repetitive_create_group - description: '' is_valid: true key: skan_total_create_group_value value: skan_total_repetitive_create_group_value - description: '' is_valid: true key: skan_total_in_app_ad_click value: skan_repetitive_in_app_ad_click - description: '' is_valid: true key: skan_total_in_app_ad_click_value value: skan_total_repetitive_in_app_ad_click_value - description: '' is_valid: true key: skan_total_in_app_ad_impr value: skan_repetitive_in_app_ad_impr - description: '' is_valid: true key: skan_total_in_app_ad_impr_value value: skan_total_repetitive_in_app_ad_impr_value - description: '' is_valid: true key: skan_total_join_group value: skan_repetitive_join_group - description: '' is_valid: true key: skan_total_join_group_value value: skan_total_repetitive_join_group_value - description: '' is_valid: true key: skan_total_launch_app value: skan_repetitive_launch_app - description: '' is_valid: true key: skan_total_loan_apply value: skan_repetitive_loan_apply - description: '' is_valid: true key: skan_total_loan_credit value: skan_repetitive_loan_credit - description: '' is_valid: true key: skan_total_loan_disbursement value: skan_repetitive_loan_completion - description: '' is_valid: true key: skan_total_login value: skan_repetitive_login - description: '' is_valid: true key: skan_total_purchase value: skan_repetitive_active_pay - description: '' is_valid: true key: skan_total_purchase_value value: skan_total_repetitive_active_pay_value - description: '' is_valid: true key: skan_total_ratings value: skan_repetitive_rate - description: '' is_valid: true key: skan_total_ratings_value value: skan_total_repetitive_rate_value - description: '' is_valid: true key: skan_total_registration value: skan_repetitive_active_register - description: '' is_valid: true key: skan_total_repetitive_active_pay_roas value: skan_total_repetitive_active_pay_roas - description: '' is_valid: true key: skan_total_sales_lead value: skan_repetitive_sales_lead - description: '' is_valid: true key: skan_total_sales_lead_value value: skan_total_repetitive_sales_lead_value - description: '' is_valid: true key: skan_total_search value: skan_repetitive_search - description: '' is_valid: true key: skan_total_spend_credits value: skan_repetitive_spend_credits - description: '' is_valid: true key: skan_total_spend_credits_value value: skan_total_repetitive_spend_credits_value - description: '' is_valid: true key: skan_total_start_trial value: skan_repetitive_start_trial - description: '' is_valid: true key: skan_total_subscribe value: skan_repetitive_subscribe - description: '' is_valid: true key: skan_total_subscribe_value value: skan_total_repetitive_subscribe_value - description: '' is_valid: true key: skan_total_unlock_achievement value: skan_repetitive_unlock_achievement - description: '' is_valid: true key: skan_total_unlock_achievement_value value: skan_total_repetitive_unlock_achievement_value - description: '' is_valid: true key: skan_total_view_content value: skan_repetitive_in_app_detail_uv - description: '' is_valid: true key: skan_total_view_content_value value: skan_total_repetitive_in_app_detail_uv_value - description: '' is_valid: true key: skan_unlock_achievement value: skan_unlock_achievement - description: '' is_valid: true key: skan_unlock_achievement_rate value: skan_unlock_achievement_per_install - description: '' is_valid: true key: skan_view_content value: skan_in_app_detail_uv - description: '' is_valid: true key: skan_view_content_rate value: skan_in_app_detail_uv_per_install - description: '' is_valid: true key: skan_vta_app_install value: skan_active_show - description: '' is_valid: true key: skan_vta_conversion value: skan_convert_cnt_show - description: '' is_valid: true key: skan_vta_purchase value: skan_active_pay_show - description: '' is_valid: true key: skan_vta_registration value: skan_active_register_show - description: '' is_valid: true key: sound_usage_clicks value: sound_usage_button_click_cnt - description: '' is_valid: true key: spend value: stat_cost - description: '' is_valid: true key: spend_credits value: time_attr_spend_credits - description: '' is_valid: true key: spend_credits_rate value: time_attr_spend_credits_per_install - description: '' is_valid: true key: start_trial value: time_attr_start_trial - description: '' is_valid: true key: start_trial_rate value: time_attr_start_trial_per_install - description: '' is_valid: true key: stitch_clicks value: stitch_click_cnt - description: '' is_valid: true key: subscribe value: time_attr_subscribe - description: '' is_valid: true key: subscribe_rate value: time_attr_subscribe_per_install - description: '' is_valid: true key: total_achieve_level value: time_attr_repetitive_update_level - description: '' is_valid: true key: total_achieve_level_value value: time_attr_total_repetitive_update_level_value - description: '' is_valid: true key: total_active_pay_roas value: time_attr_repetitive_active_pay_roas - description: '' is_valid: true key: total_ad_impression_events_value value: time_attr_total_repetitive_ad_revenue_value - description: '' is_valid: true key: total_ad_impression_roas value: time_attr_total_repetitive_ad_revenue_roas - description: '' is_valid: true key: total_add_billing_value value: time_attr_total_add_billing_value - description: '' is_valid: true key: total_add_payment_info value: time_attr_repetitive_add_payment_info - description: '' is_valid: true key: total_add_to_wishlist value: time_attr_repetitive_add_to_wishlist - description: '' is_valid: true key: total_add_to_wishlist_value value: time_attr_total_repetitive_add_to_wishlist_value - description: '' is_valid: true key: total_app_event_add_to_cart value: time_attr_repetitive_in_app_cart - description: '' is_valid: true key: total_app_event_add_to_cart_value value: time_attr_total_repetitive_in_app_cart_value - description: '' is_valid: true key: total_button_click_value value: time_attr_total_button_value - description: '' is_valid: true key: total_checkout value: time_attr_repetitive_in_app_order - description: '' is_valid: true key: total_checkout_value value: time_attr_total_repetitive_in_app_order_value - description: '' is_valid: true key: total_complete_payment_rate value: time_attr_total_shopping_value - description: '' is_valid: true key: total_complete_tutorial value: time_attr_repetitive_complete_tutorial - description: '' is_valid: true key: total_complete_tutorial_value value: time_attr_total_repetitive_complete_tutorial_value - description: '' is_valid: true key: total_create_gamerole value: time_attr_repetitive_create_gamerole - description: '' is_valid: true key: total_create_gamerole_value value: time_attr_total_repetitive_create_gamerole_value - description: '' is_valid: true key: total_create_group value: time_attr_repetitive_create_group - description: '' is_valid: true key: total_create_group_value value: time_attr_total_repetitive_create_group_value - description: '' is_valid: true key: total_day7_retention value: time_attr_repetitive_retention_7d - description: '' is_valid: true key: total_day7_retention_value value: time_attr_total_repetitive_retention_7d_value - description: '' is_valid: true key: total_download_start_value value: time_attr_total_download_start_value - description: '' is_valid: true key: total_form_value value: time_attr_total_form_value - description: '' is_valid: true key: total_in_app_ad_click value: time_attr_repetitive_in_app_ad_click - description: '' is_valid: true key: total_in_app_ad_click_value value: time_attr_total_repetitive_in_app_ad_click_value - description: '' is_valid: true key: total_in_app_ad_impr value: time_attr_repetitive_in_app_ad_impr - description: '' is_valid: true key: total_in_app_ad_impr_value value: time_attr_total_repetitive_in_app_ad_impr_value - description: '' is_valid: true key: total_initiate_checkout_value value: time_attr_total_initiate_checkout_value - description: '' is_valid: true key: total_join_group value: time_attr_repetitive_join_group - description: '' is_valid: true key: total_join_group_value value: time_attr_total_repetitive_join_group_value - description: '' is_valid: true key: total_landing_page_view value: time_attr_web_landing_page_view - description: '' is_valid: true key: total_launch_app value: time_attr_repetitive_launch_app - description: '' is_valid: true key: total_loan_apply value: time_attr_repetitive_loan_apply - description: '' is_valid: true key: total_loan_credit value: time_attr_repetitive_loan_credit - description: '' is_valid: true key: total_loan_disbursement value: time_attr_repetitive_loan_completion - description: '' is_valid: true key: total_login value: time_attr_repetitive_login - description: '' is_valid: true key: total_next_day_open value: time_attr_repetitive_next_day_open - description: '' is_valid: true key: total_on_web_add_to_wishlist_value value: time_attr_total_on_web_add_to_wishlist_value - description: '' is_valid: true key: total_on_web_order_value value: time_attr_total_on_web_order_value - description: '' is_valid: true key: total_on_web_subscribe_value value: time_attr_total_on_web_subscribe_value - description: '' is_valid: true key: total_online_consult_value value: time_attr_total_consult_standardized_value - description: '' is_valid: true key: total_onsite_add_billing_value value: time_attr_total_onsite_add_billing_value - description: '' is_valid: true key: total_onsite_add_to_wishlist_value value: time_attr_total_onsite_add_to_wishlist_value - description: '' is_valid: true key: total_onsite_form_value value: time_attr_total_onsite_form_value - description: '' is_valid: true key: total_onsite_initiate_checkout_count_value value: time_attr_total_onsite_initiate_checkout_count_value - description: '' is_valid: true key: total_onsite_on_web_cart_value value: time_attr_total_onsite_on_web_cart_value - description: '' is_valid: true key: total_onsite_on_web_detail_value value: time_attr_total_onsite_on_web_detail_value - description: '' is_valid: true key: total_onsite_shopping_value value: time_attr_total_onsite_shopping_value - description: '' is_valid: true key: total_page_event_search_value value: time_attr_total_search_value - description: '' is_valid: true key: total_page_view_content_events_value value: time_attr_total_on_web_detail_standardized_value - description: '' is_valid: true key: total_pageview value: time_attr_page_view - description: '' is_valid: true key: total_purchase value: time_attr_repetitive_active_pay - description: '' is_valid: true key: total_purchase_roas_day0 value: time_attr_active_pay_roas_d0 - description: '' is_valid: true key: total_purchase_roas_day2 value: time_attr_active_pay_roas_d2 - description: '' is_valid: true key: total_purchase_roas_day6 value: time_attr_active_pay_roas_d6 - description: '' is_valid: true key: total_purchase_value value: time_attr_total_repetitive_active_pay_value - description: '' is_valid: true key: total_purchase_value_day0 value: time_attr_total_repetitive_active_pay_value_d0 - description: '' is_valid: true key: total_purchase_value_day2 value: time_attr_total_repetitive_active_pay_value_d2 - description: '' is_valid: true key: total_purchase_value_day6 value: time_attr_total_repetitive_active_pay_value_d6 - description: '' is_valid: true key: total_ratings value: time_attr_repetitive_rate - description: '' is_valid: true key: total_ratings_value value: time_attr_total_repetitive_rate_value - description: '' is_valid: true key: total_registration value: time_attr_repetitive_active_register - description: '' is_valid: true key: total_sales_lead value: time_attr_repetitive_sales_lead - description: '' is_valid: true key: total_sales_lead_value value: time_attr_total_repetitive_sales_lead_value - description: '' is_valid: true key: total_search value: time_attr_repetitive_search - description: '' is_valid: true key: total_spend_credits value: time_attr_repetitive_spend_credits - description: '' is_valid: true key: total_spend_credits_value value: time_attr_total_repetitive_spend_credits_value - description: '' is_valid: true key: total_start_trial value: time_attr_repetitive_start_trial - description: '' is_valid: true key: total_subscribe value: time_attr_repetitive_subscribe - description: '' is_valid: true key: total_subscribe_value value: time_attr_total_repetitive_subscribe_value - description: '' is_valid: true key: total_unlock_achievement value: time_attr_repetitive_unlock_achievement - description: '' is_valid: true key: total_unlock_achievement_value value: time_attr_total_repetitive_unlock_achievement_value - description: '' is_valid: true key: total_user_registration_value value: time_attr_total_on_web_register_value - description: '' is_valid: true key: total_value_per_pageview value: time_attr_value_per_page_view - description: '' is_valid: true key: total_view_content value: time_attr_repetitive_in_app_detail_uv - description: '' is_valid: true key: total_view_content_value value: time_attr_total_repetitive_in_app_detail_uv_value - description: '' is_valid: true key: total_web_event_add_to_cart_value value: time_attr_total_on_web_cart_value - description: '' is_valid: true key: tt_playlist_visit value: tt_playlist_visit - description: '' is_valid: true key: tt_playlist_visit_rate value: tt_playlist_visit_rate - description: '' is_valid: true key: unique_ad_impression_events value: time_attr_ad_revenue - description: '' is_valid: true key: unique_custom_app_events value: time_attr_app_customized_events - description: '' is_valid: true key: unlock_achievement value: time_attr_unlock_achievement - description: '' is_valid: true key: unlock_achievement_rate value: time_attr_unlock_achievement_per_install - description: '' is_valid: true key: user_registration value: time_attr_on_web_register - description: '' is_valid: true key: user_registration_rate value: time_attr_on_web_register_per_click - description: '' is_valid: true key: value_per_ad_impression_event value: time_attr_value_per_repetitive_ad_revenue - description: '' is_valid: true key: value_per_add_billing value: time_attr_value_per_add_billing_count - description: '' is_valid: true key: value_per_button_click value: time_attr_value_per_button - description: '' is_valid: true key: value_per_checkout value: time_attr_value_per_repetitive_in_app_order - description: '' is_valid: true key: value_per_complete_payment value: time_attr_value_per_shopping - description: '' is_valid: true key: value_per_custom_app_event value: time_attr_value_per_repetitive_app_customized_events - description: '' is_valid: true key: value_per_custom_page_event value: time_attr_value_per_web_customized_events - description: '' is_valid: true key: value_per_download_start value: time_attr_value_per_download_start - description: '' is_valid: true key: value_per_form value: time_attr_value_per_form - description: '' is_valid: true key: value_per_initiate_checkout value: time_attr_value_per_initiate_checkout_count - description: '' is_valid: true key: value_per_offline_add_payment_info_event value: time_attr_value_per_offline_add_billing - description: '' is_valid: true key: value_per_offline_add_to_cart_event value: time_attr_value_per_offline_add_to_cart - description: '' is_valid: true key: value_per_offline_add_to_wishlist_event value: time_attr_value_per_offline_add_to_wishlist - description: '' is_valid: true key: value_per_offline_click_button_event value: time_attr_value_per_offline_button - description: '' is_valid: true key: value_per_offline_complete_registration_event value: time_attr_value_per_offline_register - description: '' is_valid: true key: value_per_offline_contact_event value: time_attr_value_per_offline_contact - description: '' is_valid: true key: value_per_offline_download_event value: time_attr_value_per_offline_download_start - description: '' is_valid: true key: value_per_offline_form_event value: time_attr_value_per_offline_submit_form - description: '' is_valid: true key: value_per_offline_initiate_checkout_event value: time_attr_value_per_offline_initiate_checkout - description: '' is_valid: true key: value_per_offline_place_order_event value: time_attr_value_per_offline_order - description: '' is_valid: true key: value_per_offline_search_event value: time_attr_value_per_offline_search - description: '' is_valid: true key: value_per_offline_shopping_event value: time_attr_value_per_offline_shopping - description: '' is_valid: true key: value_per_offline_subscribe_event value: time_attr_value_per_offline_subscribe - description: '' is_valid: true key: value_per_offline_view_content_event value: time_attr_value_per_offline_detail - description: '' is_valid: true key: value_per_on_web_add_to_wishlist value: time_attr_value_per_on_web_add_to_wishlist - description: '' is_valid: true key: value_per_on_web_order value: time_attr_value_per_on_web_order - description: '' is_valid: true key: value_per_on_web_subscribe value: time_attr_value_per_on_web_subscribe - description: '' is_valid: true key: value_per_online_consult value: time_attr_value_per_consult_standardized - description: '' is_valid: true key: value_per_onsite_add_billing value: time_attr_value_per_onsite_add_billing - description: '' is_valid: true key: value_per_onsite_add_to_wishlist value: time_attr_value_per_onsite_add_to_wishlist - description: '' is_valid: true key: value_per_onsite_form value: time_attr_value_per_onsite_form - description: '' is_valid: true key: value_per_onsite_initiate_checkout_count value: time_attr_value_per_onsite_initiate_checkout_count - description: '' is_valid: true key: value_per_onsite_on_web_cart value: time_attr_value_per_onsite_on_web_cart - description: '' is_valid: true key: value_per_onsite_on_web_detail value: time_attr_value_per_onsite_on_web_detail - description: '' is_valid: true key: value_per_onsite_shopping value: time_attr_value_per_onsite_shopping - description: '' is_valid: true key: value_per_page_content_view_event value: time_attr_value_per_on_web_detail_standardized - description: '' is_valid: true key: value_per_page_event_search value: time_attr_value_per_search_count - description: '' is_valid: true key: value_per_total_achieve_level value: time_attr_value_per_repetitive_update_level - description: '' is_valid: true key: value_per_total_add_to_wishlist value: time_attr_value_per_repetitive_add_to_wishlist - description: '' is_valid: true key: value_per_total_app_event_add_to_cart value: time_attr_value_per_repetitive_in_app_cart - description: '' is_valid: true key: value_per_total_complete_tutorial value: time_attr_value_per_repetitive_complete_tutorial - description: '' is_valid: true key: value_per_total_create_gamerole value: time_attr_value_per_repetitive_create_gamerole - description: '' is_valid: true key: value_per_total_create_group value: time_attr_value_per_repetitive_create_group - description: '' is_valid: true key: value_per_total_day7_retention value: time_attr_value_per_repetitive_retention_7d - description: '' is_valid: true key: value_per_total_in_app_ad_click value: time_attr_value_per_repetitive_in_app_ad_click - description: '' is_valid: true key: value_per_total_in_app_ad_impr value: time_attr_value_per_repetitive_in_app_ad_impr - description: '' is_valid: true key: value_per_total_join_group value: time_attr_value_per_repetitive_join_group - description: '' is_valid: true key: value_per_total_purchase value: time_attr_value_per_repetitive_active_pay - description: '' is_valid: true key: value_per_total_ratings value: time_attr_value_per_repetitive_rate - description: '' is_valid: true key: value_per_total_sales_lead value: time_attr_value_per_repetitive_sales_lead - description: '' is_valid: true key: value_per_total_spend_credits value: time_attr_value_per_repetitive_spend_credits - description: '' is_valid: true key: value_per_total_subscribe value: time_attr_value_per_repetitive_subscribe - description: '' is_valid: true key: value_per_total_unlock_achievement value: time_attr_value_per_repetitive_unlock_achievement - description: '' is_valid: true key: value_per_total_view_content value: time_attr_value_per_repetitive_in_app_detail_uv - description: '' is_valid: true key: value_per_user_registration value: time_attr_value_per_on_web_register - description: '' is_valid: true key: value_per_web_event_add_to_cart value: time_attr_value_per_on_web_cart - description: '' is_valid: true key: video_play_actions value: total_play - description: '' is_valid: true key: video_views_p100 value: play_over - description: '' is_valid: true key: video_views_p25 value: play_first_quartile - description: '' is_valid: true key: video_views_p50 value: play_midpoint - description: '' is_valid: true key: video_views_p75 value: play_third_quartile - description: '' is_valid: true key: video_watched_2s value: play_duration_2s - description: '' is_valid: true key: video_watched_6s value: play_duration_6s - description: '' is_valid: true key: view_content value: time_attr_in_app_detail_uv - description: '' is_valid: true key: view_content_rate value: time_attr_in_app_detail_uv_per_install - description: '' is_valid: true key: vta_app_install value: time_attr_active_show - description: '' is_valid: true key: vta_complete_payment value: time_attr_shopping_show - description: '' is_valid: true key: vta_complete_payment_roas value: time_attr_shopping_roas_show - description: '' is_valid: true key: vta_complete_payment_value value: time_attr_total_shopping_value_show - description: '' is_valid: true key: vta_conversion value: time_attr_convert_cnt_show - description: '' is_valid: true key: vta_purchase value: time_attr_active_pay_show - description: '' is_valid: true key: vta_registration value: time_attr_active_register_show - description: '' is_valid: true key: web_event_add_to_cart value: time_attr_on_web_cart - description: '' is_valid: true key: web_event_add_to_cart_rate value: time_attr_on_web_cart_per_click - description: '' is_valid: true key: website_application_approval value: time_attr_web_application_approval - description: '' is_valid: true key: website_application_approval_rate value: time_attr_web_application_approval_per_click - description: '' is_valid: true key: website_cost_per_application_approval value: time_attr_cost_per_web_application_approval - description: '' is_valid: true key: website_cost_per_cta_purchase value: time_attr_cost_per_shopping_click - description: '' is_valid: true key: website_cost_per_customize_product value: time_attr_cost_per_customizeproduct_web - description: '' is_valid: true key: website_cost_per_engaged_session value: time_attr_cost_per_engagement_session - description: '' is_valid: true key: website_cost_per_find_location value: time_attr_cost_per_findlocation_web - description: '' is_valid: true key: website_cost_per_schedule value: time_attr_cost_per_schedule_web - description: '' is_valid: true key: website_cost_per_start_trial value: time_attr_cost_per_web_start_trial - description: '' is_valid: true key: website_cost_per_submit_application value: time_attr_web_submit_application - description: '' is_valid: true key: website_cta_purchase value: time_attr_shopping_click - description: '' is_valid: true key: website_cta_purchase_roas value: time_attr_shopping_roas_click - description: '' is_valid: true key: website_cta_purchase_value value: time_attr_total_shopping_value_click - description: '' is_valid: true key: website_customize_product_rate value: time_attr_customizeproduct_per_click_web - description: '' is_valid: true key: website_engaged_session_rate value: time_attr_engagement_session_per_click - description: '' is_valid: true key: website_find_location_rate value: time_attr_findlocation_per_click_web - description: '' is_valid: true key: website_schedule_rate value: time_attr_schedule_per_click_web - description: '' is_valid: true key: website_start_trial_rate value: time_attr_web_start_trial_per_click - description: '' is_valid: true key: website_submit_application_rate value: time_attr_web_submit_application_per_click - description: '' is_valid: true key: website_total_application_approval_value value: time_attr_total_web_application_approval_value - description: '' is_valid: true key: website_total_customize_product value: time_attr_customizeproduct_web - description: '' is_valid: true key: website_total_customize_product_value value: time_attr_total_customizeproduct_value_web - description: '' is_valid: true key: website_total_engaged_session value: time_attr_engagement_session - description: '' is_valid: true key: website_total_find_location value: time_attr_findlocation_web - description: '' is_valid: true key: website_total_find_location_value value: time_attr_total_findlocation_value_web - description: '' is_valid: true key: website_total_schedule value: time_attr_schedule_web - description: '' is_valid: true key: website_total_schedule_value value: time_attr_total_schedule_value_web - description: '' is_valid: true key: website_total_start_trial value: time_attr_web_start_trial - description: '' is_valid: true key: website_total_start_trial_value value: time_attr_total_web_start_trial_value - description: '' is_valid: true key: website_total_submit_application value: time_attr_web_submit_application - description: '' is_valid: true key: website_total_submit_application_value value: time_attr_total_web_submit_application_value - description: '' is_valid: true key: website_value_per_application_approval value: time_attr_value_per_web_application_approval - description: '' is_valid: true key: website_value_per_customize_product value: time_attr_value_per_customizeproduct_web - description: '' is_valid: true key: website_value_per_find_location value: time_attr_value_per_findlocation_web - description: '' is_valid: true key: website_value_per_schedule value: time_attr_value_per_schedule_web - description: '' is_valid: true key: website_value_per_start_trial value: time_attr_value_per_web_start_trial - description: '' is_valid: true key: website_value_per_submit_application value: time_attr_value_per_web_submit_application key_format: string strict: true use_part: false validate_only: false value_format: string nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.metrics description: '' in: query name: metrics required: false x-open-field-id: 3 - description: '' in: query name: start_date required: false schema: format: date nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.start_date x-open-field-id: 4 - description: '' in: query name: end_date required: false schema: format: date nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.end_date x-open-field-id: 5 - description: '' in: query name: query_lifetime required: false schema: default: false nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.query_lifetime x-open-field-id: 6 - content: application/json: schema: nullable: false properties: ad_text_entity_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 400 minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 6 x-open-source: $.http.query.filtering.ad_text_entity_id adgroup_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) maxItems: 200 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.query.filtering.adgroup_ids call_to_action_entity_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 400 minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 7 x-open-source: $.http.query.filtering.call_to_action_entity_id campaign_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) maxItems: 200 nullable: false 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 interactive_add_on_entity_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 400 minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 8 x-open-source: $.http.query.filtering.interactive_add_on_entity_id main_material_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 400 minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 5 x-open-source: $.http.query.filtering.main_material_id main_material_types: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1836027820112065 enum_package_name: SppReportMaterialType enums: - description: '' is_valid: true key: CAROUSEL_NON_SPARK_ADS value: no_post_carousel - description: '' is_valid: true key: CAROUSEL_SPARK_ADS value: post_carousel - description: '' is_valid: true key: CATALOG_CAROUSEL value: catalog_tpl_carousel - description: '' is_valid: true key: CATALOG_MULTI_SHOW value: catalog_tpl_multi_show - description: '' is_valid: true key: CATALOG_VIDEO value: catalog_manual_video - description: '' is_valid: true key: CATALOG_VIDEO_TEMPLATE value: catalog_tpl_video - description: '' is_valid: true key: SINGLE_IMAGE_NON_SPARK_ADS value: no_post_single_image - description: '' is_valid: true key: VIDEO_NON_SPARK_ADS value: no_post_video - description: '' is_valid: true key: VIDEO_SPARK_ADS value: post_video key_format: string strict: true use_part: false validate_only: false value_format: string maxItems: 9 minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.query.filtering.main_material_types smart_plus_ad_ids: description: '' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) maxItems: 200 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.query.filtering.ad_ids 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: 7 - description: '' in: query name: sort_field required: false schema: default: spend nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1837121920475138 enum_package_name: SppReportMetrics enums: - description: '' is_valid: true key: achieve_level value: time_attr_update_level - description: '' is_valid: true key: achieve_level_rate value: time_attr_update_level_per_install - description: '' is_valid: true key: ad_impression_ad_revenue_day0 value: time_attr_total_repetitive_active_pay_value_d0_iaa - description: '' is_valid: true key: ad_impression_ad_revenue_day2 value: time_attr_total_repetitive_active_pay_value_d2_iaa - description: '' is_valid: true key: ad_impression_ad_revenue_roas_day0 value: time_attr_active_pay_roas_d0_iaa - description: '' is_valid: true key: ad_impression_ad_revenue_roas_day2 value: time_attr_active_pay_roas_d2_iaa - description: '' is_valid: true key: ad_impression_ad_revenue_roas_day6 value: time_attr_active_pay_roas_d6_iaa - description: '' is_valid: false key: ad_material_id value: ad_material_draft_id - description: '' is_valid: true key: add_billing value: time_attr_add_billing_count - description: '' is_valid: true key: add_billing_rate value: time_attr_add_billing_count_per_click - description: '' is_valid: true key: add_payment_info value: time_attr_add_payment_info - description: '' is_valid: true key: add_payment_info_rate value: time_attr_add_payment_info_per_install - description: '' is_valid: true key: add_to_wishlist value: time_attr_add_to_wishlist - description: '' is_valid: true key: add_to_wishlist_rate value: time_attr_add_to_wishlist_per_install - description: '' is_valid: true key: ads_impression_events value: time_attr_repetitive_ad_revenue - description: '' is_valid: true key: anchor_click_rate value: anchor_click_rate - description: '' is_valid: true key: anchor_clicks value: anchor_click_count - description: '' is_valid: true key: app_event_add_to_cart value: time_attr_in_app_cart - description: '' is_valid: true key: app_event_add_to_cart_rate value: time_attr_in_app_cart_per_install - description: '' is_valid: true key: app_install value: time_attr_active - description: '' is_valid: true key: average_video_play value: average_video_play - description: '' is_valid: true key: avg_value_per_pageview value: time_attr_total_page_view_value - description: '' is_valid: true key: button_click value: time_attr_button_standardized - description: '' is_valid: true key: button_click_rate value: time_attr_button_standardized_per_click - description: '' is_valid: true key: checkout value: time_attr_in_app_order - description: '' is_valid: true key: checkout_rate value: time_attr_in_app_order_per_install - description: '' is_valid: true key: clicks value: click_cnt - description: '' is_valid: true key: clicks_on_hashtag_challenge value: ies_challenge_click - description: '' is_valid: true key: clicks_on_music_disc value: ies_music_click - description: '' is_valid: true key: comments value: ad_comment - description: '' is_valid: true key: complete_payment value: time_attr_shopping - description: '' is_valid: true key: complete_payment_rate value: time_attr_shopping_per_click - description: '' is_valid: true key: complete_payment_roas value: time_attr_shopping_roas - description: '' is_valid: true key: complete_tutorial value: time_attr_complete_tutorial - description: '' is_valid: true key: complete_tutorial_rate value: time_attr_complete_tutorial_per_install - description: '' is_valid: true key: conversion value: time_attr_convert_cnt - description: '' is_valid: true key: conversion_rate_v2 value: time_attr_conversion_rate_imp - description: '' is_valid: true key: cost_per_achieve_level value: time_attr_cost_per_update_level - description: '' is_valid: true key: cost_per_add_billing value: time_attr_cost_per_add_billing_count - description: '' is_valid: true key: cost_per_add_payment_info value: time_attr_cost_per_add_payment_info - description: '' is_valid: true key: cost_per_add_to_wishlist value: time_attr_cost_per_add_to_wishlist - description: '' is_valid: true key: cost_per_app_event_add_to_cart value: time_attr_cost_per_in_app_cart - description: '' is_valid: true key: cost_per_app_install value: time_attr_active_cost - description: '' is_valid: true key: cost_per_button_click value: time_attr_cost_per_button_standardized - description: '' is_valid: true key: cost_per_checkout value: time_attr_cost_per_in_app_order - description: '' is_valid: true key: cost_per_complete_payment value: time_attr_cost_per_shopping - description: '' is_valid: true key: cost_per_complete_tutorial value: time_attr_cost_per_complete_tutorial - description: '' is_valid: true key: cost_per_conversion value: time_attr_conversion_cost - description: '' is_valid: true key: cost_per_create_gamerole value: time_attr_cost_per_create_gamerole - description: '' is_valid: true key: cost_per_create_group value: time_attr_cost_per_create_group - description: '' is_valid: true key: cost_per_cta_app_install value: time_attr_active_click_cost - description: '' is_valid: true key: cost_per_cta_conversion value: time_attr_convert_cnt_click_cost - description: '' is_valid: true key: cost_per_cta_purchase value: time_attr_active_pay_click_cost - description: '' is_valid: true key: cost_per_cta_registration value: time_attr_active_register_click_cost - description: '' is_valid: true key: cost_per_custom_app_event value: time_attr_cost_per_repetitive_app_customized_events - description: '' is_valid: true key: cost_per_custom_page_event value: time_attr_cost_per_web_customized_events - description: '' is_valid: true key: cost_per_day7_retention value: time_attr_cost_per_retention_7d - description: '' is_valid: true key: cost_per_download_start value: time_attr_cost_per_download_start - description: '' is_valid: true key: cost_per_engaged_view_through_conversion value: time_attr_convert_cnt_ev_cost - description: '' is_valid: true key: cost_per_evta_app_install value: time_attr_active_ev_cost - description: '' is_valid: true key: cost_per_evta_payments_completed value: time_attr_shopping_ev_cost - description: '' is_valid: true key: cost_per_evta_purchase value: time_attr_active_pay_ev_cost - description: '' is_valid: true key: cost_per_evta_registration value: time_attr_active_register_ev_cost - description: '' is_valid: true key: cost_per_form value: time_attr_cost_per_form - description: '' is_valid: true key: cost_per_in_app_ad_click value: time_attr_cost_per_in_app_ad_click - description: '' is_valid: true key: cost_per_in_app_ad_impr value: time_attr_cost_per_in_app_ad_impr - description: '' is_valid: true key: cost_per_initiate_checkout value: time_attr_cost_per_initiate_checkout_count - description: '' is_valid: true key: cost_per_ix_button_click_count value: cost_per_ix_button_click_count - description: '' is_valid: true key: cost_per_ix_page_view_count value: cost_per_ix_page_view_count - description: '' is_valid: true key: cost_per_ix_product_click_count value: cost_per_ix_product_click_count - description: '' is_valid: true key: cost_per_join_group value: time_attr_cost_per_join_group - description: '' is_valid: true key: cost_per_landing_page_view value: time_attr_cost_per_web_landing_page_view - description: '' is_valid: true key: cost_per_launch_app value: time_attr_cost_per_launch_app - description: '' is_valid: true key: cost_per_loan_apply value: time_attr_cost_per_loan_apply - description: '' is_valid: true key: cost_per_loan_credit value: time_attr_cost_per_loan_credit - description: '' is_valid: true key: cost_per_loan_disbursement value: time_attr_cost_per_loan_completion - description: '' is_valid: true key: cost_per_login value: time_attr_cost_per_login - description: '' is_valid: true key: cost_per_next_day_open value: time_attr_cost_per_next_day_open - description: '' is_valid: true key: cost_per_offline_add_payment_info_event value: time_attr_cost_per_offline_add_billing - description: '' is_valid: true key: cost_per_offline_add_to_cart_event value: time_attr_cost_per_offline_add_to_cart - description: '' is_valid: true key: cost_per_offline_add_to_wishlist_event value: time_attr_cost_per_offline_add_to_wishlist - description: '' is_valid: true key: cost_per_offline_click_button_event value: time_attr_cost_per_offline_button - description: '' is_valid: true key: cost_per_offline_complete_registration_event value: time_attr_cost_per_offline_register - description: '' is_valid: true key: cost_per_offline_contact_event value: time_attr_cost_per_offline_contact - description: '' is_valid: true key: cost_per_offline_download_event value: time_attr_cost_per_offline_download_start - description: '' is_valid: true key: cost_per_offline_form_event value: time_attr_cost_per_offline_submit_form - description: '' is_valid: true key: cost_per_offline_initiate_checkout_event value: time_attr_cost_per_offline_initiate_checkout - description: '' is_valid: true key: cost_per_offline_place_order_event value: time_attr_cost_per_offline_order - description: '' is_valid: true key: cost_per_offline_search_event value: time_attr_cost_per_offline_search - description: '' is_valid: true key: cost_per_offline_shopping_event value: time_attr_cost_per_offline_shopping - description: '' is_valid: true key: cost_per_offline_subscribe_event value: time_attr_cost_per_offline_subscribe - description: '' is_valid: true key: cost_per_offline_view_content_event value: time_attr_cost_per_offline_detail - description: '' is_valid: true key: cost_per_on_web_add_to_wishlist value: time_attr_cost_per_on_web_add_to_wishlist - description: '' is_valid: true key: cost_per_on_web_order value: time_attr_cost_per_on_web_order - description: '' is_valid: true key: cost_per_on_web_subscribe value: time_attr_cost_per_on_web_subscribe - description: '' is_valid: true key: cost_per_online_consult value: time_attr_cost_per_consult_standardized - description: '' is_valid: true key: cost_per_onsite_add_billing value: time_attr_cost_per_onsite_add_billing - description: '' is_valid: true key: cost_per_onsite_add_to_wishlist value: time_attr_cost_per_onsite_add_to_wishlist - description: '' is_valid: true key: cost_per_onsite_destination_visit value: time_attr_cost_per_onsite_destination_visit - description: '' is_valid: true key: cost_per_onsite_download_start value: time_attr_cost_per_onsite_download_start - description: '' is_valid: true key: cost_per_onsite_form value: time_attr_cost_per_onsite_form - description: '' is_valid: true key: cost_per_onsite_initiate_checkout_count value: time_attr_cost_per_onsite_initiate_checkout_count - description: '' is_valid: true key: cost_per_onsite_on_web_cart value: time_attr_cost_per_onsite_on_web_cart - description: '' is_valid: true key: cost_per_onsite_on_web_detail value: time_attr_cost_per_onsite_on_web_detail - description: '' is_valid: true key: cost_per_onsite_shopping value: time_attr_cost_per_onsite_shopping - description: '' is_valid: true key: cost_per_page_content_view_event value: time_attr_cost_per_on_web_detail_standardized - description: '' is_valid: true key: cost_per_page_event_search value: time_attr_cost_per_search_count - description: '' is_valid: true key: cost_per_pageview value: time_attr_cost_per_page_view - description: '' is_valid: true key: cost_per_purchase value: time_attr_active_pay_cost - description: '' is_valid: true key: cost_per_ratings value: time_attr_cost_per_rate - description: '' is_valid: true key: cost_per_registration value: time_attr_active_register_cost - description: '' is_valid: true key: cost_per_sales_lead value: time_attr_cost_per_sales_lead - description: '' is_valid: true key: cost_per_search value: time_attr_cost_per_search - description: '' is_valid: true key: cost_per_spend_credits value: time_attr_cost_per_spend_credits - description: '' is_valid: true key: cost_per_start_trial value: time_attr_cost_per_start_trial - description: '' is_valid: true key: cost_per_subscribe value: time_attr_cost_per_subscribe - description: '' is_valid: true key: cost_per_total_achieve_level value: time_attr_cost_per_repetitive_update_level - description: '' is_valid: true key: cost_per_total_add_to_wishlist value: time_attr_cost_per_repetitive_add_to_wishlist - description: '' is_valid: true key: cost_per_total_app_event_add_to_cart value: time_attr_cost_per_repetitive_in_app_cart - description: '' is_valid: true key: cost_per_total_checkout value: time_attr_cost_per_repetitive_in_app_order - description: '' is_valid: true key: cost_per_total_complete_tutorial value: time_attr_cost_per_repetitive_complete_tutorial - description: '' is_valid: true key: cost_per_total_create_gamerole value: time_attr_cost_per_repetitive_create_gamerole - description: '' is_valid: true key: cost_per_total_create_group value: time_attr_cost_per_repetitive_create_group - description: '' is_valid: true key: cost_per_total_day7_retention value: time_attr_cost_per_repetitive_retention_7d - description: '' is_valid: true key: cost_per_total_in_app_ad_click value: time_attr_cost_per_repetitive_in_app_ad_click - description: '' is_valid: true key: cost_per_total_in_app_ad_impr value: time_attr_cost_per_repetitive_in_app_ad_impr - description: '' is_valid: true key: cost_per_total_join_group value: time_attr_cost_per_repetitive_join_group - description: '' is_valid: true key: cost_per_total_launch_app value: time_attr_cost_per_repetitive_launch_app - description: '' is_valid: true key: cost_per_total_loan_apply value: time_attr_cost_per_repetitive_loan_apply - description: '' is_valid: true key: cost_per_total_loan_credit value: time_attr_cost_per_repetitive_loan_credit - description: '' is_valid: true key: cost_per_total_loan_disbursement value: time_attr_cost_per_repetitive_loan_completion - description: '' is_valid: true key: cost_per_total_login value: time_attr_cost_per_repetitive_login - description: '' is_valid: true key: cost_per_total_next_day_open value: time_attr_cost_per_repetitive_next_day_open - description: '' is_valid: true key: cost_per_total_purchase value: time_attr_cost_per_repetitive_active_pay - description: '' is_valid: true key: cost_per_total_ratings value: time_attr_cost_per_repetitive_rate - description: '' is_valid: true key: cost_per_total_registration value: time_attr_cost_per_repetitive_active_register - description: '' is_valid: true key: cost_per_total_sales_lead value: time_attr_cost_per_repetitive_sales_lead - description: '' is_valid: true key: cost_per_total_search value: time_attr_cost_per_repetitive_search - description: '' is_valid: true key: cost_per_total_spend_credits value: time_attr_cost_per_repetitive_spend_credits - description: '' is_valid: true key: cost_per_total_start_trial value: time_attr_cost_per_repetitive_start_trial - description: '' is_valid: true key: cost_per_total_subscribe value: time_attr_cost_per_repetitive_subscribe - description: '' is_valid: true key: cost_per_total_unlock_achievement value: time_attr_cost_per_repetitive_unlock_achievement - description: '' is_valid: true key: cost_per_total_view_content value: time_attr_cost_per_repetitive_in_app_detail_uv - description: '' is_valid: true key: cost_per_unique_ad_impression_event value: time_attr_cost_per_ad_revenue - description: '' is_valid: true key: cost_per_unique_custom_app_event value: time_attr_cost_per_app_customized_events - description: '' is_valid: true key: cost_per_unlock_achievement value: time_attr_cost_per_unlock_achievement - description: '' is_valid: true key: cost_per_user_registration value: time_attr_cost_per_on_web_register - description: '' is_valid: true key: cost_per_view_content value: time_attr_cost_per_in_app_detail_uv - description: '' is_valid: true key: cost_per_vta_app_install value: time_attr_active_show_cost - description: '' is_valid: true key: cost_per_vta_conversion value: time_attr_convert_cnt_show_cost - description: '' is_valid: true key: cost_per_vta_payments_completed value: time_attr_cost_per_shopping_show - description: '' is_valid: true key: cost_per_vta_purchase value: time_attr_active_pay_show_cost - description: '' is_valid: true key: cost_per_vta_registration value: time_attr_active_register_show_cost - description: '' is_valid: true key: cost_per_web_event_add_to_cart value: time_attr_cost_per_on_web_cart - description: '' is_valid: true key: cost_pre_ad_impression_event value: time_attr_cost_per_repetitive_ad_revenue - description: '' is_valid: true key: cost_total_add_payment_info value: time_attr_cost_per_repetitive_add_payment_info - description: '' is_valid: true key: countdown_sticker_recall_clicks value: recall_message_click_cnt - description: '' is_valid: true key: cpc value: cpc - description: '' is_valid: true key: cpm value: cpm - description: '' is_valid: true key: create_gamerole value: time_attr_create_gamerole - description: '' is_valid: true key: create_gamerole_rate value: time_attr_create_gamerole_per_install - description: '' is_valid: true key: create_group value: time_attr_create_group - description: '' is_valid: true key: create_group_rate value: time_attr_create_group_per_install - description: '' is_valid: true key: cta_app_install value: time_attr_active_click - description: '' is_valid: true key: cta_conversion value: time_attr_convert_cnt_click - description: '' is_valid: true key: cta_purchase value: time_attr_active_pay_click - description: '' is_valid: true key: cta_registration value: time_attr_active_register_click - description: '' is_valid: true key: ctr value: ctr - description: '' is_valid: true key: custom_app_event_rate value: time_attr_app_customized_events_per_install - description: '' is_valid: true key: custom_app_events value: time_attr_repetitive_app_customized_events - description: '' is_valid: true key: custom_app_events_value value: time_attr_total_repetitive_app_customized_events_value - description: '' is_valid: true key: custom_page_event_rate value: time_attr_web_customized_events_per_click - description: '' is_valid: true key: custom_page_events value: time_attr_web_customized_events - description: '' is_valid: true key: custom_page_events_value value: time_attr_total_web_customized_events_value - description: '' is_valid: true key: customized_ad_impression_event_rate value: time_attr_ad_revenue_per_install - description: '' is_valid: true key: day7_retention value: time_attr_retention_7d - description: '' is_valid: true key: day7_retention_rate value: time_attr_retention_7d_per_install - description: '' is_valid: true key: download_start value: time_attr_download_start - description: '' is_valid: true key: download_start_rate value: time_attr_download_start_per_click - description: '' is_valid: true key: duet_clicks value: duet_click_cnt - description: '' is_valid: true key: engaged_view value: engaged_view - description: '' is_valid: true key: engaged_view_15s value: engaged_view_15s - description: '' is_valid: true key: engaged_view_through_conversions value: time_attr_convert_cnt_ev - description: '' is_valid: true key: engagement_rate value: total_engagement_rate - description: '' is_valid: true key: engagements value: total_engagement - description: '' is_valid: true key: evta_app_install value: time_attr_active_ev - description: '' is_valid: true key: evta_payments_completed value: time_attr_shopping_ev - description: '' is_valid: true key: evta_purchase value: time_attr_active_pay_ev - description: '' is_valid: true key: evta_registration value: time_attr_active_register_ev - description: '' is_valid: true key: follows value: ad_net_follow - description: '' is_valid: true key: form value: time_attr_form - description: '' is_valid: true key: form_rate value: time_attr_form_per_click - description: '' is_valid: true key: gross_impressions value: gross_show_count - description: '' is_valid: true key: impressions value: show_cnt - description: '' is_valid: true key: in_app_ad_click value: time_attr_in_app_ad_click - description: '' is_valid: true key: in_app_ad_click_rate value: time_attr_in_app_ad_click_per_install - description: '' is_valid: true key: in_app_ad_impr value: time_attr_in_app_ad_impr - description: '' is_valid: true key: in_app_ad_impr_rate value: time_attr_in_app_ad_impr_per_install - description: '' is_valid: true key: initiate_checkout value: time_attr_initiate_checkout_count - description: '' is_valid: true key: initiate_checkout_rate value: time_attr_initiate_checkout_count_per_click - description: '' is_valid: true key: interactive_add_on_activity_clicks value: additional_format_interactive_click_count - description: '' is_valid: true key: interactive_add_on_destination_clicks value: additional_format_outbound_click_count - description: '' is_valid: true key: interactive_add_on_impressions value: additional_format_show_count - description: '' is_valid: true key: interactive_add_on_option_a_clicks value: additional_format_option_a_click_count - description: '' is_valid: true key: interactive_add_on_option_b_clicks value: additional_format_option_b_click_count - description: '' is_valid: true key: ix_average_video_play value: ix_video_duration_avg - description: '' is_valid: true key: ix_button_click_count value: ix_button_click_count - description: '' is_valid: true key: ix_button_click_count_rate value: ix_button_click_count_per_click - description: '' is_valid: true key: ix_page_duration_avg value: ix_page_duration_avg - description: '' is_valid: true key: ix_page_view_count value: ix_page_view_count - description: '' is_valid: true key: ix_page_view_count_rate value: ix_page_view_count_per_click - description: '' is_valid: true key: ix_page_viewrate_avg value: ix_page_viewrate_avg - description: '' is_valid: true key: ix_product_click_count value: ix_product_click_count - description: '' is_valid: true key: ix_product_click_count_rate value: ix_product_click_count_per_click - description: '' is_valid: true key: ix_video_views value: ix_video_view_count - description: '' is_valid: true key: ix_video_views_p100 value: ix_video_view_100pct - description: '' is_valid: true key: ix_video_views_p25 value: ix_video_view_25pct - description: '' is_valid: true key: ix_video_views_p50 value: ix_video_view_50pct - description: '' is_valid: true key: ix_video_views_p75 value: ix_video_view_75pct - description: '' is_valid: true key: join_group value: time_attr_join_group - description: '' is_valid: true key: join_group_rate value: time_attr_join_group_per_install - description: '' is_valid: true key: landing_page_view_rate value: time_attr_web_landing_page_view_per_click - description: '' is_valid: true key: launch_app value: time_attr_launch_app - description: '' is_valid: true key: launch_app_rate value: time_attr_launch_app_per_install - description: '' is_valid: true key: likes value: ad_net_like - description: '' is_valid: true key: live_effective_views value: live_effective_play_count - description: '' is_valid: true key: live_product_clicks value: live_product_click_count - description: '' is_valid: true key: live_views value: live_play_count - description: '' is_valid: true key: loan_apply value: time_attr_loan_apply - description: '' is_valid: true key: loan_apply_rate value: time_attr_loan_apply_per_install - description: '' is_valid: true key: loan_credit value: time_attr_loan_credit - description: '' is_valid: true key: loan_credit_rate value: time_attr_loan_credit_per_install - description: '' is_valid: true key: loan_disbursement value: time_attr_loan_completion - description: '' is_valid: true key: loan_disbursement_rate value: time_attr_loan_completion_per_install - description: '' is_valid: true key: login value: time_attr_login - description: '' is_valid: true key: login_rate value: time_attr_login_per_install - description: '' is_valid: false key: material_primary_status value: material_primary_status - description: '' is_valid: false key: material_second_status_list value: material_second_status_list - description: '' is_valid: true key: messaging_conversation_rate_instant_messaging_app value: time_attr_ctm_ima_messaging_per_click - description: '' is_valid: true key: messaging_conversation_rate_tiktok_direct_message value: time_attr_nonshop_onsite_tt_messaging_per_click - description: '' is_valid: true key: messaging_cost_per_conversation_instant_messaging_app value: time_attr_cost_per_ctm_ima_messaging - description: '' is_valid: true key: messaging_cost_per_conversation_tiktok_direct_message value: time_attr_cost_per_nonshop_onsite_tt_messaging - description: '' is_valid: true key: messaging_total_conversation_instant_messaging_app value: time_attr_ctm_ima_messaging_count - description: '' is_valid: true key: messaging_total_conversation_tiktok_direct_message value: time_attr_nonshop_onsite_tt_messaging - description: '' is_valid: true key: next_day_open value: time_attr_next_day_open - description: '' is_valid: true key: next_day_open_rate value: time_attr_next_day_open_per_install - description: '' is_valid: true key: offline_add_payment_info_event_rate value: time_attr_offline_add_billing_per_click - description: '' is_valid: true key: offline_add_payment_info_events value: time_attr_offline_add_billing - description: '' is_valid: true key: offline_add_payment_info_events_value value: time_attr_total_offline_add_billing_value - description: '' is_valid: true key: offline_add_to_cart_event_rate value: time_attr_offline_add_to_cart_per_click - description: '' is_valid: true key: offline_add_to_cart_events value: time_attr_offline_add_to_cart - description: '' is_valid: true key: offline_add_to_cart_events_value value: time_attr_total_offline_add_to_cart_value - description: '' is_valid: true key: offline_add_to_wishlist_event_rate value: time_attr_offline_add_to_wishlist_per_click - description: '' is_valid: true key: offline_add_to_wishlist_events value: time_attr_offline_add_to_wishlist - description: '' is_valid: true key: offline_add_to_wishlist_events_value value: time_attr_total_offline_add_to_wishlist_value - description: '' is_valid: true key: offline_application_approval value: time_attr_offline_application_approval - description: '' is_valid: true key: offline_application_approval_rate value: time_attr_offline_application_approval_per_click - description: '' is_valid: true key: offline_click_button_event_rate value: time_attr_offline_button_per_click - description: '' is_valid: true key: offline_click_button_events value: time_attr_offline_button - description: '' is_valid: true key: offline_click_button_events_value value: time_attr_total_offline_button_value - description: '' is_valid: true key: offline_complete_registration_event_rate value: time_attr_offline_register_per_click - description: '' is_valid: true key: offline_complete_registration_events value: time_attr_offline_register - description: '' is_valid: true key: offline_complete_registration_events_value value: time_attr_total_offline_register_value - description: '' is_valid: true key: offline_contact_event_rate value: time_attr_offline_contact_per_click - description: '' is_valid: true key: offline_contact_events value: time_attr_offline_contact - description: '' is_valid: true key: offline_contact_events_value value: time_attr_total_offline_contact_value - description: '' is_valid: true key: offline_cost_per_application_approval value: time_attr_cost_per_offline_application_approval - description: '' is_valid: true key: offline_cost_per_crm_event value: time_attr_cost_per_crm_events - description: '' is_valid: true key: offline_cost_per_custom_event value: time_attr_cost_per_offline_customized_events - description: '' is_valid: true key: offline_cost_per_customize_product value: time_attr_cost_per_customizeproduct_offline - description: '' is_valid: true key: offline_cost_per_find_location value: time_attr_cost_per_findlocation_offline - description: '' is_valid: true key: offline_cost_per_preferred_lead value: time_attr_cost_per_preferred_leads - description: '' is_valid: true key: offline_cost_per_schedule value: time_attr_cost_per_schedule_offline - description: '' is_valid: true key: offline_cost_per_start_trial value: time_attr_offline_start_trial_per_click - description: '' is_valid: true key: offline_cost_per_submit_application value: time_attr_cost_per_offline_submit_application - description: '' is_valid: true key: offline_crm_event_rate value: time_attr_crm_events_per_click - description: '' is_valid: true key: offline_crm_event_value value: time_attr_total_crm_events_value - description: '' is_valid: true key: offline_custom_event_rate value: time_attr_offline_customized_events_per_click - description: '' is_valid: true key: offline_customize_product_rate value: time_attr_customizeproduct_per_click_offline - description: '' is_valid: true key: offline_download_event_rate value: time_attr_offline_download_start_per_click - description: '' is_valid: true key: offline_download_events value: time_attr_offline_download_start - description: '' is_valid: true key: offline_download_events_value value: time_attr_total_offline_download_start_value - description: '' is_valid: true key: offline_find_location_rate value: time_attr_findlocation_per_click_offline - description: '' is_valid: true key: offline_form_event_rate value: time_attr_offline_submit_form_per_click - description: '' is_valid: true key: offline_form_events value: time_attr_offline_submit_form - description: '' is_valid: true key: offline_form_events_value value: time_attr_total_offline_submit_form_value - description: '' is_valid: true key: offline_initiate_checkout_event_rate value: time_attr_offline_initiate_checkout_per_click - description: '' is_valid: true key: offline_initiate_checkout_events value: time_attr_offline_initiate_checkout - description: '' is_valid: true key: offline_initiate_checkout_events_value value: time_attr_total_offline_initiate_checkout_value - description: '' is_valid: true key: offline_place_order_event_rate value: time_attr_offline_order_per_click - description: '' is_valid: true key: offline_place_order_events value: time_attr_offline_order - description: '' is_valid: true key: offline_place_order_events_value value: time_attr_total_offline_order_value - description: '' is_valid: true key: offline_preferred_lead_rate value: time_attr_preferred_leads_per_click - description: '' is_valid: true key: offline_preferred_leads value: time_attr_preferred_leads_cnt - description: '' is_valid: true key: offline_schedule_rate value: time_attr_schedule_per_click_offline - description: '' is_valid: true key: offline_search_event_rate value: time_attr_offline_search_per_click - description: '' is_valid: true key: offline_search_events value: time_attr_offline_search - description: '' is_valid: true key: offline_search_events_value value: time_attr_total_offline_search_value - description: '' is_valid: true key: offline_shopping_event_rate value: time_attr_offline_shopping_per_click - description: '' is_valid: true key: offline_shopping_events value: time_attr_offline_shopping - description: '' is_valid: true key: offline_shopping_events_roas value: time_attr_offline_shopping_roas - description: '' is_valid: true key: offline_shopping_events_value value: time_attr_total_offline_shopping_value - description: '' is_valid: true key: offline_start_trial_rate value: time_attr_cost_per_offline_start_trial - description: '' is_valid: true key: offline_submit_application_rate value: time_attr_offline_submit_application_per_click - description: '' is_valid: true key: offline_subscribe_event_rate value: time_attr_offline_subscribe_per_click - description: '' is_valid: true key: offline_subscribe_events value: time_attr_offline_subscribe - description: '' is_valid: true key: offline_subscribe_events_value value: time_attr_total_offline_subscribe_value - description: '' is_valid: true key: offline_total_application_approval_value value: time_attr_total_offline_application_approval_value - description: '' is_valid: true key: offline_total_crm_events value: time_attr_crm_events - description: '' is_valid: true key: offline_total_custom_event_value value: time_attr_total_offline_customized_events_value - description: '' is_valid: true key: offline_total_custom_events value: time_attr_offline_customized_events - description: '' is_valid: true key: offline_total_customize_product value: time_attr_customizeproduct_offline - description: '' is_valid: true key: offline_total_customize_product_value value: time_attr_total_customizeproduct_value_offline - description: '' is_valid: true key: offline_total_find_location value: time_attr_findlocation_offline - description: '' is_valid: true key: offline_total_find_location_value value: time_attr_total_findlocation_value_offline - description: '' is_valid: true key: offline_total_schedule value: time_attr_schedule_offline - description: '' is_valid: true key: offline_total_schedule_value value: time_attr_total_schedule_value_offline - description: '' is_valid: true key: offline_total_start_trial value: time_attr_offline_start_trial - description: '' is_valid: true key: offline_total_start_trial_value value: time_attr_total_offline_start_trial_value - description: '' is_valid: true key: offline_total_submit_application value: time_attr_offline_submit_application - description: '' is_valid: true key: offline_total_submit_application_value value: time_attr_total_offline_submit_application_value - description: '' is_valid: true key: offline_value_per_application_approval value: time_attr_value_per_offline_application_approval - description: '' is_valid: true key: offline_value_per_crm_event value: time_attr_value_per_crm_events - description: '' is_valid: true key: offline_value_per_custom_event value: time_attr_value_per_offline_customized_events - description: '' is_valid: true key: offline_value_per_customize_product value: time_attr_value_per_customizeproduct_offline - description: '' is_valid: true key: offline_value_per_find_location value: time_attr_value_per_findlocation_offline - description: '' is_valid: true key: offline_value_per_schedule value: time_attr_value_per_schedule_offline - description: '' is_valid: true key: offline_value_per_start_trial value: time_attr_value_per_offline_start_trial - description: '' is_valid: true key: offline_value_per_submit_application value: time_attr_value_per_offline_submit_application - description: '' is_valid: true key: offline_view_content_event_rate value: time_attr_offline_detail_per_click - description: '' is_valid: true key: offline_view_content_events value: time_attr_offline_detail - description: '' is_valid: true key: offline_view_content_events_value value: time_attr_total_offline_detail_value - description: '' is_valid: true key: on_web_add_to_wishlist value: time_attr_on_web_add_to_wishlist - description: '' is_valid: true key: on_web_add_to_wishlist_per_click value: time_attr_on_web_add_to_wishlist_per_click - description: '' is_valid: true key: on_web_order value: time_attr_on_web_order - description: '' is_valid: true key: on_web_order_rate value: time_attr_on_web_order_per_click - description: '' is_valid: true key: on_web_subscribe value: time_attr_on_web_subscribe - description: '' is_valid: true key: on_web_subscribe_per_click value: time_attr_on_web_subscribe_per_click - description: '' is_valid: true key: online_consult value: time_attr_consult_standardized - description: '' is_valid: true key: online_consult_rate value: time_attr_consult_standardized_per_click - description: '' is_valid: true key: onsite_active_by_conversion_time value: nonshop_onsite_active - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_calendar_day0 value: time_attr_total_nonshop_onsite_ad_revenue_value_cald0 - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_calendar_day13 value: time_attr_total_nonshop_onsite_ad_revenue_value_cald13 - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_calendar_day6 value: time_attr_total_nonshop_onsite_ad_revenue_value_cald6 - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_day0 value: time_attr_total_nonshop_onsite_ad_revenue_value_d0 - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_day13 value: time_attr_total_nonshop_onsite_ad_revenue_value_d13 - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_day6 value: time_attr_total_nonshop_onsite_ad_revenue_value_d6 - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_roas_calendar_day0 value: time_attr_nonshop_onsite_ad_revenue_roas_cald0 - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_roas_calendar_day13 value: time_attr_nonshop_onsite_ad_revenue_roas_cald13 - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_roas_calendar_day6 value: time_attr_nonshop_onsite_ad_revenue_roas_cald6 - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_roas_day0 value: time_attr_nonshop_onsite_ad_revenue_roas_d0 - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_roas_day13 value: time_attr_nonshop_onsite_ad_revenue_roas_d13 - description: '' is_valid: true key: onsite_ad_impression_ad_revenue_roas_day6 value: time_attr_nonshop_onsite_ad_revenue_roas_d6 - description: '' is_valid: true key: onsite_ad_impression_rate value: time_attr_nonshop_onsite_ad_revenue_per_click - description: '' is_valid: true key: onsite_add_billing value: time_attr_onsite_add_billing - description: '' is_valid: true key: onsite_add_billing_rate value: time_attr_onsite_add_billing_per_click - description: '' is_valid: true key: onsite_add_to_cart_rate value: time_attr_nonshop_onsite_on_web_cart_per_click - description: '' is_valid: true key: onsite_add_to_wishlist value: time_attr_onsite_add_to_wishlist - description: '' is_valid: true key: onsite_add_to_wishlist_rate value: time_attr_onsite_add_to_wishlist_per_click - description: '' is_valid: true key: onsite_checkout_initiation_rate value: time_attr_nonshop_onsite_initiate_checkout_count_per_click - description: '' is_valid: true key: onsite_cost_per_active value: time_attr_cost_per_nonshop_onsite_active - description: '' is_valid: true key: onsite_cost_per_active_by_conversion_time value: cost_per_nonshop_onsite_active - description: '' is_valid: true key: onsite_cost_per_add_to_cart value: time_attr_cost_per_nonshop_onsite_on_web_cart - description: '' is_valid: true key: onsite_cost_per_checkout_initiation value: time_attr_cost_per_nonshop_onsite_initiate_checkout_count - description: '' is_valid: true key: onsite_cost_per_product_details_page_view value: time_attr_cost_per_nonshop_onsite_on_web_detail - description: '' is_valid: true key: onsite_cost_per_purchase value: time_attr_cost_per_nonshop_onsite_shopping - description: '' is_valid: true key: onsite_cost_per_total_ad_impression value: time_attr_cost_per_nonshop_onsite_ad_revenue - description: '' is_valid: true key: onsite_cost_per_total_launch value: time_attr_cost_per_nonshop_onsite_launch_app - description: '' is_valid: true key: onsite_cost_per_total_registration value: time_attr_cost_per_nonshop_onsite_active_register - description: '' is_valid: true key: onsite_cost_per_unique_ad_impression value: time_attr_cost_per_unique_nonshop_onsite_ad_revenue - description: '' is_valid: true key: onsite_cost_per_unique_launch value: time_attr_cost_per_unique_nonshop_onsite_launch_app - description: '' is_valid: true key: onsite_cost_per_unique_purchase value: time_attr_cost_per_unique_nonshop_onsite_shopping - description: '' is_valid: true key: onsite_cost_per_unique_registration value: time_attr_cost_per_unique_nonshop_onsite_active_register - description: '' is_valid: true key: onsite_destination_visit_rate value: time_attr_onsite_destination_visit_per_click - description: '' is_valid: true key: onsite_destination_visits value: time_attr_onsite_destination_visit - description: '' is_valid: true key: onsite_download_start value: time_attr_onsite_download_start - description: '' is_valid: true key: onsite_download_start_rate value: time_attr_onsite_download_start_per_click - description: '' is_valid: true key: onsite_form value: time_attr_onsite_form - description: '' is_valid: true key: onsite_form_rate value: time_attr_onsite_form_per_click - description: '' is_valid: true key: onsite_initiate_checkout_count value: time_attr_onsite_initiate_checkout_count - description: '' is_valid: true key: onsite_initiate_checkout_count_rate value: time_attr_onsite_initiate_checkout_count_per_click - description: '' is_valid: true key: onsite_launch_rate value: time_attr_nonshop_onsite_launch_app_per_click - description: '' is_valid: true key: onsite_on_web_cart value: time_attr_onsite_on_web_cart - description: '' is_valid: true key: onsite_on_web_cart_rate value: time_attr_onsite_on_web_cart_per_click - description: '' is_valid: true key: onsite_on_web_detail value: time_attr_onsite_on_web_detail - description: '' is_valid: true key: onsite_on_web_detail_rate value: time_attr_onsite_on_web_detail_per_click - description: '' is_valid: true key: onsite_product_details_page_view_rate value: time_attr_nonshop_onsite_on_web_detail_per_click - description: '' is_valid: true key: onsite_purchase_rate value: time_attr_nonshop_onsite_shopping_per_click - description: '' is_valid: true key: onsite_purchase_roas_calendar_day0 value: time_attr_nonshop_onsite_shopping_roas_cald0 - description: '' is_valid: true key: onsite_purchase_roas_calendar_day13 value: time_attr_nonshop_onsite_shopping_roas_cald13 - description: '' is_valid: true key: onsite_purchase_roas_calendar_day6 value: time_attr_nonshop_onsite_shopping_roas_cald6 - description: '' is_valid: true key: onsite_purchase_roas_day0 value: time_attr_nonshop_onsite_shopping_roas_d0 - description: '' is_valid: true key: onsite_purchase_roas_day13 value: time_attr_nonshop_onsite_shopping_roas_d13 - description: '' is_valid: true key: onsite_purchase_roas_day6 value: time_attr_nonshop_onsite_shopping_roas_d6 - description: '' is_valid: true key: onsite_purchase_value_calendar_day0 value: time_attr_total_nonshop_onsite_shopping_value_cald0 - description: '' is_valid: true key: onsite_purchase_value_calendar_day13 value: time_attr_total_nonshop_onsite_shopping_value_cald13 - description: '' is_valid: true key: onsite_purchase_value_calendar_day6 value: time_attr_total_nonshop_onsite_shopping_value_cald6 - description: '' is_valid: true key: onsite_purchase_value_day0 value: time_attr_total_nonshop_onsite_shopping_value_d0 - description: '' is_valid: true key: onsite_purchase_value_day13 value: time_attr_total_nonshop_onsite_shopping_value_d13 - description: '' is_valid: true key: onsite_purchase_value_day6 value: time_attr_total_nonshop_onsite_shopping_value_d6 - description: '' is_valid: true key: onsite_purchases_roas value: time_attr_nonshop_onsite_shopping_roas - description: '' is_valid: true key: onsite_registration_rate value: time_attr_nonshop_onsite_active_register_per_click - description: '' is_valid: true key: onsite_shopping value: time_attr_onsite_shopping - description: '' is_valid: true key: onsite_shopping_rate value: time_attr_onsite_shopping_per_click - description: '' is_valid: true key: onsite_shopping_roas value: time_attr_onsite_shopping_roas - description: '' is_valid: true key: onsite_total_active value: time_attr_nonshop_onsite_active - description: '' is_valid: true key: onsite_total_ad_impression value: time_attr_nonshop_onsite_ad_revenue - description: '' is_valid: true key: onsite_total_ad_impression_value value: time_attr_nonshop_onsite_ad_revenue_value - description: '' is_valid: true key: onsite_total_add_to_cart value: time_attr_nonshop_onsite_on_web_cart - description: '' is_valid: true key: onsite_total_add_to_cart_value value: time_attr_total_nonshop_onsite_on_web_cart_value - description: '' is_valid: true key: onsite_total_checkout_initiation value: time_attr_nonshop_onsite_initiate_checkout_count - description: '' is_valid: true key: onsite_total_checkout_initiation_value value: time_attr_total_nonshop_onsite_initiate_checkout_count_value - description: '' is_valid: true key: onsite_total_filtered_out_form_submission value: ix_filtered_out_leads - description: '' is_valid: true key: onsite_total_launch value: time_attr_nonshop_onsite_launch_app - description: '' is_valid: true key: onsite_total_product_details_page_view value: time_attr_nonshop_onsite_on_web_detail - description: '' is_valid: true key: onsite_total_product_details_page_view_value value: time_attr_total_nonshop_onsite_on_web_detail_value - description: '' is_valid: true key: onsite_total_purchase value: time_attr_nonshop_onsite_shopping - description: '' is_valid: true key: onsite_total_purchase_value value: time_attr_total_nonshop_onsite_shopping_value - description: '' is_valid: true key: onsite_total_registration value: time_attr_nonshop_onsite_active_register - description: '' is_valid: true key: onsite_unique_ad_impression value: time_attr_unique_nonshop_onsite_ad_revenue - description: '' is_valid: true key: onsite_unique_launch value: time_attr_unique_nonshop_onsite_launch_app - description: '' is_valid: true key: onsite_unique_purchase value: time_attr_unique_nonshop_onsite_shopping - description: '' is_valid: true key: onsite_unique_registration value: time_attr_unique_nonshop_onsite_active_register - description: '' is_valid: true key: onsite_value_per_ad_impression_value value: time_attr_value_per_nonshop_onsite_ad_revenue - description: '' is_valid: true key: onsite_value_per_add_to_cart value: time_attr_value_per_nonshop_onsite_on_web_cart - description: '' is_valid: true key: onsite_value_per_checkout_initiation value: time_attr_value_per_nonshop_onsite_initiate_checkout_count - description: '' is_valid: true key: onsite_value_per_product_details_page_view value: time_attr_value_per_nonshop_onsite_on_web_detail - description: '' is_valid: true key: onsite_value_per_purchase value: time_attr_value_per_nonshop_onsite_shopping - description: '' is_valid: false key: operation_status value: aco_opt_status - description: '' is_valid: true key: page_content_view_event_rate value: time_attr_on_web_detail_standardized_per_click - description: '' is_valid: true key: page_content_view_events value: time_attr_on_web_detail_standardized - description: '' is_valid: true key: page_event_search value: time_attr_search_count - description: '' is_valid: true key: page_event_search_rate value: time_attr_search_count_per_click - description: '' is_valid: true key: pageview_rate value: time_attr_page_view_per_click - description: '' is_valid: true key: paid_engaged_view value: engaged_view_billed_vv - description: '' is_valid: true key: paid_engaged_view_15s value: engaged_view_15s_billed_vv - description: '' is_valid: true key: paid_engagement_engaged_view value: engaged_view_billed_engagement - description: '' is_valid: true key: paid_engagement_engaged_view_15s value: engaged_view_15s_billed_engagement - description: '' is_valid: true key: playable_download_button_click_count value: playable_cta_click - description: '' is_valid: true key: playable_first_scene_view_count value: playable_first_scene_view_count - description: '' is_valid: true key: playable_page_view_count value: playable_page_view_count - description: '' is_valid: true key: playable_second_scene_view_count value: playable_second_scene_view_count - description: '' is_valid: true key: playable_third_scene_view_count value: playable_third_scene_view_count - description: '' is_valid: true key: product_clicks value: product_click_cnt - description: '' is_valid: true key: product_cta value: stats_product_ctr - description: '' is_valid: true key: product_impressions value: product_show_cnt - description: '' is_valid: true key: profile_visits value: ad_home_visited - description: '' is_valid: true key: profile_visits_rate value: ad_home_visited_rate - description: '' is_valid: true key: purchase value: time_attr_active_pay - description: '' is_valid: true key: purchase_rate value: time_attr_active_pay_rate - description: '' is_valid: true key: ratings value: time_attr_rate - description: '' is_valid: true key: ratings_rate value: time_attr_rate_per_install - description: '' is_valid: true key: real_time_app_install value: active - description: '' is_valid: true key: real_time_app_install_cost value: active_cost - description: '' is_valid: true key: real_time_conversion value: convert_cnt - description: '' is_valid: true key: real_time_conversion_rate_v2 value: conversion_rate_imp - description: '' is_valid: true key: real_time_cost_per_conversion value: conversion_cost - description: '' is_valid: true key: registration value: time_attr_active_register - description: '' is_valid: true key: registration_rate value: time_attr_active_register_rate - description: '' is_valid: true key: sales_lead value: time_attr_sales_lead - description: '' is_valid: true key: sales_lead_rate value: time_attr_sales_lead_per_install - description: '' is_valid: true key: search value: time_attr_search - description: '' is_valid: true key: search_rate value: time_attr_search_per_install - description: '' is_valid: true key: shares value: ad_share - description: '' is_valid: true key: shop_gross_revenue_by_order_submission value: total_onsite_shopping_value - description: '' is_valid: true key: shop_total_items_purchased value: time_attr_onsite_shopping_quantity - description: '' is_valid: true key: shop_total_purchase_by_order_submission value: onsite_shopping - description: '' is_valid: true key: single_image_ctr value: single_image_ctr - description: '' is_valid: true key: single_image_impression_rate value: single_image_show_rate - description: '' is_valid: true key: single_image_impressions value: single_image_show_count - description: '' is_valid: true key: skan_achieve_level value: skan_update_level - description: '' is_valid: true key: skan_achieve_level_rate value: skan_update_level_per_install - description: '' is_valid: true key: skan_add_payment_info value: skan_add_payment_info - description: '' is_valid: true key: skan_add_payment_info_rate value: skan_add_payment_info_per_install - description: '' is_valid: true key: skan_add_to_cart value: skan_in_app_cart - description: '' is_valid: true key: skan_add_to_cart_rate value: skan_in_app_cart_per_install - description: '' is_valid: true key: skan_add_to_wishlist value: skan_add_to_wishlist - description: '' is_valid: true key: skan_add_to_wishlist_rate value: skan_add_to_wishlist_per_install - description: '' is_valid: true key: skan_app_install value: skan_active - description: '' is_valid: true key: skan_app_install_withheld value: skan_active_withheld - description: '' is_valid: true key: skan_checkout value: skan_in_app_order - description: '' is_valid: true key: skan_checkout_rate value: skan_in_app_order_per_install - description: '' is_valid: true key: skan_complete_tutorial value: skan_complete_tutorial - description: '' is_valid: true key: skan_complete_tutorial_rate value: skan_complete_tutorial_per_install - description: '' is_valid: true key: skan_conversion value: skan_convert_cnt - description: '' is_valid: true key: skan_conversion_rate_v2 value: skan_conversion_rate_imp - description: '' is_valid: true key: skan_cost_per_achieve_level value: cost_per_skan_update_level - description: '' is_valid: true key: skan_cost_per_add_payment_info value: cost_per_skan_add_payment_info - description: '' is_valid: true key: skan_cost_per_add_to_cart value: cost_per_skan_in_app_cart - description: '' is_valid: true key: skan_cost_per_add_to_wishlist value: cost_per_skan_add_to_wishlist - description: '' is_valid: true key: skan_cost_per_app_install value: cost_per_skan_active - description: '' is_valid: true key: skan_cost_per_checkout value: cost_per_skan_in_app_order - description: '' is_valid: true key: skan_cost_per_complete_tutorial value: cost_per_skan_complete_tutorial - description: '' is_valid: true key: skan_cost_per_conversion value: skan_conversion_cost - description: '' is_valid: true key: skan_cost_per_create_gamerole value: cost_per_skan_create_gamerole - description: '' is_valid: true key: skan_cost_per_create_group value: cost_per_skan_create_group - description: '' is_valid: true key: skan_cost_per_cta_app_install value: skan_active_click_cost - description: '' is_valid: true key: skan_cost_per_cta_conversion value: skan_convert_cnt_click_cost - description: '' is_valid: true key: skan_cost_per_cta_purchase value: skan_active_pay_click_cost - description: '' is_valid: true key: skan_cost_per_cta_registration value: skan_active_register_click_cost - description: '' is_valid: true key: skan_cost_per_in_app_ad_click value: cost_per_skan_in_app_ad_click - description: '' is_valid: true key: skan_cost_per_in_app_ad_impr value: cost_per_skan_in_app_ad_impr - description: '' is_valid: true key: skan_cost_per_join_group value: cost_per_skan_join_group - description: '' is_valid: true key: skan_cost_per_launch_app value: cost_per_skan_launch_app - description: '' is_valid: true key: skan_cost_per_loan_apply value: cost_per_skan_loan_apply - description: '' is_valid: true key: skan_cost_per_loan_credit value: cost_per_skan_loan_credit - description: '' is_valid: true key: skan_cost_per_loan_disbursement value: cost_per_skan_loan_completion - description: '' is_valid: true key: skan_cost_per_login value: cost_per_skan_login - description: '' is_valid: true key: skan_cost_per_purchase value: cost_per_skan_active_pay - description: '' is_valid: true key: skan_cost_per_ratings value: cost_per_skan_rate - description: '' is_valid: true key: skan_cost_per_registration value: cost_per_skan_active_register - description: '' is_valid: true key: skan_cost_per_result value: skan_effect_cost - description: '' is_valid: true key: skan_cost_per_sales_lead value: cost_per_skan_sales_lead - description: '' is_valid: true key: skan_cost_per_search value: cost_per_skan_search - description: '' is_valid: true key: skan_cost_per_spend_credits value: cost_per_skan_spend_credits - description: '' is_valid: true key: skan_cost_per_start_trial value: cost_per_skan_start_trial - description: '' is_valid: true key: skan_cost_per_subscribe value: cost_per_skan_subscribe - description: '' is_valid: true key: skan_cost_per_total_achieve_level value: cost_per_skan_repetitive_update_level - description: '' is_valid: true key: skan_cost_per_total_add_to_cart value: cost_per_skan_repetitive_in_app_cart - description: '' is_valid: true key: skan_cost_per_total_add_to_wishlist value: cost_per_skan_repetitive_add_to_wishlist - description: '' is_valid: true key: skan_cost_per_total_checkout value: cost_per_skan_repetitive_in_app_order - description: '' is_valid: true key: skan_cost_per_total_complete_tutorial value: cost_per_skan_repetitive_complete_tutorial - description: '' is_valid: true key: skan_cost_per_total_create_gamerole value: cost_per_skan_repetitive_create_gamerole - description: '' is_valid: true key: skan_cost_per_total_create_group value: cost_per_skan_repetitive_create_group - description: '' is_valid: true key: skan_cost_per_total_in_app_ad_click value: cost_per_skan_repetitive_in_app_ad_click - description: '' is_valid: true key: skan_cost_per_total_in_app_ad_impr value: cost_per_skan_repetitive_in_app_ad_impr - description: '' is_valid: true key: skan_cost_per_total_join_group value: cost_per_skan_repetitive_join_group - description: '' is_valid: true key: skan_cost_per_total_launch_app value: cost_per_skan_repetitive_launch_app - description: '' is_valid: true key: skan_cost_per_total_loan_apply value: cost_per_skan_repetitive_loan_apply - description: '' is_valid: true key: skan_cost_per_total_loan_credit value: cost_per_skan_repetitive_loan_credit - description: '' is_valid: true key: skan_cost_per_total_loan_disbursement value: cost_per_skan_repetitive_loan_completion - description: '' is_valid: true key: skan_cost_per_total_login value: cost_per_skan_repetitive_login - description: '' is_valid: true key: skan_cost_per_total_purchase value: cost_per_skan_repetitive_active_pay - description: '' is_valid: true key: skan_cost_per_total_ratings value: cost_per_skan_repetitive_rate - description: '' is_valid: true key: skan_cost_per_total_registration value: cost_per_skan_repetitive_active_register - description: '' is_valid: true key: skan_cost_per_total_sales_lead value: cost_per_skan_repetitive_sales_lead - description: '' is_valid: true key: skan_cost_per_total_search value: cost_per_skan_repetitive_search - description: '' is_valid: true key: skan_cost_per_total_spend_credits value: cost_per_skan_repetitive_spend_credits - description: '' is_valid: true key: skan_cost_per_total_start_trial value: cost_per_skan_repetitive_start_trial - description: '' is_valid: true key: skan_cost_per_total_subscribe value: cost_per_skan_repetitive_subscribe - description: '' is_valid: true key: skan_cost_per_total_unlock_achievement value: cost_per_skan_repetitive_unlock_achievement - description: '' is_valid: true key: skan_cost_per_total_view_content value: cost_per_skan_repetitive_in_app_detail_uv - description: '' is_valid: true key: skan_cost_per_unlock_achievement value: cost_per_skan_unlock_achievement - description: '' is_valid: true key: skan_cost_per_view_content value: cost_per_skan_in_app_detail_uv - description: '' is_valid: true key: skan_cost_per_vta_app_install value: skan_active_show_cost - description: '' is_valid: true key: skan_cost_per_vta_conversion value: skan_convert_cnt_show_cost - description: '' is_valid: true key: skan_cost_per_vta_purchase value: skan_active_pay_show_cost - description: '' is_valid: true key: skan_cost_per_vta_registration value: skan_active_register_show_cost - description: '' is_valid: true key: skan_cost_total_add_payment_info value: cost_per_skan_repetitive_add_payment_info - description: '' is_valid: true key: skan_create_gamerole value: skan_create_gamerole - description: '' is_valid: true key: skan_create_gamerole_rate value: skan_create_gamerole_per_install - description: '' is_valid: true key: skan_create_group value: skan_create_group - description: '' is_valid: true key: skan_create_group_rate value: skan_create_group_per_install - description: '' is_valid: true key: skan_cta_app_install value: skan_active_click - description: '' is_valid: true key: skan_cta_conversion value: skan_convert_cnt_click - description: '' is_valid: true key: skan_cta_purchase value: skan_active_pay_click - description: '' is_valid: true key: skan_cta_registration value: skan_active_register_click - description: '' is_valid: true key: skan_in_app_ad_click value: skan_in_app_ad_click - description: '' is_valid: true key: skan_in_app_ad_click_rate value: skan_in_app_ad_click_per_install - description: '' is_valid: true key: skan_in_app_ad_impr value: skan_in_app_ad_impr - description: '' is_valid: true key: skan_in_app_ad_impr_rate value: skan_in_app_ad_impr_per_install - description: '' is_valid: true key: skan_join_group value: skan_join_group - description: '' is_valid: true key: skan_join_group_rate value: skan_join_group_per_install - description: '' is_valid: true key: skan_launch_app value: skan_launch_app - description: '' is_valid: true key: skan_launch_app_rate value: skan_launch_app_per_install - description: '' is_valid: true key: skan_loan_apply value: skan_loan_apply - description: '' is_valid: true key: skan_loan_apply_rate value: skan_loan_apply_per_install - description: '' is_valid: true key: skan_loan_credit value: skan_loan_credit - description: '' is_valid: true key: skan_loan_credit_rate value: skan_loan_credit_per_install - description: '' is_valid: true key: skan_loan_disbursement value: skan_loan_completion - description: '' is_valid: true key: skan_loan_disbursement_rate value: skan_loan_completion_per_install - description: '' is_valid: true key: skan_login value: skan_login - description: '' is_valid: true key: skan_login_rate value: skan_login_per_install - description: '' is_valid: true key: skan_purchase value: skan_active_pay - description: '' is_valid: true key: skan_purchase_rate value: skan_active_pay_per_install - description: '' is_valid: true key: skan_ratings value: skan_rate - description: '' is_valid: true key: skan_ratings_rate value: skan_rate_per_install - description: '' is_valid: true key: skan_registration value: skan_active_register - description: '' is_valid: true key: skan_registration_rate value: skan_active_register_per_install - description: '' is_valid: true key: skan_result value: skan_effect_cnt - description: '' is_valid: true key: skan_result_rate value: skan_effect_rate - description: '' is_valid: true key: skan_sales_lead value: skan_sales_lead - description: '' is_valid: true key: skan_sales_lead_rate value: skan_sales_lead_per_install - description: '' is_valid: true key: skan_search value: skan_search - description: '' is_valid: true key: skan_search_rate value: skan_search_per_install - description: '' is_valid: true key: skan_spend_credits value: skan_spend_credits - description: '' is_valid: true key: skan_spend_credits_rate value: skan_spend_credits_per_install - description: '' is_valid: true key: skan_start_trial value: skan_start_trial - description: '' is_valid: true key: skan_start_trial_rate value: skan_start_trial_per_install - description: '' is_valid: true key: skan_subscribe value: skan_subscribe - description: '' is_valid: true key: skan_subscribe_rate value: skan_subscribe_per_install - description: '' is_valid: true key: skan_total_achieve_level value: skan_repetitive_update_level - description: '' is_valid: true key: skan_total_achieve_level_value value: skan_total_repetitive_update_level_value - description: '' is_valid: true key: skan_total_add_payment_info value: skan_repetitive_add_payment_info - description: '' is_valid: true key: skan_total_add_to_cart value: skan_repetitive_in_app_cart - description: '' is_valid: true key: skan_total_add_to_cart_value value: skan_total_repetitive_in_app_cart_value - description: '' is_valid: true key: skan_total_add_to_wishlist value: skan_repetitive_add_to_wishlist - description: '' is_valid: true key: skan_total_add_to_wishlist_value value: skan_total_repetitive_add_to_wishlist_value - description: '' is_valid: true key: skan_total_checkout value: skan_repetitive_in_app_order - description: '' is_valid: true key: skan_total_checkout_value value: skan_total_repetitive_in_app_order_value - description: '' is_valid: true key: skan_total_complete_tutorial value: skan_repetitive_complete_tutorial - description: '' is_valid: true key: skan_total_complete_tutorial_value value: skan_total_repetitive_complete_tutorial_value - description: '' is_valid: true key: skan_total_create_gamerole value: skan_repetitive_create_gamerole - description: '' is_valid: true key: skan_total_create_gamerole_value value: skan_total_repetitive_create_gamerole_value - description: '' is_valid: true key: skan_total_create_group value: skan_repetitive_create_group - description: '' is_valid: true key: skan_total_create_group_value value: skan_total_repetitive_create_group_value - description: '' is_valid: true key: skan_total_in_app_ad_click value: skan_repetitive_in_app_ad_click - description: '' is_valid: true key: skan_total_in_app_ad_click_value value: skan_total_repetitive_in_app_ad_click_value - description: '' is_valid: true key: skan_total_in_app_ad_impr value: skan_repetitive_in_app_ad_impr - description: '' is_valid: true key: skan_total_in_app_ad_impr_value value: skan_total_repetitive_in_app_ad_impr_value - description: '' is_valid: true key: skan_total_join_group value: skan_repetitive_join_group - description: '' is_valid: true key: skan_total_join_group_value value: skan_total_repetitive_join_group_value - description: '' is_valid: true key: skan_total_launch_app value: skan_repetitive_launch_app - description: '' is_valid: true key: skan_total_loan_apply value: skan_repetitive_loan_apply - description: '' is_valid: true key: skan_total_loan_credit value: skan_repetitive_loan_credit - description: '' is_valid: true key: skan_total_loan_disbursement value: skan_repetitive_loan_completion - description: '' is_valid: true key: skan_total_login value: skan_repetitive_login - description: '' is_valid: true key: skan_total_purchase value: skan_repetitive_active_pay - description: '' is_valid: true key: skan_total_purchase_value value: skan_total_repetitive_active_pay_value - description: '' is_valid: true key: skan_total_ratings value: skan_repetitive_rate - description: '' is_valid: true key: skan_total_ratings_value value: skan_total_repetitive_rate_value - description: '' is_valid: true key: skan_total_registration value: skan_repetitive_active_register - description: '' is_valid: true key: skan_total_repetitive_active_pay_roas value: skan_total_repetitive_active_pay_roas - description: '' is_valid: true key: skan_total_sales_lead value: skan_repetitive_sales_lead - description: '' is_valid: true key: skan_total_sales_lead_value value: skan_total_repetitive_sales_lead_value - description: '' is_valid: true key: skan_total_search value: skan_repetitive_search - description: '' is_valid: true key: skan_total_spend_credits value: skan_repetitive_spend_credits - description: '' is_valid: true key: skan_total_spend_credits_value value: skan_total_repetitive_spend_credits_value - description: '' is_valid: true key: skan_total_start_trial value: skan_repetitive_start_trial - description: '' is_valid: true key: skan_total_subscribe value: skan_repetitive_subscribe - description: '' is_valid: true key: skan_total_subscribe_value value: skan_total_repetitive_subscribe_value - description: '' is_valid: true key: skan_total_unlock_achievement value: skan_repetitive_unlock_achievement - description: '' is_valid: true key: skan_total_unlock_achievement_value value: skan_total_repetitive_unlock_achievement_value - description: '' is_valid: true key: skan_total_view_content value: skan_repetitive_in_app_detail_uv - description: '' is_valid: true key: skan_total_view_content_value value: skan_total_repetitive_in_app_detail_uv_value - description: '' is_valid: true key: skan_unlock_achievement value: skan_unlock_achievement - description: '' is_valid: true key: skan_unlock_achievement_rate value: skan_unlock_achievement_per_install - description: '' is_valid: true key: skan_view_content value: skan_in_app_detail_uv - description: '' is_valid: true key: skan_view_content_rate value: skan_in_app_detail_uv_per_install - description: '' is_valid: true key: skan_vta_app_install value: skan_active_show - description: '' is_valid: true key: skan_vta_conversion value: skan_convert_cnt_show - description: '' is_valid: true key: skan_vta_purchase value: skan_active_pay_show - description: '' is_valid: true key: skan_vta_registration value: skan_active_register_show - description: '' is_valid: true key: sound_usage_clicks value: sound_usage_button_click_cnt - description: '' is_valid: true key: spend value: stat_cost - description: '' is_valid: true key: spend_credits value: time_attr_spend_credits - description: '' is_valid: true key: spend_credits_rate value: time_attr_spend_credits_per_install - description: '' is_valid: true key: start_trial value: time_attr_start_trial - description: '' is_valid: true key: start_trial_rate value: time_attr_start_trial_per_install - description: '' is_valid: true key: stitch_clicks value: stitch_click_cnt - description: '' is_valid: true key: subscribe value: time_attr_subscribe - description: '' is_valid: true key: subscribe_rate value: time_attr_subscribe_per_install - description: '' is_valid: true key: total_achieve_level value: time_attr_repetitive_update_level - description: '' is_valid: true key: total_achieve_level_value value: time_attr_total_repetitive_update_level_value - description: '' is_valid: true key: total_active_pay_roas value: time_attr_repetitive_active_pay_roas - description: '' is_valid: true key: total_ad_impression_events_value value: time_attr_total_repetitive_ad_revenue_value - description: '' is_valid: true key: total_ad_impression_roas value: time_attr_total_repetitive_ad_revenue_roas - description: '' is_valid: true key: total_add_billing_value value: time_attr_total_add_billing_value - description: '' is_valid: true key: total_add_payment_info value: time_attr_repetitive_add_payment_info - description: '' is_valid: true key: total_add_to_wishlist value: time_attr_repetitive_add_to_wishlist - description: '' is_valid: true key: total_add_to_wishlist_value value: time_attr_total_repetitive_add_to_wishlist_value - description: '' is_valid: true key: total_app_event_add_to_cart value: time_attr_repetitive_in_app_cart - description: '' is_valid: true key: total_app_event_add_to_cart_value value: time_attr_total_repetitive_in_app_cart_value - description: '' is_valid: true key: total_button_click_value value: time_attr_total_button_value - description: '' is_valid: true key: total_checkout value: time_attr_repetitive_in_app_order - description: '' is_valid: true key: total_checkout_value value: time_attr_total_repetitive_in_app_order_value - description: '' is_valid: true key: total_complete_payment_rate value: time_attr_total_shopping_value - description: '' is_valid: true key: total_complete_tutorial value: time_attr_repetitive_complete_tutorial - description: '' is_valid: true key: total_complete_tutorial_value value: time_attr_total_repetitive_complete_tutorial_value - description: '' is_valid: true key: total_create_gamerole value: time_attr_repetitive_create_gamerole - description: '' is_valid: true key: total_create_gamerole_value value: time_attr_total_repetitive_create_gamerole_value - description: '' is_valid: true key: total_create_group value: time_attr_repetitive_create_group - description: '' is_valid: true key: total_create_group_value value: time_attr_total_repetitive_create_group_value - description: '' is_valid: true key: total_day7_retention value: time_attr_repetitive_retention_7d - description: '' is_valid: true key: total_day7_retention_value value: time_attr_total_repetitive_retention_7d_value - description: '' is_valid: true key: total_download_start_value value: time_attr_total_download_start_value - description: '' is_valid: true key: total_form_value value: time_attr_total_form_value - description: '' is_valid: true key: total_in_app_ad_click value: time_attr_repetitive_in_app_ad_click - description: '' is_valid: true key: total_in_app_ad_click_value value: time_attr_total_repetitive_in_app_ad_click_value - description: '' is_valid: true key: total_in_app_ad_impr value: time_attr_repetitive_in_app_ad_impr - description: '' is_valid: true key: total_in_app_ad_impr_value value: time_attr_total_repetitive_in_app_ad_impr_value - description: '' is_valid: true key: total_initiate_checkout_value value: time_attr_total_initiate_checkout_value - description: '' is_valid: true key: total_join_group value: time_attr_repetitive_join_group - description: '' is_valid: true key: total_join_group_value value: time_attr_total_repetitive_join_group_value - description: '' is_valid: true key: total_landing_page_view value: time_attr_web_landing_page_view - description: '' is_valid: true key: total_launch_app value: time_attr_repetitive_launch_app - description: '' is_valid: true key: total_loan_apply value: time_attr_repetitive_loan_apply - description: '' is_valid: true key: total_loan_credit value: time_attr_repetitive_loan_credit - description: '' is_valid: true key: total_loan_disbursement value: time_attr_repetitive_loan_completion - description: '' is_valid: true key: total_login value: time_attr_repetitive_login - description: '' is_valid: true key: total_next_day_open value: time_attr_repetitive_next_day_open - description: '' is_valid: true key: total_on_web_add_to_wishlist_value value: time_attr_total_on_web_add_to_wishlist_value - description: '' is_valid: true key: total_on_web_order_value value: time_attr_total_on_web_order_value - description: '' is_valid: true key: total_on_web_subscribe_value value: time_attr_total_on_web_subscribe_value - description: '' is_valid: true key: total_online_consult_value value: time_attr_total_consult_standardized_value - description: '' is_valid: true key: total_onsite_add_billing_value value: time_attr_total_onsite_add_billing_value - description: '' is_valid: true key: total_onsite_add_to_wishlist_value value: time_attr_total_onsite_add_to_wishlist_value - description: '' is_valid: true key: total_onsite_form_value value: time_attr_total_onsite_form_value - description: '' is_valid: true key: total_onsite_initiate_checkout_count_value value: time_attr_total_onsite_initiate_checkout_count_value - description: '' is_valid: true key: total_onsite_on_web_cart_value value: time_attr_total_onsite_on_web_cart_value - description: '' is_valid: true key: total_onsite_on_web_detail_value value: time_attr_total_onsite_on_web_detail_value - description: '' is_valid: true key: total_onsite_shopping_value value: time_attr_total_onsite_shopping_value - description: '' is_valid: true key: total_page_event_search_value value: time_attr_total_search_value - description: '' is_valid: true key: total_page_view_content_events_value value: time_attr_total_on_web_detail_standardized_value - description: '' is_valid: true key: total_pageview value: time_attr_page_view - description: '' is_valid: true key: total_purchase value: time_attr_repetitive_active_pay - description: '' is_valid: true key: total_purchase_roas_day0 value: time_attr_active_pay_roas_d0 - description: '' is_valid: true key: total_purchase_roas_day2 value: time_attr_active_pay_roas_d2 - description: '' is_valid: true key: total_purchase_roas_day6 value: time_attr_active_pay_roas_d6 - description: '' is_valid: true key: total_purchase_value value: time_attr_total_repetitive_active_pay_value - description: '' is_valid: true key: total_purchase_value_day0 value: time_attr_total_repetitive_active_pay_value_d0 - description: '' is_valid: true key: total_purchase_value_day2 value: time_attr_total_repetitive_active_pay_value_d2 - description: '' is_valid: true key: total_purchase_value_day6 value: time_attr_total_repetitive_active_pay_value_d6 - description: '' is_valid: true key: total_ratings value: time_attr_repetitive_rate - description: '' is_valid: true key: total_ratings_value value: time_attr_total_repetitive_rate_value - description: '' is_valid: true key: total_registration value: time_attr_repetitive_active_register - description: '' is_valid: true key: total_sales_lead value: time_attr_repetitive_sales_lead - description: '' is_valid: true key: total_sales_lead_value value: time_attr_total_repetitive_sales_lead_value - description: '' is_valid: true key: total_search value: time_attr_repetitive_search - description: '' is_valid: true key: total_spend_credits value: time_attr_repetitive_spend_credits - description: '' is_valid: true key: total_spend_credits_value value: time_attr_total_repetitive_spend_credits_value - description: '' is_valid: true key: total_start_trial value: time_attr_repetitive_start_trial - description: '' is_valid: true key: total_subscribe value: time_attr_repetitive_subscribe - description: '' is_valid: true key: total_subscribe_value value: time_attr_total_repetitive_subscribe_value - description: '' is_valid: true key: total_unlock_achievement value: time_attr_repetitive_unlock_achievement - description: '' is_valid: true key: total_unlock_achievement_value value: time_attr_total_repetitive_unlock_achievement_value - description: '' is_valid: true key: total_user_registration_value value: time_attr_total_on_web_register_value - description: '' is_valid: true key: total_value_per_pageview value: time_attr_value_per_page_view - description: '' is_valid: true key: total_view_content value: time_attr_repetitive_in_app_detail_uv - description: '' is_valid: true key: total_view_content_value value: time_attr_total_repetitive_in_app_detail_uv_value - description: '' is_valid: true key: total_web_event_add_to_cart_value value: time_attr_total_on_web_cart_value - description: '' is_valid: true key: tt_playlist_visit value: tt_playlist_visit - description: '' is_valid: true key: tt_playlist_visit_rate value: tt_playlist_visit_rate - description: '' is_valid: true key: unique_ad_impression_events value: time_attr_ad_revenue - description: '' is_valid: true key: unique_custom_app_events value: time_attr_app_customized_events - description: '' is_valid: true key: unlock_achievement value: time_attr_unlock_achievement - description: '' is_valid: true key: unlock_achievement_rate value: time_attr_unlock_achievement_per_install - description: '' is_valid: true key: user_registration value: time_attr_on_web_register - description: '' is_valid: true key: user_registration_rate value: time_attr_on_web_register_per_click - description: '' is_valid: true key: value_per_ad_impression_event value: time_attr_value_per_repetitive_ad_revenue - description: '' is_valid: true key: value_per_add_billing value: time_attr_value_per_add_billing_count - description: '' is_valid: true key: value_per_button_click value: time_attr_value_per_button - description: '' is_valid: true key: value_per_checkout value: time_attr_value_per_repetitive_in_app_order - description: '' is_valid: true key: value_per_complete_payment value: time_attr_value_per_shopping - description: '' is_valid: true key: value_per_custom_app_event value: time_attr_value_per_repetitive_app_customized_events - description: '' is_valid: true key: value_per_custom_page_event value: time_attr_value_per_web_customized_events - description: '' is_valid: true key: value_per_download_start value: time_attr_value_per_download_start - description: '' is_valid: true key: value_per_form value: time_attr_value_per_form - description: '' is_valid: true key: value_per_initiate_checkout value: time_attr_value_per_initiate_checkout_count - description: '' is_valid: true key: value_per_offline_add_payment_info_event value: time_attr_value_per_offline_add_billing - description: '' is_valid: true key: value_per_offline_add_to_cart_event value: time_attr_value_per_offline_add_to_cart - description: '' is_valid: true key: value_per_offline_add_to_wishlist_event value: time_attr_value_per_offline_add_to_wishlist - description: '' is_valid: true key: value_per_offline_click_button_event value: time_attr_value_per_offline_button - description: '' is_valid: true key: value_per_offline_complete_registration_event value: time_attr_value_per_offline_register - description: '' is_valid: true key: value_per_offline_contact_event value: time_attr_value_per_offline_contact - description: '' is_valid: true key: value_per_offline_download_event value: time_attr_value_per_offline_download_start - description: '' is_valid: true key: value_per_offline_form_event value: time_attr_value_per_offline_submit_form - description: '' is_valid: true key: value_per_offline_initiate_checkout_event value: time_attr_value_per_offline_initiate_checkout - description: '' is_valid: true key: value_per_offline_place_order_event value: time_attr_value_per_offline_order - description: '' is_valid: true key: value_per_offline_search_event value: time_attr_value_per_offline_search - description: '' is_valid: true key: value_per_offline_shopping_event value: time_attr_value_per_offline_shopping - description: '' is_valid: true key: value_per_offline_subscribe_event value: time_attr_value_per_offline_subscribe - description: '' is_valid: true key: value_per_offline_view_content_event value: time_attr_value_per_offline_detail - description: '' is_valid: true key: value_per_on_web_add_to_wishlist value: time_attr_value_per_on_web_add_to_wishlist - description: '' is_valid: true key: value_per_on_web_order value: time_attr_value_per_on_web_order - description: '' is_valid: true key: value_per_on_web_subscribe value: time_attr_value_per_on_web_subscribe - description: '' is_valid: true key: value_per_online_consult value: time_attr_value_per_consult_standardized - description: '' is_valid: true key: value_per_onsite_add_billing value: time_attr_value_per_onsite_add_billing - description: '' is_valid: true key: value_per_onsite_add_to_wishlist value: time_attr_value_per_onsite_add_to_wishlist - description: '' is_valid: true key: value_per_onsite_form value: time_attr_value_per_onsite_form - description: '' is_valid: true key: value_per_onsite_initiate_checkout_count value: time_attr_value_per_onsite_initiate_checkout_count - description: '' is_valid: true key: value_per_onsite_on_web_cart value: time_attr_value_per_onsite_on_web_cart - description: '' is_valid: true key: value_per_onsite_on_web_detail value: time_attr_value_per_onsite_on_web_detail - description: '' is_valid: true key: value_per_onsite_shopping value: time_attr_value_per_onsite_shopping - description: '' is_valid: true key: value_per_page_content_view_event value: time_attr_value_per_on_web_detail_standardized - description: '' is_valid: true key: value_per_page_event_search value: time_attr_value_per_search_count - description: '' is_valid: true key: value_per_total_achieve_level value: time_attr_value_per_repetitive_update_level - description: '' is_valid: true key: value_per_total_add_to_wishlist value: time_attr_value_per_repetitive_add_to_wishlist - description: '' is_valid: true key: value_per_total_app_event_add_to_cart value: time_attr_value_per_repetitive_in_app_cart - description: '' is_valid: true key: value_per_total_complete_tutorial value: time_attr_value_per_repetitive_complete_tutorial - description: '' is_valid: true key: value_per_total_create_gamerole value: time_attr_value_per_repetitive_create_gamerole - description: '' is_valid: true key: value_per_total_create_group value: time_attr_value_per_repetitive_create_group - description: '' is_valid: true key: value_per_total_day7_retention value: time_attr_value_per_repetitive_retention_7d - description: '' is_valid: true key: value_per_total_in_app_ad_click value: time_attr_value_per_repetitive_in_app_ad_click - description: '' is_valid: true key: value_per_total_in_app_ad_impr value: time_attr_value_per_repetitive_in_app_ad_impr - description: '' is_valid: true key: value_per_total_join_group value: time_attr_value_per_repetitive_join_group - description: '' is_valid: true key: value_per_total_purchase value: time_attr_value_per_repetitive_active_pay - description: '' is_valid: true key: value_per_total_ratings value: time_attr_value_per_repetitive_rate - description: '' is_valid: true key: value_per_total_sales_lead value: time_attr_value_per_repetitive_sales_lead - description: '' is_valid: true key: value_per_total_spend_credits value: time_attr_value_per_repetitive_spend_credits - description: '' is_valid: true key: value_per_total_subscribe value: time_attr_value_per_repetitive_subscribe - description: '' is_valid: true key: value_per_total_unlock_achievement value: time_attr_value_per_repetitive_unlock_achievement - description: '' is_valid: true key: value_per_total_view_content value: time_attr_value_per_repetitive_in_app_detail_uv - description: '' is_valid: true key: value_per_user_registration value: time_attr_value_per_on_web_register - description: '' is_valid: true key: value_per_web_event_add_to_cart value: time_attr_value_per_on_web_cart - description: '' is_valid: true key: video_play_actions value: total_play - description: '' is_valid: true key: video_views_p100 value: play_over - description: '' is_valid: true key: video_views_p25 value: play_first_quartile - description: '' is_valid: true key: video_views_p50 value: play_midpoint - description: '' is_valid: true key: video_views_p75 value: play_third_quartile - description: '' is_valid: true key: video_watched_2s value: play_duration_2s - description: '' is_valid: true key: video_watched_6s value: play_duration_6s - description: '' is_valid: true key: view_content value: time_attr_in_app_detail_uv - description: '' is_valid: true key: view_content_rate value: time_attr_in_app_detail_uv_per_install - description: '' is_valid: true key: vta_app_install value: time_attr_active_show - description: '' is_valid: true key: vta_complete_payment value: time_attr_shopping_show - description: '' is_valid: true key: vta_complete_payment_roas value: time_attr_shopping_roas_show - description: '' is_valid: true key: vta_complete_payment_value value: time_attr_total_shopping_value_show - description: '' is_valid: true key: vta_conversion value: time_attr_convert_cnt_show - description: '' is_valid: true key: vta_purchase value: time_attr_active_pay_show - description: '' is_valid: true key: vta_registration value: time_attr_active_register_show - description: '' is_valid: true key: web_event_add_to_cart value: time_attr_on_web_cart - description: '' is_valid: true key: web_event_add_to_cart_rate value: time_attr_on_web_cart_per_click - description: '' is_valid: true key: website_application_approval value: time_attr_web_application_approval - description: '' is_valid: true key: website_application_approval_rate value: time_attr_web_application_approval_per_click - description: '' is_valid: true key: website_cost_per_application_approval value: time_attr_cost_per_web_application_approval - description: '' is_valid: true key: website_cost_per_cta_purchase value: time_attr_cost_per_shopping_click - description: '' is_valid: true key: website_cost_per_customize_product value: time_attr_cost_per_customizeproduct_web - description: '' is_valid: true key: website_cost_per_engaged_session value: time_attr_cost_per_engagement_session - description: '' is_valid: true key: website_cost_per_find_location value: time_attr_cost_per_findlocation_web - description: '' is_valid: true key: website_cost_per_schedule value: time_attr_cost_per_schedule_web - description: '' is_valid: true key: website_cost_per_start_trial value: time_attr_cost_per_web_start_trial - description: '' is_valid: true key: website_cost_per_submit_application value: time_attr_web_submit_application - description: '' is_valid: true key: website_cta_purchase value: time_attr_shopping_click - description: '' is_valid: true key: website_cta_purchase_roas value: time_attr_shopping_roas_click - description: '' is_valid: true key: website_cta_purchase_value value: time_attr_total_shopping_value_click - description: '' is_valid: true key: website_customize_product_rate value: time_attr_customizeproduct_per_click_web - description: '' is_valid: true key: website_engaged_session_rate value: time_attr_engagement_session_per_click - description: '' is_valid: true key: website_find_location_rate value: time_attr_findlocation_per_click_web - description: '' is_valid: true key: website_schedule_rate value: time_attr_schedule_per_click_web - description: '' is_valid: true key: website_start_trial_rate value: time_attr_web_start_trial_per_click - description: '' is_valid: true key: website_submit_application_rate value: time_attr_web_submit_application_per_click - description: '' is_valid: true key: website_total_application_approval_value value: time_attr_total_web_application_approval_value - description: '' is_valid: true key: website_total_customize_product value: time_attr_customizeproduct_web - description: '' is_valid: true key: website_total_customize_product_value value: time_attr_total_customizeproduct_value_web - description: '' is_valid: true key: website_total_engaged_session value: time_attr_engagement_session - description: '' is_valid: true key: website_total_find_location value: time_attr_findlocation_web - description: '' is_valid: true key: website_total_find_location_value value: time_attr_total_findlocation_value_web - description: '' is_valid: true key: website_total_schedule value: time_attr_schedule_web - description: '' is_valid: true key: website_total_schedule_value value: time_attr_total_schedule_value_web - description: '' is_valid: true key: website_total_start_trial value: time_attr_web_start_trial - description: '' is_valid: true key: website_total_start_trial_value value: time_attr_total_web_start_trial_value - description: '' is_valid: true key: website_total_submit_application value: time_attr_web_submit_application - description: '' is_valid: true key: website_total_submit_application_value value: time_attr_total_web_submit_application_value - description: '' is_valid: true key: website_value_per_application_approval value: time_attr_value_per_web_application_approval - description: '' is_valid: true key: website_value_per_customize_product value: time_attr_value_per_customizeproduct_web - description: '' is_valid: true key: website_value_per_find_location value: time_attr_value_per_findlocation_web - description: '' is_valid: true key: website_value_per_schedule value: time_attr_value_per_schedule_web - description: '' is_valid: true key: website_value_per_start_trial value: time_attr_value_per_web_start_trial - description: '' is_valid: true key: website_value_per_submit_application value: time_attr_value_per_web_submit_application key_format: string strict: true use_part: true validate_only: false value_format: string x-open-source: $.http.query.sort_field x-open-field-id: 8 - description: '' in: query name: sort_type required: false schema: default: DESC nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1807850809935874 enum_package_name: ReportOrderType enums: - description: '' is_valid: true key: ASC value: '0' - description: '' is_valid: true key: DESC value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.sort_type x-open-field-id: 9 - description: '' in: query name: page required: false schema: default: 1 format: int64 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page x-open-field-id: 10 - description: '' in: query name: page_size required: false schema: default: 10 format: int64 maximum: 100 minimum: 1 nullable: false type: integer x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.page_size x-open-field-id: 11 - 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get overview of material reports [Smart Plus Material Report Overview] tags: - Reporting 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: dimensions required: true source: $.http.query.dimensions sub_type: string type: array - children: - type: string is_expand: true name: metrics required: false source: $.http.query.metrics sub_type: string type: array - name: start_date required: false source: $.http.query.start_date type: string - name: end_date required: false source: $.http.query.end_date type: string - name: query_lifetime required: false source: $.http.query.query_lifetime type: boolean - name: sort_field required: false source: $.http.query.sort_field type: string - name: sort_type required: false source: $.http.query.sort_type type: number - name: page required: false source: $.http.query.page type: number - name: page_size required: false source: $.http.query.page_size type: number - children: - children: - type: number is_expand: true name: campaign_ids required: false sub_type: number type: array - children: - type: number is_expand: true name: adgroup_ids required: false sub_type: number type: array - children: - type: number is_expand: true name: smart_plus_ad_ids required: false sub_type: number type: array - children: - type: string is_expand: true name: main_material_types required: false sub_type: string type: array - children: - type: string is_expand: true name: main_material_ids required: false sub_type: string type: array - children: - type: string is_expand: true name: ad_text_entity_ids required: false sub_type: string type: array - children: - type: string is_expand: true name: call_to_action_entity_ids required: false sub_type: string type: array - children: - type: string is_expand: true name: interactive_add_on_entity_ids required: false sub_type: string type: array is_expand: true name: filtering required: false source: $.http.query.filtering type: object plugins: after_response: - Plugin_convert_list_metrics_136362: - description: convert material_second_status_list_str - request_params: - $.rpc.output.stats - result_params: - $.newStats - version: ca27b1dce4c5b10d2ef5597a012dbdf4 before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id dimensions: $.http.query.dimensions end_date: $.http.query.end_date filtering: $.http.query.filtering metrics: $.http.query.metrics page: $.http.query.page page_size: $.http.query.page_size query_lifetime: $.http.query.query_lifetime sort_field: $.http.query.sort_field sort_type: $.http.query.sort_type start_date: $.http.query.start_date response_cookie: [] response_header: [] response_rule: list: $.newStats page_info: $.rpc.output.page_info x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /term/check/: get: operationId: Term Check parameters: - description: '' in: query name: advertiser_id required: true schema: nullable: false type: string 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: term_type required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1825806465200257 enum_package_name: TermType enums: - description: '' is_valid: true key: InstantPage value: InstantPage - description: '' is_valid: true key: LeadAds value: LeadAds - description: '' is_valid: true key: Pixel value: Pixel - description: '' is_valid: true key: ReachFrequency value: ReachFrequency key_format: string strict: true use_part: false validate_only: false value_format: string x-open-source: $.http.query.term_type 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Check the status of Terms. [Term Check](https://business-api.tiktok.com/portal/docs?id=1737192304571394) tags: - Account Management 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: string - name: term_type required: true source: $.http.query.term_type type: string - children: - name: app_id required: false source: $.context.app_id type: number - name: core_user_id required: false source: $.context.core_user_id type: number - name: developer_id required: false source: $.context.developer_id type: number is_expand: true name: context_info required: false type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id context_info: app_id: $.context.app_id core_user_id: $.context.core_user_id developer_id: $.context.developer_id term_type: $.http.query.term_type response_cookie: [] response_header: [] response_rule: confirmed: $.rpc.output.confirmed x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /term/confirm/: post: operationId: Term Confirm 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: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 1 x-open-source: $.http.body.advertiser_id term_type: description: '' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1825806465200257 enum_package_name: TermType enums: - description: '' is_valid: true key: InstantPage value: InstantPage - description: '' is_valid: true key: LeadAds value: LeadAds - description: '' is_valid: true key: Pixel value: Pixel - description: '' is_valid: true key: ReachFrequency value: ReachFrequency key_format: string strict: true use_part: false validate_only: false value_format: string x-open-field-id: 2 x-open-source: $.http.body.term_type required: - advertiser_id - term_type type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Sign Terms. [Term Confirm](https://business-api.tiktok.com/portal/docs?id=1737192284435457) tags: - Account Management 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: string - name: term_type required: true source: $.http.body.term_type type: string - children: - name: app_id required: false source: $.context.app_id type: number - name: core_user_id required: false source: $.context.core_user_id type: number - name: developer_id required: false source: $.context.developer_id type: number is_expand: true name: context_info required: false type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id context_info: app_id: $.context.app_id core_user_id: $.context.core_user_id developer_id: $.context.developer_id term_type: $.http.body.term_type response_cookie: [] response_header: [] response_rule: null x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /term/get/: get: operationId: Term Get parameters: - description: '' in: query name: advertiser_id required: true schema: nullable: false type: string 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: term_type required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1825806465200257 enum_package_name: TermType enums: - description: '' is_valid: true key: InstantPage value: InstantPage - description: '' is_valid: true key: LeadAds value: LeadAds - description: '' is_valid: true key: Pixel value: Pixel - description: '' is_valid: true key: ReachFrequency value: ReachFrequency key_format: string strict: true use_part: false validate_only: false value_format: string x-open-source: $.http.query.term_type x-open-field-id: 2 - description: '' in: query name: lang required: false schema: default: EN nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1804149984643138 enum_package_name: TermLanguage enums: - description: '' is_valid: true key: EN value: '0' - description: '' is_valid: true key: JA value: '2' - description: '' is_valid: true key: ZH value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.lang 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 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get Terms. [Term Get](https://business-api.tiktok.com/portal/docs?id=1737191909315585) tags: - Account Management 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: string - name: term_type required: true source: $.http.query.term_type type: string - name: lang required: false source: $.http.query.lang type: number - children: - name: app_id required: false source: $.context.app_id type: number - name: core_user_id required: false source: $.context.core_user_id type: number - name: developer_id required: false source: $.context.developer_id type: number is_expand: true name: context_info required: false type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id context_info: app_id: $.context.app_id core_user_id: $.context.core_user_id developer_id: $.context.developer_id lang: $.http.query.lang term_type: $.http.query.term_type response_cookie: [] response_header: [] response_rule: terms: $.rpc.output.terms x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /tool/action_category/: get: operationId: Tool Action_category parameters: - description: Advertiser ID. in: query name: advertiser_id required: true schema: nullable: false 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: nullable: false 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 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.special_industries description: 'Special ad categories. Enum values: HOUSING: Ads for real estate listings, homeowners insurance, mortgage loans or other related opportunities. EMPLOYMENT: Ads for job offers, internship, professional certification programs or other related opportunities. CREDIT: Ads for credit card offers, auto loans, long-term financing or other related opportunities. Note: This field is generally available to advertisers registered in America or Canada. Advertisers who are not registered in America or Canada but want to target these countries with special ad categories need to apply for an additional allowlist.' in: query name: special_industries required: false x-open-field-id: 2 - description: 'Category name language in repsonse. Default value: en. Supported languages: en, zh, ja, de, es, fr, id, it, ko, ru, th, tr, vi, ar, pt, ms. For details, see Enumeration - Language Code.' in: query name: language required: false schema: default: en nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.language x-open-field-id: 3 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get action categories. [Tool Action Category](https://business-api.tiktok.com/portal/docs?id=1737166752522241) tags: - Tool x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - children: - type: number name: special_industries required: false source: $.http.query.special_industries sub_type: number type: array - name: language required: false source: $.http.query.language type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id language: $.http.query.language special_industries: $.http.query.special_industries response_cookie: [] response_header: [] response_rule: action_categories[][]: - action_category_id: $.rpc.output.action_categories[].action_category_id action_scene: $.rpc.output.action_categories[].scene description: $.rpc.output.action_categories[].description level: $.rpc.output.action_categories[].level name: $.rpc.output.action_categories[].action_category_name special_industries: $.rpc.output.action_categories[].special_industries sub_category_ids: $.rpc.output.action_categories[].sub_category_ids x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /tool/bid/recommend/: post: operationId: Tool Bid Recommend parameters: - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string requestBody: content: application/json: schema: properties: advertiser_id: description: Advertiser ID. nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 campaign_id: default: '"0"' description: Campaign ID. nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 2 external_action: description: Conversion event for the ad group. nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1799795326256129 enum_package_name: ExternalAction enums: - description: '' is_valid: true key: ACTIVE value: '8' - description: '' is_valid: true key: ACTIVE_PAY value: '14' - description: '' is_valid: true key: ACTIVE_REGISTER value: '13' - description: '' is_valid: true key: ADD_BOOKSHELF value: '116' - description: '' is_valid: true key: ADD_PAYMENT_INFO value: '127' - description: '' is_valid: true key: ADD_TO_WISHLIST value: '128' - description: '' is_valid: true key: ANCHOR_CLICK value: '308' - description: '' is_valid: true key: APPLET_DEAL value: '126' - description: '' is_valid: true key: APPOINTMENT_DOWNLOAD_BUTTON value: '173' - description: '' is_valid: true key: ASCRIPTION_PHONE value: '161' - description: '' is_valid: true key: AUTHORIZATION value: '121' - description: '' is_valid: true key: BANKCARD_INFORMATION value: '107' - description: '' is_valid: true key: BOOST value: '124' - description: '' is_valid: true key: BUTTON value: '5' - description: '' is_valid: true key: CERTIFICATION_INFORMATION value: '109' - description: '' is_valid: true key: CLICK_CALL_DY value: '69' - description: '' is_valid: true key: CLICK_DOWNLOAD value: '68' - description: '' is_valid: true key: CLICK_LANDING_PAGE value: '66' - description: '' is_valid: true key: CLICK_SHOPWINDow value: '67' - description: '' is_valid: true key: CLICK_WEBSITE value: '70' - description: '' is_valid: true key: CLUE_CONFIRM value: '194' - description: '' is_valid: true key: CLUE_HIGH_INTENTION value: '196' - description: '' is_valid: true key: CLUE_INTERFLOW value: '195' - description: '' is_valid: true key: CLUE_PAY_SUCCEED value: '218' - description: '' is_valid: true key: COMMENT_ACTION value: '47' - description: '' is_valid: true key: COMMODITY_CLICK value: '122' - description: '' is_valid: true key: COMPLETE_TUTORIAL value: '131' - description: '' is_valid: true key: CONSULT value: '97' - description: '' is_valid: true key: CONSULT_CLUE value: '123' - description: '' is_valid: true key: CONSULT_EFFECTIVE value: '19' - description: '' is_valid: true key: CONVERSION_LEADS value: '313' - description: '' is_valid: true key: COUPON value: '28' - description: '' is_valid: true key: CREATE_GAMEROLE value: '38' - description: '' is_valid: true key: CUSTOMER_EFFECTIVE value: '26' - description: '' is_valid: true key: DEEP_PURCHASE value: '52' - description: '' is_valid: true key: DESTINATION_VISIT value: '272' - description: '' is_valid: true key: DIALBACK value: '33' - description: '' is_valid: true key: DIALBACK_CONFIRM value: '34' - description: '' is_valid: true key: DIALBACK_CONNECT value: '35' - description: '' is_valid: true key: DOWNLOAD_BUTTON value: '155' - description: '' is_valid: true key: DOWNLOAD_DETAIL value: '154' - description: '' is_valid: true key: DOWNLOAD_FINISH value: '4' - description: '' is_valid: true key: DOWNLOAD_START value: '9' - description: '' is_valid: true key: EC_CLICK_BUY value: '175' - description: '' is_valid: true key: EC_CLICK_PRODUCT value: '179' - description: '' is_valid: true key: EC_CONFRIM_DEAL value: '214' - description: '' is_valid: true key: EC_LIVE_CART value: '210' - description: '' is_valid: true key: EC_LIVE_CLICK_PRODUCT_ACTION value: '208' - description: '' is_valid: true key: EC_LIVE_COMMENT_ACTION value: '205' - description: '' is_valid: true key: EC_LIVE_ENTER_ACTION value: '202' - description: '' is_valid: true key: EC_LIVE_FOLLOW_ACTION value: '204' - description: '' is_valid: true key: EC_LIVE_GIFT_ACTION value: '206' - description: '' is_valid: true key: EC_LIVE_NATIVE_ACTION value: '203' - description: '' is_valid: true key: EC_LIVE_ORDER value: '211' - description: '' is_valid: true key: EC_LIVE_REDIRECT_TO_STORE_ACTION value: '209' - description: '' is_valid: true key: EC_LIVE_SLIDECART_CLICK_ACTION value: '207' - description: '' is_valid: true key: EC_SUBMIT_ORDER value: '176' - description: '' is_valid: true key: EFFECTIVE_COPY value: '27' - description: '' is_valid: true key: ENGAGED_VIEW value: '309' - description: '' is_valid: true key: ENGAGED_VIEW_FIFTEEN value: '311' - description: '' is_valid: true key: ENTER_HOMEPAGE value: '181' - description: '' is_valid: true key: FEED_LIVE_HOMEPAGE value: '120' - description: '' is_valid: true key: FOLLOW_ACTION value: '46' - description: '' is_valid: true key: FOLLOW_LIVE_ENTER value: '250' - description: '' is_valid: true key: FOLLOW_VIDEO_PLAY_FINISH value: '252' - description: '' is_valid: true key: FORM value: '2' - description: '' is_valid: true key: FORM_ANSWER value: '32' - description: '' is_valid: true key: FORM_BUTTON value: '151' - description: '' is_valid: true key: FORM_CONNECT value: '31' - description: '' is_valid: true key: FORM_DEEP value: '36' - description: '' is_valid: true key: FORM_DETAIL value: '150' - description: '' is_valid: true key: GAME_ADDICTION value: '25' - description: '' is_valid: true key: HIGHVALUE_CLUE value: '42' - description: '' is_valid: true key: IDCARD_INFORMATION value: '106' - description: '' is_valid: true key: IMPRESSION_LEVEL_AD_REVENUE value: '312' - description: '' is_valid: true key: INITIATE_ORDER value: '267' - description: '' is_valid: true key: INSTALL_FINISH value: '15' - description: '' is_valid: true key: INTENTION_CLUE value: '41' - description: '' is_valid: true key: INVALID_CLUE value: '40' - description: '' is_valid: true key: IN_APP_AD_CLICK value: '132' - description: '' is_valid: true key: IN_APP_AD_IMPR value: '133' - description: '' is_valid: true key: IN_APP_CART value: '22' - description: '' is_valid: true key: IN_APP_DETAIL_UV value: '29' - description: '' is_valid: true key: IN_APP_ORDER value: '20' - description: '' is_valid: true key: IN_APP_PAY value: '23' - description: '' is_valid: true key: IN_APP_UV value: '21' - description: '' is_valid: true key: LANDING_PAGE_VIEW value: '271' - description: '' is_valid: true key: LAUNCH_APP value: '129' - description: '' is_valid: true key: LIKE_ACTION value: '45' - description: '' is_valid: true key: LINK_ACTION value: '51' - description: '' is_valid: true key: LIVE_APPOINTMENT value: '249' - description: '' is_valid: true key: LIVE_CARD_CLICK value: '215' - description: '' is_valid: true key: LIVE_CLICK_PRODUCT_ACTION value: '167' - description: '' is_valid: true key: LIVE_COMMENT_ACTION value: '164' - description: '' is_valid: true key: LIVE_ENTER_ACTION value: '171' - description: '' is_valid: true key: LIVE_FOLLOW_ACTION value: '163' - description: '' is_valid: true key: LIVE_GIFT_ACTION value: '165' - description: '' is_valid: true key: LIVE_HOMEPAGE value: '111' - description: '' is_valid: true key: LIVE_JOIN_GROUP value: '248' - description: '' is_valid: true key: LIVE_NATIVE_ACTION value: '162' - description: '' is_valid: true key: LIVE_REDIRECT_TO_STORE_ACTION value: '168' - description: '' is_valid: true key: LIVE_ROOM_ACTION value: '254' - description: '' is_valid: true key: LIVE_SLIDECART_CLICK_ACTION value: '166' - description: '' is_valid: true key: LIVE_STAY_TIME value: '186' - description: '' is_valid: true key: LIVE_SUCCESSORDER_ACTION value: '172' - description: '' is_valid: true key: LIVE_SUCESSORDER_PAY value: '169' - description: '' is_valid: true key: LOAN value: '119' - description: '' is_valid: true key: LOAN_APPLY value: '118' - description: '' is_valid: true key: LOAN_COMPLETION value: '103' - description: '' is_valid: true key: LOAN_CREDIT value: '105' - description: '' is_valid: true key: LOCATION_ACTION value: '48' - description: '' is_valid: true key: LOGIN value: '114' - description: '' is_valid: true key: LOGIN_ACTION value: '136' - description: '' is_valid: true key: LONGTERM_CUSTOMER value: '130' - description: '' is_valid: true key: LOTTERY value: '11' - description: '' is_valid: true key: LT_ROI value: '110' - description: '' is_valid: true key: MAP_SEARCH value: '3' - description: '' is_valid: true key: MESSAGE value: '94' - description: '' is_valid: true key: MESSAGE_ACTION value: '63' - description: '' is_valid: true key: MESSAGE_CLICK value: '177' - description: '' is_valid: true key: MESSAGE_JOIN_GROUP value: '247' - description: '' is_valid: true key: MESSAGE_SELF_SERVICE value: '188' - description: '' is_valid: true key: MESSAGE_SEND value: '310' - description: '' is_valid: true key: MULTIPLE value: '100' - description: '' is_valid: true key: MULTI_NATIVE_ACTION value: '102' - description: '' is_valid: true key: NATIVE_ACTION value: '44' - description: '' is_valid: true key: NAV_BAR value: '149' - description: '' is_valid: true key: NEW_FOLLOW_ACTION value: '187' - description: '' is_valid: true key: NEXT_DAY_OPEN value: '39' - description: '' is_valid: true key: NOVEL_CHAPTER value: '115' - description: '' is_valid: true key: ON_WEB_CART value: '147' - description: '' is_valid: true key: ON_WEB_DETAIL value: '146' - description: '' is_valid: true key: ON_WEB_ORDER value: '148' - description: '' is_valid: true key: ON_WEB_REGISTER value: '145' - description: '' is_valid: true key: OTHER value: '99' - description: '' is_valid: true key: OTO_PAY value: '229' - description: '' is_valid: true key: OTO_STAY_TIME value: '228' - description: '' is_valid: true key: PAGE_VIEW value: '93' - description: '' is_valid: true key: PAGE_VISIT value: '314' - description: '' is_valid: true key: PAID_CLUE value: '43' - description: '' is_valid: true key: PAY_ACTION value: '137' - description: '' is_valid: true key: PAY_ROI value: '160' - description: '' is_valid: true key: PERSONAL_INFORMATION value: '108' - description: '' is_valid: true key: PHONE value: '1' - description: '' is_valid: true key: PHONE_BUTTON value: '153' - description: '' is_valid: true key: PHONE_CONFIRM value: '16' - description: '' is_valid: true key: PHONE_CONNECT value: '17' - description: '' is_valid: true key: PHONE_DETAIL value: '152' - description: '' is_valid: true key: PHONE_EFFECTIVE value: '18' - description: '' is_valid: true key: PREFERRED_LEAD value: '315' - description: '' is_valid: true key: PREMIUM_PAYMENT value: '174' - description: '' is_valid: true key: PRE_LOAN_CREDIT value: '104' - description: '' is_valid: true key: PURCHASE_OF_GOODS value: '156' - description: '' is_valid: true key: QQ value: '10' - description: '' is_valid: true key: RATE value: '138' - description: '' is_valid: true key: READING_TIME value: '117' - description: '' is_valid: true key: REDIRECT value: '95' - description: '' is_valid: true key: REDIRECT_TO_SHOP value: '50' - description: '' is_valid: true key: REDIRECT_TO_STORE value: '113' - description: '' is_valid: true key: REGISTER_ACTION value: '139' - description: '' is_valid: true key: RESERVATION value: '62' - description: '' is_valid: true key: RSS value: '30' - description: '' is_valid: true key: SALES_LEAD value: '24' - description: '' is_valid: true key: SEARCH value: '140' - description: '' is_valid: true key: SEVEN_DAY_OPEN value: '227' - description: '' is_valid: true key: SHARE_ACTION value: '65' - description: '' is_valid: true key: SHOPPING value: '96' - description: '' is_valid: true key: SHOPPING_ACTION value: '49' - description: '' is_valid: true key: SHOPPING_CART value: '182' - description: '' is_valid: true key: START_TRIAL value: '142' - description: '' is_valid: true key: STAY_TIME value: '125' - description: '' is_valid: true key: SUBSCRIBE value: '143' - description: '' is_valid: true key: SUCCESSORDER_ACTION value: '53' - description: '' is_valid: true key: SUCCESSORDER_PAY value: '112' - description: '' is_valid: true key: UG_EFFECTIVE_ACTION value: '245' - description: '' is_valid: true key: UG_EFFECTIVE_DEAL value: '244' - description: '' is_valid: true key: UG_EFFECTIVE_SHARE value: '246' - description: '' is_valid: true key: UG_EFFECTIVE_SPEECH value: '243' - description: '' is_valid: true key: UG_ROI value: '178' - description: '' is_valid: true key: UNLOCK_ACHIEVEMENT value: '144' - description: '' is_valid: true key: UPDATE_LEVEL value: '37' - description: '' is_valid: true key: VIEW value: '7' - description: '' is_valid: true key: VOTE value: '12' - description: '' is_valid: true key: XPATH value: '6' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 4 location_ids: description: IDs of the locations that you want to target. items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 objective_type: description: 'Campaign objective. The current API endpoint only supports Traffic and Website conversions objectives. For enum values and descriptions, see Objectives. Note: This API is being revamped to support larger function scope and more accurate result. Please stay tuned for updates.' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1815013888391169 enum_package_name: ToolCampaignObjectiveType enums: - description: '' is_valid: false key: APP_INSTALL value: '2' - description: '' is_valid: true key: APP_PROMOTION value: '16' - description: '' is_valid: false key: CATALOG_SALES value: '6' - description: '' is_valid: false key: CONVERSIONS value: '3' - description: '' is_valid: true key: ENGAGEMENT value: '9' - description: '' is_valid: false key: EST_AD value: '51' - description: '' is_valid: true key: LEAD_GENERATION value: '8' - description: '' is_valid: false key: NONE_TYPE value: '0' - description: '' is_valid: true key: PRODUCT_SALES value: '15' - description: '' is_valid: true key: REACH value: '5' - description: '' is_valid: false key: RF_APP_INSTALL value: '13' - description: '' is_valid: false key: RF_ENGAGEMENT value: '12' - description: '' is_valid: true key: RF_REACH value: '7' - description: '' is_valid: false key: RF_TRAFFIC value: '11' - description: '' is_valid: false key: RF_VIDEO_VIEW value: '10' - description: '' is_valid: false key: SS_HTC_AD value: '52' - description: '' is_valid: false key: TOPVIEW_REACH value: '50' - description: '' is_valid: true key: TRAFFIC value: '1' - description: '' is_valid: true key: VIDEO_VIEWS value: '4' - description: '' is_valid: true key: WEB_CONVERSIONS value: '3' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 5 required: - advertiser_id - location_ids - objective_type type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get a suggested bid [Tool Bid Recommend](https://ads.tiktok.com/marketing_api/docs?id=1737107845597186) tags: - Tool x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.body.advertiser_id type: number - name: campaign_id required: false source: $.http.body.campaign_id type: number - children: - type: number is_expand: true name: location_ids required: false source: $.http.body.location_ids[] sub_type: number type: array - name: external_action required: false source: $.http.body.external_action type: number - name: objective_type required: true source: $.http.body.objective_type type: number - children: - name: app_id required: false source: $.context.app_id type: number - name: core_user_id required: false source: $.context.core_user_id type: number - name: developer_id required: false source: $.context.developer_id type: number is_expand: true name: context_info required: false type: object plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id campaign_id: $.http.body.campaign_id context_info: app_id: $.context.app_id core_user_id: $.context.core_user_id developer_id: $.context.developer_id external_action: $.http.body.external_action location_ids: $.http.body.location_ids[] objective_type: $.http.body.objective_type response_cookie: [] response_header: [] response_rule: bid: $.rpc.output.bid x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /tool/brand_safety/partner/authorize/status/: get: operationId: Tool Brand_safety Partner Authorize Status parameters: - description: 'Brand Safety post bid measurement partner. Enum values: Zefr.' in: query name: partner required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: null enum_package_name: null enums: - description: '' is_valid: true key: Zefr value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.Partner x-open-field-id: 1 - description: Advertiser ID in: query name: advertiser_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.AdvertiserId x-open-field-id: 2 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get the authorization status of a Brand Safety partner [Tool Brand_safety Partner Authorize Status](https://ads.tiktok.com/marketing_api/docs?id=1738456743621634) tags: - Tool x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: Partner required: false source: $.http.query.partner type: number - name: AdvertiserId required: false source: $.http.query.advertiser_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: AdvertiserId: $.http.query.advertiser_id Partner: $.http.query.partner response_cookie: [] response_header: [] response_rule: status: $.rpc.output.Status x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /tool/carrier/: get: operationId: Tool Carrier parameters: - description: Advertiser ID in: query name: advertiser_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.advertiser_id x-open-field-id: 1 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get carriers. [Tool Carrier](https://business-api.tiktok.com/portal/docs?id=1737168013095938) tags: - Tool x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id response_cookie: [] response_header: [] response_rule: countries[][]: - carriers[][]: - carrier_id: $.rpc.output.countries[].carriers[].carrier_id in_use: $.rpc.output.countries[].carriers[].in_use name: $.rpc.output.countries[].carriers[].name value[][]: - hni_id: $.rpc.output.countries[].carriers[].value[].hni_id in_use: $.rpc.output.countries[].carriers[].value[].in_use country_code: $.rpc.output.countries[].country_code x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /tool/contextual_tag/get/: get: operationId: Tool Contextual_tag Get parameters: - description: Advertiser ID. in: query name: advertiser_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.advertiser_id x-open-field-id: 1 - description: Advertising objective. Only supports REACH, VIDEO_VIEWS, RF_REACH. in: query name: objective_type required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: null enum_package_name: null enums: - description: '' is_valid: true key: REACH value: '5' - description: '' is_valid: true key: VIDEO_VIEWS value: '4' - description: '' is_valid: true key: RF_REACH value: '7' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.objective_type x-open-field-id: 2 - content: application/json: schema: items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.region_codes description: Country or region codes. in: query name: region_codes required: false x-open-field-id: 3 - description: 'Brand safety type. Default value: STANDARD_INVENTORY. Enum values: EXPANDED_INVENTORY: Use TikTok''s brand safety solution. Expanded inventory means that your ads will appear next to content where most inappropriate content has been removed, and may contain some mature themes. In the next API version, EXPANDED_INVENTORY will replace NO_BRAND_SAFETY and will be the default brand safety option. STANDARD_INVENTORY: Use TikTok''s brand safety solution. Standard inventory means that ads will appear next to content that is appropriate for most brands. LIMITED_INVENTORY: Use TikTok''s brand safety solution. Limited inventory means that your ads will not appear next to content that contains mature themes. Note: Pre-bid first-party Brand Safety solutions for APP_PROMOTION, WEB_CONVERSIONS, TRAFFIC, LEAD_GENERATION objectives in Auction ads, and pre-bid third-party brand safety solutions are currently allowlist-only features. If you would like to access them, please contact your TikTok representative. See Brand safety to learn about the supported advertising objectives for pre-bid Brand Safety filtering.' in: query name: brand_safety_type required: false schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1799789799590914 enum_package_name: brand_safety_type enums: - description: '' is_valid: true key: EXPANDED_INVENTORY value: '7' - description: '' is_valid: true key: LIMITED_INVENTORY value: '6' - description: '' is_valid: true key: NO_BRAND_SAFETY value: '1' - description: '' is_valid: true key: STANDARD_INVENTORY value: '5' - description: '' is_valid: true key: THIRD_PARTY value: '4' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.brand_safety_type x-open-field-id: 4 - description: 'Note: When objective_type is specified as RF_REACH, use this field to set the campaign as a TikTok Pulse campaign, then you can get available premium contextual tags. Do not pass in this field when objective_type is not specified as RF_REACH. Enum values: STANDARD (Reach & Frequency campaign), PULSE（TikTok Pulse campaign）' in: query name: rf_campaign_type required: false schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1799789905918978 enum_package_name: rf_campaign_type enums: - description: '' is_valid: true key: PULSE value: '1' - description: '' is_valid: true key: STANDARD value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.rf_campaign_type x-open-field-id: 5 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get available contextual tags [Tool Contextual_tag Get](https://ads.tiktok.com/marketing_api/docs?id=1747747118654465) tags: - Tool x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - name: objective_type required: true source: $.http.query.objective_type type: number - children: - type: string is_expand: true name: region_codes required: false source: $.http.query.region_codes[] sub_type: string type: array - name: brand_safety_type required: false source: $.http.query.brand_safety_type type: number - name: rf_campaign_type required: false source: $.http.query.rf_campaign_type type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id brand_safety_type: $.http.query.brand_safety_type objective_type: $.http.query.objective_type region_codes: $.http.query.region_codes[] rf_campaign_type: $.http.query.rf_campaign_type response_cookie: [] response_header: [] response_rule: contextual_tag_list[][]: - content_lineup_type: $.rpc.output.contextual_tag_list[].content_lineup_type contextual_tag_id: $.rpc.output.contextual_tag_list[].contextual_tag_id description: $.rpc.output.contextual_tag_list[].description name: $.rpc.output.contextual_tag_list[].name objective_types: $.rpc.output.contextual_tag_list[].objective_types region_codes: $.rpc.output.contextual_tag_list[].region_codes status: $.rpc.output.contextual_tag_list[].status type: $.rpc.output.contextual_tag_list[].type x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /tool/contextual_tag/info/: get: operationId: Tool Contextual_tag Info parameters: - description: Advertiser ID. in: query name: advertiser_id required: true schema: nullable: false 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: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.contextual_tag_ids description: Contextual tag IDs. in: query name: contextual_tag_ids required: true x-open-field-id: 2 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get details of contextual tags [Tool Contextual_tag Info](https://ads.tiktok.com/marketing_api/docs?id=1747747180830722) tags: - Tool x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - children: - type: number is_expand: true name: contextual_tag_ids required: true source: $.http.query.contextual_tag_ids[] sub_type: number type: array plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id contextual_tag_ids: $.http.query.contextual_tag_ids[] response_cookie: [] response_header: [] response_rule: contextual_tag_list[][]: - content_lineup_type: $.rpc.output.contextual_tag_list[].content_lineup_type contextual_tag_id: $.rpc.output.contextual_tag_list[].contextual_tag_id description: $.rpc.output.contextual_tag_list[].description name: $.rpc.output.contextual_tag_list[].name objective_types: $.rpc.output.contextual_tag_list[].objective_types region_codes: $.rpc.output.contextual_tag_list[].region_codes status: $.rpc.output.contextual_tag_list[].status type: $.rpc.output.contextual_tag_list[].type x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /tool/hashtag/get/: get: operationId: Tool Hashtag Get parameters: - description: Advertiser ID in: query name: advertiser_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 - content: application/json: schema: items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false description: List of keyword IDs in: query name: keyword_ids required: true x-open-field-id: 2 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get targeting hashtags by ID [Tool Hashtag Get](https://ads.tiktok.com/marketing_api/docs?id=1736280889167874) tags: - Tool x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - children: - type: number is_expand: true name: keyword_ids required: false source: $.http.query.keyword_ids[] sub_type: number type: array plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id keyword_ids: $.http.query.keyword_ids[] response_cookie: [] response_header: [] response_rule: keywords_status[][]: - keyword: $.rpc.output.keywords_status[].keyword keyword_id: $.rpc.output.keywords_status[].keyword_id keyword_status: $.rpc.output.keywords_status[].status x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /tool/hashtag/recommend/: get: operationId: Tool Hashtag Recommend parameters: - description: Advertiser ID. in: query name: advertiser_id required: true schema: nullable: false 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: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 10 minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.keywords description: 'Keywords that you want to get recommended hashtags for. If you specify multiple unrelated keywords and set operator to AND, it is possible that no recommended hashtags are returned. Max size: 10.' in: query name: keywords required: true x-open-field-id: 2 - description: 'The operator to be used between the keywords. Enum values: AND: Recommended hashtags will be generated based on all the keywords specified in keywords. OR: Recommended hashtags will be generated separately for each individual keyword in keywords. Default value: AND.' in: query name: operator required: false schema: default: AND nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.operator x-open-validate: - error_msg: 'Operator: Must be one of: AND, OR.' expr: '%s in ["AND", "OR"]' x-open-field-id: 3 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Search for targeting hashtags [Tool Hashtag Recommend](https://ads.tiktok.com/marketing_api/docs?id=1736271339521025) tags: - Tool x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - children: - type: string is_expand: true name: keywords required: true source: $.http.query.keywords[] sub_type: string type: array - name: operator required: false source: $.http.query.operator type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id keywords: $.http.query.keywords[] operator: $.http.query.operator response_cookie: [] response_header: [] response_rule: recommend_keywords[][]: - input_keyword: $.rpc.output.recommend_keywords[].input_keyword keyword: $.rpc.output.recommend_keywords[].keyword keyword_id: $.rpc.output.recommend_keywords[].keyword_id keyword_status: $.rpc.output.recommend_keywords[].keyword_status x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /tool/interest_keyword/get/: get: operationId: Tool Interest_keyword Get parameters: - description: Advertiser ID. in: query name: advertiser_id required: true schema: nullable: false 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: nullable: false properties: audience_type: default: GENERAL_INTEREST description: 'The audience type that you want to filter by. Enum values: GENERAL_INTEREST: General interest. The audiences have a general, long-term interest in a video category. PURCHASE_INTENTION: Purchase intent. The audiences'' recent behavior suggests they may buy something related to a content category. Default value: GENERAL_INTEREST.' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1802435246858242 enum_package_name: KeywordScene enums: - description: '' is_valid: true key: GENERAL_INTEREST value: '12' - description: '' is_valid: false key: HASHTAG_TARGETING value: '13' - description: '' is_valid: true key: PURCHASE_INTENTION value: '14' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 1 x-open-source: $.http.query.filtering.audience_type type: object x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.filtering description: Filtering conditions. in: query name: filtering required: false x-open-field-id: 2 - content: application/json: schema: items: nullable: false properties: keyword_id: description: Additional interest category ID. nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 x-open-source: $.http.query.keyword_query[].keyword_id language: default: en description: 'Additional interest category language. Default value: en. Supported languages: fr, id, it, ja, ms, ar, vi, en, ru, es, th, tr, hi, zh, de, ko.' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1802434494012417 enum_package_name: Language enums: - description: '' is_valid: true key: ar value: '15' - description: '' is_valid: true key: de value: '3' - description: '' is_valid: true key: en value: '1' - description: '' is_valid: true key: es value: '4' - description: '' is_valid: true key: fr value: '5' - description: '' is_valid: true key: hi value: '6' - description: '' is_valid: true key: id value: '7' - description: '' is_valid: true key: it value: '8' - description: '' is_valid: true key: ja value: '2' - description: '' is_valid: true key: ko value: '9' - description: '' is_valid: true key: ms value: '10' - description: '' is_valid: true key: ru value: '11' - description: '' is_valid: true key: th value: '12' - description: '' is_valid: true key: tr value: '13' - description: '' is_valid: true key: vi value: '14' - description: '' is_valid: true key: zh value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 2 x-open-source: $.http.query.keyword_query[].language required: - keyword_id type: object x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 50 minItems: 1 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.keyword_query description: Information of the additional interest category you want to get. Max size = 50. in: query name: keyword_query required: false x-open-field-id: 3 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get additional interest categories by ID [Tool Interest_keyword Get](https://ads.tiktok.com/marketing_api/docs?id=1763590894544897) tags: - Tool x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - children: - name: audience_type required: false source: $.http.query.filtering.audience_type type: number is_expand: true name: filtering required: false type: object - children: - children: - name: keyword_id required: true source: $.http.query.keyword_query[].keyword_id type: number - name: language required: false source: $.http.query.keyword_query[].language type: number is_expand: true type: object is_expand: true name: keyword_query required: false sub_type: object type: array plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id filtering: audience_type: $.http.query.filtering.audience_type keyword_query[][]: - keyword_id: $.http.query.keyword_query[].keyword_id language: $.http.query.keyword_query[].language response_cookie: [] response_header: [] response_rule: keywords[][]: - keyword: $.rpc.output.keywords[].keyword keyword_id: $.rpc.output.keywords[].keyword_id status: $.rpc.output.keywords[].status x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /tool/open_url/: get: operationId: Tool Open_url parameters: - description: Advertiser ID in: query name: advertiser_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.advertiser_id x-open-field-id: 1 - description: Open URL that you want to get the internal link for. in: query name: url required: true schema: format: url nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.url x-open-field-id: 2 - description: 'Type of the open TikTok URL. Enum: USER_PROFILE VIDEO: Video detail page HASHTAG_CHALLENGE: Hashtag challenge page MUSIC: Music page STICKER: Sticker (special effect) page STICKER_SHOOTER: Shoot a video with a sticker (special effect).' in: query name: url_type required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.url_type x-open-field-id: 3 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get a TikTok in-app link [Tool Open_url](https://ads.tiktok.com/marketing_api/docs?id=1738457335681026) tags: - Tool x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - name: url required: true source: $.http.query.url type: string - name: url_type required: true source: $.http.query.url_type type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id url: $.http.query.url url_type: $.http.query.url_type response_cookie: [] response_header: [] response_rule: open_url: $.rpc.output.open_url supported_regions: $.rpc.output.supported_regions x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: true /tool/os_version/: get: operationId: Tool Os_version parameters: - description: Advertiser ID. in: query name: advertiser_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 - description: 'OS type. Enum values: ANDROID,IOS.' in: query name: os_type required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1802236567813122 enum_package_name: OsVersionType enums: - description: '' is_valid: true key: ANDROID value: '1' - description: '' is_valid: true key: IOS value: '2' - description: '' is_valid: false key: IOS14_MINUS value: '4' - description: '' is_valid: false key: IOS14_PLUS value: '3' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 2 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get OS versions [Tool Os_version](https://ads.tiktok.com/marketing_api/docs?id=1738308662898689) tags: - Tool x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - name: os_type required: true source: $.http.query.os_type type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id os_type: $.http.query.os_type response_cookie: [] response_header: [] response_rule: os_versions[][]: - name: $.rpc.output.os_versions[].name os_id: $.rpc.output.os_versions[].os_id os_type: $.rpc.output.os_versions[].os_type version: $.rpc.output.os_versions[].version x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /tool/phone_region_code/: get: operationId: Tool Phone_region_code parameters: - description: Advertiser ID. in: query name: advertiser_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get region calling codes and region codes for phone numbers [Tool Phone_region_code](https://ads.tiktok.com/marketing_api/docs?id=1774488637039618) tags: - Tool x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: [] plugins: after_response: [] before_request: [] request_query_rule: null request_rule: null response_cookie: [] response_header: [] response_rule: phone_region_code_infos[][]: - phone_region_calling_code: $.rpc.output.phone_area_code_info[].area phone_region_code: $.rpc.output.phone_area_code_info[].short_name phone_region_name: $.rpc.output.phone_area_code_info[].name x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /tool/targeting/info/: post: operationId: Tool Targeting Info parameters: - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string requestBody: content: application/json: schema: properties: advertiser_id: description: Advertiser ID. nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 x-open-source: $.http.body.advertiser_id brand_safety_partner: description: 'Required only when brand_safety_type is THIRD_PARTY. Brand safety partner. Enum values: IAS, OPEN_SLATE(The partner is named DoubleVerify on TikTok Ads Manager because the partner has been acquired by DoubleVerify). Note: Pre-bid third-party brand safety solutions are currently allowlist-only features. If you would like to access them, please contact your TikTok representative.' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800967691601922 enum_package_name: BrandSafetyPartnerType enums: - description: '' is_valid: true key: IAS value: '2' - description: '' is_valid: true key: OPEN_SLATE value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 8 x-open-source: $.http.body.brand_safety_partner brand_safety_type: description: 'Brand safety type. Valid only when scene is set as GEO and placements is set as PLACEMENT_TIKTOK. Default value: NO_BRAND_SAFETY. Enum values: NO_BRAND_SAFETY: To not use any brand safety solution. Full inventory, which means your ads may appear next to some content featuring mature themes. EXPANDED_INVENTORY: Use TikTok''s brand safety solution. Expanded inventory means that your ads will appear next to content where most inappropriate content has been removed, and that does not contain mature themes. In the next API version, EXPANDED_INVENTORY will replace NO_BRAND_SAFETY and will be the default brand safety option. STANDARD_INVENTORY: Use TikTok''s brand safety solution. Standard inventory means that ads will appear next to content that is appropriate for most brands. LIMITED_INVENTORY: Use TikTok''s brand safety solution. Limited inventory means that your ads will not appear next to content that contains mature themes. THIRD_PARTY: Use a third-party brand safety solution. You also need to pass in a value to the brand_safety_partner field. To get the countries and regions that your ads can be deployed to based on your brand safety settings, use the /tool/region/ endpoint. Note: Pre-bid first-party Brand Safety solutions for APP_PROMOTION, WEB_CONVERSIONS, TRAFFIC, LEAD_GENERATION objectives in Auction ads, and pre-bid third-party brand safety solutions are currently allowlist-only features. If you would like to access them, please contact your TikTok representative. See Brand safety to learn about the supported advertising objectives for pre-bid Brand Safety filtering.' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800967668879361 enum_package_name: BrandSafetyType enums: - description: '' is_valid: true key: EXPANDED_INVENTORY value: '7' - description: '' is_valid: true key: LIMITED_INVENTORY value: '6' - description: '' is_valid: true key: NO_BRAND_SAFETY value: '1' - description: '' is_valid: true key: STANDARD_INVENTORY value: '5' - description: '' is_valid: true key: THIRD_PARTY value: '4' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 7 x-open-source: $.http.body.brand_safety_type objective_type: description: 'Required when scene is set as GEO. Campaign objective. The allowed enum values: REACH, TRAFFIC, VIDEO_VIEWS, LEAD_GENERATION, ENGAGEMENT, APP_PROMOTION, WEB_CONVERSIONS, PRODUCT_SALES. For descriptions of the objectives, see Objectives.' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: null enum_package_name: CampaignObjectiveType enums: - description: '' is_valid: true key: NONE_TYPE value: '0' - description: '' is_valid: true key: REACH value: '5' - description: '' is_valid: true key: TRAFFIC value: '1' - description: '' is_valid: true key: APP_INSTALL value: '2' - description: '' is_valid: true key: VIDEO_VIEWS value: '4' - description: '' is_valid: true key: CONVERSIONS value: '3' - description: '' is_valid: true key: CATALOG_SALES value: '6' - description: '' is_valid: true key: LEAD_GENERATION value: '8' - description: '' is_valid: true key: ENGAGEMENT value: '9' - description: '' is_valid: true key: RF_VIDEO_VIEW value: '10' - description: '' is_valid: true key: RF_TRAFFIC value: '11' - description: '' is_valid: true key: RF_ENGAGEMENT value: '12' - description: '' is_valid: true key: RF_APP_INSTALL value: '13' - description: '' is_valid: true key: PRODUCT_SALES value: '15' - description: '' is_valid: true key: APP_PROMOTION value: '16' - description: '' is_valid: true key: WEB_CONVERSIONS value: '3' - description: '' is_valid: true key: TOPVIEW_REACH value: '50' - description: '' is_valid: true key: EST_AD value: '51' - description: '' is_valid: true key: SS_HTC_AD value: '52' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 4 x-open-source: $.http.body.objective_type operating_system: description: 'Valid only when scene is set as GEO. Device operating system that you want to target. Enum values: ANDROID, IOS.' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800967646681090 enum_package_name: PlatformType enums: - description: '' is_valid: true key: ANDROID value: '1' - description: '' is_valid: true key: IOS value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 6 x-open-source: $.http.body.operating_system placements: description: 'Required when scene is set as GEO. The apps where you want to deliver your ads. For enum values, see Enumeration - Placement. Note: If you want to get information about zip code IDs to be used for zip code targeting in the US or postal code IDs to be used for postal code targeting in Canada, the value of this field needs to include PLACEMENT_TIKTOK.' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800966528747521 enum_package_name: InventoryFlow enums: - description: '' is_valid: true key: PLACEMENT_GLOBAL_APP_BUNDLE value: '1000' - description: '' is_valid: true key: PLACEMENT_HELO value: '4000' - description: '' is_valid: true key: PLACEMENT_PANGLE value: '9000' - description: '' is_valid: true key: PLACEMENT_TIKTOK value: '3000' - description: '' is_valid: true key: PLACEMENT_VIGO value: '2000' key_format: string strict: true use_part: false validate_only: false value_format: int32 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 3 x-open-source: $.http.body.placements promotion_type: description: Required when scene is set as GEO and objective_type is NOT set as REACH, VIDEO_VIEWS, or ENGAGEMENT. Promotion type and you can decide where you'd like to promote your products using this field. For enum values, see Enumeration - Promotion Type. nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1799795775493121 enum_package_name: ExternalType enums: - description: '' is_valid: true key: AEO_APK value: '204' - description: '' is_valid: true key: APP_ANDROID value: '201' - description: '' is_valid: true key: APP_IOS value: '202' - description: '' is_valid: true key: LEAD_GENERATION value: '601' - description: '' is_valid: true key: LIVE_SHOPPING value: '305' - description: '' is_valid: true key: PRODUCT_SHOPPING value: '307' - description: '' is_valid: true key: TIKTOK_SHOP value: '11' - description: '' is_valid: true key: VIDEO_SHOPPING value: '304' - description: '' is_valid: true key: WEBSITE value: '102' - description: '' is_valid: true key: WEBSITE_OR_DISPLAY value: '602' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 9 x-open-source: $.http.body.promotion_type scene: default: GEO description: 'The targeting type that the specified targeting_ids is used for. Enum values: GEO: Geographical targeting, which consists of administrative region targeting and zip code targeting (or postal code targeting). ISP : Internet Service Provider targeting. Default value: GEO.' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800965588712449 enum_package_name: ListScene enums: - description: '' is_valid: true key: GEO value: '2' - description: '' is_valid: true key: ISP value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 5 x-open-source: $.http.body.scene targeting_ids: description: 'Targeting tag IDs. You can pass in location IDs, zip code IDs or postal code IDs, a combination of location IDs, zip code IDs or postal code IDs, or ISP IDs. Max size: 1,000. You can get location IDs, zip code IDs, or postal code IDs via geo_id returned from /tool/targeting/search/, or get location IDs via location_id returned from /tool/region/. You can get ISP IDs via isp_id returned from /tool/targeting/list/.' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 1000 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.targeting_ids required: - advertiser_id - targeting_ids type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Obtain details about location targeting tags by ID [Tool Targeting Info](https://ads.tiktok.com/marketing_api/docs?id=1761237001980929) tags: - Tool x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.body.advertiser_id type: number - children: - type: number is_expand: true name: placements required: false source: $.http.body.placements[] sub_type: number type: array - name: objective_type required: false source: $.http.body.objective_type type: number - name: scene required: false source: $.http.body.scene type: number - name: operating_system required: false source: $.http.body.operating_system type: number - name: brand_safety_type required: false source: $.http.body.brand_safety_type type: number - name: brand_safety_partner required: false source: $.http.body.brand_safety_partner type: number - name: promotion_type required: false source: $.http.body.promotion_type type: number - children: - type: string is_expand: true name: targeting_ids required: true source: $.http.body.targeting_ids[] sub_type: string type: array plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id brand_safety_partner: $.http.body.brand_safety_partner brand_safety_type: $.http.body.brand_safety_type objective_type: $.http.body.objective_type operating_system: $.http.body.operating_system placements: $.http.body.placements[] promotion_type: $.http.body.promotion_type scene: $.http.body.scene targeting_ids: $.http.body.targeting_ids[] response_cookie: [] response_header: [] response_rule: parent_tags[][]: - geo[]: - description: $.rpc.output.parent_tags[].geo.description geo_id: $.rpc.output.parent_tags[].geo.id geo_type: $.rpc.output.parent_tags[].geo.type parent_id: $.rpc.output.parent_tags[].geo.parent_id region_code: $.rpc.output.parent_tags[].geo.country_code isp[]: - isp_id: $.rpc.output.parent_tags[].isp.isp_id location_id: $.rpc.output.parent_tags[].isp.location_id region_code: $.rpc.output.parent_tags[].isp.region_code name: $.rpc.output.parent_tags[].name status_info[]: - reason: $.rpc.output.parent_tags[].status_info.reason status: $.rpc.output.parent_tags[].status_info.status targeting_type: $.rpc.output.parent_tags[].format_type targeting_tag_list[][]: - geo[]: - description: $.rpc.output.targeting_tag_list[].geo.description geo_id: $.rpc.output.targeting_tag_list[].geo.id geo_type: $.rpc.output.targeting_tag_list[].geo.type parent_id: $.rpc.output.targeting_tag_list[].geo.parent_id region_code: $.rpc.output.targeting_tag_list[].geo.country_code isp[]: - isp_id: $.rpc.output.targeting_tag_list[].isp.isp_id location_id: $.rpc.output.targeting_tag_list[].isp.location_id region_code: $.rpc.output.targeting_tag_list[].isp.region_code name: $.rpc.output.targeting_tag_list[].name status_info[]: - reason: $.rpc.output.targeting_tag_list[].status_info.reason status: $.rpc.output.targeting_tag_list[].status_info.status targeting_type: $.rpc.output.targeting_tag_list[].format_type x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /tool/targeting/list/: get: operationId: Tool Targeting List parameters: - description: Advertiser ID. in: query name: advertiser_id required: true schema: nullable: false 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: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 1000 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.location_ids description: 'IDs of the locations that you want to get the supported ISP IDs for. Max size: 1000. To find out the list of location IDs, see Location IDs. Note: You need to pass location IDs at the country or region level. To get the available locations and corresponding IDs based on your placement and objective, use the /tool/region/ and the returned level for location IDs at the country or region level will be COUNTRY.' in: query name: location_ids required: true x-open-field-id: 2 - description: 'The targeting type that the targeting tags are used for. The allowed enum values: ISP ( Internet Service Provider targeting).' in: query name: scene required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800965588712449 enum_package_name: ListScene enums: - description: '' is_valid: false key: GEO value: '2' - description: '' is_valid: true key: ISP value: '1' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-source: $.http.query.scene x-open-field-id: 3 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get internet service providers [Tool Targeting List](https://ads.tiktok.com/marketing_api/docs?id=1762962378261506) tags: - Tool x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - name: scene required: true source: $.http.query.scene type: number - children: - type: string is_expand: true name: location_ids required: true source: $.http.query.location_ids[] sub_type: string type: array plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id location_ids: $.http.query.location_ids[] scene: $.http.query.scene response_cookie: [] response_header: [] response_rule: parent_tags[][]: - format_type: $.rpc.output.parent_tags[].format_type geo[]: - country_code: $.rpc.output.parent_tags[].geo.country_code description: $.rpc.output.parent_tags[].geo.description id: $.rpc.output.parent_tags[].geo.id parent_id: $.rpc.output.parent_tags[].geo.parent_id type: $.rpc.output.parent_tags[].geo.type isp[]: - isp_id: $.rpc.output.parent_tags[].isp.isp_id location_id: $.rpc.output.parent_tags[].isp.location_id region_code: $.rpc.output.parent_tags[].isp.region_code name: $.rpc.output.parent_tags[].name status_info[]: - reason: $.rpc.output.parent_tags[].status_info.reason status: $.rpc.output.parent_tags[].status_info.status targeting_tag_list[][]: - geo[]: - country_code: $.rpc.output.targeting_tag_list[].geo.country_code description: $.rpc.output.targeting_tag_list[].geo.description id: $.rpc.output.targeting_tag_list[].geo.id parent_id: $.rpc.output.targeting_tag_list[].geo.parent_id type: $.rpc.output.targeting_tag_list[].geo.type isp[]: - isp_id: $.rpc.output.targeting_tag_list[].isp.isp_id location_id: $.rpc.output.targeting_tag_list[].isp.location_id region_code: $.rpc.output.targeting_tag_list[].isp.region_code name: $.rpc.output.targeting_tag_list[].name status_info[]: - reason: $.rpc.output.targeting_tag_list[].status_info.reason status: $.rpc.output.targeting_tag_list[].status_info.status targeting_type: $.rpc.output.targeting_tag_list[].format_type x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /tool/targeting/search/: post: operationId: Tool Targeting Search parameters: - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string requestBody: content: application/json: schema: properties: advertiser_id: description: Advertiser ID. nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 x-open-source: $.http.body.advertiser_id brand_safety_partner: description: 'Required only when brand_safety_type is THIRD_PARTY. Brand safety partner. Enum values: IAS, OPEN_SLATE(The partner is named DoubleVerify on TikTok Ads Manager because the partner has been acquired by DoubleVerify). Note: Pre-bid third-party brand safety solutions are currently allowlist-only features. If you would like to access them, please contact your TikTok representative.' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800967691601922 enum_package_name: BrandSafetyPartnerType enums: - description: '' is_valid: true key: IAS value: '2' - description: '' is_valid: true key: OPEN_SLATE value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 8 x-open-source: $.http.body.brand_safety_partner brand_safety_type: description: 'Brand safety type. Valid only when placements is set as PLACEMENT_TIKTOK. Default value: NO_BRAND_SAFETY. Enum values: NO_BRAND_SAFETY: To not use any brand safety solution. Full inventory, which means your ads may appear next to some content featuring mature themes. EXPANDED_INVENTORY: Use TikTok''s brand safety solution. Expanded inventory means that your ads will appear next to content where most inappropriate content has been removed, and that does not contain mature themes. In the next API version, EXPANDED_INVENTORY will replace NO_BRAND_SAFETY and will be the default brand safety option. STANDARD_INVENTORY: Use TikTok''s brand safety solution. Standard inventory means that ads will appear next to content that is appropriate for most brands. LIMITED_INVENTORY: Use TikTok''s brand safety solution. Limited inventory means that your ads will not appear next to content that contains mature themes. THIRD_PARTY: Use a third-party brand safety solution. You also need to pass in a value to the brand_safety_partner field. To get the countries and regions that your ads can be deployed to based on your brand safety settings, use the /tool/region/ endpoint. Note: Pre-bid first-party Brand Safety solutions for APP_PROMOTION, WEB_CONVERSIONS, TRAFFIC, LEAD_GENERATION objectives in Auction ads, and pre-bid third-party brand safety solutions are currently allowlist-only features. If you would like to access them, please contact your TikTok representative. See Brand safety to learn about the supported advertising objectives for pre-bid Brand Safety filtering.' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800967668879361 enum_package_name: BrandSafetyType enums: - description: '' is_valid: true key: EXPANDED_INVENTORY value: '7' - description: '' is_valid: true key: LIMITED_INVENTORY value: '6' - description: '' is_valid: true key: NO_BRAND_SAFETY value: '1' - description: '' is_valid: true key: STANDARD_INVENTORY value: '5' - description: '' is_valid: true key: THIRD_PARTY value: '4' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 7 x-open-source: $.http.body.brand_safety_type geo_types: description: 'The types of locations that you want to filter the results by. Enum values: COUNTRY (country or region), PROVINCE (province), CITY (city or county), DISTRICT (district or city), DMA (DMA), ZIP_CODE (zip code or postal code). When you specify search_type as FUZZY_SEARCH, the allowed enum values for this field are ZIP_CODE, COUNTRY, PROVINCE, CITY, DISTRICT, and DMA. When you specify search_type as BATCH_ZIPCODE_SEARCH, the allowed enum value for this field is ZIP_CODE. When you specify search_type as BATCH_REGION_SEARCH, the allowed enum values for this field are COUNTRY, PROVINCE, CITY, DISTRICT, and DMA.' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800965724901378 enum_package_name: GeoType enums: - description: '' is_valid: true key: CITY value: '3' - description: '' is_valid: true key: COUNTRY value: '1' - description: '' is_valid: true key: DISTRICT value: '4' - description: '' is_valid: true key: DMA value: '5' - description: '' is_valid: true key: POST_TOWN value: '8' - description: '' is_valid: true key: PROVINCE value: '2' - description: '' is_valid: true key: TOWN value: '7' - description: '' is_valid: true key: ZIP_CODE value: '6' key_format: string strict: true use_part: false validate_only: false value_format: int32 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 10 x-open-source: $.http.body.geo_types keywords: description: 'The keywords that you use to search for targeting tags. Length limit: 1 when search_type is FUZZY_SEARCH. 1,000 when search_type is BATCH_REGION_SEARCH or BATCH_ZIPCODE_SEARCH. If you set search_type as BATCH_ZIPCODE_SEARCH, you need to pass zip codes or postal codes as keywords because this search type only supports exact search. For US zip code targeting, provide the five-digit US zip codes as keywords. Example: ["10001","10002"]. For Canadian postal code targeting, provide the three-character Forward Sortation Area (FSA) portions of Canadian postal codes as keywords. Example: ["A0A","A0B"].' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false maxItems: 1000 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 4 x-open-source: $.http.body.keywords objective_type: description: 'Campaign objective. The allowed enum values: REACH, TRAFFIC, VIDEO_VIEWS, LEAD_GENERATION, ENGAGEMENT, APP_PROMOTION, WEB_CONVERSIONS, PRODUCT_SALES. For descriptions of the objectives, see Objectives.' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1815013888391169 enum_package_name: ToolCampaignObjectiveType enums: - description: '' is_valid: true key: APP_INSTALL value: '2' - description: '' is_valid: true key: APP_PROMOTION value: '16' - description: '' is_valid: true key: CATALOG_SALES value: '6' - description: '' is_valid: true key: CONVERSIONS value: '3' - description: '' is_valid: true key: ENGAGEMENT value: '9' - description: '' is_valid: true key: EST_AD value: '51' - description: '' is_valid: true key: LEAD_GENERATION value: '8' - description: '' is_valid: true key: NONE_TYPE value: '0' - description: '' is_valid: true key: PRODUCT_SALES value: '15' - description: '' is_valid: true key: REACH value: '5' - description: '' is_valid: true key: RF_APP_INSTALL value: '13' - description: '' is_valid: true key: RF_ENGAGEMENT value: '12' - description: '' is_valid: true key: RF_REACH value: '7' - description: '' is_valid: true key: RF_TRAFFIC value: '11' - description: '' is_valid: true key: RF_VIDEO_VIEW value: '10' - description: '' is_valid: true key: SS_HTC_AD value: '52' - description: '' is_valid: true key: TOPVIEW_REACH value: '50' - description: '' is_valid: true key: TRAFFIC value: '1' - description: '' is_valid: true key: VIDEO_VIEWS value: '4' - description: '' is_valid: true key: WEB_CONVERSIONS value: '3' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 3 x-open-source: $.http.body.objective_type operating_system: description: 'Device operating system that you want to target. Enum values: ANDROID, IOS.' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800967646681090 enum_package_name: PlatformType enums: - description: '' is_valid: true key: ANDROID value: '1' - description: '' is_valid: true key: IOS value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 6 x-open-source: $.http.body.operating_system placements: description: 'The apps where you want to deliver your ads. For enum values, see Enumeration - Placement. Note: If you want to fuzzy search for a zip code ID to be used for zip code targeting in the US or a postal code ID to be used for postal code targeting in Canada, the value of this field needs to include PLACEMENT_TIKTOK.' items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: null enum_package_name: InventoryFlow enums: - description: '' is_valid: true key: PLACEMENT_VIGO value: '2000' - description: '' is_valid: true key: PLACEMENT_TIKTOK value: '3000' - description: '' is_valid: true key: PLACEMENT_HELO value: '4000' - description: '' is_valid: true key: PLACEMENT_PANGLE value: '9000' - description: '' is_valid: true key: PLACEMENT_GLOBAL_APP_BUNDLE value: '1000' key_format: string strict: true use_part: false validate_only: false value_format: int32 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 2 x-open-source: $.http.body.placements promotion_type: description: Promotion type and you can decide where you'd like to promote your products using this field. You need to specify the field when advertising objective (objective_type) for your campaign is NOT set as REACH, VIDEO_VIEWS, or ENGAGEMENT. For enum values, see Enumeration - Promotion Type. nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1815569817057282 enum_package_name: ToolExternalType enums: - description: '' is_valid: false key: AEO_APK value: '204' - description: '' is_valid: true key: APP_ANDROID value: '201' - description: '' is_valid: true key: APP_IOS value: '202' - description: '' is_valid: true key: GAME value: '700' - description: '' is_valid: true key: LEAD_GENERATION value: '601' - description: '' is_valid: true key: LEAD_GEN_CLICK_TO_CALL value: '603' - description: '' is_valid: true key: LEAD_GEN_CLICK_TO_SOCIAL_MEDIA_APP_MESSAGE value: '605' - description: '' is_valid: true key: LEAD_GEN_CLICK_TO_TT_DIRECT_MESSAGE value: '604' - description: '' is_valid: true key: LIVE_SHOPPING value: '305' - description: '' is_valid: true key: PRODUCT_SHOPPING value: '307' - description: '' is_valid: true key: TIKTOK_SHOP value: '11' - description: '' is_valid: true key: VIDEO_SHOPPING value: '304' - description: '' is_valid: true key: WEBSITE value: '102' - description: '' is_valid: true key: WEBSITE_OR_DISPLAY value: '602' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-field-id: 11 x-open-source: $.http.body.promotion_type region_codes: description: The codes of targeted countries or regions that you want to filter the results by. When you specify search_type as BATCH_ZIPCODE_SEARCH or BATCH_REGION_SEARCH, this field is required and needs to be set as US (the US) or CA (Canada). When you specify search_type as FUZZY_SEARCH, this field is optional and you can pass any supported country or region code to this field. To find out the complete list of country or region codes, see Location code. items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-field-id: 9 x-open-source: $.http.body.region_codes search_type: description: 'The type of search you want to perform. Enum values: FUZZY_SEARCH: To fuzzy search for a single location ID, a zip code ID, or a postal code ID. For this search type, you can only pass one keyword to keywords and a maximum of 100 results will be returned. BATCH_REGION_SEARCH: To search for location IDs in batch. Fuzzy search is supported. For this search type, you can pass up to 1,000 keywords to keywords, and for each keyword a maximum of 5 results ordered by relevance will be returned. BATCH_ZIPCODE_SEARCH: To search for zip code IDs or postal code IDs in batch. Exact search is supported. For this search type, you can pass up to 1,000 keywords to keywords, and for each keyword one result or no result will be returned. Note: The enum values BATCH_ZIPCODE_SEARCH and BATCH_REGION_SEARCH can only be used to search for IDs of zip codes (or postal codes) or locations in the US or Canada. In contrast, you can use FUZZY_SEARCH to search for a single ID of a zip code (or postal code) or location in the US or Canada or in another country.' nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800967623122946 enum_package_name: LocationSearchType enums: - description: '' is_valid: true key: BATCH_REGION_SEARCH value: '2' - description: '' is_valid: true key: BATCH_ZIPCODE_SEARCH value: '3' - description: '' is_valid: true key: FUZZY_SEARCH value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-field-id: 5 x-open-source: $.http.body.search_type required: - advertiser_id - placements - objective_type - keywords - search_type type: object x-open-allow-strlist: false x-open-allow-strnum: false responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Search for location targeting tags [Tool Targeting Search](https://ads.tiktok.com/marketing_api/docs?id=1761236883355649) tags: - Tool x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.body.advertiser_id type: number - children: - type: number is_expand: true name: placements required: true source: $.http.body.placements[] sub_type: number type: array - name: objective_type required: true source: $.http.body.objective_type type: number - children: - type: string is_expand: true name: keywords required: true source: $.http.body.keywords[] sub_type: string type: array - name: search_type required: true source: $.http.body.search_type type: number - name: operating_system required: false source: $.http.body.operating_system type: number - name: brand_safety_type required: false source: $.http.body.brand_safety_type type: number - name: brand_safety_partner required: false source: $.http.body.brand_safety_partner type: number - children: - type: string is_expand: true name: region_codes required: false source: $.http.body.region_codes[] sub_type: string type: array - children: - type: number is_expand: true name: geo_types required: false source: $.http.body.geo_types[] sub_type: number type: array - name: promotion_type required: false source: $.http.body.promotion_type type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.body.advertiser_id brand_safety_partner: $.http.body.brand_safety_partner brand_safety_type: $.http.body.brand_safety_type geo_types: $.http.body.geo_types[] keywords: $.http.body.keywords[] objective_type: $.http.body.objective_type operating_system: $.http.body.operating_system placements: $.http.body.placements[] promotion_type: $.http.body.promotion_type region_codes: $.http.body.region_codes[] search_type: $.http.body.search_type response_cookie: [] response_header: [] response_rule: parent_tags[][]: - geo[]: - description: $.rpc.output.parent_tags[].geo.description geo_id: $.rpc.output.parent_tags[].geo.id geo_type: $.rpc.output.parent_tags[].geo.type parent_id: $.rpc.output.parent_tags[].geo.parent_id region_code: $.rpc.output.parent_tags[].geo.country_code isp[]: - isp_id: $.rpc.output.parent_tags[].isp.isp_id location_id: $.rpc.output.parent_tags[].isp.location_id region_code: $.rpc.output.parent_tags[].isp.region_code name: $.rpc.output.parent_tags[].name status_info[]: - reason: $.rpc.output.parent_tags[].status_info.reason status: $.rpc.output.parent_tags[].status_info.status targeting_type: $.rpc.output.parent_tags[].format_type targeting_tag_list[][]: - geo[]: - description: $.rpc.output.targeting_tag_list[].geo.description geo_id: $.rpc.output.targeting_tag_list[].geo.id geo_type: $.rpc.output.targeting_tag_list[].geo.type parent_id: $.rpc.output.targeting_tag_list[].geo.parent_id region_code: $.rpc.output.targeting_tag_list[].geo.country_code isp[]: - isp_id: $.rpc.output.targeting_tag_list[].isp.isp_id location_id: $.rpc.output.targeting_tag_list[].isp.location_id region_code: $.rpc.output.targeting_tag_list[].isp.region_code keyword: $.rpc.output.targeting_tag_list[].keyword name: $.rpc.output.targeting_tag_list[].name status_info[]: - reason: $.rpc.output.targeting_tag_list[].status_info.reason status: $.rpc.output.targeting_tag_list[].status_info.status targeting_type: $.rpc.output.targeting_tag_list[].format_type x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /tool/timezone/: get: operationId: Tool Timezone parameters: - description: Advertiser ID in: query name: advertiser_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get time zones [Tool Timezone](https://ads.tiktok.com/marketing_api/docs?id=1738455961470977) tags: - Tool x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: [] plugins: after_response: [] before_request: [] request_query_rule: null request_rule: null response_cookie: [] response_header: [] response_rule: timezones[][]: - gmt_offset: $.rpc.output.time_zone_list[].gmt_offset timezone: $.rpc.output.time_zone_list[].timezone x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /tool/url_validate/: get: operationId: Tool Url_validate parameters: - description: Advertiser ID. in: query name: advertiser_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-field-id: 1 - description: The URL that you want to get verification results for. in: query name: url required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.URL x-open-field-id: 2 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Get the verification results of a URL [Tool Url_validate](https://ads.tiktok.com/marketing_api/docs?id=1774487686007810) tags: - Tool x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: URL required: false source: $.http.query.url type: string plugins: after_response: [] before_request: [] request_query_rule: null request_rule: URL: $.http.query.url response_cookie: [] response_header: [] response_rule: url_info: validate_info: is_scheme_link: $.rpc.output.IsSchemeLink is_valid_scheme: $.rpc.output.IsValidScheme is_valid_url: $.rpc.output.IsValidURL x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false /tool/vbo_status/: get: operationId: Tool Vbo_status parameters: - description: Advertiser ID. in: query name: advertiser_id required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.advertiser_id x-open-field-id: 1 - description: 'Advertising objective. Set this field to APP_PROMOTION, WEB_CONVERSIONS, or PRODUCT_SALES. When you set this field to any other objective, vo_status will be NOT_SUPPORT because these objectives are not supported for VBO. For enum values and descriptions, see Objectives. Note: When objective_type is set to PRODUCT_SALES and promotion_type is set to LIVE_SHOPPING or VIDEO_SHOPPING, do not pass in pixel_id or app_id. Otherwise, pass in either pixel_id or app_id.' in: query name: objective_type required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: null enum_package_name: CampaignObjectiveType enums: - description: '' is_valid: true key: NONE_TYPE value: '0' - description: '' is_valid: true key: REACH value: '5' - description: '' is_valid: true key: TRAFFIC value: '1' - description: '' is_valid: true key: APP_INSTALL value: '2' - description: '' is_valid: true key: VIDEO_VIEWS value: '4' - description: '' is_valid: true key: CONVERSIONS value: '3' - description: '' is_valid: true key: CATALOG_SALES value: '6' - description: '' is_valid: true key: LEAD_GENERATION value: '8' - description: '' is_valid: true key: ENGAGEMENT value: '9' - description: '' is_valid: true key: RF_REACH value: '7' - description: '' is_valid: true key: RF_VIDEO_VIEW value: '10' - description: '' is_valid: true key: RF_TRAFFIC value: '11' - description: '' is_valid: true key: RF_ENGAGEMENT value: '12' - description: '' is_valid: true key: RF_APP_INSTALL value: '13' - description: '' is_valid: true key: PRODUCT_SALES value: '15' - description: '' is_valid: true key: APP_PROMOTION value: '16' - description: '' is_valid: true key: WEB_CONVERSIONS value: '3' - description: '' is_valid: true key: TOPVIEW_REACH value: '50' - description: '' is_valid: true key: EST_AD value: '51' - description: '' is_valid: true key: SS_HTC_AD value: '52' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.objective_type x-open-field-id: 2 - description: 'Promotion type and you can decide where you''d like to promote your products using this field. For enum values, see Enumeration - Promotion Type. Note: When objective_type is set to PRODUCT_SALES and promotion_type is set to LIVE_SHOPPING or VIDEO_SHOPPING, do not pass in pixel_id or app_id. Otherwise, pass in either pixel_id or app_id.' in: query name: promotion_type required: true schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1815569817057282 enum_package_name: ToolExternalType enums: - description: '' is_valid: false key: AEO_APK value: '204' - description: '' is_valid: true key: APP_ANDROID value: '201' - description: '' is_valid: true key: APP_IOS value: '202' - description: '' is_valid: true key: GAME value: '700' - description: '' is_valid: true key: LEAD_GENERATION value: '601' - description: '' is_valid: true key: LEAD_GEN_CLICK_TO_CALL value: '603' - description: '' is_valid: true key: LEAD_GEN_CLICK_TO_SOCIAL_MEDIA_APP_MESSAGE value: '605' - description: '' is_valid: true key: LEAD_GEN_CLICK_TO_TT_DIRECT_MESSAGE value: '604' - description: '' is_valid: true key: LIVE_SHOPPING value: '305' - description: '' is_valid: true key: MINI_APP value: '701' - description: '' is_valid: true key: PRODUCT_SHOPPING value: '307' - description: '' is_valid: true key: TIKTOK_SHOP value: '11' - description: '' is_valid: true key: VIDEO_SHOPPING value: '304' - description: '' is_valid: true key: WEBSITE value: '102' - description: '' is_valid: true key: WEBSITE_OR_DISPLAY value: '602' key_format: string strict: true use_part: true validate_only: false value_format: int32 x-open-source: $.http.query.promotion_type x-open-field-id: 3 - content: application/json: schema: items: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1800966528747521 enum_package_name: InventoryFlow enums: - description: '' is_valid: true key: PLACEMENT_GLOBAL_APP_BUNDLE value: '1000' - description: '' is_valid: false key: PLACEMENT_HELO value: '4000' - description: '' is_valid: true key: PLACEMENT_PANGLE value: '9000' - description: '' is_valid: true key: PLACEMENT_TIKTOK value: '3000' - description: '' is_valid: false key: PLACEMENT_VIGO value: '2000' key_format: string strict: true use_part: true validate_only: false value_format: int32 nullable: false type: array x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.placements description: 'The apps where you want to deliver your ads. Note: Currently, we support PLACEMENT_TIKTOK, PLACEMENT_PANGLE and PLACEMENT_GLOBAL_APP_BUNDLE. For Product Sales campaigns (objective_type = PRODUCT_SALES), only TikTok placement (PLACEMENT_TIKTOK) is supported.' in: query name: placements required: true x-open-field-id: 4 - description: Not supported when objective_type is set to PRODUCT_SALES and promotion_type is set to LIVE_SHOPPING or VIDEO_SHOPPING. Otherwise, pass in either pixel_id or app_id. Pixel ID. When you pass in this field, you need to specify optimization_event at the same time. To get Pixel IDs, use the /pixel/list/ endpoint. in: query name: pixel_id required: false schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.pixel_id x-open-field-id: 5 - description: Not supported when objective_type is set to PRODUCT_SALES and promotion_type is set to LIVE_SHOPPING or VIDEO_SHOPPING. Otherwise, pass in either pixel_id or app_id. The Application ID of the promoted app. To get App IDs, use the /app/list/ endpoint. in: query name: app_id required: false schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.app_id x-open-field-id: 6 - description: Required when pixel_id is passed. Ignored when app_id is passed. Conversion event for the ad group. See Conversion events for more. in: query name: optimization_event required: false schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1799795326256129 enum_package_name: ExternalAction enums: - description: '' is_valid: true key: ACTIVE value: '8' - description: '' is_valid: true key: ACTIVE_PAY value: '14' - description: '' is_valid: true key: ACTIVE_REGISTER value: '13' - description: '' is_valid: true key: ADD_BOOKSHELF value: '116' - description: '' is_valid: true key: ADD_PAYMENT_INFO value: '127' - description: '' is_valid: true key: ADD_TO_WISHLIST value: '128' - description: '' is_valid: true key: ANCHOR_CLICK value: '308' - description: '' is_valid: true key: APPLET_DEAL value: '126' - description: '' is_valid: true key: APPOINTMENT_DOWNLOAD_BUTTON value: '173' - description: '' is_valid: true key: ASCRIPTION_PHONE value: '161' - description: '' is_valid: true key: AUTHORIZATION value: '121' - description: '' is_valid: true key: BANKCARD_INFORMATION value: '107' - description: '' is_valid: true key: BOOST value: '124' - description: '' is_valid: true key: BUTTON value: '5' - description: '' is_valid: true key: CERTIFICATION_INFORMATION value: '109' - description: '' is_valid: true key: CLICK_CALL_DY value: '69' - description: '' is_valid: true key: CLICK_DOWNLOAD value: '68' - description: '' is_valid: true key: CLICK_LANDING_PAGE value: '66' - description: '' is_valid: true key: CLICK_SHOPWINDow value: '67' - description: '' is_valid: true key: CLICK_WEBSITE value: '70' - description: '' is_valid: true key: CLUE_CONFIRM value: '194' - description: '' is_valid: true key: CLUE_HIGH_INTENTION value: '196' - description: '' is_valid: true key: CLUE_INTERFLOW value: '195' - description: '' is_valid: true key: CLUE_PAY_SUCCEED value: '218' - description: '' is_valid: true key: COMMENT_ACTION value: '47' - description: '' is_valid: true key: COMMODITY_CLICK value: '122' - description: '' is_valid: true key: COMPLETE_TUTORIAL value: '131' - description: '' is_valid: true key: CONSULT value: '97' - description: '' is_valid: true key: CONSULT_CLUE value: '123' - description: '' is_valid: true key: CONSULT_EFFECTIVE value: '19' - description: '' is_valid: true key: CONVERSION_LEADS value: '313' - description: '' is_valid: true key: COUPON value: '28' - description: '' is_valid: true key: CREATE_GAMEROLE value: '38' - description: '' is_valid: true key: CUSTOMER_EFFECTIVE value: '26' - description: '' is_valid: true key: DEEP_PURCHASE value: '52' - description: '' is_valid: true key: DESTINATION_VISIT value: '272' - description: '' is_valid: true key: DIALBACK value: '33' - description: '' is_valid: true key: DIALBACK_CONFIRM value: '34' - description: '' is_valid: true key: DIALBACK_CONNECT value: '35' - description: '' is_valid: true key: DOWNLOAD_BUTTON value: '155' - description: '' is_valid: true key: DOWNLOAD_DETAIL value: '154' - description: '' is_valid: true key: DOWNLOAD_FINISH value: '4' - description: '' is_valid: true key: DOWNLOAD_START value: '9' - description: '' is_valid: true key: EC_CLICK_BUY value: '175' - description: '' is_valid: true key: EC_CLICK_PRODUCT value: '179' - description: '' is_valid: true key: EC_CONFRIM_DEAL value: '214' - description: '' is_valid: true key: EC_LIVE_CART value: '210' - description: '' is_valid: true key: EC_LIVE_CLICK_PRODUCT_ACTION value: '208' - description: '' is_valid: true key: EC_LIVE_COMMENT_ACTION value: '205' - description: '' is_valid: true key: EC_LIVE_ENTER_ACTION value: '202' - description: '' is_valid: true key: EC_LIVE_FOLLOW_ACTION value: '204' - description: '' is_valid: true key: EC_LIVE_GIFT_ACTION value: '206' - description: '' is_valid: true key: EC_LIVE_NATIVE_ACTION value: '203' - description: '' is_valid: true key: EC_LIVE_ORDER value: '211' - description: '' is_valid: true key: EC_LIVE_REDIRECT_TO_STORE_ACTION value: '209' - description: '' is_valid: true key: EC_LIVE_SLIDECART_CLICK_ACTION value: '207' - description: '' is_valid: true key: EC_SUBMIT_ORDER value: '176' - description: '' is_valid: true key: EFFECTIVE_COPY value: '27' - description: '' is_valid: true key: ENGAGED_VIEW value: '309' - description: '' is_valid: true key: ENGAGED_VIEW_FIFTEEN value: '311' - description: '' is_valid: true key: ENTER_HOMEPAGE value: '181' - description: '' is_valid: true key: FEED_LIVE_HOMEPAGE value: '120' - description: '' is_valid: true key: FOLLOW_ACTION value: '46' - description: '' is_valid: true key: FOLLOW_LIVE_ENTER value: '250' - description: '' is_valid: true key: FOLLOW_VIDEO_PLAY_FINISH value: '252' - description: '' is_valid: true key: FORM value: '2' - description: '' is_valid: true key: FORM_ANSWER value: '32' - description: '' is_valid: true key: FORM_BUTTON value: '151' - description: '' is_valid: true key: FORM_CONNECT value: '31' - description: '' is_valid: true key: FORM_DEEP value: '36' - description: '' is_valid: true key: FORM_DETAIL value: '150' - description: '' is_valid: true key: GAME_ADDICTION value: '25' - description: '' is_valid: true key: HIGHVALUE_CLUE value: '42' - description: '' is_valid: true key: IDCARD_INFORMATION value: '106' - description: '' is_valid: true key: IMPRESSION_LEVEL_AD_REVENUE value: '312' - description: '' is_valid: true key: INITIATE_ORDER value: '267' - description: '' is_valid: true key: INSTALL_FINISH value: '15' - description: '' is_valid: true key: INTENTION_CLUE value: '41' - description: '' is_valid: true key: INVALID_CLUE value: '40' - description: '' is_valid: true key: IN_APP_AD_CLICK value: '132' - description: '' is_valid: true key: IN_APP_AD_IMPR value: '133' - description: '' is_valid: true key: IN_APP_CART value: '22' - description: '' is_valid: true key: IN_APP_DETAIL_UV value: '29' - description: '' is_valid: true key: IN_APP_ORDER value: '20' - description: '' is_valid: true key: IN_APP_PAY value: '23' - description: '' is_valid: true key: IN_APP_UV value: '21' - description: '' is_valid: true key: LANDING_PAGE_VIEW value: '271' - description: '' is_valid: true key: LAUNCH_APP value: '129' - description: '' is_valid: true key: LIKE_ACTION value: '45' - description: '' is_valid: true key: LINK_ACTION value: '51' - description: '' is_valid: true key: LIVE_APPOINTMENT value: '249' - description: '' is_valid: true key: LIVE_CARD_CLICK value: '215' - description: '' is_valid: true key: LIVE_CLICK_PRODUCT_ACTION value: '167' - description: '' is_valid: true key: LIVE_COMMENT_ACTION value: '164' - description: '' is_valid: true key: LIVE_ENTER_ACTION value: '171' - description: '' is_valid: true key: LIVE_FOLLOW_ACTION value: '163' - description: '' is_valid: true key: LIVE_GIFT_ACTION value: '165' - description: '' is_valid: true key: LIVE_HOMEPAGE value: '111' - description: '' is_valid: true key: LIVE_JOIN_GROUP value: '248' - description: '' is_valid: true key: LIVE_NATIVE_ACTION value: '162' - description: '' is_valid: true key: LIVE_REDIRECT_TO_STORE_ACTION value: '168' - description: '' is_valid: true key: LIVE_ROOM_ACTION value: '254' - description: '' is_valid: true key: LIVE_SLIDECART_CLICK_ACTION value: '166' - description: '' is_valid: true key: LIVE_STAY_TIME value: '186' - description: '' is_valid: true key: LIVE_SUCCESSORDER_ACTION value: '172' - description: '' is_valid: true key: LIVE_SUCESSORDER_PAY value: '169' - description: '' is_valid: true key: LOAN value: '119' - description: '' is_valid: true key: LOAN_APPLY value: '118' - description: '' is_valid: true key: LOAN_COMPLETION value: '103' - description: '' is_valid: true key: LOAN_CREDIT value: '105' - description: '' is_valid: true key: LOCATION_ACTION value: '48' - description: '' is_valid: true key: LOGIN value: '114' - description: '' is_valid: true key: LOGIN_ACTION value: '136' - description: '' is_valid: true key: LONGTERM_CUSTOMER value: '130' - description: '' is_valid: true key: LOTTERY value: '11' - description: '' is_valid: true key: LT_ROI value: '110' - description: '' is_valid: true key: MAP_SEARCH value: '3' - description: '' is_valid: true key: MESSAGE value: '94' - description: '' is_valid: true key: MESSAGE_ACTION value: '63' - description: '' is_valid: true key: MESSAGE_CLICK value: '177' - description: '' is_valid: true key: MESSAGE_JOIN_GROUP value: '247' - description: '' is_valid: true key: MESSAGE_SELF_SERVICE value: '188' - description: '' is_valid: true key: MESSAGE_SEND value: '310' - description: '' is_valid: true key: MULTIPLE value: '100' - description: '' is_valid: true key: MULTI_NATIVE_ACTION value: '102' - description: '' is_valid: true key: NATIVE_ACTION value: '44' - description: '' is_valid: true key: NAV_BAR value: '149' - description: '' is_valid: true key: NEW_FOLLOW_ACTION value: '187' - description: '' is_valid: true key: NEXT_DAY_OPEN value: '39' - description: '' is_valid: true key: NOVEL_CHAPTER value: '115' - description: '' is_valid: true key: ON_WEB_CART value: '147' - description: '' is_valid: true key: ON_WEB_DETAIL value: '146' - description: '' is_valid: true key: ON_WEB_ORDER value: '148' - description: '' is_valid: true key: ON_WEB_REGISTER value: '145' - description: '' is_valid: true key: OTHER value: '99' - description: '' is_valid: true key: OTO_PAY value: '229' - description: '' is_valid: true key: OTO_STAY_TIME value: '228' - description: '' is_valid: true key: PAGE_VIEW value: '93' - description: '' is_valid: true key: PAGE_VISIT value: '314' - description: '' is_valid: true key: PAID_CLUE value: '43' - description: '' is_valid: true key: PAY_ACTION value: '137' - description: '' is_valid: true key: PAY_ROI value: '160' - description: '' is_valid: true key: PERSONAL_INFORMATION value: '108' - description: '' is_valid: true key: PHONE value: '1' - description: '' is_valid: true key: PHONE_BUTTON value: '153' - description: '' is_valid: true key: PHONE_CONFIRM value: '16' - description: '' is_valid: true key: PHONE_CONNECT value: '17' - description: '' is_valid: true key: PHONE_DETAIL value: '152' - description: '' is_valid: true key: PHONE_EFFECTIVE value: '18' - description: '' is_valid: true key: PREFERRED_LEAD value: '315' - description: '' is_valid: true key: PREMIUM_PAYMENT value: '174' - description: '' is_valid: true key: PRE_LOAN_CREDIT value: '104' - description: '' is_valid: true key: PURCHASE_OF_GOODS value: '156' - description: '' is_valid: true key: QQ value: '10' - description: '' is_valid: true key: RATE value: '138' - description: '' is_valid: true key: READING_TIME value: '117' - description: '' is_valid: true key: REDIRECT value: '95' - description: '' is_valid: true key: REDIRECT_TO_SHOP value: '50' - description: '' is_valid: true key: REDIRECT_TO_STORE value: '113' - description: '' is_valid: true key: REGISTER_ACTION value: '139' - description: '' is_valid: true key: RESERVATION value: '62' - description: '' is_valid: true key: RSS value: '30' - description: '' is_valid: true key: SALES_LEAD value: '24' - description: '' is_valid: true key: SEARCH value: '140' - description: '' is_valid: true key: SEVEN_DAY_OPEN value: '227' - description: '' is_valid: true key: SHARE_ACTION value: '65' - description: '' is_valid: true key: SHOPPING value: '96' - description: '' is_valid: true key: SHOPPING_ACTION value: '49' - description: '' is_valid: true key: SHOPPING_CART value: '182' - description: '' is_valid: true key: START_TRIAL value: '142' - description: '' is_valid: true key: STAY_TIME value: '125' - description: '' is_valid: true key: SUBSCRIBE value: '143' - description: '' is_valid: true key: SUCCESSORDER_ACTION value: '53' - description: '' is_valid: true key: SUCCESSORDER_PAY value: '112' - description: '' is_valid: true key: UG_EFFECTIVE_ACTION value: '245' - description: '' is_valid: true key: UG_EFFECTIVE_DEAL value: '244' - description: '' is_valid: true key: UG_EFFECTIVE_SHARE value: '246' - description: '' is_valid: true key: UG_EFFECTIVE_SPEECH value: '243' - description: '' is_valid: true key: UG_ROI value: '178' - description: '' is_valid: true key: UNLOCK_ACHIEVEMENT value: '144' - description: '' is_valid: true key: UPDATE_LEVEL value: '37' - description: '' is_valid: true key: VIEW value: '7' - description: '' is_valid: true key: VOTE value: '12' - description: '' is_valid: true key: XPATH value: '6' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.optimization_event x-open-field-id: 7 - description: 'Do not pass campaign_type and ios14_quota_type at the same time. If both fields are passed, ios14_quota_type will be ignored. We recommend using campaign_type alone when you specify an iOS 14 Dedicated Campaign. campaign_type as REGULAR_CAMPAIGN or ios14_quota_type as UNOCCUPIED both indicate a non-iOS 14 Dedicated Campaign. campaign_type as IOS14_CAMPAIGN or ios14_quota_type as OCCUPIED both indicate an iOS 14 Dedicated Campaign. Whether the campaign will be counted towards the iOS 14 Dedicated Campaign quota. Enum values: OCCUPIED: The campaign is an iOS 14 Dedicated Campaign. UNOCCUPIED: The campaign is not an iOS 14 Dedicated Campaign.' in: query name: ios14_quota_type required: false schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1799795370044418 enum_package_name: IOS14QuotaType enums: - description: '' is_valid: true key: OCCUPIED value: '2' - description: '' is_valid: true key: UNOCCUPIED value: '1' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.ios14_quota_type x-open-field-id: 8 - description: 'Required when objective_type is APP_PROMOTION. App promotion type. Enum values: APP_INSTALL: Get new users to install your app. APP_RETARGETING: Re-engage existing users to take action in your app. Note: Only the enum value APP_INSTALL can be used in an iOS14 Dedicated Campaign.' in: query name: app_promotion_type required: false schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1799795397435394 enum_package_name: AppCampaignType enums: - description: '' is_valid: true key: APP_INSTALL value: '1' - description: '' is_valid: true key: APP_PREREGISTRATION value: '3' - description: '' is_valid: true key: APP_RETARGETING value: '2' - description: '' is_valid: true key: PAID_CONTENT value: '4' - description: '' is_valid: true key: UNSET value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.app_promotion_type x-open-field-id: 9 - description: 'Valid only when objective_type is PRODUCT_SALES. ID of the TikTok Shop. Note: To get the TikTok Shop ID, you can use /bc/asset/get/: When in the response asset_type is TIKTOK_SHOP, the returned asset_id is the TikTok Shop ID.' in: query name: store_id required: false schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-convert: - int64(%s) x-open-source: $.http.query.store_id x-open-field-id: 10 - description: 'Whether to use App Profile Page at the campaign level to optimize delivery. Enum values: ON, OFF. You can use the field only when objective_type is APP_PROMOTION and your campaign is an iOS14 Dedicated Campaign (ios14_quota_type =OCCUPIED). Otherwise, an error will occur.' in: query name: campaign_app_profile_page_state required: false schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1799795483636802 enum_package_name: AppProfilePageType enums: - description: '' is_valid: true key: INVALID value: '-1' - description: '' is_valid: true key: 'OFF' value: '2' - description: '' is_valid: true key: 'ON' value: '1' - description: '' is_valid: true key: UNSET value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.campaign_app_profile_page_state x-open-field-id: 11 - description: 'Whether the campaign is a Smart+ Campaign or not. Enum values: true, false.' in: query name: is_smart_performance_campaign required: false schema: nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.is_smart_performance_campaign x-open-field-id: 12 - description: 'Whether to enable Campaign Budget Optimization (CBO). Enum values: true, false. For details about CBO, see Campaign Budget Optimization.' in: query name: budget_optimize_on required: false schema: default: false nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.budget_optimize_on x-open-field-id: 13 - description: 'Do not pass campaign_type and ios14_quota_type at the same time. If both fields are passed, ios14_quota_type will be ignored. Campaign type. Enums values: REGULAR_CAMPAIGN: non-iOS 14 Dedicated Campaign. IOS14_CAMPAIGN: iOS 14 Dedicated Campaign. The value IOS14_CAMPAIGN can only be used when: objective_type is PRODUCT_SALES. objective_type is APP_PROMOTION and app_promotion_type is APP_INSTALL.' in: query name: campaign_type required: false schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1799795511033857 enum_package_name: IOSCampaignType enums: - description: '' is_valid: true key: IOS14_CAMPAIGN value: '2' - description: '' is_valid: true key: REGULAR_CAMPAIGN value: '0' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.campaign_type x-open-field-id: 14 - description: '' in: query name: is_advanced_dedicated_campaign required: false schema: nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.is_advanced_dedicated_campaign x-open-field-id: 15 - description: '' in: query name: disable_skan_campaign required: false schema: nullable: false type: boolean x-open-allow-strlist: false x-open-allow-strnum: false x-open-source: $.http.query.disable_skan_campaign x-open-field-id: 16 - description: '' in: query name: bid_align_type required: false schema: nullable: false type: string x-open-allow-strlist: false x-open-allow-strnum: false x-open-enum: enum_package_expired: false enum_package_id: 1828789430630402 enum_package_name: ToolBidAlignType enums: - description: '' is_valid: true key: SAN value: '1' - description: '' is_valid: true key: SKAN value: '2' key_format: string strict: true use_part: false validate_only: false value_format: int32 x-open-source: $.http.query.bid_align_type x-open-field-id: 17 - description: Authorized access token. For details, see [Authentication](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162). in: query name: Access-Token required: true schema: type: string responses: '200': content: application/json: schema: properties: code: description: Response code. For the complete list of response codes and descriptions, see [Appendix - Return Codes](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097). Will be shown only if it is an error request. format: int64 nullable: true type: integer 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. nullable: true properties: {} type: object 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). nullable: true type: string x-open-allow-strlist: false x-open-field-id: 3 request_id: description: The log ID of a request, which uniquely identifies the request. nullable: true type: string x-open-allow-strlist: false x-open-field-id: 2 type: object x-open-allow-strlist: false description: OK summary: Check Value-Based Optimization eligibility [Tool Vbo_status](https://ads.tiktok.com/marketing_api/docs?id=1770016073586753) tags: - Tool x-open-allowlist: {} x-open-denylist: {} x-open-rules: base_rule: null extra_rule: base_source: [] http_query_source: [] http_source: - name: advertiser_id required: true source: $.http.query.advertiser_id type: number - name: core_user_id required: true source: $.http.query.context_info.core_user_id type: number - name: objective_type required: true source: $.http.query.objective_type type: number - name: promotion_type required: true source: $.http.query.promotion_type type: number - children: - type: number is_expand: true name: placements required: true source: $.http.query.placements sub_type: number type: array - name: pixel_id required: false source: $.http.query.pixel_id type: number - name: app_id required: false source: $.http.query.app_id type: number - name: optimization_event required: false source: $.http.query.optimization_event type: number - name: ios14_quota_type required: false source: $.http.query.ios14_quota_type type: number - name: app_promotion_type required: false source: $.http.query.app_promotion_type type: number - name: store_id required: false source: $.http.query.store_id type: number - name: campaign_app_profile_page_state required: false source: $.http.query.campaign_app_profile_page_state type: number - name: is_smart_performance_campaign required: false source: $.http.query.is_smart_performance_campaign type: boolean - name: budget_optimize_on required: false source: $.http.query.budget_optimize_on type: boolean - name: campaign_type required: false source: $.http.query.campaign_type type: number - children: - name: app_id required: false source: $.context.app_id type: number - name: core_user_id required: false source: $.context.core_user_id type: number is_expand: true name: context_info required: false type: object - name: is_advanced_dedicated_campaign required: false source: $.http.query.is_advanced_dedicated_campaign type: boolean - name: disable_skan_campaign required: false source: $.http.query.disable_skan_campaign type: boolean - name: bid_align_type required: false source: $.http.query.bid_align_type type: number plugins: after_response: [] before_request: [] request_query_rule: null request_rule: advertiser_id: $.http.query.advertiser_id app_id: $.http.query.app_id app_promotion_type: $.http.query.app_promotion_type bid_align_type: $.http.query.bid_align_type budget_optimize_on: $.http.query.budget_optimize_on campaign_app_profile_page_state: $.http.query.campaign_app_profile_page_state campaign_type: $.http.query.campaign_type context_info: app_id: $.context.app_id core_user_id: $.context.core_user_id core_user_id: $.http.query.context_info.core_user_id disable_skan_campaign: $.http.query.disable_skan_campaign ios14_quota_type: $.http.query.ios14_quota_type is_advanced_dedicated_campaign: $.http.query.is_advanced_dedicated_campaign is_smart_performance_campaign: $.http.query.is_smart_performance_campaign objective_type: $.http.query.objective_type optimization_event: $.http.query.optimization_event pixel_id: $.http.query.pixel_id placements: $.http.query.placements promotion_type: $.http.query.promotion_type store_id: $.http.query.store_id response_cookie: [] response_header: [] response_rule: highest_value_status_day0: $.rpc.output.highest_value_status_day0 highest_value_status_day7: $.rpc.output.roas_status_day7 roas_status_day0: $.rpc.output.roas_status_day0 roas_status_day7: $.rpc.output.roas_status_day7 vo_highest_value: $.rpc.output.vo_highest_value vo_iaa_highest_value: $.rpc.output.vo_iaa_highest_value vo_iaa_highest_value_zero_day: $.rpc.output.vo_iaa_highest_value_zero_day vo_iaa_min_roas: $.rpc.output.vo_iaa_min_roas vo_iaa_min_roas_zero_day: $.rpc.output.vo_iaa_min_roas_zero_day vo_min: $.rpc.output.vo_min vo_min_roas: $.rpc.output.vo_min_roas vo_status: $.rpc.output.vo_status x-open-scene-labels: [] x-open-settings: pop_resp_nullvalue: false components: securitySchemes: AccessToken: type: apiKey in: header name: Access-Token description: Long-term access token issued by POST /oauth2/access_token/ after advertiser authorization. See https://business-api.tiktok.com/portal/docs?id=1738373164380162 security: - AccessToken: []