Ads
Unified ads across Meta, Google, LinkedIn, TikTok, Pinterest, X, Reddit and OpenAI (ChatGPT) Ads: connections, campaigns, ad sets, ads, creatives, insights, targeting, audiences, Google Ads specifics, Ad Library, Reach & Frequency.
- Connect6
- Connections4
- Ads5
- Campaigns31
- Ad sets11
- Tree1
- Timeline1
- Boost1
- Messaging1
- Call1
- Status1
- Duplicate1
- Analytics1
- Preview2
- Review1
- Media1
- Creatives5
- Images2
- Videos4
- TikTok identities1
- Partnership content1
- Partnership permissions2
- Insights3
- TikTok smart plus materials1
- Search terms1
- Local services2
- Keywords6
- Recommendations3
- Bid strategies3
- Shared budgets2
- Interests1
- Targeting5
- Audiences7
- Library1
- Rf predictions4
Connect
Connect ads for a platform
/connect/{platform}/adsStarts an ads connection. Returns the network authorization URL (ads_connect_url), or connects at once (ads_connect_result) when a posting account (account_id) already carries the ads scopes or the connection already exists (unless force).
Try it with MCPAsk your agent to call connect-ads (toolset ads)Set up MCP
Path parameters
platformstringrequired1–40 characters
Query parameters
profile_idstringaccount_idstringlogin_modestringclassicbusiness
permission_levelstringfulladvertise
page_idstringad_account_idstringad_account_idsstringredirect_urlstringheadlessbooleanforcebooleanReturns object
One of 2 shapes
object: "ads_connect_url" object
objectstringads_connect_url
platformstringlogin_modestringurlstringauth_urlstringstatestringexpires_atstring (date-time) | nullobject: "ads_connect_result" object
objectstringads_connect_result
statusstringalready_connectedbooleanplatformstringprofile_idstring | nullconnectionobjectShow 4 child attributes
objectstringad_connection
idstringplatformstringad_accountsarray of objectad_accountsarray of objectShow 2 item attributes
objectstringad_account
idstringredirect_urlstring | nullResponses
Ads OAuth redirect target
/connect/ads/{platform}/callbackBrowser redirect target of every ads OAuth flow (Google, TikTok, LinkedIn, Pinterest, Reddit, X, Meta classic). Redirects to the caller redirect_url or the dashboard.
Path parameters
platformstringrequiredQuery parameters
statestringcodestringauth_codestringerrorstringerror_descriptionstringoauth_tokenstringoauth_verifierstringResponses
Complete Meta business login
/connect/meta-ads/callbackFacebook Login for Business redirect target (system-user token).
Query parameters
statestringrequiredcodestringerrorstringResponses
Set TikTok brand identity
/connect/tiktok-adsTry it with MCPAsk your agent to call set-tiktok-ads-brand-identity (toolset ads)Set up MCP
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
display_namestringrequired1–40 characters
image_urlstring (uri)requiredReturns object
objectstringtiktok_brand_identity
Responses
Connect an OpenAI (ChatGPT) Ads account
/connect/openai-ads/credentialsTry it with MCPAsk your agent to call connect-openai-ads (toolset ads)Set up MCP
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
api_keystringrequired8–500 characters
profile_idstringredirect_urlstringredirect_uristringstatestringReturns object
objectstringads_connect_result
statusstringalready_connectedbooleanplatformstringprofile_idstring | nullconnectionobjectShow 4 child attributes
objectstringad_connection
idstringplatformstringad_accountsarray of objectad_accountsarray of objectShow 2 item attributes
objectstringad_account
idstringredirect_urlstring | nullResponses
Connect a Whop account
/connect/whop-ads/credentialsTry it with MCPAsk your agent to call connect-whop-ads (toolset ads)Set up MCP
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
api_keystringrequired8–500 characters
profile_idstringredirect_urlstringstatestringReturns object
objectstringads_connect_result
statusstringalready_connectedbooleanplatformstringprofile_idstring | nullconnectionobjectShow 4 child attributes
objectstringad_connection
idstringplatformstringad_accountsarray of objectad_accountsarray of objectShow 2 item attributes
objectstringad_account
idstringredirect_urlstring | nullResponses
Connections
List ads connections
/ads/connectionsTry it with MCPAsk your agent to call list-ad-connections (toolset ads)Set up MCP
Query parameters
pageintegerdefault: 1Page number
≥ 1
limitintegerdefault: 20Items per page (max 100)
1–100
sortstringcreated_atplatformstatus
orderstringascdesc
matchstringCombine filters with AND (default) or OR
allor
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
profile_idstringstatusstringactiveneeds_reconnectdisconnected
Returns object
objectstringrequiredlist
dataarray of objectrequiredShow 4 item attributes
objectstringad_connection
idstringplatformstringad_accountsarray of objectpageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullResponses
Get an ads connection
/ads/connections/{id}Try it with MCPAsk your agent to call get-ad-connection (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Returns object
objectstringad_connection
idstringplatformstringad_accountsarray of objectResponses
Disconnect an ads connection
/ads/connections/{id}Try it with MCPAsk your agent to call delete-ad-connection (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Returns object
objectstringad_connection
idstringdeletedbooleantoken_revokedbooleanResponses
Queue an ads sync
/ads/connections/{id}/syncTry it with MCPAsk your agent to call sync-ad-connection (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object | null
backfillbooleanad_account_idsarray of stringReturns object
objectstringad_sync
connection_idstringstatusstringbackfillbooleanjob_idstring | nullResponses
Ads
List ads
/adsTry it with MCPAsk your agent to call list-ads (toolset ads)Set up MCP
Query parameters
pageintegerdefault: 1Page number
≥ 1
limitintegerdefault: 20Items per page (max 100)
1–100
sortstringcreated_atnamestatusupdated_atspendimpressions
orderstringascdesc
matchstringCombine filters with AND (default) or OR
allor
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
from_datestringpattern ^\d{4}-\d{2}-\d{2}$
to_datestringpattern ^\d{4}-\d{2}-\d{2}$
sourcestringallsocialitexternal
statusstringprofile_idstringcampaign_idstringad_set_idstringsearchstringhas_deliverybooleanmin_spendnumberplatform_ad_idstringpost_idstringplatform_post_idstringReturns object
objectstringrequiredlist
dataarray of objectrequiredShow 40 item attributes
objectstringad
idstringplatformstringad_account_idstring | nullconnection_idstring | nullprofile_idstring | nullexternal_idstringnamestring | nullstatusstringconfigured_statusstring | nullplatform_statusstring | nullbudgetobject | nullShow 4 child attributes
amountnumber | nulltypestringlevelstringshared_budget_idstring | nullcurrencystring | nullbid_strategystring | nullbid_amountnumber | nullstart_timestring (date-time) | nullend_timestring (date-time) | nullis_externalbooleanmetricsobject | nullShow 20 child attributes
spendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectcurrencystring | nulllast_synced_atstring (date-time) | nullplatform_created_atstring (date-time) | nullsynced_atstring (date-time) | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullnetworkstring | nullcampaign_idstring | nullad_set_idstring | nullcampaign_external_idstring | nullad_set_external_idstring | nullcampaign_namestring | nullad_set_namestring | nullad_typestringcreative_typestring | nullgoalstring | nullreview_statusstring | nullrejection_reasonstring | nullcreativeobjectpost_idstring | nullplatform_post_idstring | nulltargetingobjectdailyarray of objectShow 19 item attributes
datestringspendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectpageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullbackfill_pendingbooleanResponses
Create an ad (full tree)
/adsBuilds campaign → ad set → creative → ad in one call, or attaches to an existing campaign (existing_campaign_id) or ad set (ad_set_id). validate_only: true dry-runs (Meta, Google, OpenAI).
Try it with MCPAsk your agent to call create-ad (toolset ads)Set up MCP
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
namestringrequired1–400 characters
campaign_namestringad_set_namestringad_namestringgoalstringengagementtrafficawarenessvideo_viewslead_generationlead_conversionconversionsapp_promotioncatalog_salespage_likespage_visitsjob_applicants
existing_campaign_idstringad_set_idstringstatusstringactivepaused
campaign_statusstringactivepaused
ad_set_statusstringactivepaused
ad_statusstringactivepaused
budgetobjectShow 2 child attributes
amountnumberrequiredtypestringdefault: "daily"dailylifetime
budget_amountnumberbudget_typestringdailylifetime
budget_levelstringcampaignad_set
currencystringstart_timestringend_timestringbid_strategystringbid_amountnumberroas_average_floornumberoptimization_goalstringbilling_eventstringbuying_typestringrf_prediction_idstringspecial_ad_categoriesarray of stringtargetingobjectNormalized targeting (countries, regions, cities, zips, age_min, age_max, genders, languages, interests, audience_ids, placements, keywords, subreddits, job_titles, …) or raw (native spec)
creativeobjectCreativeInput: headline, body, description, call_to_action, link_url, image_url, image_hash, video { url | id }, carousel_cards[], existing_creative_id, url_tags, …
creativesarray of object≤ 50 items
optimize_card_orderbooleanMeta carousels: false keeps your card order (max 5 cards); omit for Meta's default (true). Only with carousel_cards.
page_idstringinstagram_account_idstringidentity_idstringidentity_typestringorganization_idstringboard_idstringlead_gen_form_idstringphone_numberstringcampaign_typestringsearchdisplayperformance_maxdemand_genvideo
keywordsarray of objectnegative_keywordsarray of objectheadlinesarray of anylong_headlinestringdescriptionsarray of anybusiness_namestringasset_groupobjectdemand_genobjecttrackingobjectplatform_specific_dataobjectvalidate_onlybooleanpost_idstringplatform_post_idstringlink_urlstringbodystringheadlinestringimage_urlstringReturns object
objectstringad_validation
validbooleanplatformstringresultsarray of objectResponses
Get an ad
/ads/{id}With a Facebook post id (<pageId>_<postId>) and ad_account_id, a placement dark post that maps to no single ad answers ad: null + dark_post; moderate its comments with the same id on /ads/{id}/comments.
Try it with MCPAsk your agent to call get-ad (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
livebooleanReturns object
One of 2 shapes
object: "ad" object
objectstringad
idstringplatformstringad_account_idstring | nullconnection_idstring | nullprofile_idstring | nullexternal_idstringnamestring | nullstatusstringconfigured_statusstring | nullplatform_statusstring | nullbudgetobject | nullShow 4 child attributes
amountnumber | nulltypestringlevelstringshared_budget_idstring | nullcurrencystring | nullbid_strategystring | nullbid_amountnumber | nullstart_timestring (date-time) | nullend_timestring (date-time) | nullis_externalbooleanmetricsobject | nullShow 20 child attributes
spendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectcurrencystring | nulllast_synced_atstring (date-time) | nullplatform_created_atstring (date-time) | nullsynced_atstring (date-time) | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullnetworkstring | nullcampaign_idstring | nullad_set_idstring | nullcampaign_external_idstring | nullad_set_external_idstring | nullcampaign_namestring | nullad_set_namestring | nullad_typestringcreative_typestring | nullgoalstring | nullreview_statusstring | nullrejection_reasonstring | nullcreativeobjectpost_idstring | nullplatform_post_idstring | nulltargetingobjectdailyarray of objectShow 19 item attributes
datestringspendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectobject: "ad_dark_post" object
objectstringad_dark_post
idstringplatformstringadnulldark_postobjectShow 7 child attributes
platformstringplatform_post_idstringpage_idstringplatform_ad_account_idsarray of stringis_publishedbooleanfirst_seen_atstring (date-time) | nulllast_activity_atstring (date-time) | nullResponses
Update an ad
/ads/{id}Try it with MCPAsk your agent to call update-ad (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
namestringstatusstringactivepaused
budgetobjectShow 2 child attributes
amountnumberrequiredtypestringdefault: "daily"dailylifetime
targetingobjectNormalized targeting (countries, regions, cities, zips, age_min, age_max, genders, languages, interests, audience_ids, placements, keywords, subreddits, job_titles, …) or raw (native spec)
creativeobjectCreativeInput: headline, body, description, call_to_action, link_url, image_url, image_hash, video { url | id }, carousel_cards[], existing_creative_id, url_tags, …
headlinesarray of any≤ 15 items
descriptionsarray of any≤ 5 items
final_urlsarray of stringasset_groupobjectdemand_genobjectpage_idstringReturns object
objectstringad
idstringplatformstringad_account_idstring | nullconnection_idstring | nullprofile_idstring | nullexternal_idstringnamestring | nullstatusstringconfigured_statusstring | nullplatform_statusstring | nullbudgetobject | nullShow 4 child attributes
amountnumber | nulltypestringlevelstringshared_budget_idstring | nullcurrencystring | nullbid_strategystring | nullbid_amountnumber | nullstart_timestring (date-time) | nullend_timestring (date-time) | nullis_externalbooleanmetricsobject | nullShow 20 child attributes
spendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectcurrencystring | nulllast_synced_atstring (date-time) | nullplatform_created_atstring (date-time) | nullsynced_atstring (date-time) | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullnetworkstring | nullcampaign_idstring | nullad_set_idstring | nullcampaign_external_idstring | nullad_set_external_idstring | nullcampaign_namestring | nullad_set_namestring | nullad_typestringcreative_typestring | nullgoalstring | nullreview_statusstring | nullrejection_reasonstring | nullcreativeobjectpost_idstring | nullplatform_post_idstring | nulltargetingobjectdailyarray of objectShow 19 item attributes
datestringspendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectResponses
Delete an ad
/ads/{id}Try it with MCPAsk your agent to call delete-ad (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
Returns object
objectstringad
idstringdeletedbooleanarchivedbooleanResponses
Campaigns
List campaigns
/ads/campaignsTry it with MCPAsk your agent to call list-ad-campaigns (toolset ads)Set up MCP
Query parameters
pageintegerdefault: 1Page number
≥ 1
limitintegerdefault: 20Items per page (max 100)
1–100
sortstringcreated_atnamestatusupdated_atspendimpressions
orderstringascdesc
matchstringCombine filters with AND (default) or OR
allor
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
from_datestringpattern ^\d{4}-\d{2}-\d{2}$
to_datestringpattern ^\d{4}-\d{2}-\d{2}$
sourcestringallsocialitexternal
statusstringprofile_idstringcampaign_idstringad_set_idstringsearchstringhas_deliverybooleanmin_spendnumberinclude_emptybooleanlivebooleanReturns object
objectstringrequiredlist
dataarray of objectrequiredShow 37 item attributes
objectstringad_campaign
idstringplatformstringad_account_idstring | nullconnection_idstring | nullprofile_idstring | nullexternal_idstringnamestring | nullstatusstringconfigured_statusstring | nullplatform_statusstring | nullbudgetobject | nullShow 4 child attributes
amountnumber | nulltypestringlevelstringshared_budget_idstring | nullcurrencystring | nullbid_strategystring | nullbid_amountnumber | nullstart_timestring (date-time) | nullend_timestring (date-time) | nullis_externalbooleanmetricsobject | nullShow 20 child attributes
spendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectcurrencystring | nulllast_synced_atstring (date-time) | nullplatform_created_atstring (date-time) | nullsynced_atstring (date-time) | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullgoalstring | nullobjectivestring | nullreview_statusstring | nullbuying_typestring | nullchannel_typestring | nullis_smart_plusbooleanroas_average_floornumber | nullspecial_ad_categoriesarray of stringad_set_countintegerad_countintegersettingsobjectissuesarray of objectad_setsarray of objectShow 36 item attributes
objectstringad_set
idstringplatformstringad_account_idstring | nullconnection_idstring | nullprofile_idstring | nullexternal_idstringnamestring | nullstatusstringconfigured_statusstring | nullplatform_statusstring | nullbudgetobject | nullShow 4 child attributes
amountnumber | nulltypestringlevelstringshared_budget_idstring | nullcurrencystring | nullbid_strategystring | nullbid_amountnumber | nullstart_timestring (date-time) | nullend_timestring (date-time) | nullis_externalbooleanmetricsobject | nullShow 20 child attributes
spendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectcurrencystring | nulllast_synced_atstring (date-time) | nullplatform_created_atstring (date-time) | nullsynced_atstring (date-time) | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullcampaign_idstring | nullcampaign_external_idstring | nullis_smart_plusbooleanroas_average_floornumber | nulloptimization_goalstring | nullbilling_eventstring | nulltargetingobjectpromoted_objectobject | nulllearning_phasestring | nullad_countintegersettingsobjectadsarray of objectShow 40 item attributes
objectstringad
idstringplatformstringad_account_idstring | nullconnection_idstring | nullprofile_idstring | nullexternal_idstringnamestring | nullstatusstringconfigured_statusstring | nullplatform_statusstring | nullbudgetobject | nullShow 4 child attributes
amountnumber | nulltypestringlevelstringshared_budget_idstring | nullcurrencystring | nullbid_strategystring | nullbid_amountnumber | nullstart_timestring (date-time) | nullend_timestring (date-time) | nullis_externalbooleanmetricsobject | nullShow 20 child attributes
spendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectcurrencystring | nulllast_synced_atstring (date-time) | nullplatform_created_atstring (date-time) | nullsynced_atstring (date-time) | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullnetworkstring | nullcampaign_idstring | nullad_set_idstring | nullcampaign_external_idstring | nullad_set_external_idstring | nullcampaign_namestring | nullad_set_namestring | nullad_typestringcreative_typestring | nullgoalstring | nullreview_statusstring | nullrejection_reasonstring | nullcreativeobjectpost_idstring | nullplatform_post_idstring | nulltargetingobjectdailyarray of objectShow 19 item attributes
datestringspendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectdailyarray of objectShow 19 item attributes
datestringspendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectdailyarray of objectShow 19 item attributes
datestringspendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectpageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullbackfill_pendingbooleanResponses
Create a campaign
/ads/campaignsTry it with MCPAsk your agent to call create-ad-campaign (toolset ads)Set up MCP
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
namestringrequired1–400 characters
goalstringrequiredengagementtrafficawarenessvideo_viewslead_generationlead_conversionconversionsapp_promotioncatalog_salespage_likespage_visitsjob_applicants
statusstringactivepaused
budgetobjectShow 2 child attributes
amountnumberrequiredtypestringdefault: "daily"dailylifetime
budget_amountnumberbudget_typestringdailylifetime
budget_levelstringcampaignad_set
buying_typestringAUCTIONRESERVED
special_ad_categoriesarray of stringspecial_ad_category_countryarray of stringpromoted_objectobjectis_skadnetwork_attributionbooleanstart_timestringend_timestringbid_strategystringbid_amountnumberroas_average_floornumberportfolio_bid_strategy_idstringtarget_impression_shareobjectmanual_cpcobjectnetwork_settingsobjectlocation_targeting_typestringcampaign_typestringsearchdisplayperformance_maxdemand_gen
targetingobjectNormalized targeting (countries, regions, cities, zips, age_min, age_max, genders, languages, interests, audience_ids, placements, keywords, subreddits, job_titles, …) or raw (native spec)
shared_budget_idstringplatform_specific_dataobjectvalidate_onlybooleanfunding_instrument_idstringReturns object
objectstringad_validation
validbooleanplatformstringresultsarray of objectResponses
Get campaign details
/ads/campaigns/{id}Try it with MCPAsk your agent to call get-ad-campaign (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
livebooleanfieldsstringReturns object
objectstringad_campaign
idstringplatformstringad_account_idstring | nullconnection_idstring | nullprofile_idstring | nullexternal_idstringnamestring | nullstatusstringconfigured_statusstring | nullplatform_statusstring | nullbudgetobject | nullShow 4 child attributes
amountnumber | nulltypestringlevelstringshared_budget_idstring | nullcurrencystring | nullbid_strategystring | nullbid_amountnumber | nullstart_timestring (date-time) | nullend_timestring (date-time) | nullis_externalbooleanmetricsobject | nullShow 20 child attributes
spendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectcurrencystring | nulllast_synced_atstring (date-time) | nullplatform_created_atstring (date-time) | nullsynced_atstring (date-time) | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullgoalstring | nullobjectivestring | nullreview_statusstring | nullbuying_typestring | nullchannel_typestring | nullis_smart_plusbooleanroas_average_floornumber | nullspecial_ad_categoriesarray of stringad_set_countintegerad_countintegersettingsobjectissuesarray of objectad_setsarray of objectShow 36 item attributes
objectstringad_set
idstringplatformstringad_account_idstring | nullconnection_idstring | nullprofile_idstring | nullexternal_idstringnamestring | nullstatusstringconfigured_statusstring | nullplatform_statusstring | nullbudgetobject | nullShow 4 child attributes
amountnumber | nulltypestringlevelstringshared_budget_idstring | nullcurrencystring | nullbid_strategystring | nullbid_amountnumber | nullstart_timestring (date-time) | nullend_timestring (date-time) | nullis_externalbooleanmetricsobject | nullShow 20 child attributes
spendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectcurrencystring | nulllast_synced_atstring (date-time) | nullplatform_created_atstring (date-time) | nullsynced_atstring (date-time) | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullcampaign_idstring | nullcampaign_external_idstring | nullis_smart_plusbooleanroas_average_floornumber | nulloptimization_goalstring | nullbilling_eventstring | nulltargetingobjectpromoted_objectobject | nulllearning_phasestring | nullad_countintegersettingsobjectadsarray of objectShow 40 item attributes
objectstringad
idstringplatformstringad_account_idstring | nullconnection_idstring | nullprofile_idstring | nullexternal_idstringnamestring | nullstatusstringconfigured_statusstring | nullplatform_statusstring | nullbudgetobject | nullShow 4 child attributes
amountnumber | nulltypestringlevelstringshared_budget_idstring | nullcurrencystring | nullbid_strategystring | nullbid_amountnumber | nullstart_timestring (date-time) | nullend_timestring (date-time) | nullis_externalbooleanmetricsobject | nullShow 20 child attributes
spendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectcurrencystring | nulllast_synced_atstring (date-time) | nullplatform_created_atstring (date-time) | nullsynced_atstring (date-time) | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullnetworkstring | nullcampaign_idstring | nullad_set_idstring | nullcampaign_external_idstring | nullad_set_external_idstring | nullcampaign_namestring | nullad_set_namestring | nullad_typestringcreative_typestring | nullgoalstring | nullreview_statusstring | nullrejection_reasonstring | nullcreativeobjectpost_idstring | nullplatform_post_idstring | nulltargetingobjectdailyarray of objectShow 19 item attributes
datestringspendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectdailyarray of objectShow 19 item attributes
datestringspendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectdailyarray of objectShow 19 item attributes
datestringspendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectResponses
Update a campaign
/ads/campaigns/{id}Try it with MCPAsk your agent to call update-ad-campaign (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
namestring1–400 characters
budgetobjectShow 2 child attributes
amountnumberrequiredtypestringdefault: "daily"dailylifetime
shared_budget_idstringallow_shared_budget_updatebooleanbid_strategystringbid_amountnumberroas_average_floornumberportfolio_bid_strategy_idstringtarget_impression_shareobjectmanual_cpcobjectnetwork_settingsobjecttracking_url_templatestringfinal_url_suffixstringstart_timestringend_timestringspend_capnumber | nullplatform_specific_dataobjectReturns object
objectstringad_campaign
idstringplatformstringad_account_idstring | nullconnection_idstring | nullprofile_idstring | nullexternal_idstringnamestring | nullstatusstringconfigured_statusstring | nullplatform_statusstring | nullbudgetobject | nullShow 4 child attributes
amountnumber | nulltypestringlevelstringshared_budget_idstring | nullcurrencystring | nullbid_strategystring | nullbid_amountnumber | nullstart_timestring (date-time) | nullend_timestring (date-time) | nullis_externalbooleanmetricsobject | nullShow 20 child attributes
spendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectcurrencystring | nulllast_synced_atstring (date-time) | nullplatform_created_atstring (date-time) | nullsynced_atstring (date-time) | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullgoalstring | nullobjectivestring | nullreview_statusstring | nullbuying_typestring | nullchannel_typestring | nullis_smart_plusbooleanroas_average_floornumber | nullspecial_ad_categoriesarray of stringad_set_countintegerad_countintegersettingsobjectissuesarray of objectad_setsarray of objectShow 36 item attributes
objectstringad_set
idstringplatformstringad_account_idstring | nullconnection_idstring | nullprofile_idstring | nullexternal_idstringnamestring | nullstatusstringconfigured_statusstring | nullplatform_statusstring | nullbudgetobject | nullShow 4 child attributes
amountnumber | nulltypestringlevelstringshared_budget_idstring | nullcurrencystring | nullbid_strategystring | nullbid_amountnumber | nullstart_timestring (date-time) | nullend_timestring (date-time) | nullis_externalbooleanmetricsobject | nullShow 20 child attributes
spendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectcurrencystring | nulllast_synced_atstring (date-time) | nullplatform_created_atstring (date-time) | nullsynced_atstring (date-time) | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullcampaign_idstring | nullcampaign_external_idstring | nullis_smart_plusbooleanroas_average_floornumber | nulloptimization_goalstring | nullbilling_eventstring | nulltargetingobjectpromoted_objectobject | nulllearning_phasestring | nullad_countintegersettingsobjectadsarray of objectShow 40 item attributes
objectstringad
idstringplatformstringad_account_idstring | nullconnection_idstring | nullprofile_idstring | nullexternal_idstringnamestring | nullstatusstringconfigured_statusstring | nullplatform_statusstring | nullbudgetobject | nullShow 4 child attributes
amountnumber | nulltypestringlevelstringshared_budget_idstring | nullcurrencystring | nullbid_strategystring | nullbid_amountnumber | nullstart_timestring (date-time) | nullend_timestring (date-time) | nullis_externalbooleanmetricsobject | nullShow 20 child attributes
spendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectcurrencystring | nulllast_synced_atstring (date-time) | nullplatform_created_atstring (date-time) | nullsynced_atstring (date-time) | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullnetworkstring | nullcampaign_idstring | nullad_set_idstring | nullcampaign_external_idstring | nullad_set_external_idstring | nullcampaign_namestring | nullad_set_namestring | nullad_typestringcreative_typestring | nullgoalstring | nullreview_statusstring | nullrejection_reasonstring | nullcreativeobjectpost_idstring | nullplatform_post_idstring | nulltargetingobjectdailyarray of objectShow 19 item attributes
datestringspendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectdailyarray of objectShow 19 item attributes
datestringspendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectdailyarray of objectShow 19 item attributes
datestringspendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectResponses
Delete a campaign
/ads/campaigns/{id}Try it with MCPAsk your agent to call delete-ad-campaign (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
Returns object
objectstringad_campaign
idstringdeletedbooleanarchivedbooleanResponses
Pause or resume a campaign
/ads/campaigns/{id}/statusTry it with MCPAsk your agent to call set-ad-campaign-status (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
statusstringrequiredactivepaused
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
Returns object
objectstringad_status_change
levelstringidstring | nullexternal_idstringplatformstringstatusstringplatform_statusstring | nullupdatedbooleanskippedbooleanskipped_reasonsarray of stringResponses
Pause or resume many campaigns
/ads/campaigns/bulk-statusTry it with MCPAsk your agent to call bulk-set-ad-campaign-status (toolset ads)Set up MCP
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
statusstringrequiredactivepaused
campaignsarray of objectrequired1–50 items
Show 3 item attributes
idstringrequiredplatformstringad_account_idstringReturns object
objectstringad_bulk_status
statusstringtotalsobjectShow 3 child attributes
updatedintegerskippedintegerfailedintegerresultsarray of objectShow 7 item attributes
idstringexternal_idstring | nullplatformstring | nullupdatedbooleanskippedbooleanplatform_statusstring | nullerrorstring | nullResponses
Duplicate a campaign
/ads/campaigns/{id}/duplicateTry it with MCPAsk your agent to call duplicate-ad-campaign (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
deep_copybooleanstatus_optionstringpausedactiveinherited
start_timestringend_timestringrename_strategystringnoneprefixsuffixdeep_rename
rename_prefixstringrename_suffixstringsync_afterbooleancampaign_idstringad_set_idstringreuse_source_creativebooleanReturns object
objectstringad_duplicate
levelstringsource_idstringcopied_external_idstring | nullcopied_idstring | nullsyncstringrawobjectResponses
Get campaign analytics
/ads/campaigns/{id}/analyticsTry it with MCPAsk your agent to call get-ad-campaign-analytics (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
from_datestringpattern ^\d{4}-\d{2}-\d{2}$
to_datestringpattern ^\d{4}-\d{2}-\d{2}$
breakdownsstringReturns object
objectstringad_analytics
levelstringidstringplatformstringnamestring | nullstatusstring | nullcurrencystring | nullbudgetobject | nullShow 4 child attributes
amountnumber | nulltypestringlevelstringshared_budget_idstring | nullfrom_datestringto_datestringbackfill_pendingbooleansummaryobjectdailyarray of objectShow 19 item attributes
datestringspendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectbreakdownsobjectunsupported_breakdownsarray of stringbreakdown_hintsobjectbreakdown_errorsobjectbreakdown_dropped_metricsobjectbreakdowns_rangeobject | nullResponses
Read a campaign's bidding
/ads/campaigns/{id}/biddingTry it with MCPAsk your agent to call get-ad-campaign-bidding (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
customer_idstringReturns object
objectstringcampaign_bidding
Responses
Read a campaign's ad schedule
/ads/campaigns/{id}/ad-scheduleTry it with MCPAsk your agent to call get-ad-campaign-schedule (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
include_performancebooleanwindow_daysinteger1–90
from_datestringpattern ^\d{4}-\d{2}-\d{2}$
to_datestringpattern ^\d{4}-\d{2}-\d{2}$
Returns object
objectstringad_schedule
Responses
Replace a campaign's ad schedule
/ads/campaigns/{id}/ad-scheduleTry it with MCPAsk your agent to call replace-ad-campaign-schedule (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
schedulearray of objectrequired≤ 42 items
Show 6 item attributes
day_of_weekstringrequiredMONDAYTUESDAYWEDNESDAYTHURSDAYFRIDAYSATURDAYSUNDAY
start_hourintegerrequired0–23
start_minuteinteger0153045
end_hourintegerrequired0–24
end_minuteinteger0153045
bid_modifiernumberReturns object
objectstringad_schedule
Responses
Read a Google campaign's targeting
/ads/campaigns/{id}/targetingTry it with MCPAsk your agent to call get-ad-campaign-targeting (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
Returns object
objectstringcampaign_targeting
Responses
Edit a Google campaign's targeting
/ads/campaigns/{id}/targetingTry it with MCPAsk your agent to call replace-ad-campaign-targeting (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
targetingobjectrequiredShow 4 child attributes
devicesarray of objectlocationsarray of objectexcluded_locationsarray of objectlanguagesarray of objectReturns object
objectstringcampaign_targeting
Responses
List campaign negative keywords
/ads/campaigns/{id}/negative-keywordsTry it with MCPAsk your agent to call list-ad-campaign-negative-keywords (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
Returns object
objectstringrequiredlist
dataarray of objectrequiredShow 1 item attributes
objectstringnegative_keyword
pageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullResponses
Replace campaign negative keywords
/ads/campaigns/{id}/negative-keywordsTry it with MCPAsk your agent to call replace-ad-campaign-negative-keywords (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
keywordsarray of objectrequired≤ 5000 items
Show 2 item attributes
textstringrequired1–80 characters
match_typestringexactphrasebroad
Returns object
objectstringrequiredlist
dataarray of objectrequiredShow 1 item attributes
objectstringnegative_keyword
pageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullResponses
List campaign negative keyword lists
/ads/campaigns/{id}/negative-keyword-listsTry it with MCPAsk your agent to call list-ad-campaign-negative-keyword-lists (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
Returns object
objectstringrequiredlist
dataarray of objectrequiredShow 1 item attributes
objectstringnegative_keyword_list
pageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullResponses
Replace campaign negative keyword lists
/ads/campaigns/{id}/negative-keyword-listsTry it with MCPAsk your agent to call replace-ad-campaign-negative-keyword-lists (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
list_idsarray of stringrequired≤ 20 items
Returns object
objectstringrequiredlist
dataarray of objectrequiredShow 1 item attributes
objectstringnegative_keyword_list
pageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullResponses
List campaign assets
/ads/campaigns/{id}/assetsTry it with MCPAsk your agent to call list-ad-campaign-assets (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
customer_idstringReturns object
objectstringrequiredlist
dataarray of objectrequiredShow 1 item attributes
objectstringad_asset
pageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullResponses
Attach campaign assets
/ads/campaigns/{id}/assetsTry it with MCPAsk your agent to call add-ad-campaign-assets (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
sitelinksarray of object≤ 50 items
calloutsarray of object≤ 50 items
structured_snippetsarray of object≤ 20 items
imagesarray of object≤ 20 items
customer_idstringReturns object
objectstringrequiredlist
dataarray of objectrequiredShow 1 item attributes
objectstringad_asset
pageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullResponses
Update campaign assets
/ads/campaigns/{id}/assetsTry it with MCPAsk your agent to call update-ad-campaign-assets (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
updatesarray of objectrequired1–100 items
customer_idstringReturns object
objectstringrequiredlist
dataarray of objectrequiredShow 1 item attributes
objectstringad_asset
pageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullResponses
Remove campaign assets
/ads/campaigns/{id}/assetsTry it with MCPAsk your agent to call remove-ad-campaign-assets (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
asset_idsstringlink_idsstringcustomer_idstringReturns object
objectstringad_asset_removal
removedintegerResponses
Get campaign conversion goals
/ads/campaigns/{id}/conversion-goalsTry it with MCPAsk your agent to call get-ad-campaign-conversion-goals (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
Returns object
objectstringcampaign_conversion_goals
Responses
Update campaign conversion goals
/ads/campaigns/{id}/conversion-goalsTry it with MCPAsk your agent to call update-ad-campaign-conversion-goals (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
goalsarray of object≤ 50 items
Show 3 item attributes
categorystringrequiredoriginstringrequiredbiddablebooleanrequiredgoal_config_levelstringcustomercampaign
custom_conversion_goal_idstring | nullReturns object
objectstringcampaign_conversion_goals
Responses
List Performance Max asset groups
/ads/campaigns/{id}/asset-groupsTry it with MCPAsk your agent to call list-ad-asset-groups (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
Returns object
objectstringrequiredlist
dataarray of objectrequiredShow 1 item attributes
objectstringasset_group
pageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullResponses
Create a Performance Max asset group
/ads/campaigns/{id}/asset-groupsTry it with MCPAsk your agent to call create-ad-asset-group (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
namestringrequired1–255 characters
final_urlsarray of stringrequired≥ 1 items
final_mobile_urlsarray of stringpath1stringpath2stringstatusstringenabledpaused
assetsobjectlisting_group_filterobjectvalidate_onlybooleanReturns object
objectstringad_validation
validbooleanplatformstringresultsarray of objectResponses
Get a Performance Max asset group
/ads/campaigns/{id}/asset-groups/{assetGroupId}Try it with MCPAsk your agent to call get-ad-asset-group (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
assetGroupIdstringrequired1–300 characters
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
Returns object
objectstringasset_group
Responses
Update a Performance Max asset group
/ads/campaigns/{id}/asset-groups/{assetGroupId}Try it with MCPAsk your agent to call update-ad-asset-group (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
assetGroupIdstringrequired1–300 characters
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
namestringstatusstringenabledpaused
final_urlsarray of stringfinal_mobile_urlsarray of stringpath1stringpath2stringvalidate_onlybooleanReturns object
objectstringasset_group
Responses
Remove a Performance Max asset group
/ads/campaigns/{id}/asset-groups/{assetGroupId}Try it with MCPAsk your agent to call delete-ad-asset-group (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
assetGroupIdstringrequired1–300 characters
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
validate_onlybooleanReturns object
objectstringasset_group
idstringdeletedbooleanarchivedbooleanResponses
Link or unlink asset group assets
/ads/campaigns/{id}/asset-groups/{assetGroupId}/assetsTry it with MCPAsk your agent to call link-ad-asset-group-assets (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
assetGroupIdstringrequired1–300 characters
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
linkarray of object≤ 100 items
unlinkarray of object≤ 100 items
validate_onlybooleanReturns object
objectstringasset_group
Responses
Replace an asset group's listing-group tree
/ads/campaigns/{id}/asset-groups/{assetGroupId}/listing-group-filtersTry it with MCPAsk your agent to call replace-ad-listing-group-filters (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
assetGroupIdstringrequired1–300 characters
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
treeobjectrequiredvalidate_onlybooleanReturns object
objectstringlisting_group_tree
Responses
Ad sets
List ad sets
/ads/ad-setsTry it with MCPAsk your agent to call list-ad-sets (toolset ads)Set up MCP
Query parameters
pageintegerdefault: 1Page number
≥ 1
limitintegerdefault: 20Items per page (max 100)
1–100
sortstringcreated_atnamestatusupdated_atspendimpressions
orderstringascdesc
matchstringCombine filters with AND (default) or OR
allor
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
from_datestringpattern ^\d{4}-\d{2}-\d{2}$
to_datestringpattern ^\d{4}-\d{2}-\d{2}$
sourcestringallsocialitexternal
statusstringprofile_idstringcampaign_idstringad_set_idstringsearchstringhas_deliverybooleanmin_spendnumberlivebooleanReturns object
objectstringrequiredlist
dataarray of objectrequiredShow 36 item attributes
objectstringad_set
idstringplatformstringad_account_idstring | nullconnection_idstring | nullprofile_idstring | nullexternal_idstringnamestring | nullstatusstringconfigured_statusstring | nullplatform_statusstring | nullbudgetobject | nullShow 4 child attributes
amountnumber | nulltypestringlevelstringshared_budget_idstring | nullcurrencystring | nullbid_strategystring | nullbid_amountnumber | nullstart_timestring (date-time) | nullend_timestring (date-time) | nullis_externalbooleanmetricsobject | nullShow 20 child attributes
spendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectcurrencystring | nulllast_synced_atstring (date-time) | nullplatform_created_atstring (date-time) | nullsynced_atstring (date-time) | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullcampaign_idstring | nullcampaign_external_idstring | nullis_smart_plusbooleanroas_average_floornumber | nulloptimization_goalstring | nullbilling_eventstring | nulltargetingobjectpromoted_objectobject | nulllearning_phasestring | nullad_countintegersettingsobjectadsarray of objectShow 40 item attributes
objectstringad
idstringplatformstringad_account_idstring | nullconnection_idstring | nullprofile_idstring | nullexternal_idstringnamestring | nullstatusstringconfigured_statusstring | nullplatform_statusstring | nullbudgetobject | nullShow 4 child attributes
amountnumber | nulltypestringlevelstringshared_budget_idstring | nullcurrencystring | nullbid_strategystring | nullbid_amountnumber | nullstart_timestring (date-time) | nullend_timestring (date-time) | nullis_externalbooleanmetricsobject | nullShow 20 child attributes
spendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectcurrencystring | nulllast_synced_atstring (date-time) | nullplatform_created_atstring (date-time) | nullsynced_atstring (date-time) | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullnetworkstring | nullcampaign_idstring | nullad_set_idstring | nullcampaign_external_idstring | nullad_set_external_idstring | nullcampaign_namestring | nullad_set_namestring | nullad_typestringcreative_typestring | nullgoalstring | nullreview_statusstring | nullrejection_reasonstring | nullcreativeobjectpost_idstring | nullplatform_post_idstring | nulltargetingobjectdailyarray of objectShow 19 item attributes
datestringspendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectdailyarray of objectShow 19 item attributes
datestringspendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectpageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullbackfill_pendingbooleanResponses
Create an ad set
/ads/ad-setsTry it with MCPAsk your agent to call create-ad-set (toolset ads)Set up MCP
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
campaign_idstringrequirednamestringrequired1–400 characters
statusstringactivepaused
budgetobjectShow 2 child attributes
amountnumberrequiredtypestringdefault: "daily"dailylifetime
bid_amountnumbermax_cpcnumberbid_strategystringoptimization_goalstringbilling_eventstringtargetingobjectNormalized targeting (countries, regions, cities, zips, age_min, age_max, genders, languages, interests, audience_ids, placements, keywords, subreddits, job_titles, …) or raw (native spec)
start_timestringend_timestringpromoted_objectobjectcustomer_idstringplatform_specific_dataobjectReturns object
objectstringad_set
idstringplatformstringad_account_idstring | nullconnection_idstring | nullprofile_idstring | nullexternal_idstringnamestring | nullstatusstringconfigured_statusstring | nullplatform_statusstring | nullbudgetobject | nullShow 4 child attributes
amountnumber | nulltypestringlevelstringshared_budget_idstring | nullcurrencystring | nullbid_strategystring | nullbid_amountnumber | nullstart_timestring (date-time) | nullend_timestring (date-time) | nullis_externalbooleanmetricsobject | nullShow 20 child attributes
spendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectcurrencystring | nulllast_synced_atstring (date-time) | nullplatform_created_atstring (date-time) | nullsynced_atstring (date-time) | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullcampaign_idstring | nullcampaign_external_idstring | nullis_smart_plusbooleanroas_average_floornumber | nulloptimization_goalstring | nullbilling_eventstring | nulltargetingobjectpromoted_objectobject | nulllearning_phasestring | nullad_countintegersettingsobjectadsarray of objectShow 40 item attributes
objectstringad
idstringplatformstringad_account_idstring | nullconnection_idstring | nullprofile_idstring | nullexternal_idstringnamestring | nullstatusstringconfigured_statusstring | nullplatform_statusstring | nullbudgetobject | nullShow 4 child attributes
amountnumber | nulltypestringlevelstringshared_budget_idstring | nullcurrencystring | nullbid_strategystring | nullbid_amountnumber | nullstart_timestring (date-time) | nullend_timestring (date-time) | nullis_externalbooleanmetricsobject | nullShow 20 child attributes
spendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectcurrencystring | nulllast_synced_atstring (date-time) | nullplatform_created_atstring (date-time) | nullsynced_atstring (date-time) | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullnetworkstring | nullcampaign_idstring | nullad_set_idstring | nullcampaign_external_idstring | nullad_set_external_idstring | nullcampaign_namestring | nullad_set_namestring | nullad_typestringcreative_typestring | nullgoalstring | nullreview_statusstring | nullrejection_reasonstring | nullcreativeobjectpost_idstring | nullplatform_post_idstring | nulltargetingobjectdailyarray of objectShow 19 item attributes
datestringspendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectdailyarray of objectShow 19 item attributes
datestringspendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectResponses
Get ad set details
/ads/ad-sets/{id}Try it with MCPAsk your agent to call get-ad-set (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
livebooleanfieldsstringReturns object
objectstringad_set
idstringplatformstringad_account_idstring | nullconnection_idstring | nullprofile_idstring | nullexternal_idstringnamestring | nullstatusstringconfigured_statusstring | nullplatform_statusstring | nullbudgetobject | nullShow 4 child attributes
amountnumber | nulltypestringlevelstringshared_budget_idstring | nullcurrencystring | nullbid_strategystring | nullbid_amountnumber | nullstart_timestring (date-time) | nullend_timestring (date-time) | nullis_externalbooleanmetricsobject | nullShow 20 child attributes
spendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectcurrencystring | nulllast_synced_atstring (date-time) | nullplatform_created_atstring (date-time) | nullsynced_atstring (date-time) | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullcampaign_idstring | nullcampaign_external_idstring | nullis_smart_plusbooleanroas_average_floornumber | nulloptimization_goalstring | nullbilling_eventstring | nulltargetingobjectpromoted_objectobject | nulllearning_phasestring | nullad_countintegersettingsobjectadsarray of objectShow 40 item attributes
objectstringad
idstringplatformstringad_account_idstring | nullconnection_idstring | nullprofile_idstring | nullexternal_idstringnamestring | nullstatusstringconfigured_statusstring | nullplatform_statusstring | nullbudgetobject | nullShow 4 child attributes
amountnumber | nulltypestringlevelstringshared_budget_idstring | nullcurrencystring | nullbid_strategystring | nullbid_amountnumber | nullstart_timestring (date-time) | nullend_timestring (date-time) | nullis_externalbooleanmetricsobject | nullShow 20 child attributes
spendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectcurrencystring | nulllast_synced_atstring (date-time) | nullplatform_created_atstring (date-time) | nullsynced_atstring (date-time) | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullnetworkstring | nullcampaign_idstring | nullad_set_idstring | nullcampaign_external_idstring | nullad_set_external_idstring | nullcampaign_namestring | nullad_set_namestring | nullad_typestringcreative_typestring | nullgoalstring | nullreview_statusstring | nullrejection_reasonstring | nullcreativeobjectpost_idstring | nullplatform_post_idstring | nulltargetingobjectdailyarray of objectShow 19 item attributes
datestringspendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectdailyarray of objectShow 19 item attributes
datestringspendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectResponses
Update an ad set
/ads/ad-sets/{id}Try it with MCPAsk your agent to call update-ad-set (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
namestringstatusstringactivepaused
budgetobjectShow 2 child attributes
amountnumberrequiredtypestringdefault: "daily"dailylifetime
bid_strategystringbid_amountnumberroas_average_floornumbersmart_targetingbooleantargetingobjectNormalized targeting (countries, regions, cities, zips, age_min, age_max, genders, languages, interests, audience_ids, placements, keywords, subreddits, job_titles, …) or raw (native spec)
start_timestringend_timestringvalue_rule_set_idstringvalue_rules_appliedbooleanoptimization_goalstringplatform_specific_dataobjectReturns object
objectstringad_set
idstringplatformstringad_account_idstring | nullconnection_idstring | nullprofile_idstring | nullexternal_idstringnamestring | nullstatusstringconfigured_statusstring | nullplatform_statusstring | nullbudgetobject | nullShow 4 child attributes
amountnumber | nulltypestringlevelstringshared_budget_idstring | nullcurrencystring | nullbid_strategystring | nullbid_amountnumber | nullstart_timestring (date-time) | nullend_timestring (date-time) | nullis_externalbooleanmetricsobject | nullShow 20 child attributes
spendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectcurrencystring | nulllast_synced_atstring (date-time) | nullplatform_created_atstring (date-time) | nullsynced_atstring (date-time) | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullcampaign_idstring | nullcampaign_external_idstring | nullis_smart_plusbooleanroas_average_floornumber | nulloptimization_goalstring | nullbilling_eventstring | nulltargetingobjectpromoted_objectobject | nulllearning_phasestring | nullad_countintegersettingsobjectadsarray of objectShow 40 item attributes
objectstringad
idstringplatformstringad_account_idstring | nullconnection_idstring | nullprofile_idstring | nullexternal_idstringnamestring | nullstatusstringconfigured_statusstring | nullplatform_statusstring | nullbudgetobject | nullShow 4 child attributes
amountnumber | nulltypestringlevelstringshared_budget_idstring | nullcurrencystring | nullbid_strategystring | nullbid_amountnumber | nullstart_timestring (date-time) | nullend_timestring (date-time) | nullis_externalbooleanmetricsobject | nullShow 20 child attributes
spendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectcurrencystring | nulllast_synced_atstring (date-time) | nullplatform_created_atstring (date-time) | nullsynced_atstring (date-time) | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullnetworkstring | nullcampaign_idstring | nullad_set_idstring | nullcampaign_external_idstring | nullad_set_external_idstring | nullcampaign_namestring | nullad_set_namestring | nullad_typestringcreative_typestring | nullgoalstring | nullreview_statusstring | nullrejection_reasonstring | nullcreativeobjectpost_idstring | nullplatform_post_idstring | nulltargetingobjectdailyarray of objectShow 19 item attributes
datestringspendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectdailyarray of objectShow 19 item attributes
datestringspendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectResponses
Delete an ad set
/ads/ad-sets/{id}Try it with MCPAsk your agent to call delete-ad-set (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
Returns object
objectstringad_set
idstringdeletedbooleanarchivedbooleanResponses
Pause or resume an ad set
/ads/ad-sets/{id}/statusTry it with MCPAsk your agent to call set-ad-set-status (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
statusstringrequiredactivepaused
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
Returns object
objectstringad_status_change
levelstringidstring | nullexternal_idstringplatformstringstatusstringplatform_statusstring | nullupdatedbooleanskippedbooleanskipped_reasonsarray of stringResponses
Duplicate an ad set
/ads/ad-sets/{id}/duplicateTry it with MCPAsk your agent to call duplicate-ad-set (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
deep_copybooleanstatus_optionstringpausedactiveinherited
start_timestringend_timestringrename_strategystringnoneprefixsuffixdeep_rename
rename_prefixstringrename_suffixstringsync_afterbooleancampaign_idstringad_set_idstringreuse_source_creativebooleanReturns object
objectstringad_duplicate
levelstringsource_idstringcopied_external_idstring | nullcopied_idstring | nullsyncstringrawobjectResponses
List ad-group assets
/ads/ad-sets/{id}/assetsTry it with MCPAsk your agent to call list-ad-set-assets (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
customer_idstringReturns object
objectstringrequiredlist
dataarray of objectrequiredShow 1 item attributes
objectstringad_asset
pageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullResponses
Attach ad-group assets
/ads/ad-sets/{id}/assetsTry it with MCPAsk your agent to call add-ad-set-assets (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
sitelinksarray of object≤ 50 items
calloutsarray of object≤ 50 items
structured_snippetsarray of object≤ 20 items
imagesarray of object≤ 20 items
customer_idstringReturns object
objectstringrequiredlist
dataarray of objectrequiredShow 1 item attributes
objectstringad_asset
pageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullResponses
Update ad-group assets
/ads/ad-sets/{id}/assetsTry it with MCPAsk your agent to call update-ad-set-assets (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
updatesarray of objectrequired1–100 items
customer_idstringReturns object
objectstringrequiredlist
dataarray of objectrequiredShow 1 item attributes
objectstringad_asset
pageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullResponses
Remove ad-group assets
/ads/ad-sets/{id}/assetsTry it with MCPAsk your agent to call remove-ad-set-assets (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
asset_idsstringlink_idsstringcustomer_idstringReturns object
objectstringad_asset_removal
removedintegerResponses
Tree
Get the campaign tree
/ads/treeTry it with MCPAsk your agent to call get-ad-tree (toolset ads)Set up MCP
Query parameters
pageintegerdefault: 1Page number
≥ 1
limitintegerdefault: 20Items per page (max 100)
1–100
sortstringcreated_atnamestatusupdated_atspendimpressions
orderstringascdesc
matchstringCombine filters with AND (default) or OR
allor
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
from_datestringpattern ^\d{4}-\d{2}-\d{2}$
to_datestringpattern ^\d{4}-\d{2}-\d{2}$
sourcestringallsocialitexternal
statusstringprofile_idstringcampaign_idstringad_set_idstringsearchstringhas_deliverybooleanmin_spendnumberupdated_sincestringdailybooleandaily_levelstringtime_incrementstringReturns object
objectstringrequiredlist
dataarray of objectrequiredShow 37 item attributes
objectstringad_campaign
idstringplatformstringad_account_idstring | nullconnection_idstring | nullprofile_idstring | nullexternal_idstringnamestring | nullstatusstringconfigured_statusstring | nullplatform_statusstring | nullbudgetobject | nullShow 4 child attributes
amountnumber | nulltypestringlevelstringshared_budget_idstring | nullcurrencystring | nullbid_strategystring | nullbid_amountnumber | nullstart_timestring (date-time) | nullend_timestring (date-time) | nullis_externalbooleanmetricsobject | nullShow 20 child attributes
spendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectcurrencystring | nulllast_synced_atstring (date-time) | nullplatform_created_atstring (date-time) | nullsynced_atstring (date-time) | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullgoalstring | nullobjectivestring | nullreview_statusstring | nullbuying_typestring | nullchannel_typestring | nullis_smart_plusbooleanroas_average_floornumber | nullspecial_ad_categoriesarray of stringad_set_countintegerad_countintegersettingsobjectissuesarray of objectad_setsarray of objectShow 36 item attributes
objectstringad_set
idstringplatformstringad_account_idstring | nullconnection_idstring | nullprofile_idstring | nullexternal_idstringnamestring | nullstatusstringconfigured_statusstring | nullplatform_statusstring | nullbudgetobject | nullShow 4 child attributes
amountnumber | nulltypestringlevelstringshared_budget_idstring | nullcurrencystring | nullbid_strategystring | nullbid_amountnumber | nullstart_timestring (date-time) | nullend_timestring (date-time) | nullis_externalbooleanmetricsobject | nullShow 20 child attributes
spendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectcurrencystring | nulllast_synced_atstring (date-time) | nullplatform_created_atstring (date-time) | nullsynced_atstring (date-time) | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullcampaign_idstring | nullcampaign_external_idstring | nullis_smart_plusbooleanroas_average_floornumber | nulloptimization_goalstring | nullbilling_eventstring | nulltargetingobjectpromoted_objectobject | nulllearning_phasestring | nullad_countintegersettingsobjectadsarray of objectShow 40 item attributes
objectstringad
idstringplatformstringad_account_idstring | nullconnection_idstring | nullprofile_idstring | nullexternal_idstringnamestring | nullstatusstringconfigured_statusstring | nullplatform_statusstring | nullbudgetobject | nullShow 4 child attributes
amountnumber | nulltypestringlevelstringshared_budget_idstring | nullcurrencystring | nullbid_strategystring | nullbid_amountnumber | nullstart_timestring (date-time) | nullend_timestring (date-time) | nullis_externalbooleanmetricsobject | nullShow 20 child attributes
spendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectcurrencystring | nulllast_synced_atstring (date-time) | nullplatform_created_atstring (date-time) | nullsynced_atstring (date-time) | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullnetworkstring | nullcampaign_idstring | nullad_set_idstring | nullcampaign_external_idstring | nullad_set_external_idstring | nullcampaign_namestring | nullad_set_namestring | nullad_typestringcreative_typestring | nullgoalstring | nullreview_statusstring | nullrejection_reasonstring | nullcreativeobjectpost_idstring | nullplatform_post_idstring | nulltargetingobjectdailyarray of objectShow 19 item attributes
datestringspendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectdailyarray of objectShow 19 item attributes
datestringspendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectdailyarray of objectShow 19 item attributes
datestringspendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectpageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullbackfill_pendingbooleanResponses
Timeline
Get daily account metrics
/ads/timelineTry it with MCPAsk your agent to call get-ad-timeline (toolset ads)Set up MCP
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
from_datestringpattern ^\d{4}-\d{2}-\d{2}$
to_datestringpattern ^\d{4}-\d{2}-\d{2}$
Returns object
objectstringad_timeline
currencystring | nullfrom_datestringto_datestringbackfill_pendingbooleandataarray of objectShow 19 item attributes
datestringspendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectResponses
Boost
Boost a post as an ad
/ads/boostTry it with MCPAsk your agent to call boost-ad-post (toolset ads)Set up MCP
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
namestringrequired1–400 characters
campaign_namestringad_set_namestringad_namestringgoalstringrequiredengagementtrafficawarenessvideo_viewslead_generationlead_conversionconversionsapp_promotioncatalog_salespage_likespage_visitsjob_applicants
existing_campaign_idstringad_set_idstringstatusstringactivepaused
campaign_statusstringactivepaused
ad_set_statusstringactivepaused
ad_statusstringactivepaused
budgetobjectShow 2 child attributes
amountnumberrequiredtypestringdefault: "daily"dailylifetime
budget_amountnumberbudget_typestringdailylifetime
budget_levelstringcampaignad_set
currencystringstart_timestringend_timestringbid_strategystringbid_amountnumberroas_average_floornumberoptimization_goalstringbilling_eventstringbuying_typestringrf_prediction_idstringspecial_ad_categoriesarray of stringtargetingobjectNormalized targeting (countries, regions, cities, zips, age_min, age_max, genders, languages, interests, audience_ids, placements, keywords, subreddits, job_titles, …) or raw (native spec)
creativeobjectCreativeInput: headline, body, description, call_to_action, link_url, image_url, image_hash, video { url | id }, carousel_cards[], existing_creative_id, url_tags, …
creativesarray of object≤ 50 items
optimize_card_orderbooleanMeta carousels: false keeps your card order (max 5 cards); omit for Meta's default (true). Only with carousel_cards.
page_idstringinstagram_account_idstringidentity_idstringidentity_typestringorganization_idstringboard_idstringlead_gen_form_idstringphone_numberstringcampaign_typestringsearchdisplayperformance_maxdemand_genvideo
keywordsarray of objectnegative_keywordsarray of objectheadlinesarray of anylong_headlinestringdescriptionsarray of anybusiness_namestringasset_groupobjectdemand_genobjecttrackingobjectplatform_specific_dataobjectvalidate_onlybooleanpost_idstringplatform_post_idstringlink_urlstringbodystringheadlinestringimage_urlstringdestination_typestringWEBSITEMESSENGERINSTAGRAM_DIRECT
spark_auth_codestringcall_to_actionstringReturns object
objectstringad_validation
validbooleanplatformstringresultsarray of objectResponses
Messaging
Create a click-to-message ad
/ads/messagingTry it with MCPAsk your agent to call create-messaging-ad (toolset ads)Set up MCP
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
namestringrequired1–400 characters
campaign_namestringad_set_namestringad_namestringgoalstringengagementtrafficawarenessvideo_viewslead_generationlead_conversionconversionsapp_promotioncatalog_salespage_likespage_visitsjob_applicants
existing_campaign_idstringad_set_idstringstatusstringactivepaused
campaign_statusstringactivepaused
ad_set_statusstringactivepaused
ad_statusstringactivepaused
budgetobjectShow 2 child attributes
amountnumberrequiredtypestringdefault: "daily"dailylifetime
budget_amountnumberbudget_typestringdailylifetime
budget_levelstringcampaignad_set
currencystringstart_timestringend_timestringbid_strategystringbid_amountnumberroas_average_floornumberoptimization_goalstringbilling_eventstringbuying_typestringrf_prediction_idstringspecial_ad_categoriesarray of stringtargetingobjectNormalized targeting (countries, regions, cities, zips, age_min, age_max, genders, languages, interests, audience_ids, placements, keywords, subreddits, job_titles, …) or raw (native spec)
creativeobjectCreativeInput: headline, body, description, call_to_action, link_url, image_url, image_hash, video { url | id }, carousel_cards[], existing_creative_id, url_tags, …
creativesarray of object≤ 50 items
optimize_card_orderbooleanMeta carousels: false keeps your card order (max 5 cards); omit for Meta's default (true). Only with carousel_cards.
page_idstringinstagram_account_idstringidentity_idstringidentity_typestringorganization_idstringboard_idstringlead_gen_form_idstringphone_numberstringcampaign_typestringsearchdisplayperformance_maxdemand_genvideo
keywordsarray of objectnegative_keywordsarray of objectheadlinesarray of anylong_headlinestringdescriptionsarray of anybusiness_namestringasset_groupobjectdemand_genobjecttrackingobjectplatform_specific_dataobjectvalidate_onlybooleanpost_idstringplatform_post_idstringlink_urlstringbodystringheadlinestringimage_urlstringdestinationstringrequiredmessengerinstagram_direct
welcome_messageobjectworkflow_idstringReturns object
objectstringad_validation
validbooleanplatformstringresultsarray of objectResponses
Call
Create a click-to-call ad
/ads/callTry it with MCPAsk your agent to call create-call-ad (toolset ads)Set up MCP
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
namestringrequired1–400 characters
campaign_namestringad_set_namestringad_namestringgoalstringengagementtrafficawarenessvideo_viewslead_generationlead_conversionconversionsapp_promotioncatalog_salespage_likespage_visitsjob_applicants
existing_campaign_idstringad_set_idstringstatusstringactivepaused
campaign_statusstringactivepaused
ad_set_statusstringactivepaused
ad_statusstringactivepaused
budgetobjectShow 2 child attributes
amountnumberrequiredtypestringdefault: "daily"dailylifetime
budget_amountnumberbudget_typestringdailylifetime
budget_levelstringcampaignad_set
currencystringstart_timestringend_timestringbid_strategystringbid_amountnumberroas_average_floornumberoptimization_goalstringbilling_eventstringbuying_typestringrf_prediction_idstringspecial_ad_categoriesarray of stringtargetingobjectNormalized targeting (countries, regions, cities, zips, age_min, age_max, genders, languages, interests, audience_ids, placements, keywords, subreddits, job_titles, …) or raw (native spec)
creativeobjectCreativeInput: headline, body, description, call_to_action, link_url, image_url, image_hash, video { url | id }, carousel_cards[], existing_creative_id, url_tags, …
creativesarray of object≤ 50 items
optimize_card_orderbooleanMeta carousels: false keeps your card order (max 5 cards); omit for Meta's default (true). Only with carousel_cards.
page_idstringinstagram_account_idstringidentity_idstringidentity_typestringorganization_idstringboard_idstringlead_gen_form_idstringphone_numberstringrequiredcampaign_typestringsearchdisplayperformance_maxdemand_genvideo
keywordsarray of objectnegative_keywordsarray of objectheadlinesarray of anylong_headlinestringdescriptionsarray of anybusiness_namestringasset_groupobjectdemand_genobjecttrackingobjectplatform_specific_dataobjectvalidate_onlybooleanpost_idstringplatform_post_idstringlink_urlstringbodystringheadlinestringimage_urlstringcall_to_actionstringReturns object
objectstringad_validation
validbooleanplatformstringresultsarray of objectResponses
Status
Pause or resume an ad
/ads/{id}/statusTry it with MCPAsk your agent to call set-ad-status (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
statusstringrequiredactivepaused
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
Returns object
objectstringad_status_change
levelstringidstring | nullexternal_idstringplatformstringstatusstringplatform_statusstring | nullupdatedbooleanskippedbooleanskipped_reasonsarray of stringResponses
Duplicate
Duplicate an ad
/ads/{id}/duplicateTry it with MCPAsk your agent to call duplicate-ad (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
deep_copybooleanstatus_optionstringpausedactiveinherited
start_timestringend_timestringrename_strategystringnoneprefixsuffixdeep_rename
rename_prefixstringrename_suffixstringsync_afterbooleancampaign_idstringad_set_idstringreuse_source_creativebooleanReturns object
objectstringad_duplicate
levelstringsource_idstringcopied_external_idstring | nullcopied_idstring | nullsyncstringrawobjectResponses
Analytics
Get ad analytics
/ads/{id}/analyticsTry it with MCPAsk your agent to call get-ad-analytics (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
from_datestringpattern ^\d{4}-\d{2}-\d{2}$
to_datestringpattern ^\d{4}-\d{2}-\d{2}$
breakdownsstringReturns object
objectstringad_analytics
levelstringidstringplatformstringnamestring | nullstatusstring | nullcurrencystring | nullbudgetobject | nullShow 4 child attributes
amountnumber | nulltypestringlevelstringshared_budget_idstring | nullfrom_datestringto_datestringbackfill_pendingbooleansummaryobjectdailyarray of objectShow 19 item attributes
datestringspendnumber | nullimpressionsnumber | nullreachnumber | nullfrequencynumber | nullclicksnumber | nulllink_clicksnumber | nullctrnumber | nullcpcnumber | nullcpmnumber | nullengagementnumber | nullvideo_viewsnumber | nullconversionsnumber | nullconversion_valuenumber | nullcost_per_conversionnumber | nullroasnumber | nullleadsnumber | nullactionsobjectaction_valuesobjectbreakdownsobjectunsupported_breakdownsarray of stringbreakdown_hintsobjectbreakdown_errorsobjectbreakdown_dropped_metricsobjectbreakdowns_rangeobject | nullResponses
Preview
Render previews of an ad
/ads/{id}/previewTry it with MCPAsk your agent to call get-ad-previews (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
formatsstringReturns object
objectstringrequiredlist
dataarray of objectrequiredShow 1 item attributes
objectstringad_preview
pageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullResponses
Render pre-create ad previews
/ads/previewTry it with MCPAsk your agent to call preview-ad-creative (toolset ads)Set up MCP
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
formatsarray of stringexisting_creative_idstringcreativeobjectCreativeInput: headline, body, description, call_to_action, link_url, image_url, image_hash, video { url | id }, carousel_cards[], existing_creative_id, url_tags, …
creative_specobjectpage_idstringinstagram_account_idstringReturns object
objectstringrequiredlist
dataarray of objectrequiredShow 1 item attributes
objectstringad_preview
pageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullResponses
Review
Read an ad's review verdict
/ads/{id}/reviewTry it with MCPAsk your agent to call get-ad-review (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
Returns object
objectstringad_review
Responses
Media
Direct URLs of an ad's media
/ads/{id}/mediaTry it with MCPAsk your agent to call get-ad-media (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
Returns object
objectstringad_media
ad_idstring | nullplatformstringmediaarray of objectResponses
Creatives
Creative library
/ads/creativesTry it with MCPAsk your agent to call list-ad-creatives (toolset ads)Set up MCP
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
limitinteger1–100
afterstringfieldsstringReturns object
objectstringrequiredlist
dataarray of objectrequiredShow 1 item attributes
objectstringad_creative
pageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullnext_cursorstring | nullResponses
Create a standalone creative
/ads/creativesTry it with MCPAsk your agent to call create-ad-creative (toolset ads)Set up MCP
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
namestringpage_idstringinstagram_account_idstringheadlinestringrequiredbodystringrequireddescriptionstringcall_to_actionstringlink_urlstringrequiredoptimize_card_orderbooleanimage_urlstringimage_hashstringvideoobjectcarousel_cardsarray of object≤ 10 items
url_tagsstringpromotionobjectcreative_featuresobjectmulti_advertiserbooleanai_disclosureobjectReturns object
objectstringad_creative
Responses
Creative details
/ads/creatives/{creativeId}Try it with MCPAsk your agent to call get-ad-creative (toolset ads)Set up MCP
Path parameters
creativeIdstringrequired1–300 characters
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
fieldsstringthumbnail_widthintegerthumbnail_heightintegerReturns object
objectstringad_creative
Responses
Rename a creative
/ads/creatives/{creativeId}Try it with MCPAsk your agent to call rename-ad-creative (toolset ads)Set up MCP
Path parameters
creativeIdstringrequired1–300 characters
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
namestringrequired1–400 characters
Returns object
objectstringad_creative
Responses
Delete a creative
/ads/creatives/{creativeId}Try it with MCPAsk your agent to call delete-ad-creative (toolset ads)Set up MCP
Path parameters
creativeIdstringrequired1–300 characters
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
Returns object
objectstringad_creative
idstringdeletedbooleanarchivedbooleanResponses
Images
Ad image library
/ads/imagesTry it with MCPAsk your agent to call list-ad-images (toolset ads)Set up MCP
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
limitinteger1–100
afterstringfieldsstringReturns object
objectstringrequiredlist
dataarray of objectrequiredShow 1 item attributes
objectstringad_image
pageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullnext_cursorstring | nullResponses
Upload an ad image
/ads/imagesTry it with MCPAsk your agent to call upload-ad-image (toolset ads)Set up MCP
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
image_base64string≤ 41000000 characters
image_urlstringfilenamestringReturns object
objectstringad_image
Responses
Videos
Ad video library
/ads/videosTry it with MCPAsk your agent to call list-ad-videos (toolset ads)Set up MCP
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
limitinteger1–100
afterstringfieldsstringReturns object
objectstringrequiredlist
dataarray of objectrequiredShow 1 item attributes
objectstringad_video
pageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullnext_cursorstring | nullResponses
Upload an ad video
/ads/videosTry it with MCPAsk your agent to call upload-ad-video (toolset ads)Set up MCP
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
video_urlstringvideo_base64string≤ 140000000 characters
filenamestringtitlestringasyncbooleanReturns object
objectstringad_video
Responses
Get ad video processing status
/ads/videos/{videoId}Try it with MCPAsk your agent to call get-ad-video (toolset ads)Set up MCP
Path parameters
videoIdstringrequired1–300 characters
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
Returns object
objectstringad_video
Responses
Delete an ad video
/ads/videos/{videoId}Try it with MCPAsk your agent to call delete-ad-video (toolset ads)Set up MCP
Path parameters
videoIdstringrequired1–300 characters
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
Returns object
objectstringad_video
idstringdeletedbooleanarchivedbooleanResponses
TikTok identities
List TikTok ad identities
/ads/tiktok-identitiesTry it with MCPAsk your agent to call list-tiktok-ad-identities (toolset ads)Set up MCP
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
Returns object
objectstringrequiredlist
dataarray of objectrequiredShow 1 item attributes
objectstringtiktok_identity
pageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullResponses
Partnership content
List partnership ad content
/ads/partnership-contentTry it with MCPAsk your agent to call list-ad-partnership-content (toolset ads)Set up MCP
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
creator_usernamestringpost_urlstringonly_allowlistedbooleaninstagram_account_idstringReturns object
objectstringrequiredlist
dataarray of objectrequiredShow 1 item attributes
objectstringpartnership_content
pageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullResponses
Partnership permissions
List partnership permissions
/ads/partnership-permissionsTry it with MCPAsk your agent to call list-ad-partnership-permissions (toolset ads)Set up MCP
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
creator_usernamestringinstagram_account_idstringReturns object
objectstringrequiredlist
dataarray of objectrequiredShow 1 item attributes
objectstringpartnership_permission
pageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullResponses
Set a partnership permission
/ads/partnership-permissionsTry it with MCPAsk your agent to call set-ad-partnership-permission (toolset ads)Set up MCP
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
creator_usernamestringrequired1–100 characters
revokebooleaninstagram_account_idstringReturns object
objectstringpartnership_permission
Responses
Insights
Flexible live insights query
/ads/insightsTry it with MCPAsk your agent to call get-ad-insights (toolset ads)Set up MCP
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
object_idstringlevelstringaccountcampaignad_setad
fieldsstringbreakdownsstringaction_breakdownsstringaction_attribution_windowsstringaction_report_timestringuse_unified_attribution_settingbooleanfilteringstringdate_presetstringfrom_datestringpattern ^\d{4}-\d{2}-\d{2}$
to_datestringpattern ^\d{4}-\d{2}-\d{2}$
time_incrementstringquerystring≤ 10000 characters
report_typestringdata_levelstringdimensionsstringmetricsstringpageinteger≥ 1
page_sizeinteger1–1000
page_tokenstringlimitinteger1–100
afterstringcustomer_idstringReturns object
objectstringad_insights
platformstringad_account_idstring | nulllevelstring | nulldataarray of objecthas_morebooleannext_cursorstring | nullsummaryobject | nullResponses
Submit an async insights report
/ads/insights/reportsTry it with MCPAsk your agent to call create-ad-insights-report (toolset ads)Set up MCP
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
object_idstringlevelstringaccountcampaignad_setad
fieldsarray of stringbreakdownsarray of stringaction_breakdownsarray of stringaction_attribution_windowsarray of stringaction_report_timestringuse_unified_attribution_settingbooleanfilteringarray of objectdate_presetstringfrom_datestringpattern ^\d{4}-\d{2}-\d{2}$
to_datestringpattern ^\d{4}-\d{2}-\d{2}$
time_incrementstringReturns object
objectstringad_insights_report
idstringstatusstringpercent_completenumber | nulldataarray of objecthas_morebooleannext_cursorstring | nullResponses
Poll an async insights report
/ads/insights/reports/{reportId}Try it with MCPAsk your agent to call get-ad-insights-report (toolset ads)Set up MCP
Path parameters
reportIdstringrequired1–300 characters
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
limitinteger1–100
afterstringReturns object
objectstringad_insights_report
idstringstatusstringpercent_completenumber | nulldataarray of objecthas_morebooleannext_cursorstring | nullResponses
TikTok smart plus materials
TikTok Smart+ per-creative performance
/ads/tiktok-smart-plus-materialsTry it with MCPAsk your agent to call get-tiktok-smart-plus-materials (toolset ads)Set up MCP
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
start_datestringrequiredend_datestringrequiredlevelstringadmaterial
smart_plus_ad_idsstringad_group_idsstringpageinteger≥ 1
page_sizeinteger1–100
Returns object
objectstringrequiredlist
dataarray of objectrequiredShow 1 item attributes
objectstringsmart_plus_material
pageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullnext_cursorstring | nullResponses
Search terms
Google Ads search terms report
/ads/search-termsTry it with MCPAsk your agent to call get-ad-search-terms (toolset ads)Set up MCP
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
from_datestringpattern ^\d{4}-\d{2}-\d{2}$
to_datestringpattern ^\d{4}-\d{2}-\d{2}$
campaign_idstringad_set_idstringad_group_idstringpage_tokenstringcustomer_idstringReturns object
objectstringrequiredlist
dataarray of objectrequiredShow 1 item attributes
objectstringsearch_term
pageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullnext_cursorstring | nullResponses
Local services
Google Local Services Ads leads
/ads/local-services/leadsTry it with MCPAsk your agent to call list-local-services-leads (toolset ads)Set up MCP
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
from_datestringpattern ^\d{4}-\d{2}-\d{2}$
to_datestringpattern ^\d{4}-\d{2}-\d{2}$
lead_typestringlead_statusstringcharged_onlybooleanpage_tokenstringcustomer_idstringReturns object
objectstringrequiredlist
dataarray of objectrequiredShow 1 item attributes
objectstringlocal_services_lead
pageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullnext_cursorstring | nullResponses
List Local Services lead conversations
/ads/local-services/leads/{leadId}/conversationsTry it with MCPAsk your agent to call list-local-services-lead-conversations (toolset ads)Set up MCP
Path parameters
leadIdstringrequired1–300 characters
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
page_tokenstringcustomer_idstringReturns object
objectstringrequiredlist
dataarray of objectrequiredShow 1 item attributes
objectstringlocal_services_lead_conversation
pageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullnext_cursorstring | nullResponses
Keywords
Generate keyword ideas
/ads/keywords/ideasTry it with MCPAsk your agent to call generate-ad-keyword-ideas (toolset ads)Set up MCP
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
customer_idstringcountriesarray of stringlanguage_idstringnetworkstringGOOGLE_SEARCHGOOGLE_SEARCH_AND_PARTNERS
include_adult_keywordsbooleanseed_keywordsarray of string≤ 20 items
seed_urlstringpage_sizeinteger1–10000
page_tokenstringReturns object
objectstringrequiredlist
dataarray of objectrequiredShow 1 item attributes
objectstringkeyword_idea
pageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullnext_cursorstring | nullResponses
Get historical keyword metrics
/ads/keywords/historical-metricsTry it with MCPAsk your agent to call get-ad-keyword-historical-metrics (toolset ads)Set up MCP
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
customer_idstringcountriesarray of stringlanguage_idstringnetworkstringGOOGLE_SEARCHGOOGLE_SEARCH_AND_PARTNERS
include_adult_keywordsbooleankeywordsarray of stringrequired1–10000 items
include_average_cpcbooleanReturns object
objectstringrequiredlist
dataarray of objectrequiredShow 1 item attributes
objectstringkeyword_idea
pageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullResponses
List Search keywords
/ads/keywordsTry it with MCPAsk your agent to call list-ad-keywords (toolset ads)Set up MCP
Query parameters
pageintegerdefault: 1Page number
≥ 1
limitintegerdefault: 20Items per page (max 100)
1–100
sortstringcreated_attext
orderstringascdesc
matchstringCombine filters with AND (default) or OR
allor
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
profile_idstringcampaign_idstringad_set_idstringstatusstringenabledpausedremoved
match_typestringexactphrasebroad
negativebooleansearchstringReturns object
objectstringrequiredlist
dataarray of objectrequiredShow 19 item attributes
objectstringad_keyword
idstringplatformstringad_account_idstring | nullcampaign_idstring | nullad_set_idstring | nullexternal_idstringcriterion_idstring | nulltextstringmatch_typestring | nullnegativebooleanstatusstringcpc_bidnumber | nullfinal_urlstring | nullquality_scoreinteger | nullmetricsobject | nullsynced_atstring (date-time) | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullpageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullResponses
Add Search keywords
/ads/keywordsTry it with MCPAsk your agent to call add-ad-keywords (toolset ads)Set up MCP
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
ad_set_idstringrequiredkeywordsarray of objectrequired1–200 items
Show 4 item attributes
textstringrequired1–80 characters
match_typestringexactphrasebroad
cpc_bidnumberfinal_urlstringnegativebooleanReturns object
objectstringrequiredlist
dataarray of objectrequiredShow 19 item attributes
objectstringad_keyword
idstringplatformstringad_account_idstring | nullcampaign_idstring | nullad_set_idstring | nullexternal_idstringcriterion_idstring | nulltextstringmatch_typestring | nullnegativebooleanstatusstringcpc_bidnumber | nullfinal_urlstring | nullquality_scoreinteger | nullmetricsobject | nullsynced_atstring (date-time) | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullpageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullResponses
Pause or enable a Search keyword
/ads/keywords/{id}Try it with MCPAsk your agent to call update-ad-keyword (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Body object
statusstringrequiredenabledpaused
cpc_bidnumberReturns object
objectstringad_keyword
idstringplatformstringad_account_idstring | nullcampaign_idstring | nullad_set_idstring | nullexternal_idstringcriterion_idstring | nulltextstringmatch_typestring | nullnegativebooleanstatusstringcpc_bidnumber | nullfinal_urlstring | nullquality_scoreinteger | nullmetricsobject | nullsynced_atstring (date-time) | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullResponses
Remove a Search keyword
/ads/keywords/{id}Try it with MCPAsk your agent to call delete-ad-keyword (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Returns object
objectstringad_keyword
idstringdeletedbooleanarchivedbooleanResponses
Recommendations
List Google Ads recommendations
/ads/recommendationsTry it with MCPAsk your agent to call list-ad-recommendations (toolset ads)Set up MCP
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
campaign_idstringtypesstringcustomer_idstringReturns object
objectstringrequiredlist
dataarray of objectrequiredShow 1 item attributes
objectstringad_recommendation
pageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullResponses
Apply Google Ads recommendations
/ads/recommendations/applyTry it with MCPAsk your agent to call apply-ad-recommendations (toolset ads)Set up MCP
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
recommendationsarray of objectrequired1–100 items
Show 2 item attributes
idstringrequiredparametersobjectcustomer_idstringReturns object
objectstringad_recommendation_result
Responses
Dismiss Google Ads recommendations
/ads/recommendations/dismissTry it with MCPAsk your agent to call dismiss-ad-recommendations (toolset ads)Set up MCP
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
idsarray of string1–100 items
resource_namesarray of string≤ 100 items
customer_idstringReturns object
objectstringad_recommendation_result
Responses
Bid strategies
List portfolio bid strategies
/ads/bid-strategiesTry it with MCPAsk your agent to call list-ad-bid-strategies (toolset ads)Set up MCP
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
from_datestringpattern ^\d{4}-\d{2}-\d{2}$
to_datestringpattern ^\d{4}-\d{2}-\d{2}$
customer_idstringReturns object
objectstringrequiredlist
dataarray of objectrequiredShow 1 item attributes
objectstringbid_strategy
pageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullResponses
Create a portfolio bid strategy
/ads/bid-strategiesTry it with MCPAsk your agent to call create-ad-bid-strategy (toolset ads)Set up MCP
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
namestringrequired1–255 characters
typestringrequiredTARGET_CPATARGET_ROASMAXIMIZE_CONVERSIONSMAXIMIZE_CONVERSION_VALUETARGET_IMPRESSION_SHARETARGET_SPEND
target_cpanumbertarget_roasnumbertarget_impression_shareobjectcustomer_idstringReturns object
objectstringbid_strategy
Responses
Update a portfolio bid strategy
/ads/bid-strategies/{strategyId}Try it with MCPAsk your agent to call update-ad-bid-strategy (toolset ads)Set up MCP
Path parameters
strategyIdstringrequired1–300 characters
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
namestringtypestringtarget_cpanumbertarget_roasnumbertarget_impression_shareobjectcustomer_idstringReturns object
objectstringbid_strategy
Responses
Shared budgets
List shared budgets
/ads/shared-budgetsTry it with MCPAsk your agent to call list-ad-shared-budgets (toolset ads)Set up MCP
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
Returns object
objectstringrequiredlist
dataarray of objectrequiredShow 1 item attributes
objectstringshared_budget
pageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullResponses
Create a shared budget
/ads/shared-budgetsTry it with MCPAsk your agent to call create-ad-shared-budget (toolset ads)Set up MCP
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
namestringrequired1–255 characters
amountnumberrequiredtypestringdaily
delivery_methodstringstandardaccelerated
Returns object
objectstringshared_budget
Responses
Interests
Search targeting interests
/ads/interestsTry it with MCPAsk your agent to call search-ad-interests (toolset ads)Set up MCP
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
qstringrequired1–200 characters
limitinteger1–100
Returns object
objectstringrequiredlist
dataarray of objectrequiredShow 1 item attributes
objectstringtargeting_option
pageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullResponses
Targeting
Search targeting options
/ads/targeting/searchTry it with MCPAsk your agent to call search-ad-targeting (toolset ads)Set up MCP
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
qstringrequired1–200 characters
dimensionstringgeo_typestringcountry_codestringlimitinteger1–100
Returns object
objectstringrequiredlist
dataarray of objectrequiredShow 1 item attributes
objectstringtargeting_option
pageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullResponses
Browse targeting categories
/ads/targeting/browseTry it with MCPAsk your agent to call browse-ad-targeting (toolset ads)Set up MCP
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
typestringparent_idstringselectablebooleanReturns object
objectstringrequiredlist
dataarray of objectrequiredShow 1 item attributes
objectstringtargeting_option
pageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullResponses
Estimate audience reach
/ads/targeting/reach-estimateTry it with MCPAsk your agent to call estimate-ad-reach (toolset ads)Set up MCP
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
targetingobjectNormalized targeting (countries, regions, cities, zips, age_min, age_max, genders, languages, interests, audience_ids, placements, keywords, subreddits, job_titles, …) or raw (native spec)
specobjectoptimization_goalstringReturns object
objectstringreach_estimate
Responses
Suggested bid and budget bounds
/ads/targeting/bid-pricingTry it with MCPAsk your agent to call get-ad-bid-pricing (toolset ads)Set up MCP
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
targetingobjectNormalized targeting (countries, regions, cities, zips, age_min, age_max, genders, languages, interests, audience_ids, placements, keywords, subreddits, job_titles, …) or raw (native spec)
specobjectcampaign_typestringbid_typestringCPMCPCCPV
match_typestringcurrencystringobjective_typestringoptimization_target_typestringdaily_budgetnumberReturns object
objectstringbid_pricing
Responses
Forecast ad delivery
/ads/targeting/supply-forecastTry it with MCPAsk your agent to call get-ad-supply-forecast (toolset ads)Set up MCP
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
targetingobjectNormalized targeting (countries, regions, cities, zips, age_min, age_max, genders, languages, interests, audience_ids, placements, keywords, subreddits, job_titles, …) or raw (native spec)
specobjectcampaign_typestringtime_range_startstringrequiredtime_range_endstringrequiredobjective_typestringoptimization_targetstringdaily_budgetnumbertotal_budgetnumbercurrencystringcompeting_bidnumberenable_audience_networkbooleanenable_audience_expansionbooleanconnected_television_onlybooleanReturns object
objectstringsupply_forecast
Responses
Audiences
List custom audiences
/ads/audiencesTry it with MCPAsk your agent to call list-ad-audiences (toolset ads)Set up MCP
Query parameters
pageintegerdefault: 1Page number
≥ 1
limitintegerdefault: 20Items per page (max 100)
1–100
sortstringcreated_atname
orderstringascdesc
matchstringCombine filters with AND (default) or OR
allor
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
profile_idstringtypestringlivebooleanReturns object
objectstringrequiredlist
dataarray of objectrequiredShow 22 item attributes
objectstringad_audience
idstringplatformstringad_account_idstring | nullconnection_idstring | nullprofile_idstring | nullexternal_idstringnamestring | nulldescriptionstring | nulltypestringsubtypestring | nullstatusstringsizenumber | nullsize_lowernumber | nullsize_uppernumber | nullspecobjectuploaded_countintegerlast_uploaded_atstring (date-time) | nullplatform_statusstring | nullsynced_atstring (date-time) | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullpageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullResponses
Create a custom audience
/ads/audiencesTry it with MCPAsk your agent to call create-ad-audience (toolset ads)Set up MCP
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
namestringrequired1–255 characters
descriptionstring≤ 1000 characters
typestringrequiredcustomer_listwebsitelookalikeengagementsavedcompany_list
customer_file_sourcestringretention_daysinteger1–540
ruleobjectpixel_idstringsource_audience_idstringcountrystringrationumber0.01–0.2
engagement_sourceobjecttargetingobjectNormalized targeting (countries, regions, cities, zips, age_min, age_max, genders, languages, interests, audience_ids, placements, keywords, subreddits, job_titles, …) or raw (native spec)
specobjectusersarray of object≤ 10000 items
hashedbooleanReturns object
objectstringad_audience
idstringplatformstringad_account_idstring | nullconnection_idstring | nullprofile_idstring | nullexternal_idstringnamestring | nulldescriptionstring | nulltypestringsubtypestring | nullstatusstringsizenumber | nullsize_lowernumber | nullsize_uppernumber | nullspecobjectuploaded_countintegerlast_uploaded_atstring (date-time) | nullplatform_statusstring | nullsynced_atstring (date-time) | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullResponses
Get audience details
/ads/audiences/{id}Try it with MCPAsk your agent to call get-ad-audience (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Returns object
objectstringad_audience
idstringplatformstringad_account_idstring | nullconnection_idstring | nullprofile_idstring | nullexternal_idstringnamestring | nulldescriptionstring | nulltypestringsubtypestring | nullstatusstringsizenumber | nullsize_lowernumber | nullsize_uppernumber | nullspecobjectuploaded_countintegerlast_uploaded_atstring (date-time) | nullplatform_statusstring | nullsynced_atstring (date-time) | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullResponses
Update an audience
/ads/audiences/{id}Try it with MCPAsk your agent to call update-ad-audience (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Body object
namestring1–255 characters
descriptionstring | null≤ 1000 characters
specobjectReturns object
objectstringad_audience
idstringplatformstringad_account_idstring | nullconnection_idstring | nullprofile_idstring | nullexternal_idstringnamestring | nulldescriptionstring | nulltypestringsubtypestring | nullstatusstringsizenumber | nullsize_lowernumber | nullsize_uppernumber | nullspecobjectuploaded_countintegerlast_uploaded_atstring (date-time) | nullplatform_statusstring | nullsynced_atstring (date-time) | nullcreated_atstring (date-time) | nullupdated_atstring (date-time) | nullResponses
Delete a custom audience
/ads/audiences/{id}Try it with MCPAsk your agent to call delete-ad-audience (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Returns object
objectstringad_audience
idstringdeletedbooleanarchivedbooleanResponses
Add users to an audience
/ads/audiences/{id}/usersTry it with MCPAsk your agent to call add-ad-audience-users (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
usersarray of objectrequired1–10000 items
Show 10 item attributes
emailstringphonestringfirst_namestringlast_namestringcountrystringzipstringcitystringstatestringexternal_idstringmobile_advertiser_idstringoperationstringaddremove
hashedbooleanReturns object
objectstringad_audience_upload
Responses
Replace audience companies
/ads/audiences/{id}/companiesTry it with MCPAsk your agent to call replace-ad-audience-companies (toolset ads)Set up MCP
Path parameters
idstringrequired1–300 characters
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
companiesarray of objectrequired1–300000 items
Show 5 item attributes
company_namestringcompany_websitestringcompany_email_domainstringlinkedin_company_page_urlstringorganization_urnstringReturns object
objectstringad_audience_upload
Responses
Library
Search the public Ad Library
/ads/libraryTry it with MCPAsk your agent to call search-ad-library (toolset ads)Set up MCP
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
platformstringAd platform (meta_ads, google_ads, linkedin_ads, tiktok_ads, pinterest_ads, x_ads, reddit_ads, openai_ads) or an alias (facebook, instagram, googleads, twitter, …)
1–40 characters
qstringpage_idsstringadvertiserstringcountriesstringad_typestringstatusstringplatformsstringmedia_typestringlanguagesstringsincestringuntilstringsearch_typestringfieldsstringlimitinteger1–100
afterstringReturns object
objectstringrequiredlist
dataarray of objectrequiredShow 1 item attributes
objectstringad_library_ad
pageintegerrequiredlimitintegerrequiredtotalinteger | nullhas_morebooleanrequirednext_page_urlstring | nullprevious_page_urlstring | nullnext_cursorstring | nullResponses
Rf predictions
Create a reach & frequency prediction
/ads/rf-predictionsTry it with MCPAsk your agent to call create-ad-reach-frequency-prediction (toolset ads)Set up MCP
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
budget_amountnumberreachinteger≥ 1
start_timestringrequiredend_timestringrequiredfrequency_capobjecttargetingobjectNormalized targeting (countries, regions, cities, zips, age_min, age_max, genders, languages, interests, audience_ids, placements, keywords, subreddits, job_titles, …) or raw (native spec)
placementsobjectobjectivestringprediction_modeintegerReturns object
objectstringrf_prediction
Responses
Get a reach & frequency prediction
/ads/rf-predictions/{predictionId}Try it with MCPAsk your agent to call get-ad-reach-frequency-prediction (toolset ads)Set up MCP
Path parameters
predictionIdstringrequired1–300 characters
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
Returns object
objectstringrf_prediction
Responses
Cancel a reach & frequency booking
/ads/rf-predictions/{predictionId}Try it with MCPAsk your agent to call cancel-ad-reach-frequency-prediction (toolset ads)Set up MCP
Path parameters
predictionIdstringrequired1–300 characters
Query parameters
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
Returns object
objectstringrf_prediction
idstringdeletedbooleanarchivedbooleanResponses
Reserve reach & frequency inventory
/ads/rf-predictions/{predictionId}/reserveTry it with MCPAsk your agent to call reserve-ad-reach-frequency-prediction (toolset ads)Set up MCP
Path parameters
predictionIdstringrequired1–300 characters
Headers
Idempotency-KeystringUnique key (for example a UUID) that makes retries safe: a repeated request with the same key and body returns the first response (Idempotent-Replayed: true) for 24 hours.
≤ 255 characters
Body object
ad_account_idstringAd account (ada_…)
≤ 80 characters
connection_idstringAds connection (adc_…); with platform_ad_account_id when it reaches several ad accounts
≤ 80 characters
platform_ad_account_idstringNetwork ad account id (act_123, Google customer id, TikTok advertiser id…)
≤ 120 characters
Returns object
objectstringrf_prediction