The specification for a link ad or carousel ad.
| Field | Description |
|---|---|
ad_contextstring | String that represents the ad context provided by advertiser |
additional_image_indexint32 | The index (zero based) of the image from the additional images array to use as the ad image for a dynamic product ad |
app_link_spec | Native deeplinks attached to the post |
attachment_styleenum | The style of the attachment |
boosted_product_set_idnumeric string | Combined with “product_set_id” to promote a specific Product Set while including other products from the Product Catalog in ads. Use the All Products Product Set ID in the “product_set_id” field and the specific Product Set ID in the “boosted_product_set_id” field. This will ensure products from the set are shown more often compared to other products from the Product Catalog. |
branded_content_shared_to_sponsor_statusstring | The branded content shared to sponsor option |
branded_content_sponsor_page_idnumeric string | The branded content sponsor page id |
branded_content_sponsor_relationshipstring | The branded content sponsor relationship option |
call_to_action | An optional call to action button. If not specified, on Instagram, a default CTA would be used, |
captionstring | Link caption. Overwrites the caption under the title in the link. The caption must be an actual URL and should accurately reflect the URL and associated advertiser or business someone visits when they click the link. See Post, Reference for more info. You do not use this setting in Instagram ads. |
child_attachments | A 2-5 element array of link objects required for carousel ads. If |
collection_thumbnailslist<AdCreativeCollectionThumbnailInfo> | List of Canvas media component IDs and their square cropping information provided by the advertiser for Collection style feed rendering |
customization_rules_speclist<AdCustomizationRuleSpec> | Customization rules for a dynamic ad |
descriptionstring | Link description. Overwrites the description in the link when your ad displays. See Post, Reference for more information. You do not use this setting for Instagram ads. |
event_idnumeric string | The id of a Facebook event. This is only to be used if this creative is for a Website Clicks campaign, the Call To Action is Buy Tickets, and the |
force_single_linkbool | Whether to force the post to render in a single link format |
format_optionenum {carousel_ar_effects, carousel_images_multi_items, carousel_images_single_item, carousel_slideshows, collection_video, single_image} | Options on how to render your ad. If not specified, default is |
image_crops | How to the image should be cropped. You can use the crop spec with |
image_hashstring | Hash of an image in your ad account's image library. Provide a value for this field or `picture` but not both |
image_layer_specs | How to render image overlays on a dynamic item in Dynamic Ads |
image_overlay_spec | How to render image overlays on a dynamic item in Dynamic Ads |
linkstring | Link url. This url is required to be the same as the CTA link url. See post for more info. This field is required for a carousel ad |
messagestring | The main body of the post. See post for more info. This field is required for a carousel ad |
multi_share_end_cardbool | If set to false, removes the end card which displays the page icon. Default is true. Used by carousel ads |
multi_share_optimizedbool | If set to true, automatically select and order images and links. Default is true. Used by carousel ads |
namestring | Name of the link. Overwrite the title of the link when you preview the ad. Facebook ignores this value when call-to-action type is LIKE_PAGE. See Post, Reference for more information |
offer_idnumeric string | The id of a Facebook native offer |
page_welcome_messagestring | The customized greeting message that is presented to the user when they are redirected from a click to Messenger or click to Whatsapp ad to the messaging app. For click to Whatsapp ads, this string is a JSON object passed as a string. It can be an autofill message, an icebreaker or an automated greeting message with an optional call to action. |
picturestring | URL of a picture to use in the post. Specify this field or |
post_click_configurationAdCreativePostClickConfiguration | Customized contents provided by the advertiser for the ad post-click experience |
preferred_image_tagslist<string> | Select which image to display by its tag, if you have added tags to your images. Tags are specified in order of priority to try |
preferred_video_tagslist<string> | Selects which video to use, if you have added tags to your video. |
retailer_item_idslist<string> | List of product IDs provided by the advertiser for Collections |
show_multiple_imagesbool | Use with force_single_link = true in order to show a single dynamic item but in carousel format using multiple images from the catalog. See dynamic product ad |
sponsorship_infoAdCreativeLinkDataSponsorshipInfoSpec | Details of the sponsor for the event ad |
static_fallback_specAdCreativeStaticFallbackSpec | Give a fallback creative for dynamic ads |
use_flexible_image_aspect_ratiobool | Default value is |