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
Create an ad set with a lifetime budget
curl -X POST \
-F 'name="My First Adset"' \
-F 'lifetime_budget=20000' \
-F 'start_time="2024-11-04T09:56:51-0800"' \
-F 'end_time="2024-11-14T09:56:51-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
The following are the limits on ad sets
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 |
Facebook is committed to protecting people from discrimination, and we are continually improving our ability to detect and deter potential abuse. It’s already against our policies to discriminate by wrongfully targeting or excluding specific groups of people. As part of a historic settlement agreement, we are making changes to the way we manage housing, employment and credit ads.
Advertisers must specify a special_ad_category
for ad campaigns that market housing, employment, and credit. In doing so, the set of targeting options available for ads in these campaigns will be restricted. See Special Ad Category for more information.
Beginning Tuesday, May 16, 2023 advertisers who include the European Union (EU), associated territories, or select global/worldwide in their ad targeting on Facebook and Instagram will be asked to include information about who benefits from the ad (the beneficiary) and who is paying for the ad (the payor) for each ad set. Advertisers will be prompted for this information in all ads buying surfaces including Ads Manager and the Marketing API. Beginning Wednesday, August 16, 2023, if beneficiary and payer information is not provided, the ad will not be published.
We are launching this requirement to respond to the EU Digital Services Act (DSA) which goes into full effect for Facebook and Instagram later this year.
Ad sets targeted to the EU and/or associated territories (see here for a complete list) are required to provide beneficiary information (who benefits from the ad running), and payer information (who pays for the ad). This applies to new ads, duplicated ads, or significantly edited ads from May 16 forward, and without the required information, the API will respond with a wrong parameter error. For convenience the advertiser can set a saved beneficiary and payor in their ad account, which will be auto-populated during ad set creation, copying, and updating targets to include EU locations and ads under existing ad seta without configured the payor and beneficiary.. For more information about the ad account level parameters, default_dsa_payor
and default_dsa_beneficiary
, see to the check the Ad Account reference document.
To facilitate the creation of ad sets targeting the EU, we're offering a new API which allows developers to get a list of likely beneficiary/payer strings, based on ad account activity. See Ad Account DSA Recommendations for more information.
Notice: To facilitate the creation of ad sets targeting the EU, we're offering a new API which allows developers to get a list of likely beneficiary/payer strings, based on ad account activity. See Ad Account Dsa Recommendations for more information.
default_dsa_payor
is payor_default
and default_dsa_beneficiary
is beneficiary_default
. During ad set creation, if only dsa_payor
is passed with the payor, the dsa_beneficiary
will be automatically filled with value of beneficiary_default
instead of dsa_payor
.payer
and the beneficiary
fields are only for ad sets targeting the EU and/or associated territories.
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.
The date_preset = lifetime
parameter is disabled in Graph API v10.0 and replaced with date_preset = maximum
, which returns a maximum of 37 months of data. For v9.0 and below, date_preset = maximum
will be enabled on May 25, 2021, and any lifetime
calls will default to maximum
and return only 37 months of data.
curl -X GET \
-d 'fields="name,status"' \
-d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v21.0/<AD_SET_ID>/
To retrieve date-time related fields in a UNIX timestamp format, use the date_format
parameter:
curl -X GET \
-d 'fields="id,name,start_time,end_time"' \
-d 'date_format="U"' \
-d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v21.0/<AD_SET_ID>/
To retrieve information for multiple ad sets:
use FacebookAds\Object\AdSet;
use FacebookAds\Object\Fields\AdSetFields;
$ad_set_ids = array(<AD_SET_1_ID>, <AD_SET_2_ID>, <AD_SET_3_ID>);
$fields = array(
AdSetFields::NAME,
AdSetFields::CONFIGURED_STATUS,
AdSetFields::EFFECTIVE_STATUS,
);
$adsets = AdSet::readIds($ad_set_ids, $fields);
foreach ($adsets as $adset) {
echo $adset->{AdSetFields::NAME}.PHP_EOL;
}
curl -G \
-d 'fields=name,configured_status,effective_status' \
-d 'ids=1000002,1000002,1000002' \
-d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v2.11/
To read all ad sets from one ad account:
use FacebookAds\Object\AdAccount;
use FacebookAds\Object\Fields\AdSetFields;
$account = new AdAccount('act_<AD_ACCOUNT_ID>');
$adsets = $account->getAdSets(array(
AdSetFields::NAME,
AdSetFields::CONFIGURED_STATUS,
AdSetFields::EFFECTIVE_STATUS,
));
foreach ($adsets as $adset) {
echo $adset->{AdSetFields::NAME}.PHP_EOL;
}
from facebookads.adobjects.adaccount import AdAccount
from facebookads.adobjects.adset import AdSet
account = AdAccount('act_<AD_ACCOUNT_ID>')
adsets = account.get_ad_sets(fields=[AdSet.Field.name])
for adset in adsets:
print(adset[AdSet.Field.name])
APINodeList<AdSet> adSets = new AdAccount(act_<AD_ACCOUNT_ID>, context).getAdSets()
.requestNameField()
.requestConfiguredStatusField()
.requestEffectiveStatusField()
.execute();
curl -G \
-d 'fields=name,configured_status,effective_status' \
-d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v2.11/act_<AD_ACCOUNT_ID>/adsets
To read the names of ad sets with status paused in an ad account
use FacebookAds\Object\AdAccount;
use FacebookAds\Object\AdSet;
use FacebookAds\Object\Fields\AdSetFields;
$account = new AdAccount('act_<AD_ACCOUNT_ID>');
$adsets = $account->getAdSets(
array(),
array(
AdSetFields::EFFECTIVE_STATUS => array(
AdSet::STATUS_PAUSED,
),
));
foreach ($adsets as $adset) {
echo $adset->{AdSetFields::NAME}.PHP_EOL;
}
APINodeList<AdSet> adSets = new AdAccount(act_<AD_ACCOUNT_ID>, context).getAdSets()
.setEffectiveStatus("[\"PAUSED\"]")
.execute();
curl -G \
-d 'effective_status=["PAUSED"]' \
-d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v2.11/act_<AD_ACCOUNT_ID>/adsets
To read the end_time
of multiple ad sets.
use FacebookAds\Object\AdSet;
use FacebookAds\Object\Fields\AdSetFields;
$adsets = AdSet::readIds(
array($ad_set_1_id, $ad_set_2_id),
array(AdSetFields::END_TIME));
foreach ($adsets as $adset) {
echo $adset->{AdSetFields::END_TIME}.PHP_EOL;
}
curl -G \
-d 'fields=end_time' \
-d 'ids=1000002,1000002' \
-d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v2.11/
GET /v21.0/<AD_SET_ID>/?fields=adset_schedule 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(
'/<AD_SET_ID>/?fields=adset_schedule',
'{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(
"/<AD_SET_ID>/",
{
"fields": "adset_schedule"
},
function (response) {
if (response && !response.error) {
/* handle the result */
}
}
);
Bundle params = new Bundle();
params.putString("fields", "adset_schedule");
/* make the API call */
new GraphRequest(
AccessToken.getCurrentAccessToken(),
"/<AD_SET_ID>/",
params,
HttpMethod.GET,
new GraphRequest.Callback() {
public void onCompleted(GraphResponse response) {
/* handle the result */
}
}
).executeAsync();
NSDictionary *params = @{
@"fields": @"adset_schedule",
};
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
initWithGraphPath:@"/<AD_SET_ID>/"
parameters:params
HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
id result,
NSError *error) {
// Handle the result
}];
curl -X GET -G \
-d 'fields="adset_schedule"' \
-d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v21.0/<AD_SET_ID>/
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. |
Field | Description |
---|---|
id numeric string | ID for the Ad Set |
account_id numeric string | ID for the Ad Account associated with this Ad Set |
adlabels | 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 |
bid_adjustments | 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 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 |
bid_constraints | Choose bid constraints for ad set to suit your specific business goals. It usually works together with |
bid_info map<string, unsigned int32> | Map of bid objective to bid value. |
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
|
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: |
brand_safety_config BrandSafetyCampaignConfig | brand_safety_config |
budget_remaining numeric string | Remaining budget of this Ad Set |
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: The |
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. |
end_time datetime | End time, in UTC UNIX timestamp |
frequency_control_specs | 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 |
instagram_actor_id numeric string | Represents your Instagram account id, used for ads, including dynamic creative ads on Instagram. |
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 for this ad set that prevented it from deliverying | |
learning_stage_info | 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 |
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. |
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 | 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 |
regional_regulated_categories list<enum> | This param is used to specify regional_regulated_categories. Currently it supports Example: |
regional_regulation_identities RegionalRegulationIdentities | This param is used to specify regional_regulation_identities. Example:
Passing |
review_feedback string | Reviews for dynamic creative ad |
rf_prediction_id id | Reach and frequency prediction ID |
source_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 |
targeting Targeting | Targeting |
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_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 |
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 |
---|---|
Edge<AdActivity> | The activities of this ad set |
Edge<AdStudy> | The ad studies containing this ad set |
Edge<AdCreative> | The creatives of this ad set |
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 |
Edge<Adgroup> | The ads under this ad set |
Edge<AdAsyncRequest> | Async ad requests for this ad set |
Edge<AdCampaign> | The copies of this ad set |
Edge<AdCampaignDeliveryEstimate> | The delivery estimate for this ad set |
Edge<MessageDeliveryEstimate> | Delivery estimation of the marketing message campaign |
Edge<TargetingSentenceLine> | The targeting description sentence for this ad set |
Error | Description |
---|---|
100 | Invalid parameter |
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 |
200 | Permissions error |
2500 | Error parsing graph query |
Validate an ad set with a daily budget where campaign objective is set to APP_INSTALLS
curl -X POST \
-F 'name="Mobile App Installs Ad Set"' \
-F 'daily_budget=1000' \
-F 'bid_amount=2' \
-F 'billing_event="IMPRESSIONS"' \
-F 'optimization_goal="APP_INSTALLS"' \
-F 'campaign_id="<AD_CAMPAIGN_ID>"' \
-F 'promoted_object={
"application_id": "<APP_ID>",
"object_store_url": "<APP_STORE_URL>"
}' \
-F 'targeting={
"device_platforms": [
"mobile"
],
"facebook_positions": [
"feed"
],
"geo_locations": {
"countries": [
"US"
]
},
"publisher_platforms": [
"facebook",
"audience_network"
],
"user_os": [
"IOS"
]
}' \
-F 'status="PAUSED"' \
-F 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v21.0/act_<AD_ACCOUNT_ID>/adsets
When creating an ad set, from v2.4
and on, there will be a minimum budget for different billing events (clicks, impressions, actions). Minimum values are defined in terms of the daily budget but apply to lifetime budgets as well. For example, if the minimum daily budget is $5, a campaign lasting 5 days will need at least $25 for budget. All values in this section are in US Dollars. Differenct currency has different minimum daily budget limit.
If bid_strategy
is set to LOWEST_COST_WITHOUT_CAP
in the ad set:
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. |
If bid_strategy
is set to LOWEST_COST_WITH_BID_CAP
in the ad set:
Billing Event | Minimum Daily Budget |
---|---|
Impressions | At least the |
Clicks/Actions | 5x the |
Budgets in other non-USD currencies will be converted and validated upon time of ad set creation.
For ads belonging to ad accounts from countries in the list below, the minimum values are 2x the ones in the tables. For example if billing event is an impression, minimum daily budget is $0.50 but in the the following countries minimum would be $1.00:
Australia, Austria, Belgium, Canada, Denmark, Finland, France, Germany, Greece, Hong Kong, Israel, Italy, Japan, Netherlands, New Zealand, Norway, Singapore, South Korea, Spain, Sweden, Switzerland, Taiwan, United Kingdom, United States of America.
The only exception to this rule are low-frequency actions when bid_strategy
is LOWEST_COST_WITHOUT_CAP
.
If you promote a Page post which has been targeted by locale the ad set targeting must include the same, or a subset of, locale targeting as the Page post.
E.g. if the Page post is targeted at locales 6 (US English) and 24 (UK English), then the ad set must be targeted at one or more of the same locales.
Mobile app ad sets should
MOBILE_APP_*
objective on the campaignDesktop app ad sets must
'page_types':['desktopfeed']
or'page_types':['rightcolumn']
or'page_types':['desktop']
along with the other targeting options you have selected.CANVAS_APP_*
objectiveBeginning with v13.0, for newly created ad sets that optimize for value, conversions, or app events, lookalike expansion will be turned on by default and cannot be disabled. When getting an ad set that optimizes for value, conversions, or app events, we will return a new lookalike property in the targeting_optimization_types
map that indicates lookalike expansion is enabled and complements the existing detailed_targeting
property for the detailed targeting expansion.
For ad sets targeting the EU and/or associated territories, the dsa_payor
and dsa_beneficiary
fields are required. The information provided in these 2 fields will be shown to end users to indicate who is paying for the ad and who is the beneficiary of the ad.
Request
Include the following fields in an API call to the /{adset_id}
endpoint.
{ "dsa_payor": "<PAYOR_NAME>", "dsa_beneficiary": "<BENEFICIARY_NAME>" ... }
Fields
Name | Description |
---|---|
string (max 512 char) | The payor of all ads in this ad set. |
string (max 512 char) | The beneficiary of all ads in this ad set. |
If these fields are not provided, the API may returns the following errors:
Payor missing error
{ "error": { "message": "Invalid parameter", "type": "FacebookApiException", "code": 100, "error_data": "{\"blame_field_specs\":[[\"dsa_payor\"]]}", "error_subcode": 3858079, "is_transient": false, "error_user_title": "No payor provided in DSA regulated region", "error_user_msg": "The DSA requires ads to provide payor information in regulated regions. Updating/creating ad needs to provide payor of the ad.", "fbtrace_id": "fbtrace_id" }, "__fb_trace_id__": "fbtrace_id", "__www_request_id__": "request_id" }Beneficiary missing error
{ "error": { "message": "Invalid parameter", "type": "FacebookApiException", "code": 100, "error_data": "{\"blame_field_specs\":[[\"dsa_beneficiary\"]]}", "error_subcode": 3858081, "is_transient": false, "error_user_title": "No payor/beneficiary provided in DSA regulated location", "error_user_msg": "The DSA requires ads to provide beneficiary information in regulated regions. Updating/creating ad needs to provide beneficiary of the ad.", "fbtrace_id": "fbtrace_id" }, "__fb_trace_id__": "fbtrace_id", "__www_request_id__": "request_id" }
copies
edge from the following paths: 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. |
rename_options JSON or object-like arrays | Rename options |
start_time datetime | The start time of the set, e.g. |
status_option enum {ACTIVE, PAUSED, INHERITED_FROM_SOURCE} | Default value: PAUSED
|
copied_adset_id
in the return type.copied_adset_id
: numeric string, ad_object_ids
: List [ad_object_type
: enum {unique_adcreative, ad, ad_set, campaign, opportunities, privacy_info_center, topline, ad_account}, source_id
: numeric string, copied_id
: numeric string, Error | Description |
---|---|
100 | Invalid parameter |
368 | The action attempted has been deemed abusive or is otherwise disallowed |
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. |
613 | Calls to this api have exceeded the rate limit. |
adsets
edge from the following paths: POST /v21.0/act_<AD_ACCOUNT_ID>/adsets HTTP/1.1
Host: graph.facebook.com
name=My+First+AdSet&daily_budget=10000&bid_amount=300&billing_event=IMPRESSIONS&optimization_goal=REACH&campaign_id=%3CAD_CAMPAIGN_ID%3E&promoted_object=%7B%22page_id%22%3A%22%3CPAGE_ID%3E%22%7D&targeting=%7B%22facebook_positions%22%3A%5B%22feed%22%5D%2C%22geo_locations%22%3A%7B%22countries%22%3A%5B%22US%22%5D%2C%22regions%22%3A%5B%7B%22key%22%3A%224081%22%7D%5D%2C%22cities%22%3A%5B%7B%22key%22%3A777934%2C%22radius%22%3A10%2C%22distance_unit%22%3A%22mile%22%7D%5D%7D%2C%22genders%22%3A%5B1%5D%2C%22age_max%22%3A24%2C%22age_min%22%3A20%2C%22publisher_platforms%22%3A%5B%22facebook%22%2C%22audience_network%22%5D%2C%22device_platforms%22%3A%5B%22mobile%22%5D%2C%22flexible_spec%22%3A%5B%7B%22interests%22%3A%5B%7B%22id%22%3A%22%3CINTEREST_ID%3E%22%2C%22name%22%3A%22%3CINTEREST_NAME%3E%22%7D%5D%7D%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',
'daily_budget' => '10000',
'bid_amount' => '300',
'billing_event' => 'IMPRESSIONS',
'optimization_goal' => 'REACH',
'campaign_id' => '<AD_CAMPAIGN_ID>',
'promoted_object' => '{"page_id":"<PAGE_ID>"}',
'targeting' => '{"facebook_positions":["feed"],"geo_locations":{"countries":["US"],"regions":[{"key":"4081"}],"cities":[{"key":777934,"radius":10,"distance_unit":"mile"}]},"genders":[1],"age_max":24,"age_min":20,"publisher_platforms":["facebook","audience_network"],"device_platforms":["mobile"],"flexible_spec":[{"interests":[{"id":"<INTEREST_ID>","name":"<INTEREST_NAME>"}]}]}',
'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",
"daily_budget": "10000",
"bid_amount": "300",
"billing_event": "IMPRESSIONS",
"optimization_goal": "REACH",
"campaign_id": "<AD_CAMPAIGN_ID>",
"promoted_object": "{\"page_id\":\"<PAGE_ID>\"}",
"targeting": "{\"facebook_positions\":[\"feed\"],\"geo_locations\":{\"countries\":[\"US\"],\"regions\":[{\"key\":\"4081\"}],\"cities\":[{\"key\":777934,\"radius\":10,\"distance_unit\":\"mile\"}]},\"genders\":[1],\"age_max\":24,\"age_min\":20,\"publisher_platforms\":[\"facebook\",\"audience_network\"],\"device_platforms\":[\"mobile\"],\"flexible_spec\":[{\"interests\":[{\"id\":\"<INTEREST_ID>\",\"name\":\"<INTEREST_NAME>\"}]}]}",
"status": "PAUSED"
},
function (response) {
if (response && !response.error) {
/* handle the result */
}
}
);
Bundle params = new Bundle();
params.putString("name", "My First AdSet");
params.putString("daily_budget", "10000");
params.putString("bid_amount", "300");
params.putString("billing_event", "IMPRESSIONS");
params.putString("optimization_goal", "REACH");
params.putString("campaign_id", "<AD_CAMPAIGN_ID>");
params.putString("promoted_object", "{\"page_id\":\"<PAGE_ID>\"}");
params.putString("targeting", "{\"facebook_positions\":[\"feed\"],\"geo_locations\":{\"countries\":[\"US\"],\"regions\":[{\"key\":\"4081\"}],\"cities\":[{\"key\":777934,\"radius\":10,\"distance_unit\":\"mile\"}]},\"genders\":[1],\"age_max\":24,\"age_min\":20,\"publisher_platforms\":[\"facebook\",\"audience_network\"],\"device_platforms\":[\"mobile\"],\"flexible_spec\":[{\"interests\":[{\"id\":\"<INTEREST_ID>\",\"name\":\"<INTEREST_NAME>\"}]}]}");
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",
@"daily_budget": @"10000",
@"bid_amount": @"300",
@"billing_event": @"IMPRESSIONS",
@"optimization_goal": @"REACH",
@"campaign_id": @"<AD_CAMPAIGN_ID>",
@"promoted_object": @"{\"page_id\":\"<PAGE_ID>\"}",
@"targeting": @"{\"facebook_positions\":[\"feed\"],\"geo_locations\":{\"countries\":[\"US\"],\"regions\":[{\"key\":\"4081\"}],\"cities\":[{\"key\":777934,\"radius\":10,\"distance_unit\":\"mile\"}]},\"genders\":[1],\"age_max\":24,\"age_min\":20,\"publisher_platforms\":[\"facebook\",\"audience_network\"],\"device_platforms\":[\"mobile\"],\"flexible_spec\":[{\"interests\":[{\"id\":\"<INTEREST_ID>\",\"name\":\"<INTEREST_NAME>\"}]}]}",
@"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 'daily_budget=10000' \
-F 'bid_amount=300' \
-F 'billing_event="IMPRESSIONS"' \
-F 'optimization_goal="REACH"' \
-F 'campaign_id="<AD_CAMPAIGN_ID>"' \
-F 'promoted_object={
"page_id": "<PAGE_ID>"
}' \
-F 'targeting={
"facebook_positions": [
"feed"
],
"geo_locations": {
"countries": [
"US"
],
"regions": [
{
"key": "4081"
}
],
"cities": [
{
"key": 777934,
"radius": 10,
"distance_unit": "mile"
}
]
},
"genders": [
1
],
"age_max": 24,
"age_min": 20,
"publisher_platforms": [
"facebook",
"audience_network"
],
"device_platforms": [
"mobile"
],
"flexible_spec": [
{
"interests": [
{
"id": "<INTEREST_ID>",
"name": "<INTEREST_NAME>"
}
]
}
]
}' \
-F 'status="PAUSED"' \
-F 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v21.0/act_<AD_ACCOUNT_ID>/adsets
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 |
attribution_spec list<JSON object> | Conversion attribution spec used for attributing conversions for optimization. Supported window lengths differ by optimization goal and campaign objective. |
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 |
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 Notes:
|
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: |
budget_schedule_specs list<JSON or object-like arrays> | Initial high demand periods to be created with the ad set. |
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 |
contextual_bundling_spec Object | settings of Contextual Bundle to support ads serving in Facebook contextual surfaces |
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 |
daily_imps int64 | Daily impressions. Available only for campaigns with |
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, |
dsa_beneficiary string | dsa_beneficiary |
dsa_payor string | dsa_payor |
end_time datetime | End time, required when |
execution_options list<enum{validate_only, include_recommendations}> | Default value: Set An execution setting |
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 |
boolean | Indicates the ad set must only be used for dynamic creatives. Dynamic creative ads can be created in this ad set. Defaults to |
lifetime_budget int64 | Lifetime budget, defined in your account currency. If specified, you must also specify an |
lifetime_imps int64 | Lifetime impressions. Available only for campaigns with |
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. |
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.
optimization_goal is OFFSITE_CONVERSIONS
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. |
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. |
status enum{ACTIVE, PAUSED, DELETED, ARCHIVED} | Only |
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_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_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 |
id
in the return type.id
: numeric string, success
: bool, 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. |
2695 | The ad set creation reached its campaign group(ios14) limit. |
368 | The action attempted has been deemed abusive or is otherwise disallowed |
2635 | You are calling a deprecated version of the Ads API. Please update to the latest version. |
190 | Invalid OAuth 2.0 Access Token |
2641 | Your ad includes or excludes locations that are currently restricted |
900 | No such application exists. |
curl -X POST \
-F 'billing_event="IMPRESSIONS"' \
-F 'optimization_goal="LINK_CLICKS"' \
-F 'bid_amount=200' \
-F 'targeting={
"geo_locations": {
"countries": [
"US"
]
},
"facebook_positions": [
"feed"
]
}' \
-F 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v21.0/<AD_SET_ID>/
To update the end_time
of an ad set, using ISO-8601 date-time format
use FacebookAds\Object\AdSet;
$adset = new AdSet('<AD_SET_ID>');
$adset->end_time = '2013-10-02T00:00:00-0700';
$adset->update();
To update the status of an ad set to paused
use FacebookAds\Object\AdSet;
$adset = new AdSet('<AD_SET_ID>');
$adset->campaign_status = AdSet::STATUS_PAUSED;
$adset->update();
An archived ad set can only update two fields: name
and campaign_status
. The campaign_status
field can only be changed to DELETED
.
A deleted ad set can only change its name
.
There are two considerations to take into account when adjusting an ad set's budget value or budget type:
v2.4
, ad sets have a minimum required budget. Any update must take that into consideration. Check the details at the Create Considerations section from this page.curl -X DELETE \
-F 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v21.0/<AD_SET_ID>/
/{ad_set_id}
.DELETE /v21.0/<AD_SET_ID>/ HTTP/1.1
Host: graph.facebook.com
/* PHP SDK v5.0.0 */
/* make the API call */
try {
// Returns a `Facebook\FacebookResponse` object
$response = $fb->delete(
'/<AD_SET_ID>/',
array (),
'{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(
"/<AD_SET_ID>/",
"DELETE",
function (response) {
if (response && !response.error) {
/* handle the result */
}
}
);
/* make the API call */
new GraphRequest(
AccessToken.getCurrentAccessToken(),
"/<AD_SET_ID>/",
null,
HttpMethod.DELETE,
new GraphRequest.Callback() {
public void onCompleted(GraphResponse response) {
/* handle the result */
}
}
).executeAsync();
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
initWithGraphPath:@"/<AD_SET_ID>/"
parameters:params
HTTPMethod:@"DELETE"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
id result,
NSError *error) {
// Handle the result
}];
curl -X DELETE -G \
-F 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v21.0/<AD_SET_ID>/
success
: bool, Error | Description |
---|---|
200 | Permissions error |
100 | Invalid parameter |
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 |
Outcome-Driven Ads Experiences (Engagement Outcome + ON_PAGE
destination_type)
curl -i -X POST \ -d "name=New ODAX Adset" \ -d "autobid=true" \ -d "optimization_goal=PAGE_LIKES" \ -d "destination_type=ON_PAGE" \ -d "billing_event=IMPRESSIONS" \ -d "daily_budget=500" \ -d "targeting={\"geo_locations\": {\"countries\": [\"US\"]}}" \ -d "promoted_object={\"page_id\": PAGE_ID}" \ -d "campaign_id=CAMPAIGN_ID" \ -d "status=PAUSED" \ -d "access_token=ACCESS_TOKEN" \ https://graph.facebook.com/v11.0/ act_AD_ACCOUNT_ID/adsets |
Legacy
curl -i -X POST \ -d "name=New ODAX Adset" \ -d "autobid=true" \ -d "optimization_goal=PAGE_LIKES" \ -d "billing_event=IMPRESSIONS" \ -d "daily_budget=500" \ -d "targeting={\"geo_locations\": {\"countries\": [\"US\"]}}" \ -d "promoted_object={\"page_id\": PAGE_ID}" \ -d "campaign_id=CAMPAIGN_ID" \ -d "status=PAUSED" \ -d "access_token=ACCESS_TOKEN" \ https://graph.facebook.com/v11.0/ act_AD_ACCOUNT_ID/adsets |
There will be new restrictions on Outcome-Driven Ads Experiences (ODAX) campaigns as outlined in the table below. Refer to the Outcome-Driven Ads Experiences mapping table to find the new objectives and their corresponding destination types, optimization goals and promoted objects.
ODAX Objectives | Conversion Location (L2) | Conversion Events (L2) | Optimization Goals (L2) | Legacy Objectives |
---|---|---|---|---|
Awareness | N/A | N/A | Ad Recall Lift, Reach, Impressions API enum { | Reach, Brand Awareness |
Traffic | Facebook Shops (closed beta) | N/A | Link Clicks API enum { | Traffic |
Website | N/A | Landing Page Views, Link Clicks, Impressions, Daily Unique Reach API enum { | Traffic | |
App | N/A | Link Clicks, Daily Unique Reach API enum { | Traffic | |
Messenger | N/A | Link Clicks, Impressions, Daily Unique Reach API enum { | Traffic | |
N/A | Link Clicks, Impressions, Daily Unique Reach API enum { | Traffic | ||
Engagement | On Video | N/A | ThruPlay, 2 second continuous view API enum { | Video Views |
On Post | N/A | Post Engagement, Impressions, Daily Unique Reach API enum { | Post Engagement | |
On Event | N/A | Event Response, Impressions, Post Engagement, Daily Unique Reach API enum { | Event Responses | |
Messenger | N/A | Conversations, Link Clicks API enum { | Messages | |
N/A | Conversations, Link Clicks API enum { | Messages | ||
N/A | Conversations, Link Clicks API enum { | 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 { | 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 { | Conversions | |
On Page | N/A | Page Likes API enum { | Engagement | |
Leads | Website | Lead, CompleteRegistration, Contact, FindLocation, Schedule, StartTrial, SubmitApplication, Subscribe | Conversions, Landing Page Views, Link Clicks, Impressions, Daily Unique Reach API enum { | Conversions |
Instant Forms | N/A | Leads API enum { | Lead Generation | |
Messenger | N/A | Leads API enum { | Messages | |
Calls | N/A | Calls API enum { | 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 { | Conversions | |
App Promotion | N/A | All app events, including all custom events | Non-AAA: Link Clicks, App Installs, App Events, Value API enum { AAA: App Installs, App Installs w/ App Events, App Events, Value API enum { | App Installs |
Sales | 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 { | Conversions |
Website | Purchase, InitiateCheckout, AddPaymentInfo, AddToCart, CompleteRegistration, Donate, StartTrial, Subscribe, ViewContent | Conversions, Value, Landing Page Views, Link Clicks, Impressions, Daily Unique Reach API enum { | 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 { | Conversions | |
Website & App | Purchase, InitiateCheckout, AddPaymentInfo, AddToCart, CompleteRegistration, Donate, StartTrial, Subscribe, ViewContent | Conversions API enum { | Conversions | |
Messenger | Purchase, InitiateCheckout, AddPaymentInfo, AddToCart, CompleteRegistration, Donate, StartTrial, Subscribe, ViewContent | Conversations, Conversions, Link Clicks, Impressions, Reach API enum { | Conversions | |
Purchase, InitiateCheckout, AddPaymentInfo, AddToCart, CompleteRegistration, Donate, StartTrial, Subscribe, ViewContent | Conversions, Link Clicks, Impressions, Reach API enum { | Conversions |