Graph API Version

Ad Campaign Placement

Reading

AdCampaignPlacement

Example

GET /v24.0/ad_campaign_placement 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_campaign_placement',
    '{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_campaign_placement",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);

/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/ad_campaign_placement",
    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_campaign_placement"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];

If you want to learn how to use the Graph API, read our Using Graph API guide.

Parameters

Parameter	Description
`account_id` numeric string	Ad Account ID Required
`billing_event` enum{APP_INSTALLS, CLICKS, IMPRESSIONS, LINK_CLICKS, NONE, OFFER_CLAIMS, PAGE_LIKES, POST_ENGAGEMENT, THRUPLAY, PURCHASE, LISTING_INTERACTION}	The billing event for the 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 videos. Required
`buying_type` string	Buying type, possible values are: `AUCTION`: default `RESERVED`: for reach and frequency ads Required
`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}	Default value: `UNDEFINED` Destination type of the campaign
`has_dynamic_creative` boolean	Default value: `false` If ad set has dynamic creatives
`objective` enum{APP_INSTALLS, BRAND_AWARENESS, CONVERSIONS, EVENT_RESPONSES, LEAD_GENERATION, LINK_CLICKS, LOCAL_AWARENESS, MESSAGES, OFFER_CLAIMS, OUTCOME_APP_PROMOTION, OUTCOME_AWARENESS, OUTCOME_ENGAGEMENT, OUTCOME_LEADS, OUTCOME_SALES, OUTCOME_TRAFFIC, PAGE_LIKES, POST_ENGAGEMENT, PRODUCT_CATALOG_SALES, REACH, STORE_VISITS, VIDEO_VIEWS}	Campaign's objective Required
`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}	Which optimization goal the 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. BRAND_AWARENESS: Optimize to reach the most number of users who are likely to spend at least a minimum amount of time on the image or video. 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. LINK_CLICKS: Optimize for people more likely to click in the link of the ad. OFFER_CLAIMS: Optimize for people more likely to claim the offer. OFFSITE_CONVERSIONS: Optimize for people more likely to make a conversion in the site PAGE_ENGAGEMENT: Optimize for people more likely to engage with your page. PAGE_LIKES: Optimize for people more likely to like your page. POST_ENGAGEMENT: 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. I.e. 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. VIDEO_VIEWS: Optimize for people more likely to watch videos. VALUE: Optimize for maximum total purchase value within the specified attribution window. REPLIES: REPLIES optimization will direct ads to people more likely to have a conversation with the business. Required
`promoted_object` Object	The object the ad set is promoting across all its ads.
`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>	Required
`onsite` array<JSON object>
`whats_app_business_phone_number_id` numeric string or integer
`whatsapp_phone_number` string

Fields

Field	Description
`effective_audience_network_positions` list<enum>	Effective Audience Network Positions Default
`effective_device_platforms` list<enum {mobile, desktop}>	Effective Device Platforms Default
`effective_facebook_positions` list<enum>	Effective Facebook Positions Default
`effective_instagram_positions` list<enum>	Effective Instagram Positions Default
`effective_messenger_positions` list<enum>	Effective Messenger Positions Default
`effective_publisher_platforms` list<enum>	Effective Publisher Platforms Default
`recommendations` list<AdRecommendation>	List of recommendations Default

Error Codes

Error	Description
100	Invalid parameter
104	Incorrect signature
190	Invalid OAuth 2.0 Access Token

Creating

You can't perform this operation on this endpoint.

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.