LibraryImageAd

Text Size: A A A

Save to My Help

Save this article to My Help for easy reference. You can visit the article at any time from any computer.

Replace an article

You have reached the maximum number of saved articles. Your oldest saved article will be replaced with the new one.

The LibraryImageAd data object represents an image ad.

Restrictions *
Element Data Type Description Add Full-Up
accountID string The ID of the account. RO RO
adFormat AdFormat The format of the ad. RO RO
adSecurity AdSecurity The security of the ad. Opt Opt
adSizeID long The ID of the ad size (based on the width and height of the ad). RO RO
alternateText string The short description (alternate text) that is displayed when the ad does not render properly. Opt Opt
associatedTo
Placement
boolean Indicates whether the ad is associated with an a placement. RO RO
clickToCallNo string The phone number (to call) associated with the mobile ad. This field is only applicable when screen type is mobile.
If screen type is mobile, either click to call number or click through URL is required. Do not specify a click tracking URL if you specify the click to call number.
Opt opt
compositeClick
ThroughURL
CompositeURL The URL to go to when the user clicks on the ad. Req Req
createTimestamp dateTime The date the ad was added. RO RO
editorialStatus EditorialStatus The editorial status of the ad. RO RO
externalCreative
URL
string The URL of the externally hosted creative. This is required if the ID of the local creative is not provided. The URL of the external creative cannot exceed 400 characters. Opt Opt
folderID long The ID of the folder for the ad. By default, the ad will be placed under the root folder of the current account. Opt Opt
height long The height of the ad. Opt RO
ID long The ID of the ad. RO Req
imageCreative
ID
long The ID of the creative for the ad. This is required if the URL for the externally hosted creative is not provided. Opt Opt
impressionTracking
URL
string The URL of the impression tracking system for the ad. Opt Opt
isLocalCreative boolean If true, the ad uses creatives from the creative library. RO RO
lastUpdateTimestamp dateTime The date the ad was last updated. RO RO
name string The name of the ad. Req Req
postCustomAdCode string The additional HTML to be appended to the ad code of hosted image ad. Opt Opt
preCustomAdCode string The additional HTML to be prepended to the ad code of hosted image ad. Opt Opt
screenType ScreenType The ad screen type. The default value is WEB. Opt Opt
status LibraryAdStatus The status of the ad. RO RO
suppressAptAdMarker boolean Indicates if the APT from Yahoo! platform ad marker must be suppressed (true) or displayed (false). Opt Opt
tagLine string The tag line or text (that provides additional information or enhances the message) to display with the image associated with the ad. This field is only applicable when screen type is mobile. Opt Opt
type long The type of ad. For:
TEXT ad, 1
MOBILE ad, 2
IMAGE ad, 3
FLASH ad, 4
VIDEO ad, 5
AUDIO ad, 6
RICHMEDIA ad, 7
THIRDPARTY ad, 8
CUSTOM ad, 9
CUSTOMIZABLEFLASH ad, 10
DYNAMICFLASH ad, 11
CLICKABLEVIDEO ad, 12
INTERACTIVEVIDEO ad, 13
CUSTOMIZABLECLICKABLEVIDEO ad, 14
BUMPERVIDEO ad, 15
OVERLAYCLICKTOSITE ad, 16
OVERLAYCLICKTOVIDEO ad, 17
INTERACTIVEPHARMA ad, 18
CUSTOMTEMPLATE ad, 19.
RO RO
weight long The weight of the ad. RO RO
width long The width of the ad. Opt RO
windowTarget WindowTarget The target window for the ad landing page. Req Req
* See Restrictions for more information.

Was this information helpful?      

My Help

Forgot your ID or password?

Sign In

Sign in to see your account information saved articles and more.
  1. Recent Searches (0)

  2. Saved Articles