Marketing API Version

Ad Creative Link Data

Reading

The specification for a link ad or carousel ad .

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

Parameters

This endpoint doesn't have any parameters.

Fields

FieldDescription

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 {link, default}

The style of the attachment.

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, {"type":"LEARN_MORE","value": {"link":<LINK VALUE OF LINK_DATA>,}}. Note that LIKE_PAGE is not supported.

caption

string

Link caption. Overwrites the caption under the title in the link. The caption must be an actual URLs and should accurately reflect the URL and associated advertiser or business someone visits when they click on it. See post for more info. This setting is not used on Instagram.

child_attachments

A 2-5 element array of link objects required for carousel ads. If multi_share_optimized is set to true, this array could have up to 10 objects. Facebook will automatically optimize the order in which the carousel cards are shown and display the top 5. We strongly recommend that you use at least 3 attachments for achieving optimal performance; allowing minimum of 2 attachments is for enabling lightweight integrations and using 2 objects might result in sub-optimal campaign results.
If this ad creative is used for an Instagram Carousel ad, you will need to have at least 3 attachments for MOBILE_APP_INSTALLS ads and 2 for the other objectives. If more than 5 are given, only the first 5 will be shown on Instagram, even if multi_share_optimized is true.

description

string

Link description. Overwrites the description in the link on Facebook. See post for more info. This setting is not used on Instagram.

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 link points to the ticketing website of this Facebook event.

force_single_link

bool

Whether to force the post to render in a single link format

image_crops

How to the image should be cropped. Different placements use different crop specs. For example, Facebook News Feed uses the crop spec with 191x100 key, and Instagram uses 100x100 crop spec.

image_hash

string

Hash of an image in your image library with Facebook. Specify this field or picture but not both

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. Overwrites the title of the link preview. See post for more info.

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 image_hash but not both. See post for more info. The image specified at the URL will be saved into the ad accounts image library

post_click_configuration

AdCreativePostClickConfiguration

Customized contents provided by the advertiser for the ad post-click experience.

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

Edges

No edges

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.