NAiOS IconNAiOS Logo
Volver al catálogo

Meta Ads

metaads

Create, edit and get insights from ads across Meta technologies, including Facebook, Instagram, Messenger, WhatsApp and more.

Acciones
16
Triggers
0
Autenticación
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

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ón

Create 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

  • namestringObligatorio

    Name of the ad

  • statusstringenum

    Initial status of the ad

    ACTIVEPAUSEDDELETEDARCHIVED
  • creativeobjectObligatorio

    Creative specifications for the ad

  • ad_set_idstringObligatorio

    ID of the ad set to create the ad in

  • bid_amountinteger

    Bid amount in cents (overrides ad set bid)

  • tracking_specsobject[]

    Tracking specifications for the ad

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Ad CreativeMETAADS_CREATE_AD_CREATIVEAcción

Create 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

  • namestringObligatorio

    Name 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

  • creativeobjectObligatorio

    The 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_idstringObligatorio

    The 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

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Ad SetMETAADS_CREATE_AD_SETAcción

Create a new ad set within a campaign using the meta marketing api. supports detailed targeting options, budgets, and optimization goals.

Parámetros de entrada

  • namestringObligatorio

    Name of the ad set

  • statusstringenum

    Initial status of the ad set

    ACTIVEPAUSEDDELETEDARCHIVED
  • end_timestring

    End time in ISO 8601 format

  • targetingobjectObligatorio

    Targeting specifications for the ad set

  • bid_amountintegerObligatorio

    Bid amount in cents

  • start_timestring

    Start time in ISO 8601 format

  • campaign_idstringObligatorio

    ID of the campaign to create the ad set in

  • daily_budgetnumber

    Daily budget limit in account currency

  • billing_eventstringObligatorioenum

    The billing event for the ad set

    IMPRESSIONSLINK_CLICKSAPP_INSTALLSPOST_ENGAGEMENTTHRUPLAY
  • lifetime_budgetnumber

    Lifetime budget limit in account currency

  • optimization_goalstringObligatorioenum

    The optimization goal for the ad set

    APP_INSTALLSCONVERSATIONSLINK_CLICKSOFFSITE_CONVERSIONSPAGE_LIKESPOST_ENGAGEMENTREACHTHRUPLAYVALUE

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create CampaignMETAADS_CREATE_CAMPAIGNAcción

Create a new advertising campaign using the meta marketing api. supports various campaign objectives, budgets, and bidding strategies.

Parámetros de entrada

  • namestringObligatorio

    Name of the campaign

  • statusstringenum

    Initial status of the campaign

    ACTIVEPAUSEDDELETEDARCHIVED
  • objectivestringObligatorioenum

    The objective of the campaign

    APP_INSTALLSBRAND_AWARENESSCONVERSIONSEVENT_RESPONSESLEAD_GENERATIONLINK_CLICKSLOCAL_AWARENESSMESSAGESOFFER_CLAIMSPAGE_LIKESPOST_ENGAGEMENTREACH+2
  • account_idstringObligatorio

    The ID of the ad account to create the campaign in

  • bid_strategystringenum

    Bidding strategy for the campaign

    LOWEST_COST_WITHOUT_CAPLOWEST_COST_WITH_BID_CAPCOST_CAP
  • daily_budgetnumber

    Daily budget limit in account currency

  • lifetime_budgetnumber

    Lifetime budget limit in account currency

  • special_ad_categoriesstring[]

    List of special ad categories that apply to this campaign

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Custom AudienceMETAADS_CREATE_CUSTOM_AUDIENCEAcción

Create 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

  • namestringObligatorio

    Name of the custom audience

  • ruleobject

    Rule for website/app custom audiences

  • prefillboolean

    Whether to prefill the audience with available data

  • subtypestringObligatorioenum

    Type of the custom audience

    CUSTOM_AUDIENCEWEBSITEAPPOFFLINE_CONVERSIONCLAIMPARTNERMANAGED_PARTNERVIDEOPAGEENGAGEMENTDATA_SETBAG_OF_ACCOUNTS+2
  • account_idstringObligatorio

    The ID of the ad account to create the custom audience in

  • descriptionstring

    Description of the custom audience

  • content_typestringenum

    Type of content for customer file-based audiences

    EMAILPHONEMOBILE_ADVERTISER_IDMADIDEXTERNAL_IDLOOKALIKE_VALUE
  • customer_filestring[]

    List of customer identifiers (hashed)

  • retention_daysinteger

    Number of days to keep the audience data

  • customer_file_sourcestringenum

    Source of the customer file data

    USER_PROVIDED_ONLYPARTNER_PROVIDED_ONLYBOTH_USER_AND_PARTNER_PROVIDED

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Ad CreativeMETAADS_DELETE_AD_CREATIVEAcción

Delete ad creative

