Graph API-Version

Ad Account Adsets

Due to the iOS 14.5 launch, changes have been made to this endpoint.

Mobile App Custom Audiences for inclusion targeting is no longer supported for the POST /{ad-account-id}/adsets endpoint for iOS 14.5 SKAdNetwork campaigns.
New iOS 14.5 app install campaigns will no longer be able to use app connections targeting.

Wird gelesen

The adsets of this ad account

Beispiel

GET /v24.0/act_<AD_ACCOUNT_ID>/adsets?fields=name%2Cid%2Cstatus HTTP/1.1
Host: graph.facebook.com

/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->get(
    '/act_<AD_ACCOUNT_ID>/adsets?fields=name%2Cid%2Cstatus',
    '{access-token}'
  );
} catch(Facebook\Exceptions\FacebookResponseException $e) {
  echo 'Graph returned an error: ' . $e->getMessage();
  exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
  echo 'Facebook SDK returned an error: ' . $e->getMessage();
  exit;
}
$graphNode = $response->getGraphNode();
/* handle the result */

/* make the API call */
FB.api(
    "/act_<AD_ACCOUNT_ID>/adsets",
    {
        "fields": "name,id,status"
    },
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);

Bundle params = new Bundle();
params.putString("fields", "name,id,status");
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/act_<AD_ACCOUNT_ID>/adsets",
    params,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();

NSDictionary *params = @{
  @"fields": @"name,id,status",
};
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/act_<AD_ACCOUNT_ID>/adsets"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];

curl -X GET -G \
  -d 'fields="name,id,status"' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v24.0/act_<AD_ACCOUNT_ID>/adsets

Weitere Informationen zur Verwendung der Graph API findest du in unserem Graph API-Leitfaden.

Parameter

Parameter	Beschreibung
`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}	Predefine date range used to aggregate insights metrics
`effective_status` list<enum{ACTIVE, PAUSED, DELETED, PENDING_REVIEW, DISAPPROVED, PREAPPROVED, PENDING_BILLING_INFO, CAMPAIGN_PAUSED, ARCHIVED, ADSET_PAUSED, IN_PROCESS, WITH_ISSUES}>	Effective status of adset
`is_completed` boolean	Filter adset by completed status
`time_range` {'since':YYYY-MM-DD,'until':YYYY-MM-DD}	Date range used to aggregate insights metrics
`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.
`updated_since` integer	Time since the Adset has been updated.

Felder

Beim Lesen dieses Edge wird ein Ergebnis im JSON-Format ausgegeben:

{
    "data": [],
    "paging": {},
    "summary": {}
}

`data`

Eine Liste von AdSet-Nodes.

`paging`

Weitere Informationen zur Paginierung findest du im Graph API-Leitfaden.

`summary`

Gesammelte Informationen zum Edge (z. B. Aufrufe). Gib im Parameter „summary“ an, welche Felder einbezogen werden sollen (z. B. summary=insights).

Feld Beschreibung

Feld	Beschreibung
`insights` Edge<AdsInsights>	Analytics summary for all objects. Use nested parameters with this field. `insights.time_range({'until':'2018-01-01', 'since':'2017-12-12'}).time_increment(1)`
`total_count` unsigned int32	Total number of objects Standard

insights

Edge<AdsInsights>

Analytics summary for all objects. Use nested parameters with this field. insights.time_range({'until':'2018-01-01', 'since':'2017-12-12'}).time_increment(1)

total_count

unsigned int32

Total number of objects

Standard

Error Codes

Fehler	Beschreibung
200	Permissions error
613	Calls to this api have exceeded the rate limit.
100	Invalid parameter
190	Invalid OAuth 2.0 Access Token
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.
368	The action attempted has been deemed abusive or is otherwise disallowed
3018	The start date of the time range cannot be beyond 37 months from the current date
2500	Error parsing graph query

Wird erstellt

Mobile App Install CPA Billing will no longer be supported. The billing event cannot be App Install if the Optimization goal is App Install.

You can make a POST request to adsets edge from the following paths:

/act_{ad_account_id}/adsets

When posting to this edge, an AdSet will be created.

Beispiel

Graph API Explorer

POST /v24.0/act_<AD_ACCOUNT_ID>/adsets HTTP/1.1
Host: graph.facebook.com

name=My+First+Adset&lifetime_budget=20000&start_time=2025-11-17T20%3A18%3A06-0800&end_time=2025-11-27T20%3A18%3A06-0800&campaign_id=%3CAD_CAMPAIGN_ID%3E&bid_amount=100&billing_event=LINK_CLICKS&optimization_goal=LINK_CLICKS&targeting=%7B%22facebook_positions%22%3A%5B%22feed%22%5D%2C%22geo_locations%22%3A%7B%22countries%22%3A%5B%22US%22%5D%7D%2C%22publisher_platforms%22%3A%5B%22facebook%22%2C%22audience_network%22%5D%7D&status=PAUSED

