Graph API Version

Ad Set

An ad set is a group of ads that share the same daily or lifetime budget, schedule, bid type, bid info, and targeting data. Ad sets enable you to group ads according to your criteria, and you can retrieve the ad-related statistics that apply to a set. See Optimized CPM and Promoted Object.

For example, create an ad set with a daily budget:


curl -X POST \
  -F 'name="My Reach Ad Set"' \
  -F 'optimization_goal="REACH"' \
  -F 'billing_event="IMPRESSIONS"' \
  -F 'bid_amount=2' \
  -F 'daily_budget=1000' \
  -F 'campaign_id="<AD_CAMPAIGN_ID>"' \
  -F 'targeting={
       "geo_locations": {
         "countries": [
           "US"
         ]
       },
       "facebook_positions": [
         "feed"
       ]
     }' \
  -F 'status="PAUSED"' \
  -F 'promoted_object={
       "page_id": "<PAGE_ID>"
     }' \
  -F 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v21.0/act_<AD_ACCOUNT_ID>/adsets

Open In Graph API Explorer Open In Postman


'use strict';
const bizSdk = require('facebook-nodejs-business-sdk');
const AdAccount = bizSdk.AdAccount;
const AdSet = bizSdk.AdSet;

const access_token = '<ACCESS_TOKEN>';
const app_secret = '<APP_SECRET>';
const app_id = '<APP_ID>';
const id = '<AD_ACCOUNT_ID>';
const api = bizSdk.FacebookAdsApi.init(access_token);
const showDebugingInfo = true; // Setting this to true shows more debugging info.
if (showDebugingInfo) {
  api.setDebug(true);
}

const logApiCallResult = (apiCallName, data) => {
  console.log(apiCallName);
  if (showDebugingInfo) {
    console.log('Data:' + JSON.stringify(data));
  }
};

let fields, params;
fields = [
];
params = {
  'name' : 'My Reach Ad Set',
  'optimization_goal' : 'REACH',
  'billing_event' : 'IMPRESSIONS',
  'bid_amount' : '2',
  'daily_budget' : '1000',
  'campaign_id' : '<adCampaignLinkClicksID>',
  'targeting' : {'geo_locations':{'countries':['US']},'facebook_positions':['feed']},
  'status' : 'PAUSED',
  'promoted_object' : {'page_id':'<pageID>'},
};
const adsets = (new AdAccount(id)).createAdSet(
  fields,
  params
);
logApiCallResult('adsets api call complete.', adsets);

Open In Graph API Explorer Open In Postman


require __DIR__ . '/vendor/autoload.php';

use FacebookAds\Object\AdAccount;
use FacebookAds\Object\AdSet;
use FacebookAds\Api;
use FacebookAds\Logger\CurlLogger;

$access_token = '<ACCESS_TOKEN>';
$app_secret = '<APP_SECRET>';
$app_id = '<APP_ID>';
$id = '<AD_ACCOUNT_ID>';

$api = Api::init($app_id, $app_secret, $access_token);
$api->setLogger(new CurlLogger());

$fields = array(
);
$params = array(
  'name' => 'My Reach Ad Set',
  'optimization_goal' => 'REACH',
  'billing_event' => 'IMPRESSIONS',
  'bid_amount' => '2',
  'daily_budget' => '1000',
  'campaign_id' => '<adCampaignLinkClicksID>',
  'targeting' => array('geo_locations' => array('countries' => array('US')),'facebook_positions' => array('feed')),
  'status' => 'PAUSED',
  'promoted_object' => array('page_id' => '<pageID>'),
);
echo json_encode((new AdAccount($id))->createAdSet(
  $fields,
  $params
)->exportAllData(), JSON_PRETTY_PRINT);

Open In Graph API Explorer Open In Postman

View on GitHub


from facebook_business.adobjects.adaccount import AdAccount
from facebook_business.adobjects.adset import AdSet
from facebook_business.api import FacebookAdsApi

access_token = '<ACCESS_TOKEN>'
app_secret = '<APP_SECRET>'
app_id = '<APP_ID>'
id = '<AD_ACCOUNT_ID>'
FacebookAdsApi.init(access_token=access_token)

fields = [
]
params = {
  'name': 'My Reach Ad Set',
  'optimization_goal': 'REACH',
  'billing_event': 'IMPRESSIONS',
  'bid_amount': '2',
  'daily_budget': '1000',
  'campaign_id': '<adCampaignLinkClicksID>',
  'targeting': {'geo_locations':{'countries':['US']},'facebook_positions':['feed']},
  'status': 'PAUSED',
  'promoted_object': {'page_id':'<pageID>'},
}
print AdAccount(id).create_ad_set(
  fields=fields,
  params=params,
)

Open In Graph API Explorer Open In Postman

View on GitHub


import com.facebook.ads.sdk.*;
import java.io.File;
import java.util.Arrays;

