adgroup_rf_update

ID of the ad group to modify. The campaign it belongs to must have `objective_type` = `RF_REACH`.

Ad group name. Must not exceed 100 characters or contain emojis.

Advertiser ID.

Audience age ranges. If your targeted locations include Israel or Brazil, `AGE_13_17` cannot be used. In some US scenarios, targeting age 13-17 is not allowed. If you use targeting options that are not supported for US age 13-17 and omit `age_groups` or set it to `[]`, an error will occur; explicitly specify the exact age groups you want, such as `AGE_18_24`, to avoid errors.

Audience IDs to target. For an audience to be targeted or excluded in R&F ads, its `audience_sub_type` must be `REACH_FREQUENCY` when the audience is created or updated. Lookalike Audience cannot be used in R&F ads, or an error will occur.

Brand safety type. `EXPANDED_INVENTORY`: use TikTok's brand safety solution with expanded inventory; in the next API version, `EXPANDED_INVENTORY` will replace `NO_BRAND_SAFETY` and be the default option. `STANDARD_INVENTORY`: use TikTok's standard inventory. `LIMITED_INVENTORY`: use TikTok's limited inventory. To get countries and regions your ads can run in for a given brand safety setting, use /tool/region/. Updating Brand Safety settings, including `brand_safety_type`, `category_exclusion_ids`, and `vertical_sensitivity_id`, is currently allowlist-only.

Budget. Fill this value based on data returned by the ad inventory estimate API.

Carrier IDs to target. A carrier is valid only when its `in_use` field is `true`. Carriers must be consistent with the targeted location(s).

Content exclusion category IDs. This field can be updated only if either: (1) the ad group's `schedule_start_time` has not been reached; or (2) `schedule_start_time` has been reached, but the ad group's `operation_status` is `DISABLE` and cost is 0. Use /adgroup/get/ to retrieve `schedule_start_time` and `operation_status`. Use /tool/content_exclusion/get/ to get valid `excluded_category_list` values. Updating Brand Safety settings, including `brand_safety_type`, `category_exclusion_ids`, and `vertical_sensitivity_id`, is currently allowlist-only.

Whether to prohibit users from posting comments on your ads on TikTok.

Contextual tag IDs. Use /tool/contextual_tag/get/ to get available tags. This is an allowlist-only feature. Only supported when the campaign-level `objective_type` is `RF_REACH`. Not supported when `brand_safety_type` is `THIRD_PARTY` or when `feed_type` is `TOP_FEED`. If `rf_campaign_type` is `PULSE` in /campaign/create/, you must provide contextual tags of `PREMIUM` type, and in that case the ad group's CPM is fixed.

Strategy for sequencing and scheduling ad delivery. `STANDARD`: distribute ads evenly for similar traffic size; not available for the 6-second view-through rate (View+) optimization goal when `optimization_goal` is `REACH` and `cpv_video_duration` is `SIX_SECONDS`. `SCHEDULE`: scheduled delivery; if used, you must pass `schedules`. `SEQUENCE`: sequenced delivery; if used, you must pass `expected_orders`. `VIEW_OPTIMIZE`: maximize view-through rate (VTR); only available for the 6-second view-through rate (View+) optimization goal when `optimization_goal` is `REACH` and `cpv_video_duration` is `SIX_SECONDS`. `OPTIMIZE`: optimized delivery for best performance.

IDs of device models to target. Only brand-level model IDs are currently supported. If this field is specified, `device_price_ranges` must not be specified. Only active devices (`is_active` = `True` in /tool/device_model/) can be used.

Target device price range. `10000` means 1000+. Values must be multiples of 50. The upper limit you set is increased by 50 and that resulting number is used as the actual upper limit for device targeting; for example, if you set and get `[0, 250]`, it actually means `[0, 300]`. Do not specify this field when `device_model_ids` is specified.

Audience IDs to exclude. For an audience to be targeted or excluded in R&F ads, its `audience_sub_type` must be `REACH_FREQUENCY` when the audience is created or updated. Lookalike Audience cannot be used in R&F ads, or an error will occur.

Feed type. `STANDARD_FEED` refers to large inventory with normal CPM pricing. `TOP_FEED` refers to limited inventory with higher CPM pricing.

Together with `frequency_schedule`, controls how often people see your ad. Only available for `REACH` ads. For example, `frequency` = 2 and `frequency_schedule` = 3 means show ads no more than twice every 3 days. Conditions: `1 ≤ frequency ≤ frequency_schedule`; `1 ≤ frequency_schedule ≤ min(schedule_end_time - schedule_start_time, 30)`; and the resulting frequency cap must not exceed four times per day.

Together with `frequency`, controls how often people see your ad. Only available for `REACH` ads. See `frequency` for constraints and behavior.

Target gender.

Interest category IDs. If specified, users who do not match the interest targeting are excluded during delivery. Omit this field if you want to target everyone. Use /tool/target_recommend_tags/ to get recommended interest categories based on targeting regions and industries, and /tool/interest_category/ to get the complete list.

Whether the promoted content is HFSS food (high in fat, salt, or sugar). In the European market, HFSS foods cannot be promoted to underage users.

Audience language codes.

IDs of targeted locations (country/region, province, DMA/metropolitan, or city level). Get valid IDs from `tool_region_get` with `objective_type=RF_REACH` and the same `placements`; do not pass country codes such as `US`. All IDs must belong to a single country or region. R&F supports only these countries and regions: Argentina, Australia, Austria, Bahrain, Belarus, Belgium, Brazil, Cambodia, Canada, Chile, Colombia, Czech Republic, Denmark, Ecuador, Egypt, Finland, France, Germany, Greece, Hungary, Indonesia, Iraq, Ireland, Israel, Italy, Japan, Jordan, Kazakhstan, Kuwait, Lebanon, Malaysia, Mexico, Morocco, Netherlands, New Zealand, Norway, Oman, Pakistan, Peru, Philippines, Poland, Portugal, Qatar, Romania, Russia, Saudi Arabia, Singapore, South Africa, South Korea, Spain, Sweden, Switzerland, Taiwan Province, Thailand, Turkey, Ukraine, United Arab Emirates, United Kingdom, United States, Uruguay, Vietnam.

Target device connection types. Default value: `unlimited`.

Target device operating systems.

Impressions to purchase, in units of 1,000. Fill this value based on data returned by the ad inventory estimate API.

Users reached to purchase, in units of 1,000. Fill this value based on inventory estimation results.

Buying type. `FIXED_SHOW`: purchase a fixed amount of impressions. `FIXED_REACH`: purchase a fixed number of users reached. `FIXED_BUDGE`: purchase with a fixed budget.

Schedule end time in UTC+0, format `YYYY-MM-DD HH:MM:SS`. The interval between `schedule_start_time` and `schedule_end_time` must not exceed 90 days. The value must be at `YYYY-MM-DD HH:59:59` for the time zone where the ad will be delivered; for example, for a UTC-5 advertiser ending delivery on November 10, 2023, set `2023-11-10 04:59:59`.

Ad delivery information. When `delivery_mode` is `SEQUENCE`, the number of objects in this array represents the number of ads for which you specify the sequence.

Schedule start time in UTC+0, format `YYYY-MM-DD HH:MM:SS`. The interval between `schedule_start_time` and `schedule_end_time` must not exceed 90 days. The value must be at `YYYY-MM-DD HH:00:00` for the time zone where the ad will be delivered; for example, for a UTC-5 advertiser delivering from November 1, 2023, set `2023-11-01 05:00:00`.

Whether sharing to third-party platforms is disabled for ads in this ad group.