/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->post(
    '/act_<AD_ACCOUNT_ID>/adsets',
    array (
      'name' => 'My First Adset',
      'lifetime_budget' => '20000',
      'start_time' => '2025-11-17T20:18:06-0800',
      'end_time' => '2025-11-27T20:18:06-0800',
      'campaign_id' => '<AD_CAMPAIGN_ID>',
      'bid_amount' => '100',
      'billing_event' => 'LINK_CLICKS',
      'optimization_goal' => 'LINK_CLICKS',
      'targeting' => '{"facebook_positions":["feed"],"geo_locations":{"countries":["US"]},"publisher_platforms":["facebook","audience_network"]}',
      'status' => 'PAUSED',
    ),
    '{access-token}'
  );
} catch(Facebook\Exceptions\FacebookResponseException $e) {
  echo 'Graph returned an error: ' . $e->getMessage();
  exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
  echo 'Facebook SDK returned an error: ' . $e->getMessage();
  exit;
}
$graphNode = $response->getGraphNode();
/* handle the result */

/* make the API call */
FB.api(
    "/act_<AD_ACCOUNT_ID>/adsets",
    "POST",
    {
        "name": "My First Adset",
        "lifetime_budget": "20000",
        "start_time": "2025-11-17T20:18:06-0800",
        "end_time": "2025-11-27T20:18:06-0800",
        "campaign_id": "<AD_CAMPAIGN_ID>",
        "bid_amount": "100",
        "billing_event": "LINK_CLICKS",
        "optimization_goal": "LINK_CLICKS",
        "targeting": "{\"facebook_positions\":[\"feed\"],\"geo_locations\":{\"countries\":[\"US\"]},\"publisher_platforms\":[\"facebook\",\"audience_network\"]}",
        "status": "PAUSED"
    },
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);

Bundle params = new Bundle();
params.putString("name", "My First Adset");
params.putString("lifetime_budget", "20000");
params.putString("start_time", "2025-11-17T20:18:06-0800");
params.putString("end_time", "2025-11-27T20:18:06-0800");
params.putString("campaign_id", "<AD_CAMPAIGN_ID>");
params.putString("bid_amount", "100");
params.putString("billing_event", "LINK_CLICKS");
params.putString("optimization_goal", "LINK_CLICKS");
params.putString("targeting", "{\"facebook_positions\":[\"feed\"],\"geo_locations\":{\"countries\":[\"US\"]},\"publisher_platforms\":[\"facebook\",\"audience_network\"]}");
params.putString("status", "PAUSED");
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/act_<AD_ACCOUNT_ID>/adsets",
    params,
    HttpMethod.POST,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();

NSDictionary *params = @{
  @"name": @"My First Adset",
  @"lifetime_budget": @"20000",
  @"start_time": @"2025-11-17T20:18:06-0800",
  @"end_time": @"2025-11-27T20:18:06-0800",
  @"campaign_id": @"<AD_CAMPAIGN_ID>",
  @"bid_amount": @"100",
  @"billing_event": @"LINK_CLICKS",
  @"optimization_goal": @"LINK_CLICKS",
  @"targeting": @"{\"facebook_positions\":[\"feed\"],\"geo_locations\":{\"countries\":[\"US\"]},\"publisher_platforms\":[\"facebook\",\"audience_network\"]}",
  @"status": @"PAUSED",
};
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/act_<AD_ACCOUNT_ID>/adsets"
                                      parameters:params
                                      HTTPMethod:@"POST"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];

curl -X POST \
  -F 'name="My First Adset"' \
  -F 'lifetime_budget=20000' \
  -F 'start_time="2025-11-17T20:18:06-0800"' \
  -F 'end_time="2025-11-27T20:18:06-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/v24.0/act_<AD_ACCOUNT_ID>/adsets

Weitere Informationen zur Verwendung der Graph API findest du in unserem Graph API-Leitfaden.

Parameter

