Creative (Display & Video 360 API v4-rev20260505-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.displayvideo.v4.model.Creative

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Creative
extends com.google.api.client.json.GenericJson
```
A single Creative.
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 Display & Video 360 API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Creative()

Constructors
Constructor and Description
`Creative()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Creative`	`clone()`
`List<Dimensions>`	`getAdditionalDimensions()` Optional.
`Long`	`getAdvertiserId()` Output only.
`String`	`getAppendedTag()` Optional.
`List<AssetAssociation>`	`getAssets()` Required.
`Long`	`getCmPlacementId()` Output only.
`CmTrackingAd`	`getCmTrackingAd()` Optional.
`List<Long>`	`getCompanionCreativeIds()` Optional.
`List<CounterEvent>`	`getCounterEvents()` Optional.
`String`	`getCreateTime()` Output only.
`List<String>`	`getCreativeAttributes()` Output only.
`Long`	`getCreativeId()` Output only.
`String`	`getCreativeType()` Required.
`Dimensions`	`getDimensions()` Required.
`String`	`getDisplayName()` Required.
`Boolean`	`getDynamic()` Output only.
`String`	`getEntityStatus()` Required.
`List<ExitEvent>`	`getExitEvents()` Required.
`String`	`getExpandingDirection()` Optional.
`Boolean`	`getExpandOnHover()` Optional.
`String`	`getHostingSource()` Required.
`Boolean`	`getHtml5Video()` Output only.
`Boolean`	`getIasCampaignMonitoring()` Optional.
`String`	`getIntegrationCode()` Optional.
`String`	`getJsTrackerUrl()` Optional.
`List<Long>`	`getLineItemIds()` Output only.
`String`	`getMediaDuration()` Output only.
`Boolean`	`getMp3Audio()` Output only.
`String`	`getName()` Output only.
`String`	`getNotes()` Optional.
`ObaIcon`	`getObaIcon()` Optional.
`Boolean`	`getOggAudio()` Output only.
`AudioVideoOffset`	`getProgressOffset()` Optional.
`Boolean`	`getRequireHtml5()` Optional.
`Boolean`	`getRequireMraid()` Optional.
`Boolean`	`getRequirePingForAttribution()` Optional.
`ReviewStatusInfo`	`getReviewStatus()` Output only.
`AudioVideoOffset`	`getSkipOffset()` Optional.
`Boolean`	`getSkippable()` Optional.
`String`	`getThirdPartyTag()` Optional.
`List<ThirdPartyUrl>`	`getThirdPartyUrls()` Optional.
`List<TimerEvent>`	`getTimerEvents()` Optional.
`List<String>`	`getTrackerUrls()` Optional.
`List<Transcode>`	`getTranscodes()` Output only.
`UniversalAdId`	`getUniversalAdId()` Optional.
`String`	`getUpdateTime()` Output only.
`String`	`getVastTagUrl()` Optional.
`Boolean`	`getVpaid()` Output only.
`Creative`	`set(String fieldName, Object value)`
`Creative`	`setAdditionalDimensions(List<Dimensions> additionalDimensions)` Optional.
`Creative`	`setAdvertiserId(Long advertiserId)` Output only.
`Creative`	`setAppendedTag(String appendedTag)` Optional.
`Creative`	`setAssets(List<AssetAssociation> assets)` Required.
`Creative`	`setCmPlacementId(Long cmPlacementId)` Output only.
`Creative`	`setCmTrackingAd(CmTrackingAd cmTrackingAd)` Optional.
`Creative`	`setCompanionCreativeIds(List<Long> companionCreativeIds)` Optional.
`Creative`	`setCounterEvents(List<CounterEvent> counterEvents)` Optional.
`Creative`	`setCreateTime(String createTime)` Output only.
`Creative`	`setCreativeAttributes(List<String> creativeAttributes)` Output only.
`Creative`	`setCreativeId(Long creativeId)` Output only.
`Creative`	`setCreativeType(String creativeType)` Required.
`Creative`	`setDimensions(Dimensions dimensions)` Required.
`Creative`	`setDisplayName(String displayName)` Required.
`Creative`	`setDynamic(Boolean dynamic)` Output only.
`Creative`	`setEntityStatus(String entityStatus)` Required.
`Creative`	`setExitEvents(List<ExitEvent> exitEvents)` Required.
`Creative`	`setExpandingDirection(String expandingDirection)` Optional.
`Creative`	`setExpandOnHover(Boolean expandOnHover)` Optional.
`Creative`	`setHostingSource(String hostingSource)` Required.
`Creative`	`setHtml5Video(Boolean html5Video)` Output only.
`Creative`	`setIasCampaignMonitoring(Boolean iasCampaignMonitoring)` Optional.
`Creative`	`setIntegrationCode(String integrationCode)` Optional.
`Creative`	`setJsTrackerUrl(String jsTrackerUrl)` Optional.
`Creative`	`setLineItemIds(List<Long> lineItemIds)` Output only.
`Creative`	`setMediaDuration(String mediaDuration)` Output only.
`Creative`	`setMp3Audio(Boolean mp3Audio)` Output only.
`Creative`	`setName(String name)` Output only.
`Creative`	`setNotes(String notes)` Optional.
`Creative`	`setObaIcon(ObaIcon obaIcon)` Optional.
`Creative`	`setOggAudio(Boolean oggAudio)` Output only.
`Creative`	`setProgressOffset(AudioVideoOffset progressOffset)` Optional.
`Creative`	`setRequireHtml5(Boolean requireHtml5)` Optional.
`Creative`	`setRequireMraid(Boolean requireMraid)` Optional.
`Creative`	`setRequirePingForAttribution(Boolean requirePingForAttribution)` Optional.
`Creative`	`setReviewStatus(ReviewStatusInfo reviewStatus)` Output only.
`Creative`	`setSkipOffset(AudioVideoOffset skipOffset)` Optional.
`Creative`	`setSkippable(Boolean skippable)` Optional.
`Creative`	`setThirdPartyTag(String thirdPartyTag)` Optional.
`Creative`	`setThirdPartyUrls(List<ThirdPartyUrl> thirdPartyUrls)` Optional.
`Creative`	`setTimerEvents(List<TimerEvent> timerEvents)` Optional.
`Creative`	`setTrackerUrls(List<String> trackerUrls)` Optional.
`Creative`	`setTranscodes(List<Transcode> transcodes)` Output only.
`Creative`	`setUniversalAdId(UniversalAdId universalAdId)` Optional.
`Creative`	`setUpdateTime(String updateTime)` Output only.
`Creative`	`setVastTagUrl(String vastTagUrl)` Optional.
`Creative`	`setVpaid(Boolean vpaid)` Output only.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Creative
```
public Creative()
```
- Method Detail
  - getAdditionalDimensions
```
public List<Dimensions> getAdditionalDimensions()
```
    Optional. Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0.
    
    Returns:
    
    value or null for none
  - setAdditionalDimensions
```
public Creative setAdditionalDimensions(List<Dimensions> additionalDimensions)
```
    Optional. Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0.
    
    Parameters:
    
    additionalDimensions - additionalDimensions or null for none
  - getAdvertiserId
```
public Long getAdvertiserId()
```
    Output only. The unique ID of the advertiser the creative belongs to.
    
    Returns:
    
    value or null for none
  - setAdvertiserId
```
public Creative setAdvertiserId(Long advertiserId)
```
    Output only. The unique ID of the advertiser the creative belongs to.
    
    Parameters:
    
    advertiserId - advertiserId or null for none
  - getAppendedTag
```
public String getAppendedTag()
```
    Optional. Third-party HTML tracking tag to be appended to the creative tag.
    
    Returns:
    
    value or null for none
  - setAppendedTag
```
public Creative setAppendedTag(String appendedTag)
```
    Optional. Third-party HTML tracking tag to be appended to the creative tag.
    
    Parameters:
    
    appendedTag - appendedTag or null for none
  - getAssets
```
public List<AssetAssociation> getAssets()
```
    Required. Assets associated to this creative.
    
    Returns:
    
    value or null for none
  - setAssets
```
public Creative setAssets(List<AssetAssociation> assets)
```
    Required. Assets associated to this creative.
    
    Parameters:
    
    assets - assets or null for none
  - getCmPlacementId
```
public Long getCmPlacementId()
```
    Output only. The unique ID of the Campaign Manager 360 placement associated with the creative. This field is only applicable for creatives that are synced from Campaign Manager.
    
    Returns:
    
    value or null for none
  - setCmPlacementId
```
public Creative setCmPlacementId(Long cmPlacementId)
```
    Output only. The unique ID of the Campaign Manager 360 placement associated with the creative. This field is only applicable for creatives that are synced from Campaign Manager.
    
    Parameters:
    
    cmPlacementId - cmPlacementId or null for none
  - getCmTrackingAd
```
public CmTrackingAd getCmTrackingAd()
```
    Optional. The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases.
    
    Returns:
    
    value or null for none
  - setCmTrackingAd
```
public Creative setCmTrackingAd(CmTrackingAd cmTrackingAd)
```
    Optional. The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases.
    
    Parameters:
    
    cmTrackingAd - cmTrackingAd or null for none
  - getCompanionCreativeIds
```
public List<Long> getCompanionCreativeIds()
```
    Optional. The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`
    
    Returns:
    
    value or null for none
  - setCompanionCreativeIds
```
public Creative setCompanionCreativeIds(List<Long> companionCreativeIds)
```
    Optional. The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`
    
    Parameters:
    
    companionCreativeIds - companionCreativeIds or null for none
  - getCounterEvents
```
public List<CounterEvent> getCounterEvents()
```
    Optional. Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse- outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only.
    
    Returns:
    
    value or null for none
  - setCounterEvents
```
public Creative setCounterEvents(List<CounterEvent> counterEvents)
```
    Optional. Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse- outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only.
    
    Parameters:
    
    counterEvents - counterEvents or null for none
  - getCreateTime
```
public String getCreateTime()
```
    Output only. The timestamp when the creative was created. Assigned by the system.
    
    Returns:
    
    value or null for none
  - setCreateTime
```
public Creative setCreateTime(String createTime)
```
    Output only. The timestamp when the creative was created. Assigned by the system.
    
    Parameters:
    
    createTime - createTime or null for none
  - getCreativeAttributes
```
public List<String> getCreativeAttributes()
```
    Output only. A list of attributes of the creative that is generated by the system.
    
    Returns:
    
    value or null for none
  - setCreativeAttributes
```
public Creative setCreativeAttributes(List<String> creativeAttributes)
```
    Output only. A list of attributes of the creative that is generated by the system.
    
    Parameters:
    
    creativeAttributes - creativeAttributes or null for none
  - getCreativeId
```
public Long getCreativeId()
```
    Output only. The unique ID of the creative. Assigned by the system.
    
    Returns:
    
    value or null for none
  - setCreativeId
```
public Creative setCreativeId(Long creativeId)
```
    Output only. The unique ID of the creative. Assigned by the system.
    
    Parameters:
    
    creativeId - creativeId or null for none
  - getCreativeType
```
public String getCreativeType()
```
    Required. Immutable. The type of the creative.
    
    Returns:
    
    value or null for none
  - setCreativeType
```
public Creative setCreativeType(String creativeType)
```
    Required. Immutable. The type of the creative.
    
    Parameters:
    
    creativeType - creativeType or null for none
  - getDimensions
```
public Dimensions getDimensions()
```
    Required. Primary dimensions of the creative. Applicable to all creative types. The value of width_pixels and height_pixels defaults to `0` when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO`
    
    Returns:
    
    value or null for none
  - setDimensions
```
public Creative setDimensions(Dimensions dimensions)
```
    Required. Primary dimensions of the creative. Applicable to all creative types. The value of width_pixels and height_pixels defaults to `0` when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO`
    
    Parameters:
    
    dimensions - dimensions or null for none
  - getDisplayName
```
public String getDisplayName()
```
    Required. The display name of the creative. Must be UTF-8 encoded with a maximum size of 240 bytes.
    
    Returns:
    
    value or null for none
  - setDisplayName
```
public Creative setDisplayName(String displayName)
```
    Required. The display name of the creative. Must be UTF-8 encoded with a maximum size of 240 bytes.
    
    Parameters:
    
    displayName - displayName or null for none
  - getDynamic
```
public Boolean getDynamic()
```
    Output only. Indicates whether the creative is dynamic.
    
    Returns:
    
    value or null for none
  - setDynamic
```
public Creative setDynamic(Boolean dynamic)
```
    Output only. Indicates whether the creative is dynamic.
    
    Parameters:
    
    dynamic - dynamic or null for none
  - getEntityStatus
```
public String getEntityStatus()
```
    Required. Controls whether or not the creative can serve. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` * `ENTITY_STATUS_PAUSED`
    
    Returns:
    
    value or null for none
  - setEntityStatus
```
public Creative setEntityStatus(String entityStatus)
```
    Required. Controls whether or not the creative can serve. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` * `ENTITY_STATUS_PAUSED`
    
    Parameters:
    
    entityStatus - entityStatus or null for none
  - getExitEvents
```
public List<ExitEvent> getExitEvents()
```
    Required. Exit events for this creative. An exit (also known as a click tag) is any area in your creative that someone can click or tap to open an advertiser's landing page. Every creative must include at least one exit. You can add an exit to your creative in any of the following ways: * Use Google Web Designer's tap area. * Define a JavaScript variable called "clickTag". * Use the Enabler (Enabler.exit()) to track exits in rich media formats.
    
    Returns:
    
    value or null for none
  - setExitEvents
```
public Creative setExitEvents(List<ExitEvent> exitEvents)
```
    Required. Exit events for this creative. An exit (also known as a click tag) is any area in your creative that someone can click or tap to open an advertiser's landing page. Every creative must include at least one exit. You can add an exit to your creative in any of the following ways: * Use Google Web Designer's tap area. * Define a JavaScript variable called "clickTag". * Use the Enabler (Enabler.exit()) to track exits in rich media formats.
    
    Parameters:
    
    exitEvents - exitEvents or null for none
  - getExpandOnHover
```
public Boolean getExpandOnHover()
```
    Optional. Indicates the creative will automatically expand on hover. Optional and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_EXPANDABLE`
    
    Returns:
    
    value or null for none
  - setExpandOnHover
```
public Creative setExpandOnHover(Boolean expandOnHover)
```
    Optional. Indicates the creative will automatically expand on hover. Optional and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_EXPANDABLE`
    
    Parameters:
    
    expandOnHover - expandOnHover or null for none
  - getExpandingDirection
```
public String getExpandingDirection()
```
    Optional. Specifies the expanding direction of the creative. Required and only valid for third- party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_EXPANDABLE`
    
    Returns:
    
    value or null for none
  - setExpandingDirection
```
public Creative setExpandingDirection(String expandingDirection)
```
    Optional. Specifies the expanding direction of the creative. Required and only valid for third- party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_EXPANDABLE`
    
    Parameters:
    
    expandingDirection - expandingDirection or null for none
  - getHostingSource
```
public String getHostingSource()
```
    Required. Indicates where the creative is hosted.
    
    Returns:
    
    value or null for none
  - setHostingSource
```
public Creative setHostingSource(String hostingSource)
```
    Required. Indicates where the creative is hosted.
    
    Parameters:
    
    hostingSource - hostingSource or null for none
  - getHtml5Video
```
public Boolean getHtml5Video()
```
    Output only. Indicates the third-party VAST tag creative requires HTML5 Video support. Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO`
    
    Returns:
    
    value or null for none
  - setHtml5Video
```
public Creative setHtml5Video(Boolean html5Video)
```
    Output only. Indicates the third-party VAST tag creative requires HTML5 Video support. Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO`
    
    Parameters:
    
    html5Video - html5Video or null for none
  - getIasCampaignMonitoring
```
public Boolean getIasCampaignMonitoring()
```
    Optional. Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID.
    
    Returns:
    
    value or null for none
  - setIasCampaignMonitoring
```
public Creative setIasCampaignMonitoring(Boolean iasCampaignMonitoring)
```
    Optional. Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID.
    
    Parameters:
    
    iasCampaignMonitoring - iasCampaignMonitoring or null for none
  - getIntegrationCode
```
public String getIntegrationCode()
```
    Optional. ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters.
    
    Returns:
    
    value or null for none
  - setIntegrationCode
```
public Creative setIntegrationCode(String integrationCode)
```
    Optional. ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters.
    
    Parameters:
    
    integrationCode - integrationCode or null for none
  - getJsTrackerUrl
```
public String getJsTrackerUrl()
```
    Optional. JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`
    
    Returns:
    
    value or null for none
  - setJsTrackerUrl
```
public Creative setJsTrackerUrl(String jsTrackerUrl)
```
    Optional. JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`
    
    Parameters:
    
    jsTrackerUrl - jsTrackerUrl or null for none
  - getLineItemIds
```
public List<Long> getLineItemIds()
```
    Output only. The IDs of the line items this creative is associated with. To associate a creative to a line item, use LineItem.creative_ids instead.
    
    Returns:
    
    value or null for none
  - setLineItemIds
```
public Creative setLineItemIds(List<Long> lineItemIds)
```
    Output only. The IDs of the line items this creative is associated with. To associate a creative to a line item, use LineItem.creative_ids instead.
    
    Parameters:
    
    lineItemIds - lineItemIds or null for none
  - getMediaDuration
```
public String getMediaDuration()
```
    Output only. Media duration of the creative. Applicable when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_PUBLISHER_HOSTED`
    
    Returns:
    
    value or null for none
  - setMediaDuration
```
public Creative setMediaDuration(String mediaDuration)
```
    Output only. Media duration of the creative. Applicable when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_PUBLISHER_HOSTED`
    
    Parameters:
    
    mediaDuration - mediaDuration or null for none
  - getMp3Audio
```
public Boolean getMp3Audio()
```
    Output only. Indicates the third-party audio creative supports MP3. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO`
    
    Returns:
    
    value or null for none
  - setMp3Audio
```
public Creative setMp3Audio(Boolean mp3Audio)
```
    Output only. Indicates the third-party audio creative supports MP3. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO`
    
    Parameters:
    
    mp3Audio - mp3Audio or null for none
  - getName
```
public String getName()
```
    Output only. The resource name of the creative.
    
    Returns:
    
    value or null for none
  - setName
```
public Creative setName(String name)
```
    Output only. The resource name of the creative.
    
    Parameters:
    
    name - name or null for none
  - getNotes
```
public String getNotes()
```
    Optional. User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters.
    
    Returns:
    
    value or null for none
  - setNotes
```
public Creative setNotes(String notes)
```
    Optional. User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters.
    
    Parameters:
    
    notes - notes or null for none
  - getObaIcon
```
public ObaIcon getObaIcon()
```
    Optional. Specifies the OBA icon for a video creative. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO`
    
    Returns:
    
    value or null for none
  - setObaIcon
```
public Creative setObaIcon(ObaIcon obaIcon)
```
    Optional. Specifies the OBA icon for a video creative. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO`
    
    Parameters:
    
    obaIcon - obaIcon or null for none
  - getOggAudio
```
public Boolean getOggAudio()
```
    Output only. Indicates the third-party audio creative supports OGG. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO`
    
    Returns:
    
    value or null for none
  - setOggAudio
```
public Creative setOggAudio(Boolean oggAudio)
```
    Output only. Indicates the third-party audio creative supports OGG. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO`
    
    Parameters:
    
    oggAudio - oggAudio or null for none
  - getProgressOffset
```
public AudioVideoOffset getProgressOffset()
```
    Optional. Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`
    
    Returns:
    
    value or null for none
  - setProgressOffset
```
public Creative setProgressOffset(AudioVideoOffset progressOffset)
```
    Optional. Amount of time to play the video before counting a view. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`
    
    Parameters:
    
    progressOffset - progressOffset or null for none
  - getRequireHtml5
```
public Boolean getRequireHtml5()
```
    Optional. Indicates that the creative relies on HTML5 to render properly. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE`
    
    Returns:
    
    value or null for none
  - setRequireHtml5
```
public Creative setRequireHtml5(Boolean requireHtml5)
```
    Optional. Indicates that the creative relies on HTML5 to render properly. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE`
    
    Parameters:
    
    requireHtml5 - requireHtml5 or null for none
  - getRequireMraid
```
public Boolean getRequireMraid()
```
    Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad Interface Definitions system). Set this if the creative relies on mobile gestures for interactivity, such as swiping or tapping. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE`
    
    Returns:
    
    value or null for none
  - setRequireMraid
```
public Creative setRequireMraid(Boolean requireMraid)
```
    Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad Interface Definitions system). Set this if the creative relies on mobile gestures for interactivity, such as swiping or tapping. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE`
    
    Parameters:
    
    requireMraid - requireMraid or null for none
  - getRequirePingForAttribution
```
public Boolean getRequirePingForAttribution()
```
    Optional. Indicates that the creative will wait for a return ping for attribution. Only valid when using a Campaign Manager 360 tracking ad with a third-party ad server parameter and the ${DC_DBM_TOKEN} macro. Optional and only valid for third-party tag creatives or third-party VAST tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`
    
    Returns:
    
    value or null for none
  - setRequirePingForAttribution
