Ad Tools
Tools for managing Facebook ads including delivery control and naming.
Ad Tools
Tools for reading, starting, and pausing Facebook ads, plus managing ad names. Ads inherit delivery settings from their parent ad set and contain the creative assets shown to users.
get_ad
Retrieve full configuration details for a single Facebook ad, including status, creative, and targeting inherited from its parent ad set.
Parameters
| Prop | Type | Default |
|---|---|---|
account_id | string | - |
ad_id | string | - |
get_ads
Retrieve configuration details for up to 50 Facebook ads in a single request. More efficient than calling get_ad individually.
Parameters
| Prop | Type | Default |
|---|---|---|
account_id | string | - |
ad_ids | number[] | - |
list_ads_by_account
List all Facebook ads in an ad account with optional filtering by effective status, date range, and custom conditions.
Parameters
| Prop | Type | Default |
|---|---|---|
account_id | string | - |
list_ads_by_campaign
List all Facebook ads across all ad sets within a specific campaign. Useful for getting a complete view without querying each ad set separately.
Parameters
| Prop | Type | Default |
|---|---|---|
account_id | string | - |
campaign_id | string | - |
Example
list_ads_by_adset
List all Facebook ads within a specific ad set. Returns ad configuration data including creative, status, and bidding.
Parameters
| Prop | Type | Default |
|---|---|---|
account_id | string | - |
adset_id | string | - |
pause_ad
Pause a currently active Facebook ad to stop delivery immediately without deleting it. The ad can be reactivated later.
Parameters
| Prop | Type | Default |
|---|---|---|
account_id | string | - |
object_id | string | - |
Active Ads Only
Only ads with ACTIVE status can be paused.
start_ad
Activate a paused Facebook ad by setting its delivery status to ACTIVE. The ad resumes serving without changing its creative, budget, or targeting.
Parameters
| Prop | Type | Default |
|---|---|---|
account_id | string | - |
entity_id | string | - |
Paused Ads Only
Only ads with PAUSED status can be started. The parent campaign and ad set must also be active.
add_text_to_ad_name
Add text to a Facebook ad name by prepending or appending. Does not modify budget, status, targeting, or creatives.
Parameters
| Prop | Type | Default |
|---|---|---|
account_id | string | - |
entity_id | string | - |
text | string | - |
position | "prefix" | "suffix" | - |
separator | string | undefined | - |
remove_text_from_ad_name
Remove specific text from a Facebook ad name.
Parameters
| Prop | Type | Default |
|---|---|---|
account_id | string | - |
entity_id | string | - |
text | string | - |
position | "prefix" | "suffix" | "anywhere" | - |
case_sensitive | boolean | undefined | - |
replace_text_in_ad_name
Replace one substring with another in a Facebook ad name.
Parameters
| Prop | Type | Default |
|---|---|---|
account_id | string | - |
entity_id | string | - |
text_name_from | string | - |
text_name_to | string | - |