Parameter	Beschreibung
`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 erforderlich
`end_minute` int64	A 0 based minute of the day representing when the schedule ends erforderlich
`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. erforderlich
`timezone_type` enum {USER, ADVERTISER}	Standardwert: `USER`
`anchor_event_attribution_window_days` int64	anchor_event_attribution_window_days
`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}	erforderlich
`window_days` int64	erforderlich
`weight` float	Standardwert: `100`
`automatic_manual_state` enum{UNSET, AUTOMATIC, MANUAL}	automatic_manual_state
`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
`budget_source` enum{NONE, RMN}	budget_source
`budget_split_set_id` numeric string or integer	budget_split_set_id
`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, INSTAGRAM_LIVE, FACEBOOK_LIVE, IMAGINE}	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}>	Standardwert: `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. Writes to this field are only available in ad sets where `REACH` and `THRUPLAY` are the performance goal.
`event` enum{IMPRESSIONS, VIDEO_VIEWS, VIDEO_VIEWS_2S, VIDEO_VIEWS_15S}	Event name, only `IMPRESSIONS` currently. erforderlich
`interval_days` integer	Interval period in days, between 1 and 90 (inclusive) erforderlich
`max_frequency` integer	The maximum frequency, between 1 and 90 (inclusive) erforderlich
`type` enum{NONE, CAP, TARGET}
`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`
`is_sac_cfca_terms_certified` boolean	is_sac_cfca_terms_certified
`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. erforderlichSupports 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, PROFILE_AND_PAGE_ENGAGEMENT, ADVERTISER_SILOED_VALUE, AUTOMATIC_OBJECTIVE, 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, POST_INTERACTION}	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.
`object_store_urls` list<URL>	The vec of 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_crm_single_event, onsite_web, onsite_p2b_call, onsite_messaging}	The event source of lead ads form.
`lead_ads_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.
`lead_ads_custom_event_str` string	The event from an App Event of a mobile app, not in the standard event list.
`lead_ads_offsite_conversion_type` enum{default, clo}	The offsite conversion type for lead ads
`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_PHONE_CALL, PRODUCT_SET_AND_WEBSITE, PRODUCT_SET_AND_WEBSITE_AND_PHONE_CALL, PRODUCT_SET_WEBSITE_APP_AND_INSTORE}	Variation of the promoted object for a PCA ad
`passback_pixel_id` numeric string or integer	ID of the pixel used for tracking passback events
`passback_application_id` numeric string or integer	ID of the application used for tracking passback events
`product_set_optimization` enum{enabled, disabled}	Enum defining whether or not the ad should be optimized for the promoted product set
`full_funnel_objective` enum{OFFER_CLAIMS, PAGE_LIKES, EVENT_RESPONSES, POST_ENGAGEMENT, WEBSITE_CONVERSIONS, LINK_CLICKS, VIDEO_VIEWS, LOCAL_AWARENESS, PRODUCT_CATALOG_SALES, LEAD_GENERATION, BRAND_AWARENESS, STORE_VISITS, REACH, APP_INSTALLS, MESSAGES, OUTCOME_AWARENESS, OUTCOME_ENGAGEMENT, OUTCOME_LEADS, OUTCOME_SALES, OUTCOME_TRAFFIC, OUTCOME_APP_PROMOTION}	Enum defining the full funnel objective of the campaign
`dataset_split_id` numeric string or integer	ID of the dataset split used to perform additional optimization on the dataset
`dataset_split_ids` array<numeric string>	IDs of the dataset splits used to perform additional optimization on the dataset
`lead_ads_selected_pixel_id` numeric string or integer	The selected pixel id for lead ads conversion leads optimization
`multi_event_product` int64	Identifies which action-to-action product the advertiser is using
`product_sales_channel` enum {ONLINE, IN_STORE, OMNI}	ProductSalesChannel of the promoted object for Omni L3 DA SBLI ads
`anchor_event_config` string	Configuration for anchor event in multi-event optimization campaigns
`omnichannel_object` Object
`app` array<JSON object>
`pixel` array<JSON object>	erforderlich
`onsite` array<JSON object>
`whats_app_business_phone_number_id` numeric string or integer
`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
`value_rule_set_id` numeric string or integer	Value Rule Set ID
`value_rules_applied` boolean	value_rules_applied

Rückgabetyp

This endpoint supports read-after-write and will read the node represented by id in the return type.

Struct {

id: numeric string,

success: bool,

}

Error Codes

Fehler	Beschreibung
100	Invalid parameter
200	Permissions error
2635	You are calling a deprecated version of the Ads API. Please update to the latest version.
368	The action attempted has been deemed abusive or is otherwise disallowed
2695	The ad set creation reached its campaign group(ios14) limit.
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.
2641	Your ad includes or excludes locations that are currently restricted
190	Invalid OAuth 2.0 Access Token
900	No such application exists.

Wird aktualisiert

Diese Handlung kann auf diesem Endpunkt nicht durchgeführt werden.

Wird gelöscht

This operation has been deprecated with Marketing API V8.

Diese Handlung kann auf diesem Endpunkt nicht durchgeführt werden.