```
public Creative setRequirePingForAttribution(Boolean requirePingForAttribution)
```
    Optional. Indicates that the creative will wait for a return ping for attribution. Only valid when using a Campaign Manager 360 tracking ad with a third-party ad server parameter and the ${DC_DBM_TOKEN} macro. Optional and only valid for third-party tag creatives or third-party VAST tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`
    
    Parameters:
    
    requirePingForAttribution - requirePingForAttribution or null for none
  - getReviewStatus
```
public ReviewStatusInfo getReviewStatus()
```
    Output only. The current status of the creative review process.
    
    Returns:
    
    value or null for none
  - setReviewStatus
```
public Creative setReviewStatus(ReviewStatusInfo reviewStatus)
```
    Output only. The current status of the creative review process.
    
    Parameters:
    
    reviewStatus - reviewStatus or null for none
  - getSkipOffset
```
public AudioVideoOffset getSkipOffset()
```
    Optional. Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`
    
    Returns:
    
    value or null for none
  - setSkipOffset
```
public Creative setSkipOffset(AudioVideoOffset skipOffset)
```
    Optional. Amount of time to play the video before the skip button appears. This field is required when skippable is true. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`
    
    Parameters:
    
    skipOffset - skipOffset or null for none
  - getSkippable
```
public Boolean getSkippable()
```
    Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`
    
    Returns:
    
    value or null for none
  - setSkippable
