Returns the delivery estimate for a given ad set configuration in this ad account. You are not able to retrieve this field for inactive Lookalike Audiences .
Delivery estimate for a given ad set configuration in this ad account.
GET /v20.0/{ad-account-id}/delivery_estimate 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-account-id}/delivery_estimate',
'{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-account-id}/delivery_estimate",
function (response) {
if (response && !response.error) {
/* handle the result */
}
}
);
/* make the API call */
new GraphRequest(
AccessToken.getCurrentAccessToken(),
"/{ad-account-id}/delivery_estimate",
null,
HttpMethod.GET,
new GraphRequest.Callback() {
public void onCompleted(GraphResponse response) {
/* handle the result */
}
}
).executeAsync();
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
initWithGraphPath:@"/{ad-account-id}/delivery_estimate"
parameters:params
HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
id result,
NSError *error) {
// Handle the result
}];
Parameter | Description |
---|---|
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 that you want the estimate for. You only get action predictions for optimization goals where actions make sense. See optimization_goals for allowed values. Required
|
promoted_object
Object
|
The promoted object for the ad set that you want an estimate for. This is the same format as when you create an ad set . |
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, onsite_crm, onsite_web}
|
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 |
omnichannel_object
Object
|
|
app
array<JSON object>
|
|
pixel
array<JSON object>
|
Required
|
onsite
array<JSON object>
|
|
whatsapp_phone_number
string
|
|
targeting_spec
Targeting object
|
The targeting specification for delivery estimate. See Advanced Targeting and Placement . Required
|
Reading from this edge will return a JSON formatted result:
{ "
data
": [], "paging
": {} }
data
Error | Description |
---|---|
100 | Invalid parameter |
2641 | Your ad includes or excludes locations that are currently restricted |
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. |
2654 | Failed to create custom audience |
2635 | You are calling a deprecated version of the Ads API. Please update to the latest version. |
190 | Invalid OAuth 2.0 Access Token |
105 | The number of parameters exceeded the maximum for this operation |
368 | The action attempted has been deemed abusive or is otherwise disallowed |