account | DynamicAccount | Yes | - | Select the X Ads account whose ad groups (line items) should be listed. |
ad_group_ids | string or array of string | No | - | Scope to specific ad group (line item) IDs (list or comma-separated string, up to 200). |
campaign_ids | string or array of string | No | - | Scope to ad groups under specific campaign IDs (list or comma-separated string, up to 200). |
funding_instrument_ids | string or array of string | No | - | Scope to ad groups under specific funding instrument IDs (list or comma-separated string, up to 200). |
q | string | No | - | Scope ad groups by name (case-insensitive prefix match, so it matches names that start with this text). |
sort_by | string | No | - | Sort by a supported attribute, e.g. ‘created_at-desc’ or ‘updated_at-asc’. |
with_drafts | boolean | No | False | Include draft ad groups. |
with_deleted | boolean | No | False | Include deleted ad groups. |
filters | array of FilterItem | No | - | Additional filters applied to the returned ad groups. The available fields to filter by are: - id: Filter by ad group ID - name: Filter by ad group name - campaign_id: Filter by parent campaign ID - entity_status: Filter by status (ACTIVE, PAUSED, DRAFT) - objective: Filter by objective Filters are combined using AND logic. If you want to use OR logic, use relevant operators like REGEXP_MATCH or IN_LIST. |
limit | integer | No | 100 | Maximum number of ad groups to return. Default: 100. |