public final class Creative
extends com.google.api.client.json.GenericJson
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Campaign Manager 360 API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json
com.google.api.client.util.GenericData.Flags
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
Constructor and Description |
---|
Creative() |
Modifier and Type | Method and Description |
---|---|
Creative |
clone() |
Long |
getAccountId()
Account ID of this creative.
|
Boolean |
getActive()
Whether the creative is active.
|
List<Size> |
getAdditionalSizes()
Additional sizes associated with a responsive creative.
|
String |
getAdParameters()
Ad parameters user for VPAID creative.
|
List<String> |
getAdTagKeys()
Keywords for a Rich Media creative.
|
Long |
getAdvertiserId()
Required.
|
Boolean |
getAllowScriptAccess()
Whether script access is allowed for this creative.
|
Boolean |
getArchived()
Whether the creative is archived.
|
String |
getArtworkType()
Type of artwork used for the creative.
|
String |
getAuthoringSource()
Source application where creative was authored.
|
String |
getAuthoringTool()
Authoring tool for HTML5 banner creatives.
|
Boolean |
getAutoAdvanceImages()
Whether images are automatically advanced for image gallery creatives.
|
String |
getBackgroundColor()
The 6-character HTML color code, beginning with #, for the background of the window area where
the Flash file is displayed.
|
CreativeClickThroughUrl |
getBackupImageClickThroughUrl()
Click-through URL for backup image.
|
List<String> |
getBackupImageFeatures()
List of feature dependencies that will cause a backup image to be served if the browser that
serves the ad does not support them.
|
String |
getBackupImageReportingLabel()
Reporting label used for HTML5 banner backup image.
|
TargetWindow |
getBackupImageTargetWindow()
Target window for backup image.
|
List<ClickTag> |
getClickTags()
Click tags of the creative.
|
String |
getCommercialId()
Industry standard ID assigned to creative for reach and frequency.
|
List<Long> |
getCompanionCreatives()
List of companion creatives assigned to an in-Stream video creative.
|
List<String> |
getCompatibility()
Compatibilities associated with this creative.
|
Boolean |
getConvertFlashToHtml5()
Whether Flash assets associated with the creative need to be automatically converted to HTML5.
|
List<CreativeCustomEvent> |
getCounterCustomEvents()
List of counter events configured for the creative.
|
List<CreativeAsset> |
getCreativeAssets()
Assets associated with a creative.
|
List<CreativeFieldAssignment> |
getCreativeFieldAssignments()
Creative field assignments for this creative.
|
List<String> |
getCustomKeyValues()
Custom key-values for a Rich Media creative.
|
List<CreativeCustomEvent> |
getExitCustomEvents()
List of exit events configured for the creative.
|
FsCommand |
getFsCommand()
OpenWindow FSCommand of this creative.
|
String |
getHtmlCode()
HTML code for the creative.
|
Boolean |
getHtmlCodeLocked()
Whether HTML code is generated by Campaign Manager or manually entered.
|
Long |
getId()
ID of this creative.
|
DimensionValue |
getIdDimensionValue()
Dimension value for the ID of this creative.
|
String |
getKind()
Identifies what kind of resource this is.
|
LastModifiedInfo |
getLastModifiedInfo()
Creative last modification information.
|
Long |
getLatestTraffickedCreativeId()
Latest Studio trafficked creative ID associated with rich media and VPAID creatives.
|
String |
getMediaDescription()
Description of the audio or video ad.
|
Float |
getMediaDuration()
Creative audio or video duration in seconds.
|
String |
getName()
Required.
|
ObaIcon |
getObaIcon()
Online behavioral advertising icon to be added to the creative.
|
String |
getOverrideCss()
Override CSS value for rich media creatives.
|
VideoOffset |
getProgressOffset()
Amount of time to play the video before counting a view.
|
String |
getRedirectUrl()
URL of hosted image or hosted video or another ad tag.
|
Long |
getRenderingId()
ID of current rendering version.
|
DimensionValue |
getRenderingIdDimensionValue()
Dimension value for the rendering ID of this creative.
|
String |
getRequiredFlashPluginVersion()
The minimum required Flash plugin version for this creative.
|
Integer |
getRequiredFlashVersion()
The internal Flash version for this creative as calculated by Studio.
|
Size |
getSize()
Size associated with this creative.
|
VideoOffset |
getSkipOffset()
Amount of time to play the video before the skip button appears.
|
Boolean |
getSkippable()
Whether the user can choose to skip the creative.
|
Boolean |
getSslCompliant()
Whether the creative is SSL-compliant.
|
Boolean |
getSslOverride()
Whether creative should be treated as SSL compliant even if the system scan shows it's not.
|
Long |
getStudioAdvertiserId()
Studio advertiser ID associated with rich media and VPAID creatives.
|
Long |
getStudioCreativeId()
Studio creative ID associated with rich media and VPAID creatives.
|
Long |
getStudioTraffickedCreativeId()
Studio trafficked creative ID associated with rich media and VPAID creatives.
|
Long |
getSubaccountId()
Subaccount ID of this creative.
|
String |
getThirdPartyBackupImageImpressionsUrl()
Third-party URL used to record backup image impressions.
|
String |
getThirdPartyRichMediaImpressionsUrl()
Third-party URL used to record rich media impressions.
|
List<ThirdPartyTrackingUrl> |
getThirdPartyUrls()
Third-party URLs for tracking in-stream creative events.
|
List<CreativeCustomEvent> |
getTimerCustomEvents()
List of timer events configured for the creative.
|
Long |
getTotalFileSize()
Combined size of all creative assets.
|
String |
getType()
Required.
|
UniversalAdId |
getUniversalAdId()
A Universal Ad ID as per the VAST 4.0 spec.
|
Integer |
getVersion()
The version number helps you keep track of multiple versions of your creative in your reports.
|
Creative |
set(String fieldName,
Object value) |
Creative |
setAccountId(Long accountId)
Account ID of this creative.
|
Creative |
setActive(Boolean active)
Whether the creative is active.
|
Creative |
setAdditionalSizes(List<Size> additionalSizes)
Additional sizes associated with a responsive creative.
|
Creative |
setAdParameters(String adParameters)
Ad parameters user for VPAID creative.
|
Creative |
setAdTagKeys(List<String> adTagKeys)
Keywords for a Rich Media creative.
|
Creative |
setAdvertiserId(Long advertiserId)
Required.
|
Creative |
setAllowScriptAccess(Boolean allowScriptAccess)
Whether script access is allowed for this creative.
|
Creative |
setArchived(Boolean archived)
Whether the creative is archived.
|
Creative |
setArtworkType(String artworkType)
Type of artwork used for the creative.
|
Creative |
setAuthoringSource(String authoringSource)
Source application where creative was authored.
|
Creative |
setAuthoringTool(String authoringTool)
Authoring tool for HTML5 banner creatives.
|
Creative |
setAutoAdvanceImages(Boolean autoAdvanceImages)
Whether images are automatically advanced for image gallery creatives.
|
Creative |
setBackgroundColor(String backgroundColor)
The 6-character HTML color code, beginning with #, for the background of the window area where
the Flash file is displayed.
|
Creative |
setBackupImageClickThroughUrl(CreativeClickThroughUrl backupImageClickThroughUrl)
Click-through URL for backup image.
|
Creative |
setBackupImageFeatures(List<String> backupImageFeatures)
List of feature dependencies that will cause a backup image to be served if the browser that
serves the ad does not support them.
|
Creative |
setBackupImageReportingLabel(String backupImageReportingLabel)
Reporting label used for HTML5 banner backup image.
|
Creative |
setBackupImageTargetWindow(TargetWindow backupImageTargetWindow)
Target window for backup image.
|
Creative |
setClickTags(List<ClickTag> clickTags)
Click tags of the creative.
|
Creative |
setCommercialId(String commercialId)
Industry standard ID assigned to creative for reach and frequency.
|
Creative |
setCompanionCreatives(List<Long> companionCreatives)
List of companion creatives assigned to an in-Stream video creative.
|
Creative |
setCompatibility(List<String> compatibility)
Compatibilities associated with this creative.
|
Creative |
setConvertFlashToHtml5(Boolean convertFlashToHtml5)
Whether Flash assets associated with the creative need to be automatically converted to HTML5.
|
Creative |
setCounterCustomEvents(List<CreativeCustomEvent> counterCustomEvents)
List of counter events configured for the creative.
|
Creative |
setCreativeAssets(List<CreativeAsset> creativeAssets)
Assets associated with a creative.
|
Creative |
setCreativeFieldAssignments(List<CreativeFieldAssignment> creativeFieldAssignments)
Creative field assignments for this creative.
|
Creative |
setCustomKeyValues(List<String> customKeyValues)
Custom key-values for a Rich Media creative.
|
Creative |
setExitCustomEvents(List<CreativeCustomEvent> exitCustomEvents)
List of exit events configured for the creative.
|
Creative |
setFsCommand(FsCommand fsCommand)
OpenWindow FSCommand of this creative.
|
Creative |
setHtmlCode(String htmlCode)
HTML code for the creative.
|
Creative |
setHtmlCodeLocked(Boolean htmlCodeLocked)
Whether HTML code is generated by Campaign Manager or manually entered.
|
Creative |
setId(Long id)
ID of this creative.
|
Creative |
setIdDimensionValue(DimensionValue idDimensionValue)
Dimension value for the ID of this creative.
|
Creative |
setKind(String kind)
Identifies what kind of resource this is.
|
Creative |
setLastModifiedInfo(LastModifiedInfo lastModifiedInfo)
Creative last modification information.
|
Creative |
setLatestTraffickedCreativeId(Long latestTraffickedCreativeId)
Latest Studio trafficked creative ID associated with rich media and VPAID creatives.
|
Creative |
setMediaDescription(String mediaDescription)
Description of the audio or video ad.
|
Creative |
setMediaDuration(Float mediaDuration)
Creative audio or video duration in seconds.
|
Creative |
setName(String name)
Required.
|
Creative |
setObaIcon(ObaIcon obaIcon)
Online behavioral advertising icon to be added to the creative.
|
Creative |
setOverrideCss(String overrideCss)
Override CSS value for rich media creatives.
|
Creative |
setProgressOffset(VideoOffset progressOffset)
Amount of time to play the video before counting a view.
|
Creative |
setRedirectUrl(String redirectUrl)
URL of hosted image or hosted video or another ad tag.
|
Creative |
setRenderingId(Long renderingId)
ID of current rendering version.
|
Creative |
setRenderingIdDimensionValue(DimensionValue renderingIdDimensionValue)
Dimension value for the rendering ID of this creative.
|
Creative |
setRequiredFlashPluginVersion(String requiredFlashPluginVersion)
The minimum required Flash plugin version for this creative.
|
Creative |
setRequiredFlashVersion(Integer requiredFlashVersion)
The internal Flash version for this creative as calculated by Studio.
|
Creative |
setSize(Size size)
Size associated with this creative.
|
Creative |
setSkipOffset(VideoOffset skipOffset)
Amount of time to play the video before the skip button appears.
|
Creative |
setSkippable(Boolean skippable)
Whether the user can choose to skip the creative.
|
Creative |
setSslCompliant(Boolean sslCompliant)
Whether the creative is SSL-compliant.
|
Creative |
setSslOverride(Boolean sslOverride)
Whether creative should be treated as SSL compliant even if the system scan shows it's not.
|
Creative |
setStudioAdvertiserId(Long studioAdvertiserId)
Studio advertiser ID associated with rich media and VPAID creatives.
|
Creative |
setStudioCreativeId(Long studioCreativeId)
Studio creative ID associated with rich media and VPAID creatives.
|
Creative |
setStudioTraffickedCreativeId(Long studioTraffickedCreativeId)
Studio trafficked creative ID associated with rich media and VPAID creatives.
|
Creative |
setSubaccountId(Long subaccountId)
Subaccount ID of this creative.
|
Creative |
setThirdPartyBackupImageImpressionsUrl(String thirdPartyBackupImageImpressionsUrl)
Third-party URL used to record backup image impressions.
|
Creative |
setThirdPartyRichMediaImpressionsUrl(String thirdPartyRichMediaImpressionsUrl)
Third-party URL used to record rich media impressions.
|
Creative |
setThirdPartyUrls(List<ThirdPartyTrackingUrl> thirdPartyUrls)
Third-party URLs for tracking in-stream creative events.
|
Creative |
setTimerCustomEvents(List<CreativeCustomEvent> timerCustomEvents)
List of timer events configured for the creative.
|
Creative |
setTotalFileSize(Long totalFileSize)
Combined size of all creative assets.
|
Creative |
setType(String type)
Required.
|
Creative |
setUniversalAdId(UniversalAdId universalAdId)
A Universal Ad ID as per the VAST 4.0 spec.
|
Creative |
setVersion(Integer version)
The version number helps you keep track of multiple versions of your creative in your reports.
|
getFactory, setFactory, toPrettyString, toString
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys
clear, containsKey, containsValue, isEmpty, keySet, size, values
finalize, getClass, notify, notifyAll, wait, wait, wait
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
public Long getAccountId()
null
for nonepublic Creative setAccountId(Long accountId)
accountId
- accountId or null
for nonepublic Boolean getActive()
null
for nonepublic Creative setActive(Boolean active)
active
- active or null
for nonepublic String getAdParameters()
null
for nonepublic Creative setAdParameters(String adParameters)
adParameters
- adParameters or null
for nonepublic List<String> getAdTagKeys()
null
for nonepublic Creative setAdTagKeys(List<String> adTagKeys)
adTagKeys
- adTagKeys or null
for nonepublic List<Size> getAdditionalSizes()
null
for nonepublic Creative setAdditionalSizes(List<Size> additionalSizes)
additionalSizes
- additionalSizes or null
for nonepublic Long getAdvertiserId()
null
for nonepublic Creative setAdvertiserId(Long advertiserId)
advertiserId
- advertiserId or null
for nonepublic Boolean getAllowScriptAccess()
null
for nonepublic Creative setAllowScriptAccess(Boolean allowScriptAccess)
allowScriptAccess
- allowScriptAccess or null
for nonepublic Boolean getArchived()
null
for nonepublic Creative setArchived(Boolean archived)
archived
- archived or null
for nonepublic String getArtworkType()
null
for nonepublic Creative setArtworkType(String artworkType)
artworkType
- artworkType or null
for nonepublic String getAuthoringSource()
null
for nonepublic Creative setAuthoringSource(String authoringSource)
authoringSource
- authoringSource or null
for nonepublic String getAuthoringTool()
null
for nonepublic Creative setAuthoringTool(String authoringTool)
authoringTool
- authoringTool or null
for nonepublic Boolean getAutoAdvanceImages()
null
for nonepublic Creative setAutoAdvanceImages(Boolean autoAdvanceImages)
autoAdvanceImages
- autoAdvanceImages or null
for nonepublic String getBackgroundColor()
null
for nonepublic Creative setBackgroundColor(String backgroundColor)
backgroundColor
- backgroundColor or null
for nonepublic CreativeClickThroughUrl getBackupImageClickThroughUrl()
null
for nonepublic Creative setBackupImageClickThroughUrl(CreativeClickThroughUrl backupImageClickThroughUrl)
backupImageClickThroughUrl
- backupImageClickThroughUrl or null
for nonepublic List<String> getBackupImageFeatures()
null
for nonepublic Creative setBackupImageFeatures(List<String> backupImageFeatures)
backupImageFeatures
- backupImageFeatures or null
for nonepublic String getBackupImageReportingLabel()
null
for nonepublic Creative setBackupImageReportingLabel(String backupImageReportingLabel)
backupImageReportingLabel
- backupImageReportingLabel or null
for nonepublic TargetWindow getBackupImageTargetWindow()
null
for nonepublic Creative setBackupImageTargetWindow(TargetWindow backupImageTargetWindow)
backupImageTargetWindow
- backupImageTargetWindow or null
for nonepublic List<ClickTag> getClickTags()
null
for nonepublic Creative setClickTags(List<ClickTag> clickTags)
clickTags
- clickTags or null
for nonepublic String getCommercialId()
null
for nonepublic Creative setCommercialId(String commercialId)
commercialId
- commercialId or null
for nonepublic List<Long> getCompanionCreatives()
null
for nonepublic Creative setCompanionCreatives(List<Long> companionCreatives)
companionCreatives
- companionCreatives or null
for nonepublic List<String> getCompatibility()
null
for nonepublic Creative setCompatibility(List<String> compatibility)
compatibility
- compatibility or null
for nonepublic Boolean getConvertFlashToHtml5()
null
for nonepublic Creative setConvertFlashToHtml5(Boolean convertFlashToHtml5)
convertFlashToHtml5
- convertFlashToHtml5 or null
for nonepublic List<CreativeCustomEvent> getCounterCustomEvents()
null
for nonepublic Creative setCounterCustomEvents(List<CreativeCustomEvent> counterCustomEvents)
counterCustomEvents
- counterCustomEvents or null
for nonepublic List<CreativeAsset> getCreativeAssets()
null
for nonepublic Creative setCreativeAssets(List<CreativeAsset> creativeAssets)
creativeAssets
- creativeAssets or null
for nonepublic List<CreativeFieldAssignment> getCreativeFieldAssignments()
null
for nonepublic Creative setCreativeFieldAssignments(List<CreativeFieldAssignment> creativeFieldAssignments)
creativeFieldAssignments
- creativeFieldAssignments or null
for nonepublic List<String> getCustomKeyValues()
null
for nonepublic Creative setCustomKeyValues(List<String> customKeyValues)
customKeyValues
- customKeyValues or null
for nonepublic List<CreativeCustomEvent> getExitCustomEvents()
null
for nonepublic Creative setExitCustomEvents(List<CreativeCustomEvent> exitCustomEvents)
exitCustomEvents
- exitCustomEvents or null
for nonepublic FsCommand getFsCommand()
null
for nonepublic Creative setFsCommand(FsCommand fsCommand)
fsCommand
- fsCommand or null
for nonepublic String getHtmlCode()
null
for nonepublic Creative setHtmlCode(String htmlCode)
htmlCode
- htmlCode or null
for nonepublic Boolean getHtmlCodeLocked()
null
for nonepublic Creative setHtmlCodeLocked(Boolean htmlCodeLocked)
htmlCodeLocked
- htmlCodeLocked or null
for nonepublic Long getId()
null
for nonepublic Creative setId(Long id)
id
- id or null
for nonepublic DimensionValue getIdDimensionValue()
null
for nonepublic Creative setIdDimensionValue(DimensionValue idDimensionValue)
idDimensionValue
- idDimensionValue or null
for nonepublic String getKind()
null
for nonepublic Creative setKind(String kind)
kind
- kind or null
for nonepublic LastModifiedInfo getLastModifiedInfo()
null
for nonepublic Creative setLastModifiedInfo(LastModifiedInfo lastModifiedInfo)
lastModifiedInfo
- lastModifiedInfo or null
for nonepublic Long getLatestTraffickedCreativeId()
null
for nonepublic Creative setLatestTraffickedCreativeId(Long latestTraffickedCreativeId)
latestTraffickedCreativeId
- latestTraffickedCreativeId or null
for nonepublic String getMediaDescription()
null
for nonepublic Creative setMediaDescription(String mediaDescription)
mediaDescription
- mediaDescription or null
for nonepublic Float getMediaDuration()
null
for nonepublic Creative setMediaDuration(Float mediaDuration)
mediaDuration
- mediaDuration or null
for nonepublic String getName()
null
for nonepublic Creative setName(String name)
name
- name or null
for nonepublic ObaIcon getObaIcon()
null
for nonepublic Creative setObaIcon(ObaIcon obaIcon)
obaIcon
- obaIcon or null
for nonepublic String getOverrideCss()
null
for nonepublic Creative setOverrideCss(String overrideCss)
overrideCss
- overrideCss or null
for nonepublic VideoOffset getProgressOffset()
null
for nonepublic Creative setProgressOffset(VideoOffset progressOffset)
progressOffset
- progressOffset or null
for nonepublic String getRedirectUrl()
null
for nonepublic Creative setRedirectUrl(String redirectUrl)
redirectUrl
- redirectUrl or null
for nonepublic Long getRenderingId()
null
for nonepublic Creative setRenderingId(Long renderingId)
renderingId
- renderingId or null
for nonepublic DimensionValue getRenderingIdDimensionValue()
null
for nonepublic Creative setRenderingIdDimensionValue(DimensionValue renderingIdDimensionValue)
renderingIdDimensionValue
- renderingIdDimensionValue or null
for nonepublic String getRequiredFlashPluginVersion()
null
for nonepublic Creative setRequiredFlashPluginVersion(String requiredFlashPluginVersion)
requiredFlashPluginVersion
- requiredFlashPluginVersion or null
for nonepublic Integer getRequiredFlashVersion()
null
for nonepublic Creative setRequiredFlashVersion(Integer requiredFlashVersion)
requiredFlashVersion
- requiredFlashVersion or null
for nonepublic Size getSize()
null
for nonepublic Creative setSize(Size size)
size
- size or null
for nonepublic VideoOffset getSkipOffset()
null
for nonepublic Creative setSkipOffset(VideoOffset skipOffset)
skipOffset
- skipOffset or null
for nonepublic Boolean getSkippable()
null
for nonepublic Creative setSkippable(Boolean skippable)
skippable
- skippable or null
for nonepublic Boolean getSslCompliant()
null
for nonepublic Creative setSslCompliant(Boolean sslCompliant)
sslCompliant
- sslCompliant or null
for nonepublic Boolean getSslOverride()
null
for nonepublic Creative setSslOverride(Boolean sslOverride)
sslOverride
- sslOverride or null
for nonepublic Long getStudioAdvertiserId()
null
for nonepublic Creative setStudioAdvertiserId(Long studioAdvertiserId)
studioAdvertiserId
- studioAdvertiserId or null
for nonepublic Long getStudioCreativeId()
null
for nonepublic Creative setStudioCreativeId(Long studioCreativeId)
studioCreativeId
- studioCreativeId or null
for nonepublic Long getStudioTraffickedCreativeId()
null
for nonepublic Creative setStudioTraffickedCreativeId(Long studioTraffickedCreativeId)
studioTraffickedCreativeId
- studioTraffickedCreativeId or null
for nonepublic Long getSubaccountId()
null
for nonepublic Creative setSubaccountId(Long subaccountId)
subaccountId
- subaccountId or null
for nonepublic String getThirdPartyBackupImageImpressionsUrl()
null
for nonepublic Creative setThirdPartyBackupImageImpressionsUrl(String thirdPartyBackupImageImpressionsUrl)
thirdPartyBackupImageImpressionsUrl
- thirdPartyBackupImageImpressionsUrl or null
for nonepublic String getThirdPartyRichMediaImpressionsUrl()
null
for nonepublic Creative setThirdPartyRichMediaImpressionsUrl(String thirdPartyRichMediaImpressionsUrl)
thirdPartyRichMediaImpressionsUrl
- thirdPartyRichMediaImpressionsUrl or null
for nonepublic List<ThirdPartyTrackingUrl> getThirdPartyUrls()
null
for nonepublic Creative setThirdPartyUrls(List<ThirdPartyTrackingUrl> thirdPartyUrls)
thirdPartyUrls
- thirdPartyUrls or null
for nonepublic List<CreativeCustomEvent> getTimerCustomEvents()
null
for nonepublic Creative setTimerCustomEvents(List<CreativeCustomEvent> timerCustomEvents)
timerCustomEvents
- timerCustomEvents or null
for nonepublic Long getTotalFileSize()
null
for nonepublic Creative setTotalFileSize(Long totalFileSize)
totalFileSize
- totalFileSize or null
for nonepublic String getType()
null
for nonepublic Creative setType(String type)
type
- type or null
for nonepublic UniversalAdId getUniversalAdId()
null
for nonepublic Creative setUniversalAdId(UniversalAdId universalAdId)
universalAdId
- universalAdId or null
for nonepublic Integer getVersion()
null
for nonepublic Creative setVersion(Integer version)
version
- version or null
for nonepublic Creative set(String fieldName, Object value)
set
in class com.google.api.client.json.GenericJson
public Creative clone()
clone
in class com.google.api.client.json.GenericJson
Copyright © 2011–2025 Google. All rights reserved.