public class SAMPLE_CODE_EXAMPLE {
  public static void main (String args[]) throws APIException {

    String access_token = \"<ACCESS_TOKEN>\";
    String app_secret = \"<APP_SECRET>\";
    String app_id = \"<APP_ID>\";
    String id = \"<AD_ACCOUNT_ID>\";
    APIContext context = new APIContext(access_token).enableDebug(true);

    new AdAccount(id, context).createAdSet()
      .setName(\"My Reach Ad Set\")
      .setOptimizationGoal(AdSet.EnumOptimizationGoal.VALUE_REACH)
      .setBillingEvent(AdSet.EnumBillingEvent.VALUE_IMPRESSIONS)
      .setBidAmount(2L)
      .setDailyBudget(1000L)
      .setCampaignId(\"<adCampaignLinkClicksID>\")
      .setTargeting(
          new Targeting()
            .setFieldFacebookPositions(Arrays.asList(\"feed\"))
            .setFieldGeoLocations(
              new TargetingGeoLocation()
                .setFieldCountries(Arrays.asList(\"US\"))
            )
        )
      .setStatus(AdSet.EnumStatus.VALUE_PAUSED)
      .setPromotedObject(\"{\\"page_id\\":\\"<pageID>\\"}\")
      .execute();

  }
}

Open In Graph API Explorer Open In Postman

View on GitHub


require 'facebook_ads'

access_token = '<ACCESS_TOKEN>'
app_secret = '<APP_SECRET>'
app_id = '<APP_ID>'
id = '<AD_ACCOUNT_ID>'

FacebookAds.configure do |config|
  config.access_token = access_token
  config.app_secret = app_secret
end

ad_account = FacebookAds::AdAccount.get(id)
adsets = ad_account.adsets.create({
    name: 'My Reach Ad Set',
    optimization_goal: 'REACH',
    billing_event: 'IMPRESSIONS',
    bid_amount: '2',
    daily_budget: '1000',
    campaign_id: '<adCampaignLinkClicksID>',
    targeting: {'geo_locations':{'countries':['US']},'facebook_positions':['feed']},
    status: 'PAUSED',
    promoted_object: {'page_id':'<pageID>'},
})

Open In Graph API Explorer Open In Postman

View on GitHub

Create an ad set with a lifetime budget


curl -X POST \
  -F 'name="My First Adset"' \
  -F 'lifetime_budget=20000' \
  -F 'start_time="2024-12-21T18:59:48-0800"' \
  -F 'end_time="2024-12-31T18:59:48-0800"' \
  -F 'campaign_id="<AD_CAMPAIGN_ID>"' \
  -F 'bid_amount=100' \
  -F 'billing_event="LINK_CLICKS"' \
  -F 'optimization_goal="LINK_CLICKS"' \
  -F 'targeting={
       "facebook_positions": [
         "feed"
       ],
       "geo_locations": {
         "countries": [
           "US"
         ]
       },
       "publisher_platforms": [
         "facebook",
         "audience_network"
       ]
     }' \
  -F 'status="PAUSED"' \
  -F 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v21.0/act_<AD_ACCOUNT_ID>/adsets

Limit	Value
Maximum number of ad sets per regular ad account	5000 non-deleted ad sets
Maximum number of ad sets per bulk ad account	10000 non-deleted ad sets
Maximum number of ads per ad set	50 non-archived ads

Parameter	Description
`date_preset` enum{today, yesterday, this_month, last_month, this_quarter, maximum, data_maximum, last_3d, last_7d, last_14d, last_28d, last_30d, last_90d, last_week_mon_sun, last_week_sun_sat, last_quarter, last_year, this_week_mon_today, this_week_sun_today, this_year}	Date Preset
`time_range` {'since':YYYY-MM-DD,'until':YYYY-MM-DD}	Time Range. Note if time range is invalid, it will be ignored.
`since` datetime	A date in the format of "YYYY-MM-DD", which means from the beginning midnight of that day.
`until` datetime	A date in the format of "YYYY-MM-DD", which means to the beginning midnight of the following day.

Field	Description
`id` numeric string	ID for the Ad Set Default
`account_id` numeric string	ID for the Ad Account associated with this Ad Set
`adlabels` list<AdLabel>	Ad Labels associated with this ad set
`adset_schedule` list<DayPart>	Ad set schedule, representing a delivery schedule for a single day
`asset_feed_id` numeric string	The ID of the asset feed that constains a content to create ads
`attribution_spec` list<AttributionSpec>	Conversion attribution spec used for attributing conversions for optimization. Supported window lengths differ by optimization goal and campaign objective. See Objective, Optimization Goal and `attribution_spec`.
`bid_adjustments` AdBidAdjustments	Map of bid adjustment types to values
`bid_amount` unsigned int32	Bid cap or target cost for this ad set. The bid cap used in a lowest cost bid strategy is defined as the maximum bid you want to pay for a result based on your `optimization_goal`. The target cost used in a target cost bid strategy lets Facebook bid on your behalf to meet your target on average and keep costs stable as you raise budget. The bid amount's unit is cents for currencies like USD, EUR, and the basic unit for currencies like JPY, KRW. The bid amount for ads with `IMPRESSION` or `REACH` as `billing_event` is per 1,000 occurrences of that event, and the bid amount for ads with other `billing_event`s is for each occurrence.
`bid_constraints` AdCampaignBidConstraint	Choose bid constraints for ad set to suit your specific business goals. It usually works together with `bid_strategy` field.
`bid_info` map<string, unsigned int32>	Map of bid objective to bid value.
`bid_strategy` enum {LOWEST_COST_WITHOUT_CAP, LOWEST_COST_WITH_BID_CAP, COST_CAP, LOWEST_COST_WITH_MIN_ROAS}	Bid strategy for this ad set when you use `AUCTION` as your buying type: `LOWEST_COST_WITHOUT_CAP`: Designed to get the most results for your budget based on your ad set `optimization_goal` without limiting your bid amount. This is the best strategy if you care most about cost efficiency. However with this strategy it may be harder to get stable average costs as you spend. This strategy is also known as automatic bidding. Learn more in Ads Help Center, About bid strategies: Lowest cost. `LOWEST_COST_WITH_BID_CAP`: Designed to get the most results for your budget based on your ad set `optimization_goal` while limiting actual bid to your specified amount. With a bid cap you have more control over your cost per actual optimization event. However if you set a limit which is too low you may get less ads delivery. Get your bid cap with the field `bid_amount`. This strategy is also known as manual maximum-cost bidding. Learn more in Ads Help Center, About bid strategies: Lowest cost. Notes: If you enable campaign budget optimization, you should get `bid_strategy` at the parent campaign level. `TARGET_COST` bidding strategy has been deprecated with Marketing API v9.
`billing_event` enum {APP_INSTALLS, CLICKS, IMPRESSIONS, LINK_CLICKS, NONE, OFFER_CLAIMS, PAGE_LIKES, POST_ENGAGEMENT, THRUPLAY, PURCHASE, LISTING_INTERACTION}	The billing event for this ad set: `APP_INSTALLS`: Pay when people install your app. `CLICKS`: Pay when people click anywhere in the ad. `IMPRESSIONS`: Pay when the ads are shown to people. `LINK_CLICKS`: Pay when people click on the link of the ad. `OFFER_CLAIMS`: Pay when people claim the offer. `PAGE_LIKES`: Pay when people like your page. `POST_ENGAGEMENT`: Pay when people engage with your post. `VIDEO_VIEWS`: Pay when people watch your video ads for at least 10 seconds. `THRUPLAY`: Pay for ads that are played to completion, or played for at least 15 seconds.
`brand_safety_config` BrandSafetyCampaignConfig	brand_safety_config
`budget_remaining` numeric string	Remaining budget of this Ad Set
`campaign` Campaign	The campaign that contains this ad set
`campaign_active_time` numeric string	Campaign running length
`campaign_attribution` enum	campaign_attribution, a new field for app ads campaign, used to indicate a campaign's attribution type, eg: SKAN or AEM
`campaign_id` numeric string	The ID of the campaign that contains this ad set
`configured_status` enum {ACTIVE, PAUSED, DELETED, ARCHIVED}	The status set at the ad set level. It can be different from the effective status due to its parent campaign. Prefer using 'status' instead of this.
`contextual_bundling_spec` ContextualBundlingSpec	specs of contextual bundling Ad Set setup, including signal of opt-in/out the feature
`created_time` datetime	Time when this Ad Set was created
`creative_sequence` list<numeric string>	Order of the adgroup sequence to be shown to users
`daily_budget` numeric string	The daily budget of the set defined in your account currency.
`daily_min_spend_target` numeric string	Daily minimum spend target of the ad set defined in your account currency. To use this field, daily budget must be specified in the Campaign. This target is not a guarantee but our best effort.
`daily_spend_cap` numeric string	Daily spend cap of the ad set defined in your account currency. To use this field, daily budget must be specified in the Campaign.
`destination_type` string	Destination of ads in this Ad Set. Options include: `WEBSITE`, `APP`, `MESSENGER`, `INSTAGRAM_DIRECT`. The `ON_AD`, `ON_POST`, `ON_VIDEO`, `ON_PAGE`, and `ON_EVENT` destination types are currently in limited beta testing. Trying to duplicate campaigns with existing destination types using these new destination types may throw an error. See the Outcome-Driven Ads Experiences section below for more information.
`dsa_beneficiary` string	The beneficiary of all ads in this ad set.
`dsa_payor` string	The payor of all ads in this ad set.
`effective_status` enum {ACTIVE, PAUSED, DELETED, CAMPAIGN_PAUSED, ARCHIVED, IN_PROCESS, WITH_ISSUES}	The effective status of the adset. The status could be effective either because of its own status, or the status of its parent campaign. `WITH_ISSUES` is available for version 3.2 or higher. `IN_PROCESS` is available for version 4.0 or higher.
`end_time` datetime	End time, in UTC UNIX timestamp
`frequency_control_specs` list<AdCampaignFrequencyControlSpecs>	An array of frequency control specs for this ad set. As there is only one event type currently supported, this array has no more than one element. Writes to this field are only available in ad sets where `REACH` is the objective.
`instagram_actor_id` numeric string	Represents your Instagram account id, used for ads, including dynamic creative ads on Instagram.
`is_dynamic_creative` bool	Whether this ad set is a dynamic creative ad set. dynamic creative ad can be created only under ad set with this field set to be true.
`issues_info` list<AdCampaignIssuesInfo>	Issues for this ad set that prevented it from deliverying
`learning_stage_info` AdCampaignLearningStageInfo	Info about whether the ranking or delivery system is still learning for this ad set. While the ad set is still in learning , we might unstablized delivery performances.
`lifetime_budget` numeric string	The lifetime budget of the set defined in your account currency.
`lifetime_imps` int32	Lifetime impressions. Available only for campaigns with `buying_type=FIXED_CPM`
`lifetime_min_spend_target` numeric string	Lifetime minimum spend target of the ad set defined in your account currency. To use this field, lifetime budget must be specified in the Campaign. This target is not a guarantee but our best effort.
`lifetime_spend_cap` numeric string	Lifetime spend cap of the ad set defined in your account currency. To use this field, lifetime budget must be specified in the Campaign.
`min_budget_spend_percentage` numeric string	min_budget_spend_percentage
`multi_optimization_goal_weight` string	multi_optimization_goal_weight
`name` string	Name of the ad set
`optimization_goal` enum {NONE, APP_INSTALLS, AD_RECALL_LIFT, ENGAGED_USERS, EVENT_RESPONSES, IMPRESSIONS, LEAD_GENERATION, QUALITY_LEAD, LINK_CLICKS, OFFSITE_CONVERSIONS, PAGE_LIKES, POST_ENGAGEMENT, QUALITY_CALL, REACH, LANDING_PAGE_VIEWS, VISIT_INSTAGRAM_PROFILE, VALUE, THRUPLAY, DERIVED_EVENTS, APP_INSTALLS_AND_OFFSITE_CONVERSIONS, CONVERSATIONS, IN_APP_VALUE, MESSAGING_PURCHASE_CONVERSION, SUBSCRIBERS, REMINDERS_SET, MEANINGFUL_CALL_ATTEMPT, PROFILE_VISIT, MESSAGING_APPOINTMENT_CONVERSION}	The optimization goal this ad set is using. `NONE`: Only available in read mode for campaigns created pre-v2.4. `APP_INSTALLS`: Optimize for people more likely to install your app. `AD_RECALL_LIFT`: Optimize for people more likely to remember seeing your ads. `CLICKS`: Deprecated. Only available in read mode. `ENGAGED_USERS`: Optimize for people more likely to take a particular action in your app. `EVENT_RESPONSES`: Optimize for people more likely to attend your event. `IMPRESSIONS`: Show the ads as many times as possible. `LEAD_GENERATION`: Optimize for people more likely to fill out a lead generation form. `QUALITY_LEAD`: Optimize for people who are likely to have a deeper conversation with advertisers after lead submission. `LINK_CLICKS`: Optimize for people more likely to click in the link of the ad. `OFFSITE_CONVERSIONS`: Optimize for people more likely to make a conversion on the site. `PAGE_LIKES`: Optimize for people more likely to like your page. `POST_ENGAGEMENT`: Optimize for people more likely to engage with your post. `QUALITY_CALL`: Optimize for people who are likely to call the advertiser. `REACH`: Optimize to reach the most unique users for each day or interval specified in `frequency_control_specs`. `LANDING_PAGE_VIEWS`: Optimize for people who are most likely to click on and load your chosen landing page. `VISIT_INSTAGRAM_PROFILE`: Optimize for visits to the advertiser's Instagram profile. `VALUE`: Optimize for maximum total purchase value within the specified attribution window. `THRUPLAY`: Optimize delivery of your ads to people who are more likely to play your ad to completion, or play it for at least 15 seconds. `DERIVED_EVENTS`: Optimize for retention, which reaches people who are most likely to return to the app and open it again during a given time frame after installing. You can choose either two days, meaning the app is likely to be reopened between 24 and 48 hours after installation; or seven days, meaning the app is likely to be reopened between 144 and 168 hours after installation. `APP_INSTALLS_AND_OFFSITE_CONVERSIONS`: Optimizes for people more likely to install your app and make a conversion on your site. `CONVERSATIONS`: Directs ads to people more likely to have a conversation with the business.
`optimization_sub_event` string	Optimization sub event for a specific optimization goal. For example: Sound-On event for Video-View-2s optimization goal.
`pacing_type` list<string>	Defines the pacing type, standard or using ad scheduling
`promoted_object` AdPromotedObject	The object this ad set is promoting across all its ads.
`recommendations` list<AdRecommendation>	If there are recommendations for this ad set, this field includes them. Otherwise, will not be included in the response. This field is not included in redownload mode.
`recurring_budget_semantics` bool	If this field is `true`, your daily spend may be more than your daily budget while your weekly spend will not exceed 7 times your daily budget. More details explained in the Ad Set Budget document. If this is `false`, your amount spent daily will not exceed the daily budget. This field is not applicable for lifetime budgets.
`regional_regulated_categories` list<enum>	This param is used to specify `regional_regulated_categories`. Currently it supports `null` and three values: TAIWAN_FINSERV: Use this value to declare a Financial Service Ad Set if the ad targets Taiwan Audience AUSTRALIA_FINSERV: Use this value to declare a Financial Service Ad Set if the ad set targets Australia Audience TAIWAN_UNIVERSAL: Use this value to declare an Ad Set if it targets Taiwan Audience If an ad set is a Financial Service Ad and it targets Taiwan, it needs to declare both `TAIWAN_FINSERV` and `TAIWAN_UNIVERSAL` Example: `null` or `[AUSTRALIA_FINSERV]` or `[TAIWAN_FINSERV, TAIWAN_UNIVERSAL]`
`regional_regulation_identities` RegionalRegulationIdentities	This param is used to specify regional_regulation_identities used to represent the ad set. Currently it supports 6 fields: taiwan_finserv_beneficiary: used for TAIWAN_FINSERV category taiwan_finserv_payer: used for TAIWAN_FINSERV category australia_finserv_beneficiary: used for AUSTRALIA_FINSERV category australia_finserv_payer: used for AUSTRALIA_FINSERV category taiwan_universal_beneficiary: used for TAIWAN_UNIVERSAL category taiwan_universal_payer: used for TAIWAN_UNIVERSAL category Example: `regional_regulation_identities: { "taiwan_finserv_beneficiary": <verified_identity_id>, "taiwan_finserv_payer": <verified_identity_id>, "taiwan_universal_beneficiary": <verified_identity_id>, "taiwan_universal_payer": <verified_identity_id>, }` During creation and update, the passed identities fields need to correspond to declared categories. To update an existing ad set identities, you need to pass new values for both categories and identities to overwrite the identity id or `null` to remove existing id. For example: Upon creation, `regional_regulated_categories` is `[TAIWAN_FINSERV, TAIWAN_UNIVERSAL]` and `regional_regulation_identities` is `regional_regulation_identities: { "taiwan_finserv_beneficiary": <id_123>, "taiwan_finserv_payer": <id_123>, "taiwan_universal_beneficiary": <id_456>, "taiwan_universal_payer": <id_456>, }` For update, passing `[TAIWAN_UNIVERSAL]` and `regional_regulation_identities: { "taiwan_finserv_beneficiary": null "taiwan_finserv_payer": null, "taiwan_universal_beneficiary": <id_789>, "taiwan_universal_payer": <id_789>, }` will remove `TAIWAN_FINSERV` declaration and update the identities ID of `TAIWAN_UNIVERSAL`
`review_feedback` string	Reviews for dynamic creative ad
`rf_prediction_id` id	Reach and frequency prediction ID
`source_adset` AdSet	The source ad set that this ad set was copied from
`source_adset_id` numeric string	The source ad set id that this ad set was copied from
`start_time` datetime	Start time, in UTC UNIX timestamp
`status` enum {ACTIVE, PAUSED, DELETED, ARCHIVED}	The status set at the ad set level. It can be different from the effective status due to its parent campaign. The field returns the same value as `configured_status`, and is the suggested one to use.
`targeting` Targeting	Targeting
`targeting_optimization_types` list<KeyValue:string,int32>	Targeting options that are relaxed and used as a signal for optimization
`time_based_ad_rotation_id_blocks` list<list<integer>>	Specify ad creative that displays at custom date ranges in a campaign as an array. A list of Adgroup IDs. The list of ads to display for each time range in a given schedule. For example display first ad in Adgroup for first date range, second ad for second date range, and so on. You can display more than one ad per date range by providing more than one ad ID per array. For example set `time_based_ad_rotation_id_blocks` to [[1], [2, 3], [1, 4]]. On the first date range show ad 1, on the second date range show ad 2 and ad 3 and on the last date range show ad 1 and ad 4. Use with `time_based_ad_rotation_intervals` to specify date ranges.
`time_based_ad_rotation_intervals` list<unsigned int32>	Date range when specific ad creative displays during a campaign. Provide date ranges in an array of UNIX timestamps where each timestamp represents the start time for each date range. For example a 3-day campaign from May 9 12am to May 11 11:59PM PST can have three date ranges, the first date range starts from May 9 12:00AM to May 9 11:59PM, second date range starts from May 10 12:00AM to May 10 11:59PM and last starts from May 11 12:00AM to May 11 11:59PM. The first timestamp should match the campaign start time. The last timestamp should be at least 1 hour before the campaign end time. You must provide at least two date ranges. All date ranges must cover the whole campaign length, so any date range cannot exceed campaign length. Use with `time_based_ad_rotation_id_blocks` to specify ad creative for each date range.
`updated_time` datetime	Time when the Ad Set was updated
`use_new_app_click` bool	If set, allows Mobile App Engagement ads to optimize for LINK_CLICKS

Edge	Description
`activities` Edge<AdActivity>	The activities of this ad set
`ad_studies` Edge<AdStudy>	The ad studies containing this ad set
`adcreatives` Edge<AdCreative>	The creatives of this ad set
`adrules_governed` Edge<AdRule>	Ad rules that govern this ad set - by default, this only returns rules that either directly mention the ad set by id or indirectly through the set `entity_type`
`ads` Edge<Adgroup>	The ads under this ad set
`asyncadrequests` Edge<AdAsyncRequest>	Async ad requests for this ad set
`copies` Edge<AdCampaign>	The copies of this ad set
`delivery_estimate` Edge<AdCampaignDeliveryEstimate>	The delivery estimate for this ad set
`message_delivery_estimate` Edge<MessageDeliveryEstimate>	Delivery estimation of the marketing message campaign
`targetingsentencelines` Edge<TargetingSentenceLine>	The targeting description sentence for this ad set

Error	Description
100	Invalid parameter
200	Permissions error
80004	There have been too many calls to this ad-account. Wait a bit and try again. For more info, please refer to https://developers.facebook.com/docs/graph-api/overview/rate-limiting#ads-management.
190	Invalid OAuth 2.0 Access Token
2635	You are calling a deprecated version of the Ads API. Please update to the latest version.
270	This Ads API request is not allowed for apps with development access level (Development access is by default for all apps, please request for upgrade). Make sure that the access token belongs to a user that is both admin of the app and admin of the ad account
2500	Error parsing graph query

Billing Event	Minimum Daily Budget	Notes
Impressions	$0.50
Clicks/Likes/Video Views	$2.50
Low-frequency Actions	$40	Low-frequency actions include mobile app installs, offer claims or canvas app installs. Important: This minimum daily budget is the same for all countries.

Billing Event	Minimum Daily Budget
Impressions	At least the `bid_amount`. For example, if the bid amount is $10, then $10 will be the minimum budget required.
Clicks/Actions	5x the `bid_amount` for a Click or Action. For example, if the bid amount is $5 per click/action, then $25 will be the minimum budget required.

Name	Description
`dsa_payor` string (max 512 char)	The payor of all ads in this ad set.
`dsa_beneficiary` string (max 512 char)	The beneficiary of all ads in this ad set.

Parameter	Description
`campaign_id` numeric string or integer	Single ID of a campaign to make parent of the copy. The copy inherits all campaign settings, such as budget from the parent.Ignore if you want to keep the copy under the original campaign parent.
`deep_copy` boolean	Default value: `false` Whether to copy all the child ads. Limits: the total number of children ads to copy should not exceed 3 for a synchronous call and 51 for an asynchronous call.
`end_time` datetime	The end time of the set, e.g. `2015-03-12 23:59:59-07:00` or `2015-03-12 23:59:59 PDT`. UTC UNIX timestamp. When creating a set with a daily budget, specify `end_time=0` to set the set to be ongoing without end date. If not set, the copied adset will inherit the end time from the original set
`rename_options` JSON or object-like arrays	Rename options
`rename_strategy` enum {DEEP_RENAME, ONLY_TOP_LEVEL_RENAME, NO_RENAME}	Default value: `ONLY_TOP_LEVEL_RENAME` `DEEP_RENAME`: will change this object's name and children's names in the copied object. `ONLY_TOP_LEVEL_RENAME`: will change the this object's name but won't change the children's name in the copied object. `NO_RENAME`: will change no name in the copied object
`rename_prefix` string	A prefix to copy names. Defaults to null if not provided.
`rename_suffix` string	A suffix to copy names. Defaults to null if not provided and appends a localized string of `- Copy` based on the ad account locale.
`start_time` datetime	The start time of the set, e.g. `2015-03-12 23:59:59-07:00` or `2015-03-12 23:59:59 PDT`. UTC UNIX timestamp. If not set, the copied adset will inherit the start time from the original set
`status_option` enum {ACTIVE, PAUSED, INHERITED_FROM_SOURCE}	Default value: `PAUSED` `ACTIVE`: the copied adset will have active status. `PAUSED`: the copied adset will have paused status. `INHERITED_FROM_SOURCE`: the copied adset will have the status from the original set.

Error	Description
100	Invalid parameter
368	The action attempted has been deemed abusive or is otherwise disallowed
200	Permissions error

ODAX Objectives	Conversion Location (L2)	Conversion Events (L2)	Optimization Goals (L2)	Legacy Objectives
Awareness Reach the largest number of people who are likely to remember your ad.	N/A	N/A	Ad Recall Lift, Reach, Impressions API enum {`AD_RECALL_LIFT`, `REACH`, `IMPRESSIONS`}	Reach, Brand Awareness
Traffic Send people to a destination like your website, app or Shop.	Facebook Shops (closed beta)	N/A	Link Clicks API enum {`LINK_CLICKS`}	Traffic
	Website	N/A	Landing Page Views, Link Clicks, Impressions, Daily Unique Reach API enum {`LANDING_PAGE_VIEWS`, `LINK_CLICKS`, `IMPRESSIONS`, `REACH`}	Traffic
	App	N/A	Link Clicks, Daily Unique Reach API enum {`LINK_CLICKS`, `REACH`}	Traffic
	Messenger	N/A	Link Clicks, Impressions, Daily Unique Reach API enum {`LINK_CLICKS`, `IMPRESSIONS`, `REACH`}	Traffic
	WhatsApp	N/A	Link Clicks, Impressions, Daily Unique Reach API enum {`LINK_CLICKS`, `IMPRESSIONS`, `REACH`}	Traffic
Engagement Find people likely to interact with your business online, and take actions like starting a conversation or commenting on posts.	On Video	N/A	ThruPlay, 2 second continuous view API enum {`THRUPLAY`, `TWO_SECOND_CONTINUOUS_VIDEO_VIEWS`}	Video Views
	On Post	N/A	Post Engagement, Impressions, Daily Unique Reach API enum {`POST_ENGAGEMENT`, `IMPRESSIONS`, `REACH`}	Post Engagement
	On Event	N/A	Event Response, Impressions, Post Engagement, Daily Unique Reach API enum {`EVENT_RESPONSES`, `IMPRESSIONS`, `POST_ENGAGEMENT`, `REACH`}	Event Responses
	Messenger	N/A	Conversations, Link Clicks API enum {`CONVERSATIONS`, `LINK_CLICKS`}	Messages
	WhatsApp	N/A	Conversations, Link Clicks API enum {`CONVERSATIONS`, `LINK_CLICKS`}	Messages
	Instagram	N/A	Conversations, Link Clicks API enum {`CONVERSATIONS`, `LINK_CLICKS`}	Messages
	Website	AddToWishlist, Contact, CustomizeProduct, Donate, FindLocation,, Schedule, Search, StartTrial, SubmitApplication, Subscribe, ViewContent	Conversions, Landing Page Views, Link Clicks, Impressions, Daily Unique Reach API enum {`OFFSITE_CONVERSIONS`, `ONSITE_CONVERSIONS`, `LANDING_PAGE_VIEWS`, `LINK_CLICKS`, `IMPRESSIONS`, `REACH`}	Conversions
	App	Achieve Level, Activate App, Add to Wishlist, Complete Tutorial, Contact, Customize Product, Donate, Find Location, In-App Ad Click, In-App Ad Impression, Rate, Schedule, Search, Spent Credits, Start Trial, Submit Application, Subscribe, Unlock Achievement, View Content	App Events, Link Clicks, Daily Unique Reach API enum {`APP_INSTALLS_AND_OFFSITE_CONVERSIONS`, `LINK_CLICKS`, `REACH`}	Conversions
	On Page	N/A	Page Likes API enum {`PAGE_LIKES`}	Engagement
Leads Find people interested in your business who are likely to share their contact information.	Website	Lead, CompleteRegistration, Contact, FindLocation, Schedule, StartTrial, SubmitApplication, Subscribe	Conversions, Landing Page Views, Link Clicks, Impressions, Daily Unique Reach API enum {`OFFSITE_CONVERSIONS`, `ONSITE_CONVERSIONS`, `LANDING_PAGE_VIEWS`, `LINK_CLICKS`, `IMPRESSIONS`, `REACH`}	Conversions
	Instant Forms	N/A	Leads API enum {`LEAD_GENERATION`, `QUALITY_LEAD`}	Lead Generation
	Messenger	N/A	Leads API enum {`LEAD_GENERATION`, `QUALITY_LEAD`}	Messages
	Calls	N/A	Calls API enum {`QUALITY_CALL`}	Lead Generation
	App	Complete Registration, Complete Tutorial, Contact, Find Location, Schedule, Start Trial, Submit Application, Subscribe	App Events, Link Clicks, Daily Unique Reach API enum {`APP_INSTALLS_AND_OFFSITE_CONVERSIONS`, `LINK_CLICKS`, `REACH`}	Conversions
App Promotion Find people likely to install your app.	N/A	All app events, including all custom events	Non-AAA: Link Clicks, App Installs, App Events, Value API enum {`LINK_CLICKS`, `APP_INSTALLS`, `APP_INSTALLS_AND_OFFSITE_CONVERSIONS`, `VALUE`} AAA: App Installs, App Installs w/ App Events, App Events, Value API enum {`APP_INSTALLS`, `APP_INSTALLS_AND_OFFSITE_CONVERSIONS`, `VALUE`}	App Installs
Sales Find people likely to make purchases or take other important actions online or in store.	Website & Facebook Shops (closed beta)	Purchase, InitiateCheckout, AddPaymentInfo, AddToCart, CompleteRegistration, Donate, StartTrial, Subscribe, ViewContent	(source of truth: same as today's Conversions objective + web and shop) API enum {`OFFSITE_CONVERSIONS`, `VALUE`, `LINK_CLICKS`, `LANDING_PAGE_VIEWS`, `LINK_CLICKS`, `IMPRESSIONS`, `REACH`}	Conversions
	Website	Purchase, InitiateCheckout, AddPaymentInfo, AddToCart, CompleteRegistration, Donate, StartTrial, Subscribe, ViewContent	Conversions, Value, Landing Page Views, Link Clicks, Impressions, Daily Unique Reach API enum {`OFFSITE_CONVERSIONS`, `VALUE`, `LANDING_PAGE_VIEWS`, `LINK_CLICKS`, `IMPRESSIONS`, `REACH`}	Conversions
	App	Purchase, Initiate Checkout, Add Payment Info, Add to Cart, Complete Registration, Donate, In-App Ad Click, In-App Ad Impression, Spent Credits, Start Trial, Subscribe, View Content	App Events, Link Clicks, Daily Unique Reach API enum {`OFFSITE_CONVERSIONS`, `LINK_CLICKS`, `REACH`}	Conversions
	Website & App	Purchase, InitiateCheckout, AddPaymentInfo, AddToCart, CompleteRegistration, Donate, StartTrial, Subscribe, ViewContent	Conversions API enum {`OFFSITE_CONVERSIONS`}	Conversions
	Messenger	Purchase, InitiateCheckout, AddPaymentInfo, AddToCart, CompleteRegistration, Donate, StartTrial, Subscribe, ViewContent	Conversations, Conversions, Link Clicks, Impressions, Reach API enum {`CONVERSATIONS`, `OFFSITE_CONVERSIONS`, `LINK_CLICKS`, `IMPRESSIONS`, `REACH`}	Conversions
	WhatsApp	Purchase, InitiateCheckout, AddPaymentInfo, AddToCart, CompleteRegistration, Donate, StartTrial, Subscribe, ViewContent	Conversions, Link Clicks, Impressions, Reach API enum {`OFFSITE_CONVERSIONS`, `LINK_CLICKS`, `IMPRESSIONS`, `REACH`}	Conversions

Parameter	Description
`adlabels` list<Object>	Specifies list of labels to be associated with this object. This field is optional
`adset_schedule` list<Object>	Ad set schedule, representing a delivery schedule for a single day
`start_minute` int64	A 0 based minute of the day representing when the schedule starts Required
`end_minute` int64	A 0 based minute of the day representing when the schedule ends Required
`days` list<int64>	Array of ints representing which days the schedule is active. Valid values are 0-6 with 0 representing Sunday, 1 representing Monday, ... and 6 representing Saturday. Required
`timezone_type` enum {USER, ADVERTISER}	Default value: `USER`
`attribution_spec` list<JSON object>	Conversion attribution spec used for attributing conversions for optimization. Supported window lengths differ by optimization goal and campaign objective.
`event_type` enum {CLICK_THROUGH, VIEW_THROUGH, ENGAGED_VIDEO_VIEW}	Required
`window_days` int64	Required
`bid_amount` integer	Bid cap or target cost for this ad set. The bid cap used in a lowest cost bid strategy is defined as the maximum bid you want to pay for a result based on your `optimization_goal`. The target cost used in a target cost bid strategy lets Facebook bid to meet your target on average and keep costs stable as you spend. If an ad level `bid_amount` is specified, updating this value will overwrite the previous ad level bid. Unless you are using Reach and Frequency, `bid_amount` is required if `bid_strategy` is set to `LOWEST_COST_WITH_BID_CAP` or `COST_CAP`. The bid amount's unit is cents for currencies like USD, EUR, and the basic unit for currencies like JPY, KRW. The bid amount for ads with `IMPRESSION` or `REACH` as `billing_event` is per 1,000 occurrences, and has to be at least 2 US cents or more. For ads with other `billing_event`s, the bid amount is for each occurrence, and has a minimum value 1 US cents. The minimum bid amounts of other currencies are of similar value to the US Dollar values provided.
`bid_strategy` enum{LOWEST_COST_WITHOUT_CAP, LOWEST_COST_WITH_BID_CAP, COST_CAP, LOWEST_COST_WITH_MIN_ROAS}	Choose bid strategy for this ad set to suit your specific business goals. Each strategy has tradeoffs and may be available for certain `optimization_goal`s: `LOWEST_COST_WITHOUT_CAP`: Designed to get the most results for your budget based on your ad set `optimization_goal` without limiting your bid amount. This is the best strategy if you care most about cost efficiency. However with this strategy it may be harder to get stable average costs as you spend. This strategy is also known as automatic bidding. Learn more in Ads Help Center, About bid strategies: Lowest cost. `LOWEST_COST_WITH_BID_CAP`: Designed to get the most results for your budget based on your ad set `optimization_goal` while limiting actual bid to your specified amount. With a bid cap you have more control over your cost per actual optimization event. However if you set a limit which is too low you may get less ads delivery. If you select this, you must provide a bid cap with the `bid_amount` field. Note: during creation this bid strategy is set if you provide `bid_amount` only. This strategy is also known as manual maximum-cost bidding. Learn more in Ads Help Center, About bid strategies: Lowest cost. Notes: If you enable campaign budget optimization, you should set `bid_strategy` at the parent campaign level. `TARGET_COST` bidding strategy has been deprecated with Marketing API v9.
`billing_event` enum{APP_INSTALLS, CLICKS, IMPRESSIONS, LINK_CLICKS, NONE, OFFER_CLAIMS, PAGE_LIKES, POST_ENGAGEMENT, THRUPLAY, PURCHASE, LISTING_INTERACTION}	The billing event that this ad set is using: APP_INSTALLS: Pay when people install your app. CLICKS: Deprecated. IMPRESSIONS: Pay when the ads are shown to people. LINK_CLICKS: Pay when people click on the link of the ad. OFFER_CLAIMS: Pay when people claim the offer. PAGE_LIKES: Pay when people like your page. POST_ENGAGEMENT: Pay when people engage with your post. VIDEO_VIEWS: Pay when people watch your video ads for at least 10 seconds. THRUPLAY: Pay for ads that are played to completion, or played for at least 15 seconds.
`budget_schedule_specs` list<JSON or object-like arrays>	Initial high demand periods to be created with the ad set. Provide list of `time_start`, `time_end`,`budget_value`, and `budget_value_type`. For example, -F 'budget_schedule_specs=[{ "time_start":1699081200, "time_end":1699167600, "budget_value":100, "budget_value_type":"ABSOLUTE" }]' See High Demand Period for more details on each field.
`id` int64
`time_start` datetime
`time_end` datetime
`budget_value` int64
`budget_value_type` enum{ABSOLUTE, MULTIPLIER}
`recurrence_type` enum{ONE_TIME, WEEKLY}
`weekly_schedule` list<JSON or object-like arrays>
`days` list<int64>
`minute_start` int64
`minute_end` int64
`timezone_type` string
`campaign_attribution` enum{}	campaign_attribution
`campaign_id` numeric string or integer	The ad campaign you wish to add this ad set to.
`campaign_spec` Campaign spec	Provide `name`, `objective` and `buying_type` for a campaign you want to create. Otherwise you need to provide `campaign_id` for an existing ad campaign. For example: -F 'campaign_spec={ "name": "Inline created campaign", "objective": "CONVERSIONS", "buying_type": "AUCTION" }' Please refer to the Outcome-Driven Ads Experiences mapping table to find new objectives and their corresponding destination types, optimization goals and promoted objects.
`contextual_bundling_spec` Object	settings of Contextual Bundle to support ads serving in Facebook contextual surfaces
`status` enum{OPT_OUT, OPT_IN}
`creative_sequence` list<numeric string or integer>	Order of the adgroup sequence to be shown to users
`daily_budget` int64	The daily budget defined in your account currency, allowed only for ad sets with a duration (difference between `end_time` and `start_time`) longer than 24 hours. Either `daily_budget` or `lifetime_budget` must be greater than 0.
`daily_imps` int64	Daily impressions. Available only for campaigns with `buying_type=FIXED_CPM`
`daily_min_spend_target` int64	Daily minimum spend target of the ad set defined in your account currency. To use this field, daily budget must be specified in the Campaign. This target is not a guarantee but our best effort.
`daily_spend_cap` int64	Daily spend cap of the ad set defined in your account currency. To use this field, daily budget must be specified in the Campaign. Set the value to 922337203685478 to remove the spend cap.
`destination_type` enum{WEBSITE, APP, MESSENGER, APPLINKS_AUTOMATIC, WHATSAPP, INSTAGRAM_DIRECT, FACEBOOK, MESSAGING_MESSENGER_WHATSAPP, MESSAGING_INSTAGRAM_DIRECT_MESSENGER, MESSAGING_INSTAGRAM_DIRECT_MESSENGER_WHATSAPP, MESSAGING_INSTAGRAM_DIRECT_WHATSAPP, SHOP_AUTOMATIC, ON_AD, ON_POST, ON_EVENT, ON_VIDEO, ON_PAGE, INSTAGRAM_PROFILE, FACEBOOK_PAGE, INSTAGRAM_PROFILE_AND_FACEBOOK_PAGE}	Destination of ads in this Ad Set. Options include: Website, App, Messenger, `INSTAGRAM_DIRECT`, `INSTAGRAM_PROFILE`.
`dsa_beneficiary` string	dsa_beneficiary
`dsa_payor` string	dsa_payor
`end_time` datetime	End time, required when `lifetime_budget` is specified. e.g. `2015-03-12 23:59:59-07:00` or `2015-03-12 23:59:59 PDT`. When creating a set with a daily budget, specify `end_time=0` to set the set to be ongoing and have no end date. UTC UNIX timestamp
`execution_options` list<enum{validate_only, include_recommendations}>	Default value: `Set` An execution setting `validate_only`: when this option is specified, the API call will not perform the mutation but will run through the validation rules against values of each field. `include_recommendations`: this option cannot be used by itself. When this option is used, recommendations for ad object's configuration will be included. A separate section recommendations will be included in the response, but only if recommendations for this specification exist. If the call passes validation or review, response will be `{"success": true}`. If the call does not pass, an error will be returned with more details. These options can be used to improve any UI to display errors to the user much sooner, e.g. as soon as a new value is typed into any field corresponding to this ad object, rather than at the upload/save stage, or after review.
`existing_customer_budget_percentage` int64	existing_customer_budget_percentage
`frequency_control_specs` list<Object>	An array of frequency control specs for this ad set. As there is only one event type currently supported, this array has no more than one element. Writes to this field are only available in ad sets where `REACH` is the objective.
`event` enum{IMPRESSIONS, VIDEO_VIEWS, VIDEO_VIEWS_2S, VIDEO_VIEWS_15S}	Event name, only `IMPRESSIONS` currently. Required
`interval_days` integer	Interval period in days, between 1 and 90 (inclusive) Required
`max_frequency` integer	The maximum frequency, between 1 and 90 (inclusive) Required
`is_dynamic_creative` boolean	Indicates the ad set must only be used for dynamic creatives. Dynamic creative ads can be created in this ad set. Defaults to `false`
`lifetime_budget` int64	Lifetime budget, defined in your account currency. If specified, you must also specify an `end_time`. Either `daily_budget` or `lifetime_budget` must be greater than 0.
`lifetime_imps` int64	Lifetime impressions. Available only for campaigns with `buying_type=FIXED_CPM`
`lifetime_min_spend_target` int64	Lifetime minimum spend target of the ad set defined in your account currency. To use this field, lifetime budget must be specified in the Campaign. This target is not a guarantee but our best effort.
`lifetime_spend_cap` int64	Lifetime spend cap of the ad set defined in your account currency. To use this field, lifetime budget must be specified in the Campaign. Set the value to 922337203685478 to remove the spend cap.
`max_budget_spend_percentage` int64	max_budget_spend_percentage
`min_budget_spend_percentage` int64	min_budget_spend_percentage
`multi_optimization_goal_weight` enum{UNDEFINED, BALANCED, PREFER_INSTALL, PREFER_EVENT}	multi_optimization_goal_weight
`name` string	Ad set name, max length of 400 characters. RequiredSupports Emoji
`optimization_goal` enum{NONE, APP_INSTALLS, AD_RECALL_LIFT, ENGAGED_USERS, EVENT_RESPONSES, IMPRESSIONS, LEAD_GENERATION, QUALITY_LEAD, LINK_CLICKS, OFFSITE_CONVERSIONS, PAGE_LIKES, POST_ENGAGEMENT, QUALITY_CALL, REACH, LANDING_PAGE_VIEWS, VISIT_INSTAGRAM_PROFILE, VALUE, THRUPLAY, DERIVED_EVENTS, APP_INSTALLS_AND_OFFSITE_CONVERSIONS, CONVERSATIONS, IN_APP_VALUE, MESSAGING_PURCHASE_CONVERSION, SUBSCRIBERS, REMINDERS_SET, MEANINGFUL_CALL_ATTEMPT, PROFILE_VISIT, MESSAGING_APPOINTMENT_CONVERSION}	What the ad set is optimizing for. `APP_INSTALLS`: Will optimize for people more likely to install your app. `ENGAGED_USERS`: Will optimize for people more likely to take a particular action in your app. `EVENT_RESPONSES`: Will optimize for people more likely to attend your event. `IMPRESSIONS`: Will show the ads as many times as possible. `LEAD_GENERATION`: Will optimize for people more likely to fill out a lead generation form. `LINK_CLICKS`: Will optimize for people more likely to click in the link of the ad. `OFFER_CLAIMS`: Will optimize for people more likely to claim the offer. `OFFSITE_CONVERSIONS`: Will optimize for people more likely to make a conversion in the site `PAGE_ENGAGEMENT`: Will optimize for people more likely to engage with your page. `PAGE_LIKES`: Will optimize for people more likely to like your page. `POST_ENGAGEMENT`: Will optimize for people more likely to engage with your post. `REACH`: Optimize to reach the most unique users of each day or interval specified in `frequency_control_specs`. `SOCIAL_IMPRESSIONS`: Increase the number of impressions with social context. For example, with the names of one or more of the user's friends attached to the ad who have already liked the page or installed the app. `VALUE`: Will optimize for maximum total purchase value within the specified attribution window. `THRUPLAY`: Will optimize delivery of your ads to people are more likely to play your ad to completion, or play it for at least 15 seconds. `AD_RECALL_LIFT`: Optimize for people more likely to remember seeing your ads. `VISIT_INSTAGRAM_PROFILE`: Optimize for visits to the advertiser's instagram profile.
`optimization_sub_event` enum{NONE, VIDEO_SOUND_ON, TRIP_CONSIDERATION, TRAVEL_INTENT, TRAVEL_INTENT_NO_DESTINATION_INTENT, TRAVEL_INTENT_BUCKET_01, TRAVEL_INTENT_BUCKET_02, TRAVEL_INTENT_BUCKET_03, TRAVEL_INTENT_BUCKET_04, TRAVEL_INTENT_BUCKET_05}	Optimization sub event for a specific optimization goal (ex: Sound-On event for Video-View-2s optimization goal)
`pacing_type` list<string>	Defines the pacing type, standard by default or using ad scheduling
`promoted_object` Object	The object this ad set is promoting across all its ads. Required with certain campaign objectives. CONVERSIONS `pixel_id` (Conversion pixel ID) `pixel_id` (Facebook pixel ID) and `custom_event_type` `pixel_id` (Facebook pixel ID) and `pixel_rule` and `custom_event_type` `event_id` (Facebook event ID) and `custom_event_type` `application_id`, `object_store_url`, and `custom_event_type` for mobile app events `offline_conversion_data_set_id` (Offline dataset ID) and `custom_event_type` for offline conversions PAGE_LIKES `page_id` OFFER_CLAIMS `page_id` LINK_CLICKS `application_id` and `object_store_url` for mobile app or Canvas app engagement link clicks APP_INSTALLS `application_id` and `object_store_url` if the `optimization_goal` is `OFFSITE_CONVERSIONS` `application_id`, `object_store_url`, and `custom_event_type` (Standard Events) `application_id`, `object_store_url`, `custom_event_type = OTHER` and `custom_event_str` (Custom Events) PRODUCT_CATALOG_SALES `product_set_id` `product_set_id` and `custom_event_type` When `optimization_goal` is `LEAD_GENERATION`, `page_id` needs to be passed as promoted_object. Please refer to the Outcome-Driven Ads Experiences mapping table to find new objectives and their corresponding destination types, optimization goals and promoted objects.
`application_id` int	The ID of a Facebook Application. Usually related to mobile or canvas games being promoted on Facebook for installs or engagement
`pixel_id` numeric string or integer	The ID of a Facebook conversion pixel. Used with offsite conversion campaigns.
`custom_event_type` enum{AD_IMPRESSION, RATE, TUTORIAL_COMPLETION, CONTACT, CUSTOMIZE_PRODUCT, DONATE, FIND_LOCATION, SCHEDULE, START_TRIAL, SUBMIT_APPLICATION, SUBSCRIBE, ADD_TO_CART, ADD_TO_WISHLIST, INITIATED_CHECKOUT, ADD_PAYMENT_INFO, PURCHASE, LEAD, COMPLETE_REGISTRATION, CONTENT_VIEW, SEARCH, SERVICE_BOOKING_REQUEST, MESSAGING_CONVERSATION_STARTED_7D, LEVEL_ACHIEVED, ACHIEVEMENT_UNLOCKED, SPENT_CREDITS, LISTING_INTERACTION, D2_RETENTION, D7_RETENTION, OTHER}	The event from an App Event of a mobile app, not in the standard event list.
`object_store_url` URL	The uri of the mobile / digital store where an application can be bought / downloaded. This is platform specific. When combined with the "application_id" this uniquely specifies an object which can be the subject of a Facebook advertising campaign.
`offer_id` numeric string or integer	The ID of an Offer from a Facebook Page.
`page_id` Page ID	The ID of a Facebook Page
`product_catalog_id` numeric string or integer	The ID of a Product Catalog. Used with Dynamic Product Ads.
`product_item_id` numeric string or integer	The ID of the product item.
`instagram_profile_id` numeric string or integer	The ID of the instagram profile id.
`product_set_id` numeric string or integer	The ID of a Product Set within an Ad Set level Product Catalog. Used with Dynamic Product Ads.
`event_id` numeric string or integer	The ID of a Facebook Event
`offline_conversion_data_set_id` numeric string or integer	The ID of the offline dataset.
`fundraiser_campaign_id` numeric string or integer	The ID of the fundraiser campaign.
`custom_event_str` string	The event from an App Event of a mobile app, not in the standard event list.
`mcme_conversion_id` numeric string or integer	The ID of a MCME conversion.
`conversion_goal_id` numeric string or integer	The ID of a Conversion Goal.
`offsite_conversion_event_id` numeric string or integer	The ID of a Offsite Conversion Event
`boosted_product_set_id` numeric string or integer	The ID of the Boosted Product Set within an Ad Set level Product Catalog. Should only be present when the advertiser has opted into Product Set Boosting.
`lead_ads_form_event_source_type` enum{inferred, offsite_crm, offsite_web, onsite_crm, onsite_web, onsite_p2b_call, onsite_messaging}	The event source of lead ads form.
`value_semantic_type` enum {VALUE, MARGIN, LIFETIME_VALUE}	The semantic of the event value to be using for optimization
`variation` enum {OMNI_CHANNEL_SHOP_AUTOMATIC_DATA_COLLECTION, PRODUCT_SET_AND_APP, PRODUCT_SET_AND_IN_STORE, PRODUCT_SET_AND_OMNICHANNEL, PRODUCT_SET_AND_WEBSITE}	Variation of the promoted object for a PCA ad
`omnichannel_object` Object
`app` array<JSON object>
`pixel` array<JSON object>	Required
`onsite` array<JSON object>
`whatsapp_phone_number` string
`rf_prediction_id` numeric string or integer	Reach and frequency prediction ID
`source_adset_id` numeric string or integer	The source adset id that this ad is copied from (if applicable).
`start_time` datetime	The start time of the set, e.g. `2015-03-12 23:59:59-07:00` or `2015-03-12 23:59:59 PDT`. UTC UNIX timestamp
`status` enum{ACTIVE, PAUSED, DELETED, ARCHIVED}	Only `ACTIVE` and `PAUSED` are valid for creation. The other statuses can be used for update. If it is set to `PAUSED`, all its active ads will be paused and have an effective status `ADSET_PAUSED`.
`targeting` Targeting object	An ad set's targeting structure. "countries" is required. See targeting.
`time_based_ad_rotation_id_blocks` list<list<int64>>	Specify ad creative that displays at custom date ranges in a campaign as an array. A list of Adgroup IDs. The list of ads to display for each time range in a given schedule. For example display first ad in Adgroup for first date range, second ad for second date range, and so on. You can display more than one ad per date range by providing more than one ad ID per array. For example set `time_based_ad_rotation_id_blocks` to [[1], [2, 3], [1, 4]]. On the first date range show ad 1, on the second date range show ad 2 and ad 3 and on the last date range show ad 1 and ad 4. Use with `time_based_ad_rotation_intervals` to specify date ranges.
`time_based_ad_rotation_intervals` list<int64>	Date range when specific ad creative displays during a campaign. Provide date ranges in an array of UNIX timestamps where each timestamp represents the start time for each date range. For example a 3-day campaign from May 9 12am to May 11 11:59PM PST can have three date ranges, the first date range starts from May 9 12:00AM to May 9 11:59PM, second date range starts from May 10 12:00AM to May 10 11:59PM and last starts from May 11 12:00AM to May 11 11:59PM. The first timestamp should match the campaign start time. The last timestamp should be at least 1 hour before the campaign end time. You must provide at least two date ranges. All date ranges must cover the whole campaign length, so any date range cannot exceed campaign length. Use with `time_based_ad_rotation_id_blocks` to specify ad creative for each date range.
`time_start` datetime	Time start
`time_stop` datetime	Time stop
`tune_for_category` enum{NONE, EMPLOYMENT, HOUSING, CREDIT, ISSUES_ELECTIONS_POLITICS, ONLINE_GAMBLING_AND_GAMING, FINANCIAL_PRODUCTS_SERVICES}	tune_for_category

Error	Description
100	Invalid parameter
200	Permissions error
2695	The ad set creation reached its campaign group(ios14) limit.
368	The action attempted has been deemed abusive or is otherwise disallowed
80004	There have been too many calls to this ad-account. Wait a bit and try again. For more info, please refer to https://developers.facebook.com/docs/graph-api/overview/rate-limiting#ads-management.
900	No such application exists.
2641	Your ad includes or excludes locations that are currently restricted
2635	You are calling a deprecated version of the Ads API. Please update to the latest version.

Ad Set

Limits

Housing, Employment and Credit Ads

Targeting European Union Ads

Reading

Examples

Example

Parameters

Fields

Edges

Error Codes

Creating

Examples

Considerations

Bid/Budget Validations

Locale targeted page post

Mobile App Ads

Desktop App Ads

Lookalike Expansion

Targeting DSA Regulated Locations (EU)

Parameters

Return Type

Error Codes

Example

Parameters

Return Type

Error Codes

Updating

Examples

Remarks

Deleting

Examples

Example

Parameters

Return Type

Error Codes

Outcome-Driven Ads Experiences

Example

Restrictions