account | DynamicAccount | Yes | - | Select the TikTok Ads account whose ad groups should be listed. |
status | string or SelectableOption | No | ALL | Filter ad groups by delivery status. Defaults to ALL (excludes deleted). Choose ACTIVE to only see ad groups currently delivering. Options: ALL, ALL_INCLUDING_DELETED, ACTIVE, NOT_STARTED, NOT_DELIVERING, DISABLED, DELETED. |
operation_status | string or SelectableOption | No | ALL | Filter ad groups by ON/OFF operation status. Defaults to ALL. Options: ALL, ENABLE (the ad group is ON), DISABLE (the ad group is OFF), FROZEN (the ad group is terminated and cannot be enabled). |
filters | array of FilterItem | No | - | Additional filters to apply when retrieving ad groups. The available fields to filter by are: - campaign_id: Filter by parent campaign ID - campaign_name: Filter by parent campaign name - adgroup_id: Filter by ad group ID - adgroup_name: Filter by ad group name Filters are combined using AND logic. If you want to use OR logic, use relevant operators like REGEXP_MATCH or IN_LIST. |
exclude_null_fields | boolean | No | False | When true, ask TikTok to remove fields with null values from the response. Use this when the result will be reused as an update payload for tiktok_ads_update_ad_group. Leave false when you need to inspect every returned field, including empty/null fields. |
limit | integer | No | 100 | Maximum number of ad groups to return. Default: 100. |