The specification for a link ad or carousel ad.
Field | Description |
---|---|
ad_context string | String that represents the ad context provided by advertiser |
additional_image_index int32 | 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_style enum | The style of the attachment |
boosted_product_set_id numeric string | The id of the product set currently being boosted |
branded_content_shared_to_sponsor_status string | The branded content shared to sponsor option |
branded_content_sponsor_page_id numeric string | The branded content sponsor page id |
branded_content_sponsor_relationship string | 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, |
caption string | 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_thumbnails list<AdCreativeCollectionThumbnailInfo> | List of Canvas media component IDs and their square cropping information provided by the advertiser for Collection style feed rendering |
customization_rules_spec list<AdCustomizationRuleSpec> | Customization rules for a dynamic ad |
description string | 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_id numeric 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_link bool | Whether to force the post to render in a single link format |
format_option enum {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_hash string | 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 |
link string | 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 |
message string | The main body of the post. See post for more info. This field is required for a carousel ad |
multi_share_end_card bool | If set to false, removes the end card which displays the page icon. Default is true. Used by carousel ads |
multi_share_optimized bool | If set to true, automatically select and order images and links. Default is true. Used by carousel ads |
name string | 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_id numeric string | The id of a Facebook native offer |
page_welcome_message string | A welcome text from page to user on Messenger once a user performs send message action on an ad |
picture string | URL of a picture to use in the post. Specify this field or |
post_click_configuration AdCreativePostClickConfiguration | Customized contents provided by the advertiser for the ad post-click experience |
preferred_image_tags list<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_tags list<string> | Selects which video to use, if you have added tags to your video. |
retailer_item_ids list<string> | List of product IDs provided by the advertiser for Collections |
show_multiple_images bool | 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_info AdCreativeLinkDataSponsorshipInfoSpec | Details of the sponsor for the event ad |
static_fallback_spec AdCreativeStaticFallbackSpec | Give a fallback creative for dynamic ads |
use_flexible_image_aspect_ratio bool | Default value is |