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
| Parameter | Type | Description |
|---|---|---|
account_id |
string |
Facebook Ad Account ID (e.g., act_123456789) |
adset_id |
string |
Facebook Ad Set ID to retrieve |
get_adsets
Retrieve configuration details for up to 50 Facebook ad sets in a single batch request. More efficient than individual requests.
Parameters
| Parameter | Type | Description |
|---|---|---|
account_id |
string |
Facebook Ad Account ID (e.g., act_123456789) |
adset_ids |
number[] |
List of ad set IDs to retrieve (max 50) |
list_adsets_by_account
List all Facebook ad sets in an ad account with optional filtering by status, date range, or custom conditions.
Parameters
| Parameter | Type | Description |
|---|---|---|
account_id |
string |
Facebook Ad Account ID (e.g., act_123456789) |
Example
Show me all ad sets in account act_123456789
list_adsets_by_campaign
List all Facebook ad sets within a specific campaign. Returns targeting, budget, and bidding configuration for each ad set.
Parameters
| Parameter | Type | Description |
|---|---|---|
account_id |
string |
Facebook Ad Account ID (e.g., act_123456789) |
campaign_id |
string |
Campaign ID to list ad sets for |
Example
Show me all ad sets in campaign 120211556789
pause_adset
Pause a currently active Facebook ad set, stopping delivery of all ads within it. The ad set can be reactivated later.
Parameters
| Parameter | Type | Description |
|---|---|---|
account_id |
string |
Facebook Ad Account ID (e.g., act_123456789) |
object_id |
string |
Ad set ID to pause |
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
| Parameter | Type | Description |
|---|---|---|
account_id |
string |
Facebook Ad Account ID (e.g., act_123456789) |
adset_id |
string |
Ad set ID to retrieve activity log for |
Example
Show me the change history for ad set 120211556789
start_adset
Activate a paused Facebook ad set by setting its delivery status to ACTIVE. All ads within the ad set resume delivery.
Parameters
| Parameter | Type | Description |
|---|---|---|
account_id |
string |
Facebook Ad Account ID (e.g., act_123456789) |
entity_id |
string |
Ad set ID to activate |
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
| Parameter | Type | Description |
|---|---|---|
account_id |
string |
Facebook Ad Account ID (e.g., act_123456789) |
entity_id |
string |
Ad set ID to update |
amount |
number |
New budget amount in account currency (cents) |
Example
Set ad set 120211556789 budget to $50/day
increase_adset_budget
Increase the budget of a Facebook ad set by a specified amount.
Parameters
| Parameter | Type | Description |
|---|---|---|
account_id |
string |
Facebook Ad Account ID (e.g., act_123456789) |
entity_id |
string |
Ad set ID to update |
amount |
number |
Amount to increase the budget by |
decrease_adset_budget
Decrease the budget of a Facebook ad set by a specified amount.
Parameters
| Parameter | Type | Description |
|---|---|---|
account_id |
string |
Facebook Ad Account ID (e.g., act_123456789) |
entity_id |
string |
Ad set ID to update |
amount |
number |
Amount to decrease the budget by |
set_adset_bid
Set the bid amount for a Facebook ad set to a specific value.
Parameters
| Parameter | Type | Description |
|---|---|---|
account_id |
string |
Facebook Ad Account ID (e.g., act_123456789) |
entity_id |
string |
Ad set ID to update |
amount |
number |
New bid amount in account currency (cents) |
Example
Set ad set 120211556789 bid to $5
decrease_adset_bid
Decrease the bid amount of a Facebook ad set by a specified amount.
Parameters
| Parameter | Type | Description |
|---|---|---|
account_id |
string |
Facebook Ad Account ID (e.g., act_123456789) |
entity_id |
string |
Ad set ID to update |
amount |
number |
Amount to decrease the bid by |
increase_adset_spending_limit
Increase the spending limit of a Facebook ad set by a specified amount.
Parameters
| Parameter | Type | Description |
|---|---|---|
account_id |
string |
Facebook Ad Account ID (e.g., act_123456789) |
entity_id |
string |
Ad set ID to update |
amount |
number |
Amount to increase the spending limit by |
decrease_adset_spending_limit
Decrease the spending limit of a Facebook ad set by a specified amount.
Parameters
| Parameter | Type | Description |
|---|---|---|
account_id |
string |
Facebook Ad Account ID (e.g., act_123456789) |
entity_id |
string |
Ad set ID to update |
amount |
number |
Amount to decrease the spending limit by |
add_text_to_adset_name
Add text to a Facebook ad set name by prepending or appending.
Parameters
| Parameter | Type | Description |
|---|---|---|
account_id |
string |
Facebook Ad Account ID (e.g., act_123456789) |
entity_id |
string |
Ad set ID to update |
text |
string |
Text to add (1-100 characters) |
position |
"prefix" | "suffix" |
Where to add text: "prefix" (beginning) or "suffix" (end). Default: "prefix" |
separator |
string | undefined |
Separator between added text and original name (max 5 characters, default: " ") |
remove_text_from_adset_name
Remove specific text from a Facebook ad set name.
Parameters
| Parameter | Type | Description |
|---|---|---|
account_id |
string |
Facebook Ad Account ID (e.g., act_123456789) |
entity_id |
string |
Ad set ID to update |
text |
string |
Text to remove (1-100 characters) |
position |
"prefix" | "suffix" | "anywhere" |
Where to remove text from. Default: "anywhere" |
case_sensitive |
boolean | undefined |
Whether removal is case-sensitive (default: false) |
replace_text_in_adset_name
Replace one substring with another in a Facebook ad set name.
Parameters
| Parameter | Type | Description |
|---|---|---|
account_id |
string |
Facebook Ad Account ID (e.g., act_123456789) |
entity_id |
string |
Ad set ID to update |
text_name_from |
string |
Text to find and replace (must be non-blank) |
text_name_to |
string |
Replacement text (must be non-blank) |
Related
- Campaign Tools Manage parent campaigns
- Ad Tools Manage ads within ad sets
- Ad Set Insights View ad set performance metrics