Ad Set Tools
Tools for managing Facebook ad sets including targeting, budgets, and delivery settings.
Ad Set Tools
Tools for reading, starting, and pausing Facebook ad sets, plus managing budgets, bids, spending limits, and ad set names. Ad sets control budget, targeting, placement, and delivery optimization for their contained ads.
get_adset
Retrieve full configuration details for a single Facebook ad set, including audience targeting, budget, bid strategy, optimization goal, and schedule.
Parameters
| Prop | Type | Default |
|---|---|---|
account_id | string | - |
adset_id | string | - |
get_adsets
Retrieve configuration details for up to 50 Facebook ad sets in a single batch request. More efficient than individual requests.
Parameters
| Prop | Type | Default |
|---|---|---|
account_id | string | - |
adset_ids | number[] | - |
list_adsets_by_account
List all Facebook ad sets in an ad account with optional filtering by status, date range, or custom conditions.
Parameters
| Prop | Type | Default |
|---|---|---|
account_id | string | - |
Example
list_adsets_by_campaign
List all Facebook ad sets within a specific campaign. Returns targeting, budget, and bidding configuration for each ad set.
Parameters
| Prop | Type | Default |
|---|---|---|
account_id | string | - |
campaign_id | string | - |
Example
pause_adset
Pause a currently active Facebook ad set, stopping delivery of all ads within it. The ad set can be reactivated later.
Parameters
| Prop | Type | Default |
|---|---|---|
account_id | string | - |
object_id | string | - |
Active Ad Sets Only
Only ad sets with ACTIVE status can be paused. All ads within the ad set are also paused.
get_adset_activities
Retrieve the audit log of changes made to a Facebook ad set, including budget edits, targeting updates, status changes, and bid modifications. Each entry includes the timestamp and actor who made the change.
Parameters
| Prop | Type | Default |
|---|---|---|
account_id | string | - |
adset_id | string | - |
Example
start_adset
Activate a paused Facebook ad set by setting its delivery status to ACTIVE. All ads within the ad set resume delivery.
Parameters
| Prop | Type | Default |
|---|---|---|
account_id | string | - |
entity_id | string | - |
Paused Ad Sets Only
Only ad sets with PAUSED status can be started. The parent campaign must also be active.
set_adset_budget
Set the budget for a Facebook ad set to a specific amount.
Parameters
| Prop | Type | Default |
|---|---|---|
account_id | string | - |
entity_id | string | - |
amount | number | - |
Example
increase_adset_budget
Increase the budget of a Facebook ad set by a specified amount.
Parameters
| Prop | Type | Default |
|---|---|---|
account_id | string | - |
entity_id | string | - |
amount | number | - |
decrease_adset_budget
Decrease the budget of a Facebook ad set by a specified amount.
Parameters
| Prop | Type | Default |
|---|---|---|
account_id | string | - |
entity_id | string | - |
amount | number | - |
set_adset_bid
Set the bid amount for a Facebook ad set to a specific value.
Parameters
| Prop | Type | Default |
|---|---|---|
account_id | string | - |
entity_id | string | - |
amount | number | - |
Example
decrease_adset_bid
Decrease the bid amount of a Facebook ad set by a specified amount.
Parameters
| Prop | Type | Default |
|---|---|---|
account_id | string | - |
entity_id | string | - |
amount | number | - |
increase_adset_spending_limit
Increase the spending limit of a Facebook ad set by a specified amount.
Parameters
| Prop | Type | Default |
|---|---|---|
account_id | string | - |
entity_id | string | - |
amount | number | - |
decrease_adset_spending_limit
Decrease the spending limit of a Facebook ad set by a specified amount.
Parameters
| Prop | Type | Default |
|---|---|---|
account_id | string | - |
entity_id | string | - |
amount | number | - |
add_text_to_adset_name
Add text to a Facebook ad set name by prepending or appending.
Parameters
| Prop | Type | Default |
|---|---|---|
account_id | string | - |
entity_id | string | - |
text | string | - |
position | "prefix" | "suffix" | - |
separator | string | undefined | - |
remove_text_from_adset_name
Remove specific text from a Facebook ad set name.
Parameters
| Prop | Type | Default |
|---|---|---|
account_id | string | - |
entity_id | string | - |
text | string | - |
position | "prefix" | "suffix" | "anywhere" | - |
case_sensitive | boolean | undefined | - |
replace_text_in_adset_name
Replace one substring with another in a Facebook ad set name.
Parameters
| Prop | Type | Default |
|---|---|---|
account_id | string | - |
entity_id | string | - |
text_name_from | string | - |
text_name_to | string | - |