```
public Creative setSkippable(Boolean skippable)
```
    Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`
    
    Parameters:
    
    skippable - skippable or null for none
  - getThirdPartyTag
```
public String getThirdPartyTag()
```
    Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE`
    
    Returns:
    
    value or null for none
  - setThirdPartyTag
```
public Creative setThirdPartyTag(String thirdPartyTag)
```
    Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE`
    
    Parameters:
    
    thirdPartyTag - thirdPartyTag or null for none
  - getThirdPartyUrls
```
public List<ThirdPartyUrl> getThirdPartyUrls()
```
    Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO`
    
    Returns:
    
    value or null for none
  - setThirdPartyUrls
```
public Creative setThirdPartyUrls(List<ThirdPartyUrl> thirdPartyUrls)
```
    Optional. Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO`
    
    Parameters:
    
    thirdPartyUrls - thirdPartyUrls or null for none
  - getTimerEvents
```
public List<TimerEvent> getTimerEvents()
```
    Optional. Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only.
    
    Returns:
    
    value or null for none
  - setTimerEvents
```
public Creative setTimerEvents(List<TimerEvent> timerEvents)
```
    Optional. Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only.
    
    Parameters:
    
    timerEvents - timerEvents or null for none
  - getTrackerUrls
```
public List<String> getTrackerUrls()
```
    Optional. Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with `https:` (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`
    
    Returns:
    
    value or null for none
  - setTrackerUrls