Parámetros de entrada

  • creative_idstringObligatorio

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete CampaignMETAADS_DELETE_CAMPAIGNAcción

Delete 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_idstringObligatorio

    ID of the campaign to delete

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Ad CreativeMETAADS_GET_AD_CREATIVEAcción

Get ad creative

Parámetros de entrada

  • fieldsstring[]
  • creative_idstringObligatorio

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get InsightsMETAADS_GET_INSIGHTSAcción

Get 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)

  • levelstringenum

    Level at which to aggregate the data

    accountcampaignadsetad
  • fieldsstring[]

    List of fields to include in the response

  • filteringobject[]

    Filters to apply to the data

  • object_idstringObligatorio

    ID of the object to get insights for (ad account, campaign, ad set, or ad)

  • breakdownsstring[]

    List of breakdowns to apply to the data

  • time_rangeobject

    Custom date range for the insights

  • date_presetstringenum

    Predefined date range for the insights

    todayyesterdaylast_7dlast_30dthis_monthlast_monththis_quarterlifetime
  • action_attribution_windowsstring[]

    Attribution windows for conversion metrics

Parámetros de salida

  • dataobject[]Obligatorio

    List of insight results

  • errorstring

    Error if any occurred during the execution of the action

  • pagingobject

    Paging information if available

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Pause CampaignMETAADS_PAUSE_CAMPAIGNAcción

Pause 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_idstringObligatorio

    ID of the campaign to pause

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Preview Ad CreativeMETAADS_PREVIEW_AD_CREATIVEAcción

Preview ad creative

Parámetros de entrada

  • creative_idstringObligatorio

    ID of the ad creative to preview. Get this from: - CreateAdCreative response - Existing ad creative lookup Format: 23842938523454

  • thumbnail_widthinteger

    Width of the preview thumbnail in pixels. - Default: 150px - Min: 50px - Max: 1200px Larger sizes give better quality but load slower.

  • thumbnail_heightinteger

    Height of the preview thumbnail in pixels. - Default: 120px - Min: 50px - Max: 1200px Choose based on your display needs.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Read Ad SetsMETAADS_READ_ADSETSAcción

Retrieve 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

  • limitinteger

    Maximum number of adsets to return

  • fieldsstring[]

    Fields to return for each ad set

  • date_presetstringenum

    Predefined date range used to aggregate insights metrics

    TODAYYESTERDAYTHIS_MONTHLAST_MONTHTHIS_QUARTERMAXIMUMDATA_MAXIMUMLAST_3DLAST_7DLAST_14DLAST_28DLAST_30D+8
  • is_completedboolean

    Filter adsets by completed status

  • ad_account_idstringObligatorio

    ID of the ad account to fetch adsets from

  • updated_sinceinteger

    Time since the Adset has been updated (in seconds)

  • effective_statusstring[]

    Filter adsets by their effective status

  • time_range_sincestring

    Start date in YYYY-MM-DD format for custom date range

  • time_range_untilstring

    End date in YYYY-MM-DD format for custom date range

Parámetros de salida

  • dataobject[]Obligatorio

    List of ad sets

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

  • paging_nextstring

    URL to the next page of data

  • total_countinteger

    Total number of adsets

  • paging_previousstring

    URL to the previous page of data

Resume CampaignMETAADS_RESUME_CAMPAIGNAcción

Resume 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_idstringObligatorio

    ID of the campaign to resume

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Ad CreativeMETAADS_UPDATE_AD_CREATIVEAcción

Update ad creative

Parámetros de entrada

  • namestring
  • statusstringenum
    ACTIVEPAUSEDDELETEDARCHIVED
  • creative_idstringObligatorio

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update CampaignMETAADS_UPDATE_CAMPAIGNAcción

Update 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

  • namestring

    New name for the campaign

  • statusstringenum

    Updated status of the campaign

    ACTIVEPAUSEDDELETEDARCHIVED
  • spend_capnumber

    Updated spend cap for the campaign in account currency (minimum value $100 USD)

  • campaign_idstringObligatorio

    ID of the campaign to update

  • bid_strategystringenum

    Updated bidding strategy for the campaign

    LOWEST_COST_WITHOUT_CAPLOWEST_COST_WITH_BID_CAPCOST_CAPLOWEST_COST_WITH_MIN_ROAS
  • daily_budgetnumber

    Updated daily budget limit in account currency

  • lifetime_budgetnumber

    Updated lifetime budget limit in account currency

  • special_ad_categoriesstring[]

    Updated list of special ad categories that apply to this campaign

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Upload Ad ImageMETAADS_UPLOAD_AD_IMAGEAcción

Upload 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

  • namestring

    Optional name for the image (max 100 characters)

  • imageobjectObligatorio

    Image file to upload. Supported formats include JPG, PNG, GIF, etc.

  • ad_account_idstringObligatorio

    ID of the ad account to upload the image to

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not