Meta Ads
metaadsCreate, edit and get insights from ads across Meta technologies, including Facebook, Instagram, Messenger, WhatsApp and more.
Acciones disponibles (16)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Create AdMETAADS_CREATE_ADAcciónCreate a new ad within an ad set using the meta marketing api. supports various ad formats including image, video, carousel, and collection ads.
METAADS_CREATE_ADAcciónCreate a new ad within an ad set using the meta marketing api. supports various ad formats including image, video, carousel, and collection ads.
Parámetros de entrada
namestringObligatorioName of the ad
statusstringenumInitial status of the ad
ACTIVEPAUSEDDELETEDARCHIVEDcreativeobjectObligatorioCreative specifications for the ad
ad_set_idstringObligatorioID of the ad set to create the ad in
bid_amountintegerBid amount in cents (overrides ad set bid)
tracking_specsobject[]Tracking specifications for the ad
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Ad CreativeMETAADS_CREATE_AD_CREATIVEAcciónCreate a new ad creative using the meta marketing api. ad creatives are reusable visual and interactive elements that define how your ad looks and behaves: - can be used in multiple ads - support various formats (image, video, carousel) - include text, media, and call-to-action buttons - must follow meta's ad policies
METAADS_CREATE_AD_CREATIVEAcciónCreate a new ad creative using the meta marketing api. ad creatives are reusable visual and interactive elements that define how your ad looks and behaves: - can be used in multiple ads - support various formats (image, video, carousel) - include text, media, and call-to-action buttons - must follow meta's ad policies
Parámetros de entrada
namestringObligatorioName of your ad creative. Best practices: - Include the creative type (e.g., "Summer Sale - Image") - Add version if iterating (e.g., "v1") - Include target audience if specific - Keep it searchable and organized
creativeobjectObligatorioThe creative specifications for your ad. This defines: - What type of ad (image, video, carousel) - What it looks like (images, text) - How it behaves (links, buttons) See AdCreative model for details.
account_idstringObligatorioThe ad account ID where you want to create the creative. Format: act_1234567890 Get this from your Meta Ads account settings. Must have proper permissions set up.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Ad SetMETAADS_CREATE_AD_SETAcciónCreate a new ad set within a campaign using the meta marketing api. supports detailed targeting options, budgets, and optimization goals.
METAADS_CREATE_AD_SETAcciónCreate a new ad set within a campaign using the meta marketing api. supports detailed targeting options, budgets, and optimization goals.
Parámetros de entrada
namestringObligatorioName of the ad set
statusstringenumInitial status of the ad set
ACTIVEPAUSEDDELETEDARCHIVEDend_timestringEnd time in ISO 8601 format
targetingobjectObligatorioTargeting specifications for the ad set
bid_amountintegerObligatorioBid amount in cents
start_timestringStart time in ISO 8601 format
campaign_idstringObligatorioID of the campaign to create the ad set in
daily_budgetnumberDaily budget limit in account currency
billing_eventstringObligatorioenumThe billing event for the ad set
IMPRESSIONSLINK_CLICKSAPP_INSTALLSPOST_ENGAGEMENTTHRUPLAYlifetime_budgetnumberLifetime budget limit in account currency
optimization_goalstringObligatorioenumThe optimization goal for the ad set
APP_INSTALLSCONVERSATIONSLINK_CLICKSOFFSITE_CONVERSIONSPAGE_LIKESPOST_ENGAGEMENTREACHTHRUPLAYVALUE
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create CampaignMETAADS_CREATE_CAMPAIGNAcciónCreate a new advertising campaign using the meta marketing api. supports various campaign objectives, budgets, and bidding strategies.
METAADS_CREATE_CAMPAIGNAcciónCreate a new advertising campaign using the meta marketing api. supports various campaign objectives, budgets, and bidding strategies.
Parámetros de entrada
namestringObligatorioName of the campaign
statusstringenumInitial status of the campaign
ACTIVEPAUSEDDELETEDARCHIVEDobjectivestringObligatorioenumThe objective of the campaign
APP_INSTALLSBRAND_AWARENESSCONVERSIONSEVENT_RESPONSESLEAD_GENERATIONLINK_CLICKSLOCAL_AWARENESSMESSAGESOFFER_CLAIMSPAGE_LIKESPOST_ENGAGEMENTREACH+2account_idstringObligatorioThe ID of the ad account to create the campaign in
bid_strategystringenumBidding strategy for the campaign
LOWEST_COST_WITHOUT_CAPLOWEST_COST_WITH_BID_CAPCOST_CAPdaily_budgetnumberDaily budget limit in account currency
lifetime_budgetnumberLifetime budget limit in account currency
special_ad_categoriesstring[]List of special ad categories that apply to this campaign
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Custom AudienceMETAADS_CREATE_CUSTOM_AUDIENCEAcciónCreate a new custom audience using the meta marketing api. supports various types of custom audiences including customer lists, website visitors, and app users.
METAADS_CREATE_CUSTOM_AUDIENCEAcciónCreate a new custom audience using the meta marketing api. supports various types of custom audiences including customer lists, website visitors, and app users.
Parámetros de entrada
namestringObligatorioName of the custom audience
ruleobjectRule for website/app custom audiences
prefillbooleanWhether to prefill the audience with available data
subtypestringObligatorioenumType of the custom audience
CUSTOM_AUDIENCEWEBSITEAPPOFFLINE_CONVERSIONCLAIMPARTNERMANAGED_PARTNERVIDEOPAGEENGAGEMENTDATA_SETBAG_OF_ACCOUNTS+2account_idstringObligatorioThe ID of the ad account to create the custom audience in
descriptionstringDescription of the custom audience
content_typestringenumType of content for customer file-based audiences
EMAILPHONEMOBILE_ADVERTISER_IDMADIDEXTERNAL_IDLOOKALIKE_VALUEcustomer_filestring[]List of customer identifiers (hashed)
retention_daysintegerNumber of days to keep the audience data
customer_file_sourcestringenumSource of the customer file data
USER_PROVIDED_ONLYPARTNER_PROVIDED_ONLYBOTH_USER_AND_PARTNER_PROVIDED
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Ad CreativeMETAADS_DELETE_AD_CREATIVEAcciónDelete ad creative
METAADS_DELETE_AD_CREATIVEAcciónDelete ad creative
Parámetros de entrada
creative_idstringObligatorio
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete CampaignMETAADS_DELETE_CAMPAIGNAcciónDelete an advertising campaign using the meta marketing api. this marks the campaign as deleted, which prevents it from delivering ads. note that deleted campaigns are not permanently removed from meta's systems and can still be viewed in reports.
METAADS_DELETE_CAMPAIGNAcciónDelete an advertising campaign using the meta marketing api. this marks the campaign as deleted, which prevents it from delivering ads. note that deleted campaigns are not permanently removed from meta's systems and can still be viewed in reports.
Parámetros de entrada
campaign_idstringObligatorioID of the campaign to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Ad CreativeMETAADS_GET_AD_CREATIVEAcciónGet ad creative
METAADS_GET_AD_CREATIVEAcciónGet ad creative
Parámetros de entrada
fieldsstring[]creative_idstringObligatorio
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get InsightsMETAADS_GET_INSIGHTSAcciónGet insights data for a meta ads object (ad account, campaign, ad set, or ad) using the meta marketing api. supports various metrics, breakdowns, and filtering options with flexible date ranges.
METAADS_GET_INSIGHTSAcciónGet insights data for a meta ads object (ad account, campaign, ad set, or ad) using the meta marketing api. supports various metrics, breakdowns, and filtering options with flexible date ranges.
Parámetros de entrada
sortstring[]Fields to sort by with direction (_ascending or _descending suffix)
levelstringenumLevel at which to aggregate the data
accountcampaignadsetadfieldsstring[]List of fields to include in the response
filteringobject[]Filters to apply to the data
object_idstringObligatorioID of the object to get insights for (ad account, campaign, ad set, or ad)
breakdownsstring[]List of breakdowns to apply to the data
time_rangeobjectCustom date range for the insights
date_presetstringenumPredefined date range for the insights
todayyesterdaylast_7dlast_30dthis_monthlast_monththis_quarterlifetimeaction_attribution_windowsstring[]Attribution windows for conversion metrics
Parámetros de salida
dataobject[]ObligatorioList of insight results
errorstringError if any occurred during the execution of the action
pagingobjectPaging information if available
successfulbooleanObligatorioWhether or not the action execution was successful or not
Pause CampaignMETAADS_PAUSE_CAMPAIGNAcciónPause an advertising campaign using the meta marketing api. this stops the campaign from delivering ads but allows it to be resumed later. all child ad sets and ads will also be paused with an effective status of campaign paused.
METAADS_PAUSE_CAMPAIGNAcciónPause an advertising campaign using the meta marketing api. this stops the campaign from delivering ads but allows it to be resumed later. all child ad sets and ads will also be paused with an effective status of campaign paused.
Parámetros de entrada
campaign_idstringObligatorioID of the campaign to pause
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Preview Ad CreativeMETAADS_PREVIEW_AD_CREATIVEAcciónPreview ad creative
METAADS_PREVIEW_AD_CREATIVEAcciónPreview ad creative
Parámetros de entrada
creative_idstringObligatorioID of the ad creative to preview. Get this from: - CreateAdCreative response - Existing ad creative lookup Format: 23842938523454
thumbnail_widthintegerWidth of the preview thumbnail in pixels. - Default: 150px - Min: 50px - Max: 1200px Larger sizes give better quality but load slower.
thumbnail_heightintegerHeight of the preview thumbnail in pixels. - Default: 120px - Min: 50px - Max: 1200px Choose based on your display needs.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Read Ad SetsMETAADS_READ_ADSETSAcciónRetrieve ad sets from a meta ad account using the marketing api. returns information about the ad sets including their status, targeting, and other properties.
METAADS_READ_ADSETSAcciónRetrieve ad sets from a meta ad account using the marketing api. returns information about the ad sets including their status, targeting, and other properties.
Parámetros de entrada
limitintegerMaximum number of adsets to return
fieldsstring[]Fields to return for each ad set
date_presetstringenumPredefined date range used to aggregate insights metrics
TODAYYESTERDAYTHIS_MONTHLAST_MONTHTHIS_QUARTERMAXIMUMDATA_MAXIMUMLAST_3DLAST_7DLAST_14DLAST_28DLAST_30D+8is_completedbooleanFilter adsets by completed status
ad_account_idstringObligatorioID of the ad account to fetch adsets from
updated_sinceintegerTime since the Adset has been updated (in seconds)
effective_statusstring[]Filter adsets by their effective status
time_range_sincestringStart date in YYYY-MM-DD format for custom date range
time_range_untilstringEnd date in YYYY-MM-DD format for custom date range
Parámetros de salida
dataobject[]ObligatorioList of ad sets
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
paging_nextstringURL to the next page of data
total_countintegerTotal number of adsets
paging_previousstringURL to the previous page of data
Resume CampaignMETAADS_RESUME_CAMPAIGNAcciónResume a paused advertising campaign using the meta marketing api. this sets the campaign status to active so it can deliver ads again. note that child ad sets and ads that were previously active will also resume delivery, but those that were individually paused will remain paused.
METAADS_RESUME_CAMPAIGNAcciónResume a paused advertising campaign using the meta marketing api. this sets the campaign status to active so it can deliver ads again. note that child ad sets and ads that were previously active will also resume delivery, but those that were individually paused will remain paused.
Parámetros de entrada
campaign_idstringObligatorioID of the campaign to resume
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Ad CreativeMETAADS_UPDATE_AD_CREATIVEAcciónUpdate ad creative
METAADS_UPDATE_AD_CREATIVEAcciónUpdate ad creative
Parámetros de entrada
namestringstatusstringenumACTIVEPAUSEDDELETEDARCHIVEDcreative_idstringObligatorio
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update CampaignMETAADS_UPDATE_CAMPAIGNAcciónUpdate an existing advertising campaign using the meta marketing api. allows modification of campaign properties like name, status, budget, and bidding strategy. only the fields that need to be updated should be included in the request.
METAADS_UPDATE_CAMPAIGNAcciónUpdate an existing advertising campaign using the meta marketing api. allows modification of campaign properties like name, status, budget, and bidding strategy. only the fields that need to be updated should be included in the request.
Parámetros de entrada
namestringNew name for the campaign
statusstringenumUpdated status of the campaign
ACTIVEPAUSEDDELETEDARCHIVEDspend_capnumberUpdated spend cap for the campaign in account currency (minimum value $100 USD)
campaign_idstringObligatorioID of the campaign to update
bid_strategystringenumUpdated bidding strategy for the campaign
LOWEST_COST_WITHOUT_CAPLOWEST_COST_WITH_BID_CAPCOST_CAPLOWEST_COST_WITH_MIN_ROASdaily_budgetnumberUpdated daily budget limit in account currency
lifetime_budgetnumberUpdated lifetime budget limit in account currency
special_ad_categoriesstring[]Updated list of special ad categories that apply to this campaign
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Upload Ad ImageMETAADS_UPLOAD_AD_IMAGEAcciónUpload an image for use in meta ad creatives using the marketing api. the image can later be referenced by its hash when creating ad creatives.
METAADS_UPLOAD_AD_IMAGEAcciónUpload an image for use in meta ad creatives using the marketing api. the image can later be referenced by its hash when creating ad creatives.
Parámetros de entrada
namestringOptional name for the image (max 100 characters)
imageobjectObligatorioImage file to upload. Supported formats include JPG, PNG, GIF, etc.
ad_account_idstringObligatorioID of the ad account to upload the image to
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not