Package com.restfb.types.ads

Klasse AdCreativeLinkData

java.lang.Object
com.restfb.types.AbstractFacebookType
com.restfb.types.ads.AdCreativeLinkData
Alle implementierten Schnittstellen:
HasMessage, Serializable
public class AdCreativeLinkData extends AbstractFacebookType implements HasMessage
Represents the AdCreativeLinkData Marketing API type
Siehe auch:

  • Konstruktordetails

  • Methodendetails

    • getAdditionalImageIndex

      public Long getAdditionalImageIndex()
      Gibt zurück:
      The index (zero based) of the image from the additionalimages array to use as the ad image for a dynamic product ad

    • setAdditionalImageIndex

      public void setAdditionalImageIndex(Long additionalImageIndex)
      The index (zero based) of the image from the additionalimages array to use as the ad image for a dynamic product ad

    • getAppLinkSpec

      public AdCreativeLinkDataAppLinkSpec getAppLinkSpec()
      Gibt zurück:
      Native deeplinks attached to the post

    • setAppLinkSpec

      public void setAppLinkSpec(AdCreativeLinkDataAppLinkSpec appLinkSpec)
      Native deeplinks attached to the post

    • getAttachmentStyle

      public String getAttachmentStyle()
      Gibt zurück:
      The style of the attachment.

    • setAttachmentStyle

      public void setAttachmentStyle(String attachmentStyle)
      The style of the attachment.

    • getBrandedContentSponsorPageId

      public String getBrandedContentSponsorPageId()
      Gibt zurück:
      The branded content sponsor page id.

    • setBrandedContentSponsorPageId

      public void setBrandedContentSponsorPageId(String brandedContentSponsorPageId)
      The branded content sponsor page id.

    • getBrandedContentSponsorRelationship

      public String getBrandedContentSponsorRelationship()
      Gibt zurück:
      The branded content sponsor relationship option.

    • setBrandedContentSponsorRelationship

      public void setBrandedContentSponsorRelationship(String brandedContentSponsorRelationship)
      The branded content sponsor relationship option.

    • getCallToAction

      public AdCreativeLinkDataCallToAction getCallToAction()
      Gibt zurück:
      An optional call to action button

    • setCallToAction

      public void setCallToAction(AdCreativeLinkDataCallToAction callToAction)
      An optional call to action button. If not specified, on Instagram, a default CTA would be used, {"type":"LEARN_MORE","value": {"link":,}}.

    • getCanvasEnabled

      public Boolean getCanvasEnabled()
      Gibt zurück:
      If canvas experience is enabled post click

    • setCanvasEnabled

      public void setCanvasEnabled(Boolean canvasEnabled)
      If canvas experience is enabled post click

    • getCaption

      public String getCaption()
      Gibt zurück:
      Link caption.

    • setCaption

      public void setCaption(String caption)
      Link caption. Overwrites the caption under the title in the link on Facebook. See post for more info. This setting is not used on Instagram.

    • getChildAttachments

      public List<AdCreativeLinkDataChildAttachment> getChildAttachments()

    • setChildAttachments

      public void setChildAttachments(List<AdCreativeLinkDataChildAttachment> childAttachments)

    • getDescription

      public String getDescription()
      Gibt zurück:
      Link description.

    • setDescription

      public void setDescription(String description)
      Link description. Overwrites the description in the link on Facebook. See post for more info. This setting is not used on Instagram.

    • getEventId

      public String getEventId()
      Gibt zurück:
      The id of a Facebook event.

    • setEventId

      public void setEventId(String eventId)
      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.

    • getForceSingleLink

      public Boolean getForceSingleLink()
      Gibt zurück:
      Whether to force the post to render in a single link format

    • setForceSingleLink

      public void setForceSingleLink(Boolean forceSingleLink)
      Whether to force the post to render in a single link format

    • getImageCrops

      public AdsImageCrops getImageCrops()
      Gibt zurück:
      How to the image should be cropped.

    • setImageCrops

      public void setImageCrops(AdsImageCrops imageCrops)
      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.

    • getImageHash

      public String getImageHash()
      Gibt zurück:
      Hash of an image in your image library with Facebook.

    • setImageHash

      public void setImageHash(String imageHash)
      Hash of an image in your image library with Facebook. Specify this field or picture but not both

    • getLink

      public String getLink()
      Gibt zurück:
      Link url

    • setLink

      public void setLink(String link)
      Link url. See post for more info. This field is required for a carousel ad .

    • getMessage

      public String getMessage()
      Angegeben von:
      getMessage in Schnittstelle HasMessage
      Gibt zurück:
      The main body of the post

    • setMessage

      public void setMessage(String message)
      The main body of the post. See post for more info. This field is required for a carousel ad .

    • getMultiShareEndCard

      public Boolean getMultiShareEndCard()
      Gibt zurück:
      If set to false, removes the end card which displays the page icon.

    • setMultiShareEndCard

      public void setMultiShareEndCard(Boolean multiShareEndCard)
      If set to false, removes the end card which displays the page icon. Default is true. Used by carousel ads.

    • getMultiShareOptimized

      public Boolean getMultiShareOptimized()
      Gibt zurück:
      If set to true, automatically select and order images and links.

    • setMultiShareOptimized

      public void setMultiShareOptimized(Boolean multiShareOptimized)
      If set to true, automatically select and order images and links. Default is true. Used by carousel ads.

    • getName

      public String getName()
      Gibt zurück:
      Name of the link.

    • setName

      public void setName(String name)
      Name of the link. Overwrites the title of the link preview. See post for more info.

    • getOfferId

      public String getOfferId()
      Gibt zurück:
      The id of a Facebook native offer.

    • setOfferId

      public void setOfferId(String offerId)
      The id of a Facebook native offer.

    • getPageWelcomeMessage

      public String getPageWelcomeMessage()
      Gibt zurück:
      A welcome text from page to user on Messenger once a user performs send message action on an ad.

    • setPageWelcomeMessage

      public void setPageWelcomeMessage(String pageWelcomeMessage)
      A welcome text from page to user on Messenger once a user performs send message action on an ad.

    • getPicture

      public String getPicture()
      Gibt zurück:
      URL of a picture to use in the post.

    • setPicture

      public void setPicture(String picture)
      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

    • getPostClickConfiguration

      public AdCreativePostClickConfiguration getPostClickConfiguration()

    • setPostClickConfiguration

      public void setPostClickConfiguration(AdCreativePostClickConfiguration postClickConfiguration)

    • getRetailerItemIds

      public List<String> getRetailerItemIds()
      Gibt zurück:
      List of product IDs provided by the advertiser for Collections

    • setRetailerItemIds

      public void setRetailerItemIds(List<String> retailerItemIds)
      List of product IDs provided by the advertiser for Collections