ErrorCode::ADPRO2__AD_MUST_HAVE_PAGE (1885833)EVENT_RESPONSESbody, object_idLINK_CLICKStitle, body, object_url containing image_file or image_hashactor_id in the ad creative's object_story_id or object_story_spec fields
EVENT_RESPONSESobject_story_id or object_story_specLINK_CLICKSobject_story_id or object_story_specname parameter of the Page Post will be overwritten with the name of the app from the Play Store/App Store.
ad_format are supported:
GET /v25.0/<CREATIVE_ID>/previews?ad_format=DESKTOP_FEED_STANDARD&product_item_ids=%5B%22%3CPRODUCT_ITEM_ID%3E%22%5D HTTP/1.1 Host: graph.facebook.com
| Parameter | Description |
|---|---|
ad_formatenum{AUDIENCE_NETWORK_INSTREAM_VIDEO, AUDIENCE_NETWORK_INSTREAM_VIDEO_MOBILE, AUDIENCE_NETWORK_OUTSTREAM_VIDEO, AUDIENCE_NETWORK_REWARDED_VIDEO, BIZ_DISCO_FEED_MOBILE, DESKTOP_FEED_STANDARD, FACEBOOK_IFU_REELS_MOBILE, FACEBOOK_PROFILE_FEED_DESKTOP, FACEBOOK_PROFILE_FEED_MOBILE, FACEBOOK_PROFILE_REELS_MOBILE, FACEBOOK_REELS_BANNER, FACEBOOK_REELS_BANNER_DESKTOP, FACEBOOK_REELS_BANNER_FEED_ANDROID, FACEBOOK_REELS_BANNER_FEED_ANDROID_LARGE, FACEBOOK_REELS_BANNER_FULLSCREEN_IOS, FACEBOOK_REELS_BANNER_FULLSCREEN_MOBILE, FACEBOOK_REELS_MOBILE, FACEBOOK_REELS_POSTLOOP, FACEBOOK_REELS_POSTLOOP_FEED, FACEBOOK_REELS_SIMILAR_PRODUCTS_MOBILE, FACEBOOK_REELS_STICKER, FACEBOOK_STORY_MOBILE, FACEBOOK_STORY_STICKER_MOBILE, INSTAGRAM_EXPLORE_CONTEXTUAL, INSTAGRAM_EXPLORE_GRID_HOME, INSTAGRAM_EXPLORE_IMMERSIVE, INSTAGRAM_FEED_WEB, INSTAGRAM_FEED_WEB_M_SITE, INSTAGRAM_LEAD_GEN_MULTI_SUBMIT_ADS, INSTAGRAM_PROFILE_FEED, INSTAGRAM_PROFILE_REELS, INSTAGRAM_REELS, INSTAGRAM_REELS_OVERLAY, INSTAGRAM_REELS_WEB, INSTAGRAM_REELS_WEB_M_SITE, INSTAGRAM_SEARCH_CHAIN, INSTAGRAM_SEARCH_GRID, INSTAGRAM_STANDARD, INSTAGRAM_STORY, INSTAGRAM_STORY_EFFECT_TRAY, INSTAGRAM_STORY_WEB, INSTAGRAM_STORY_WEB_M_SITE, INSTANT_ARTICLE_RECIRCULATION_AD, INSTANT_ARTICLE_STANDARD, INSTREAM_BANNER_DESKTOP, INSTREAM_BANNER_FEED_IOS, INSTREAM_BANNER_FULLSCREEN_IOS, INSTREAM_BANNER_FULLSCREEN_MOBILE, INSTREAM_BANNER_IMMERSIVE_MOBILE, INSTREAM_BANNER_MOBILE, INSTREAM_VIDEO_DESKTOP, INSTREAM_VIDEO_FULLSCREEN_IOS, INSTREAM_VIDEO_FULLSCREEN_MOBILE, INSTREAM_VIDEO_IMAGE, INSTREAM_VIDEO_IMMERSIVE_MOBILE, INSTREAM_VIDEO_MOBILE, JOB_BROWSER_DESKTOP, JOB_BROWSER_MOBILE, MARKETPLACE_MOBILE, MESSENGER_MOBILE_INBOX_MEDIA, MESSENGER_MOBILE_STORY_MEDIA, MOBILE_BANNER, MOBILE_FEED_BASIC, MOBILE_FEED_STANDARD, MOBILE_FULLWIDTH, MOBILE_INTERSTITIAL, MOBILE_MEDIUM_RECTANGLE, MOBILE_NATIVE, RIGHT_COLUMN_STANDARD, SUGGESTED_VIDEO_DESKTOP, SUGGESTED_VIDEO_FULLSCREEN_MOBILE, SUGGESTED_VIDEO_IMMERSIVE_MOBILE, SUGGESTED_VIDEO_MOBILE, WATCH_FEED_HOME, WATCH_FEED_MOBILE, WHATSAPP_STATUS_MEDIA} |
Use this to select what placement on Facebook the ad preview should be for. The API returns an iframe, which is only valid for 24 hours.
required |
creative_featureenum{ig_video_native_subtitle, image_animation, product_browsing, product_metadata_automation, profile_card, standard_enhancements_catalog, text_overlay_translation} |
Creative feature to see previews for
|
dynamic_asset_labelstring |
Provide a label for rendering specific variation of an asset customization ad
|
dynamic_creative_specObject |
Dynamic creative spec for dynamic ads.
supports emoji |
dynamic_customizationObject |
For dynamic ads in multiple languages, specify the customization to be applied to the ad
|
end_datedatetime |
Provide an end date for trip.* parameters in the creative
|
heightint64 |
Custom height of the resulting iframe, recommended at least 280 x 280 for the large right hand size height. Note: the parameter affects only the size of the iframe containing the preview object. It has no affect on the actual size of the previewed ad. |
place_page_idPage ID |
Place page ID to use when rendering a dynamic local ad preview
|
postObject |
Specs for a page post. This field is used when the creative field contains only a Page id as object_id in it. Not supported for ad_format = RIGHT_COLUMN_STANDARDlink URL
Destination URL of the ad
required message UTF-8 string
Post message
supports emoji picture URL
Image URL
name UTF-8 encoded string
Post name
caption UTF-8 encoded string
Post caption
description UTF-8 encoded string
Post description
call_to_action Object
Call to action
supports emoji type enum{BOOK_TRAVEL, CONTACT_US, DONATE, DONATE_NOW, DOWNLOAD, GET_DIRECTIONS, GO_LIVE, INTERESTED, LEARN_MORE, SEE_DETAILS, LIKE_PAGE, MESSAGE_PAGE, RAISE_MONEY, SAVE, SEND_TIP, SHOP_NOW, SIGN_UP, VIEW_INSTAGRAM_PROFILE, INSTAGRAM_MESSAGE, LOYALTY_LEARN_MORE, PURCHASE_GIFT_CARDS, PAY_TO_ACCESS, SEE_MORE, TRY_IN_CAMERA, WHATSAPP_LINK, GET_IN_TOUCH, TRY_NOW, ASK_A_QUESTION, START_A_CHAT, CHAT_NOW, ASK_US, CHAT_WITH_US, BOOK_NOW, CHECK_AVAILABILITY, ORDER_NOW, WHATSAPP_MESSAGE, GET_MOBILE_APP, INSTALL_MOBILE_APP, USE_MOBILE_APP, INSTALL_APP, USE_APP, PLAY_GAME, TRY_DEMO, WATCH_VIDEO, WATCH_MORE, OPEN_LINK, NO_BUTTON, LISTEN_MUSIC, MOBILE_DOWNLOAD, GET_OFFER, GET_OFFER_VIEW, BUY_NOW, BUY_TICKETS, UPDATE_APP, BET_NOW, ADD_TO_CART, SELL_NOW, GET_SHOWTIMES, LISTEN_NOW, GET_EVENT_TICKETS, REMIND_ME, SEARCH_MORE, PRE_REGISTER, SWIPE_UP_PRODUCT, SWIPE_UP_SHOP, PLAY_GAME_ON_FACEBOOK, VISIT_WORLD, OPEN_INSTANT_APP, JOIN_GROUP, GET_PROMOTIONS, SEND_UPDATES, INQUIRE_NOW, VISIT_PROFILE, CHAT_ON_WHATSAPP, EXPLORE_MORE, CONFIRM, JOIN_CHANNEL, MAKE_AN_APPOINTMENT, ASK_ABOUT_SERVICES, BOOK_A_CONSULTATION, GET_A_QUOTE, BUY_VIA_MESSAGE, ASK_FOR_MORE_INFO, VIEW_PRODUCT, VIEW_CHANNEL, WATCH_LIVE_VIDEO, JOIN_LIVE_VIDEO, IMAGINE, CALL, MISSED_CALL, CALL_NOW, CALL_ME, APPLY_NOW, BUY, GET_QUOTE, SUBSCRIBE, RECORD_NOW, VOTE_NOW, GIVE_FREE_RIDES, REGISTER_NOW, OPEN_MESSENGER_EXT, EVENT_RSVP, CIVIC_ACTION, SEND_INVITES, REFER_FRIENDS, REQUEST_TIME, SEE_MENU, SEARCH, TRY_IT, TRY_ON, LINK_CARD, DIAL_CODE, FIND_YOUR_GROUPS, START_ORDER}
The type of the action. Not all types can be used for all
ads. Check
Ads Product Guide
to see which type can be used for based on the objective of your
campaign.
required value ObjectDefault value: Vec
JSON containing the call to action data.
supports emoji android_url stringios_url stringlink URLapp_link stringpage numeric string or integerlink_format enum {VIDEO_LEAD, VIDEO_LPP, VIDEO_NEKO, VIDEO_NON_LINK, VIDEO_SHOP, WHATSAPP_CATALOG_ATTACHMENT}application numeric string or integerlink_title stringsupports emoji link_description stringsupports emoji link_caption stringproduct_link stringget_movie_showtimes booleansponsorship Objectlink URLimage URLShow child parameters video_annotation Objectannotations list<Object>start_time_in_sec int64end_time_in_sec int64link URLlink_title stringlink_description stringlink_caption stringimage_url URLShow child parameters header_color stringlogo_url URLpost_click_cta_title stringpost_click_description_title stringShow child parameters offer_id numeric string or integeroffer_view_id numeric string or integeradvanced_data Objectoffer_id numeric string or integerShow child parameters lead_gen_form_id numeric string or integerreferral_id numeric string or integersearch_dialog_id numeric string or integerfundraiser_campaign_id numeric string or integerevent_id numeric string or integerevent_tour_id numeric string or integerapp_destination enum {MESSENGER, MESSENGER_EXTENSIONS, MESSENGER_GAMES, LINK_CARD, MARKETPLACE, WHATSAPP, INSTAGRAM_DIRECT, INSTAGRAM_LIVE_VIDEO, FACEBOOK_LIVE_VIDEO}app_destination_page_id numeric string or integeris_canvas_video_transition_enabled booleanwhatsapp_number stringpreinput_text stringcustomized_message_page_cta_text stringexternal_offer_provider_id numeric string or integerorigins enum {COMPOSER, CAMERA}object_store_urls array<string>facebook_login_spec Objectfacebook_login_app_id numeric string or integeroffer_type enum {NO_OFFER, PERCENTAGE_BASED, AMOUNT_BASED}offer_pct_call_to_action enum {TEN}offer_amt_call_to_action enum {TEN}Show child parameters product_id numeric string or integergroup_id numeric string or integerchannel_id stringland_on_whatsapp_catalog enum{1, 2}land_on_whatsapp_profile stringShow child parameters Show child parameters photo_replacement_preview_fbid Show child parameters |
product_item_idslist<string> |
A list of Product Item IDs to use when rendering a dynamic ad preview.
|
start_datedatetime |
Provide a start date for trip.* parameters in the creative
|
widthint64 |
Custom width of the resulting iframe, recommended at least 280 x 280 for the large right hand size widths. Note: the parameter affects only the size of the iframe containing the preview object. It has no affect on the actual size of the previewed ad. |
{
"data": [],
"paging": {}
}
| Error Code | Description |
|---|---|
80004 | There have been too many calls to this ad-account. Wait a bit and try again. For more info, please refer to /docs/graph-api/overview/rate-limiting#ads-management. |
100 | Invalid parameter |
200 | Permissions error |