```
public Creative setTrackerUrls(List<String> trackerUrls)
```
    Optional. Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with `https:` (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in the following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`
    
    Parameters:
    
    trackerUrls - trackerUrls or null for none
  - getTranscodes
```
public List<Transcode> getTranscodes()
```
    Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO`
    
    Returns:
    
    value or null for none
  - setTranscodes
```
public Creative setTranscodes(List<Transcode> transcodes)
```
    Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in the following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO`
    
    Parameters:
    
    transcodes - transcodes or null for none
  - getUniversalAdId
```
public UniversalAdId getUniversalAdId()
```
    Optional. An optional creative identifier provided by a registry that is unique across all platforms. Universal Ad ID is part of the VAST 4.0 standard. It can be modified after the creative is created. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`
    
    Returns:
    
    value or null for none
  - setUniversalAdId
```
public Creative setUniversalAdId(UniversalAdId universalAdId)
```
    Optional. An optional creative identifier provided by a registry that is unique across all platforms. Universal Ad ID is part of the VAST 4.0 standard. It can be modified after the creative is created. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO`
    
    Parameters:
    
    universalAdId - universalAdId or null for none
  - getUpdateTime
```
public String getUpdateTime()
```
    Output only. The timestamp when the creative was last updated, either by the user or system (e.g. creative review). Assigned by the system.
    
    Returns:
    
    value or null for none
  - setUpdateTime
```
public Creative setUpdateTime(String updateTime)
```
    Output only. The timestamp when the creative was last updated, either by the user or system (e.g. creative review). Assigned by the system.
    
    Parameters:
    
    updateTime - updateTime or null for none
  - getVastTagUrl
```
public String getVastTagUrl()
```
    Optional. The URL of the VAST tag for a third-party VAST tag creative. Required and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`
    
    Returns:
    
    value or null for none
  - setVastTagUrl
```
public Creative setVastTagUrl(String vastTagUrl)
```
    Optional. The URL of the VAST tag for a third-party VAST tag creative. Required and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`
    
    Parameters:
    
    vastTagUrl - vastTagUrl or null for none
  - getVpaid
```
public Boolean getVpaid()
```
    Output only. Indicates the third-party VAST tag creative requires VPAID (Digital Video Player- Ad Interface). Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO`
    
    Returns:
    
    value or null for none
  - setVpaid
```
public Creative setVpaid(Boolean vpaid)
```
    Output only. Indicates the third-party VAST tag creative requires VPAID (Digital Video Player- Ad Interface). Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO`
    
    Parameters:
    
    vpaid - vpaid or null for none
  - set
```
public Creative set(String fieldName,
                    Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Creative clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class Creative

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Creative

Method Detail

getAdditionalDimensions

setAdditionalDimensions

getAdvertiserId

setAdvertiserId

getAppendedTag

setAppendedTag

getAssets

setAssets

getCmPlacementId

setCmPlacementId

getCmTrackingAd

setCmTrackingAd

getCompanionCreativeIds

setCompanionCreativeIds

getCounterEvents

setCounterEvents

getCreateTime

setCreateTime

getCreativeAttributes

setCreativeAttributes

getCreativeId

setCreativeId

getCreativeType

setCreativeType

getDimensions

setDimensions

getDisplayName

setDisplayName

getDynamic

setDynamic

getEntityStatus

setEntityStatus

getExitEvents

setExitEvents

getExpandOnHover

setExpandOnHover

getExpandingDirection

setExpandingDirection

getHostingSource

setHostingSource

getHtml5Video

setHtml5Video

getIasCampaignMonitoring

setIasCampaignMonitoring

getIntegrationCode

setIntegrationCode

getJsTrackerUrl

setJsTrackerUrl

getLineItemIds

setLineItemIds

getMediaDuration

setMediaDuration

getMp3Audio

setMp3Audio

getName

setName

getNotes

setNotes

getObaIcon

setObaIcon

getOggAudio

setOggAudio

getProgressOffset

setProgressOffset

getRequireHtml5