CreativeAsset (DCM/DFA Reporting And Trafficking API v3.0 (Rev. 1) 1.23.0)

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

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class CreativeAsset
extends com.google.api.client.json.GenericJson
```
Creative Asset.
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 DCM/DFA Reporting And Trafficking 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
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

CreativeAsset()

Constructors
Constructor and Description
`CreativeAsset()`

Method Summary

Methods
Modifier and Type	Method and Description
`CreativeAsset`	`clone()`
`java.lang.Boolean`	`getActionScript3()` Whether ActionScript3 is enabled for the flash asset.
`java.lang.Boolean`	`getActive()` Whether the video asset is active.
`java.lang.String`	`getAlignment()` Possible alignments for an asset.
`java.lang.String`	`getArtworkType()` Artwork type of rich media creative.
`CreativeAssetId`	`getAssetIdentifier()` Identifier of this asset.
`CreativeCustomEvent`	`getBackupImageExit()` Exit event configured for the backup image.
`java.lang.Integer`	`getBitRate()` Detected bit-rate for video asset.
`java.lang.String`	`getChildAssetType()` Rich media child asset type.
`Size`	`getCollapsedSize()` Size of an asset when collapsed.
`java.util.List<java.lang.Long>`	`getCompanionCreativeIds()` List of companion creatives assigned to an in-stream video creative asset.
`java.lang.Integer`	`getCustomStartTimeValue()` Custom start time in seconds for making the asset visible.
`java.util.List<java.lang.String>`	`getDetectedFeatures()` List of feature dependencies for the creative asset that are detected by DCM.
`java.lang.String`	`getDisplayType()` Type of rich media asset.
`java.lang.Integer`	`getDuration()` Duration in seconds for which an asset will be displayed.
`java.lang.String`	`getDurationType()` Duration type for which an asset will be displayed.
`Size`	`getExpandedDimension()` Detected expanded dimension for video asset.
`java.lang.Long`	`getFileSize()` File size associated with this creative asset.
`java.lang.Integer`	`getFlashVersion()` Flash version of the asset.
`java.lang.Boolean`	`getHideFlashObjects()` Whether to hide Flash objects flag for an asset.
`java.lang.Boolean`	`getHideSelectionBoxes()` Whether to hide selection boxes flag for an asset.
`java.lang.Boolean`	`getHorizontallyLocked()` Whether the asset is horizontally locked.
`java.lang.Long`	`getId()` Numeric ID of this creative asset.
`DimensionValue`	`getIdDimensionValue()` Dimension value for the ID of the asset.
`java.lang.String`	`getMimeType()` Detected MIME type for video asset.
`OffsetPosition`	`getOffset()` Offset position for an asset in collapsed mode.
`java.lang.String`	`getOrientation()` Orientation of video asset.
`java.lang.Boolean`	`getOriginalBackup()` Whether the backup asset is original or changed by the user in DCM.
`OffsetPosition`	`getPosition()` Offset position for an asset.
`java.lang.String`	`getPositionLeftUnit()` Offset left unit for an asset.
`java.lang.String`	`getPositionTopUnit()` Offset top unit for an asset.
`java.lang.String`	`getProgressiveServingUrl()` Progressive URL for video asset.
`java.lang.Boolean`	`getPushdown()` Whether the asset pushes down other content.
`java.lang.Float`	`getPushdownDuration()` Pushdown duration in seconds for an asset.
`java.lang.String`	`getRole()` Role of the asset in relation to creative.
`Size`	`getSize()` Size associated with this creative asset.
`java.lang.Boolean`	`getSslCompliant()` Whether the asset is SSL-compliant.
`java.lang.String`	`getStartTimeType()` Initial wait time type before making the asset visible.
`java.lang.String`	`getStreamingServingUrl()` Streaming URL for video asset.
`java.lang.Boolean`	`getTransparency()` Whether the asset is transparent.
`java.lang.Boolean`	`getVerticallyLocked()` Whether the asset is vertically locked.
`java.lang.Float`	`getVideoDuration()` Detected video duration for video asset.
`java.lang.String`	`getWindowMode()` Window mode options for flash assets.
`java.lang.Integer`	`getZIndex()` zIndex value of an asset.
`java.lang.String`	`getZipFilename()` File name of zip file.
`java.lang.String`	`getZipFilesize()` Size of zip file.
`CreativeAsset`	`set(java.lang.String fieldName, java.lang.Object value)`
`CreativeAsset`	`setActionScript3(java.lang.Boolean actionScript3)` Whether ActionScript3 is enabled for the flash asset.
`CreativeAsset`	`setActive(java.lang.Boolean active)` Whether the video asset is active.
`CreativeAsset`	`setAlignment(java.lang.String alignment)` Possible alignments for an asset.
`CreativeAsset`	`setArtworkType(java.lang.String artworkType)` Artwork type of rich media creative.
`CreativeAsset`	`setAssetIdentifier(CreativeAssetId assetIdentifier)` Identifier of this asset.
`CreativeAsset`	`setBackupImageExit(CreativeCustomEvent backupImageExit)` Exit event configured for the backup image.
`CreativeAsset`	`setBitRate(java.lang.Integer bitRate)` Detected bit-rate for video asset.
`CreativeAsset`	`setChildAssetType(java.lang.String childAssetType)` Rich media child asset type.
`CreativeAsset`	`setCollapsedSize(Size collapsedSize)` Size of an asset when collapsed.
`CreativeAsset`	`setCompanionCreativeIds(java.util.List<java.lang.Long> companionCreativeIds)` List of companion creatives assigned to an in-stream video creative asset.
`CreativeAsset`	`setCustomStartTimeValue(java.lang.Integer customStartTimeValue)` Custom start time in seconds for making the asset visible.
`CreativeAsset`	`setDetectedFeatures(java.util.List<java.lang.String> detectedFeatures)` List of feature dependencies for the creative asset that are detected by DCM.
`CreativeAsset`	`setDisplayType(java.lang.String displayType)` Type of rich media asset.
`CreativeAsset`	`setDuration(java.lang.Integer duration)` Duration in seconds for which an asset will be displayed.
`CreativeAsset`	`setDurationType(java.lang.String durationType)` Duration type for which an asset will be displayed.
`CreativeAsset`	`setExpandedDimension(Size expandedDimension)` Detected expanded dimension for video asset.
`CreativeAsset`	`setFileSize(java.lang.Long fileSize)` File size associated with this creative asset.
`CreativeAsset`	`setFlashVersion(java.lang.Integer flashVersion)` Flash version of the asset.
`CreativeAsset`	`setHideFlashObjects(java.lang.Boolean hideFlashObjects)` Whether to hide Flash objects flag for an asset.
`CreativeAsset`	`setHideSelectionBoxes(java.lang.Boolean hideSelectionBoxes)` Whether to hide selection boxes flag for an asset.
`CreativeAsset`	`setHorizontallyLocked(java.lang.Boolean horizontallyLocked)` Whether the asset is horizontally locked.
`CreativeAsset`	`setId(java.lang.Long id)` Numeric ID of this creative asset.
`CreativeAsset`	`setIdDimensionValue(DimensionValue idDimensionValue)` Dimension value for the ID of the asset.
`CreativeAsset`	`setMimeType(java.lang.String mimeType)` Detected MIME type for video asset.
`CreativeAsset`	`setOffset(OffsetPosition offset)` Offset position for an asset in collapsed mode.
`CreativeAsset`	`setOrientation(java.lang.String orientation)` Orientation of video asset.
`CreativeAsset`	`setOriginalBackup(java.lang.Boolean originalBackup)` Whether the backup asset is original or changed by the user in DCM.
`CreativeAsset`	`setPosition(OffsetPosition position)` Offset position for an asset.
`CreativeAsset`	`setPositionLeftUnit(java.lang.String positionLeftUnit)` Offset left unit for an asset.
`CreativeAsset`	`setPositionTopUnit(java.lang.String positionTopUnit)` Offset top unit for an asset.
`CreativeAsset`	`setProgressiveServingUrl(java.lang.String progressiveServingUrl)` Progressive URL for video asset.
`CreativeAsset`	`setPushdown(java.lang.Boolean pushdown)` Whether the asset pushes down other content.
`CreativeAsset`	`setPushdownDuration(java.lang.Float pushdownDuration)` Pushdown duration in seconds for an asset.
`CreativeAsset`	`setRole(java.lang.String role)` Role of the asset in relation to creative.
`CreativeAsset`	`setSize(Size size)` Size associated with this creative asset.
`CreativeAsset`	`setSslCompliant(java.lang.Boolean sslCompliant)` Whether the asset is SSL-compliant.
`CreativeAsset`	`setStartTimeType(java.lang.String startTimeType)` Initial wait time type before making the asset visible.
`CreativeAsset`	`setStreamingServingUrl(java.lang.String streamingServingUrl)` Streaming URL for video asset.
`CreativeAsset`	`setTransparency(java.lang.Boolean transparency)` Whether the asset is transparent.
`CreativeAsset`	`setVerticallyLocked(java.lang.Boolean verticallyLocked)` Whether the asset is vertically locked.
`CreativeAsset`	`setVideoDuration(java.lang.Float videoDuration)` Detected video duration for video asset.
`CreativeAsset`	`setWindowMode(java.lang.String windowMode)` Window mode options for flash assets.
`CreativeAsset`	`setZIndex(java.lang.Integer zIndex)` zIndex value of an asset.
`CreativeAsset`	`setZipFilename(java.lang.String zipFilename)` File name of zip file.
`CreativeAsset`	`setZipFilesize(java.lang.String zipFilesize)` Size of zip file.

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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

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

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

- Constructor Detail
  - CreativeAsset
```
public CreativeAsset()
```
- Method Detail
  - getActionScript3
```
public java.lang.Boolean getActionScript3()
```
    Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
    
    Returns:
    value or null for none
  - setActionScript3
```
public CreativeAsset setActionScript3(java.lang.Boolean actionScript3)
```
    Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
    
    Parameters:
    actionScript3 - actionScript3 or null for none
  - getActive
```
public java.lang.Boolean getActive()
```
    Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
    
    Returns:
    value or null for none
  - setActive
```
public CreativeAsset setActive(java.lang.Boolean active)
```
    Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
    
    Parameters:
    active - active or null for none
  - getAlignment
```
public java.lang.String getAlignment()
```
    Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL.
    
    Returns:
    value or null for none
  - setAlignment
```
public CreativeAsset setAlignment(java.lang.String alignment)
```
    Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL.
    
    Parameters:
    alignment - alignment or null for none
  - getArtworkType
```
public java.lang.String getArtworkType()
```
    Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
    
    Returns:
    value or null for none
  - setArtworkType
```
public CreativeAsset setArtworkType(java.lang.String artworkType)
```
    Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
    
    Parameters:
    artworkType - artworkType or null for none
  - getAssetIdentifier
```
public CreativeAssetId getAssetIdentifier()
```
    Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
    
    Returns:
    value or null for none
  - setAssetIdentifier
```
public CreativeAsset setAssetIdentifier(CreativeAssetId assetIdentifier)
```
    Identifier of this asset. This is the same identifier returned during creative asset insert operation. This is a required field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
    
    Parameters:
    assetIdentifier - assetIdentifier or null for none
  - getBackupImageExit
```
public CreativeCustomEvent getBackupImageExit()
```
    Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
    
    Returns:
    value or null for none
  - setBackupImageExit
```
public CreativeAsset setBackupImageExit(CreativeCustomEvent backupImageExit)
```
    Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
    
    Parameters:
    backupImageExit - backupImageExit or null for none
  - getBitRate
```
public java.lang.Integer getBitRate()
```
    Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
    
    Returns:
    value or null for none
  - setBitRate
```
public CreativeAsset setBitRate(java.lang.Integer bitRate)
```
    Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
    
    Parameters:
    bitRate - bitRate or null for none
  - getChildAssetType
```
public java.lang.String getChildAssetType()
```
    Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
    
    Returns:
    value or null for none
  - setChildAssetType
```
public CreativeAsset setChildAssetType(java.lang.String childAssetType)
```
    Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
    
    Parameters:
    childAssetType - childAssetType or null for none
  - getCollapsedSize
```
public Size getCollapsedSize()
```
    Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
    
    Returns:
    value or null for none
  - setCollapsedSize
```
public CreativeAsset setCollapsedSize(Size collapsedSize)
```
    Size of an asset when collapsed. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
    
    Parameters:
    collapsedSize - collapsedSize or null for none
  - getCompanionCreativeIds
```
public java.util.List<java.lang.Long> getCompanionCreativeIds()
```
    List of companion creatives assigned to an in-stream video creative asset. Acceptable values include IDs of existing flash and image creatives. Applicable to INSTREAM_VIDEO creative type with dynamicAssetSelection set to true.
    
    Returns:
    value or null for none
  - setCompanionCreativeIds
```
public CreativeAsset setCompanionCreativeIds(java.util.List<java.lang.Long> companionCreativeIds)
```
    List of companion creatives assigned to an in-stream video creative asset. Acceptable values include IDs of existing flash and image creatives. Applicable to INSTREAM_VIDEO creative type with dynamicAssetSelection set to true.
    
    Parameters:
    companionCreativeIds - companionCreativeIds or null for none
  - getCustomStartTimeValue
```
public java.lang.Integer getCustomStartTimeValue()
```
    Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA. Value must be greater than or equal to 0.
    
    Returns:
    value or null for none
  - setCustomStartTimeValue
```
public CreativeAsset setCustomStartTimeValue(java.lang.Integer customStartTimeValue)
```
    Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA. Value must be greater than or equal to 0.
    
    Parameters:
    customStartTimeValue - customStartTimeValue or null for none
  - getDetectedFeatures
```
public java.util.List<java.lang.String> getDetectedFeatures()
```
    List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
    
    Returns:
    value or null for none
  - setDetectedFeatures
```
public CreativeAsset setDetectedFeatures(java.util.List<java.lang.String> detectedFeatures)
```
    List of feature dependencies for the creative asset that are detected by DCM. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
    
    Parameters:
    detectedFeatures - detectedFeatures or null for none
  - getDisplayType
```
public java.lang.String getDisplayType()
```
    Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
    
    Returns:
    value or null for none
  - setDisplayType
```
public CreativeAsset setDisplayType(java.lang.String displayType)
```
    Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
    
    Parameters:
    displayType - displayType or null for none
  - getDuration
```
public java.lang.Integer getDuration()
```
    Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR_VIDEO. Value must be greater than or equal to 1.
    
    Returns:
    value or null for none
  - setDuration
```
public CreativeAsset setDuration(java.lang.Integer duration)
```
    Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR_VIDEO. Value must be greater than or equal to 1.
    
    Parameters:
    duration - duration or null for none
  - getDurationType
```
public java.lang.String getDurationType()
```
    Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
    
    Returns:
    value or null for none
  - setDurationType
```
public CreativeAsset setDurationType(java.lang.String durationType)
```
    Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
    
    Parameters:
    durationType - durationType or null for none
  - getExpandedDimension
```
public Size getExpandedDimension()
```
    Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
    
    Returns:
    value or null for none
  - setExpandedDimension
```
public CreativeAsset setExpandedDimension(Size expandedDimension)
```
    Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
    
    Parameters:
    expandedDimension - expandedDimension or null for none
  - getFileSize
```
public java.lang.Long getFileSize()
```
    File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
    
    Returns:
    value or null for none
  - setFileSize
```
public CreativeAsset setFileSize(java.lang.Long fileSize)
```
    File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
    
    Parameters:
    fileSize - fileSize or null for none
  - getFlashVersion
```
public java.lang.Integer getFlashVersion()
```
    Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
    
    Returns:
    value or null for none
  - setFlashVersion
```
public CreativeAsset setFlashVersion(java.lang.Integer flashVersion)
```
    Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
    
    Parameters:
    flashVersion - flashVersion or null for none
  - getHideFlashObjects
```
public java.lang.Boolean getHideFlashObjects()
```
    Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
    
    Returns:
    value or null for none
  - setHideFlashObjects
```
public CreativeAsset setHideFlashObjects(java.lang.Boolean hideFlashObjects)
```
    Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
    
    Parameters:
    hideFlashObjects - hideFlashObjects or null for none
  - getHideSelectionBoxes
```
public java.lang.Boolean getHideSelectionBoxes()
```
    Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
    
    Returns:
    value or null for none
  - setHideSelectionBoxes
```
public CreativeAsset setHideSelectionBoxes(java.lang.Boolean hideSelectionBoxes)
```
    Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
    
    Parameters:
    hideSelectionBoxes - hideSelectionBoxes or null for none
  - getHorizontallyLocked
```
public java.lang.Boolean getHorizontallyLocked()
```
    Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
    
    Returns:
    value or null for none
  - setHorizontallyLocked
```
public CreativeAsset setHorizontallyLocked(java.lang.Boolean horizontallyLocked)
```
    Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
    
    Parameters:
    horizontallyLocked - horizontallyLocked or null for none
  - getId
```
public java.lang.Long getId()
```
    Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
    
    Returns:
    value or null for none
  - setId
```
public CreativeAsset setId(java.lang.Long id)
```
    Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
    
    Parameters:
    id - id or null for none
  - getIdDimensionValue
```
public DimensionValue getIdDimensionValue()
```
    Dimension value for the ID of the asset. This is a read-only, auto-generated field.
    
    Returns:
    value or null for none
  - setIdDimensionValue
```
public CreativeAsset setIdDimensionValue(DimensionValue idDimensionValue)
```
    Dimension value for the ID of the asset. This is a read-only, auto-generated field.
    
    Parameters:
    idDimensionValue - idDimensionValue or null for none
  - getMimeType
```
public java.lang.String getMimeType()
```
    Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
    
    Returns:
    value or null for none
  - setMimeType
```
public CreativeAsset setMimeType(java.lang.String mimeType)
```
    Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
    
    Parameters:
    mimeType - mimeType or null for none
  - getOffset
```
public OffsetPosition getOffset()
```
    Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
    
    Returns:
    value or null for none
  - setOffset
```
public CreativeAsset setOffset(OffsetPosition offset)
```
    Offset position for an asset in collapsed mode. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA and all VPAID. Additionally, only applicable to assets whose displayType is ASSET_DISPLAY_TYPE_EXPANDING or ASSET_DISPLAY_TYPE_PEEL_DOWN.
    
    Parameters:
    offset - offset or null for none
  - getOrientation
```
public java.lang.String getOrientation()
```
    Orientation of video asset. This is a read-only, auto-generated field.
    
    Returns:
    value or null for none
  - setOrientation
```
public CreativeAsset setOrientation(java.lang.String orientation)
```
    Orientation of video asset. This is a read-only, auto-generated field.
    
    Parameters:
    orientation - orientation or null for none
  - getOriginalBackup
```
public java.lang.Boolean getOriginalBackup()
```
    Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
    
    Returns:
    value or null for none
  - setOriginalBackup
```
public CreativeAsset setOriginalBackup(java.lang.Boolean originalBackup)
```
    Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA.
    
    Parameters:
    originalBackup - originalBackup or null for none
  - getPosition
```
public OffsetPosition getPosition()
```
    Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
    
    Returns:
    value or null for none
  - setPosition
```
public CreativeAsset setPosition(OffsetPosition position)
```
    Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
    
    Parameters:
    position - position or null for none
  - getPositionLeftUnit
```
public java.lang.String getPositionLeftUnit()
```
    Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
    
    Returns:
    value or null for none
  - setPositionLeftUnit
```
public CreativeAsset setPositionLeftUnit(java.lang.String positionLeftUnit)
```
    Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
    
    Parameters:
    positionLeftUnit - positionLeftUnit or null for none
  - getPositionTopUnit
```
public java.lang.String getPositionTopUnit()
```
    Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
    
    Returns:
    value or null for none
  - setPositionTopUnit
```
public CreativeAsset setPositionTopUnit(java.lang.String positionTopUnit)
```
    Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA.
    
    Parameters:
    positionTopUnit - positionTopUnit or null for none
  - getProgressiveServingUrl
```
public java.lang.String getProgressiveServingUrl()
```
    Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
    
    Returns:
    value or null for none
  - setProgressiveServingUrl
```
public CreativeAsset setProgressiveServingUrl(java.lang.String progressiveServingUrl)
```
    Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
    
    Parameters:
    progressiveServingUrl - progressiveServingUrl or null for none
  - getPushdown
```
public java.lang.Boolean getPushdown()
```
    Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
    
    Returns:
    value or null for none
  - setPushdown
```
public CreativeAsset setPushdown(java.lang.Boolean pushdown)
```
    Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height.
    
    Parameters:
    pushdown - pushdown or null for none
  - getPushdownDuration
```
public java.lang.Float getPushdownDuration()
```
    Pushdown duration in seconds for an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height. Acceptable values are 0 to 9.99, inclusive.
    
    Returns:
    value or null for none
  - setPushdownDuration
```
public CreativeAsset setPushdownDuration(java.lang.Float pushdownDuration)
```
    Pushdown duration in seconds for an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height. Acceptable values are 0 to 9.99, inclusive.
    
    Parameters:
    pushdownDuration - pushdownDuration or null for none
  - getRole
```
public java.lang.String getRole()
```
    Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field. PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives. BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives. OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives. PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM. For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative.
    
    Returns:
    value or null for none
  - setRole
```
public CreativeAsset setRole(java.lang.String role)
```
    Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field. PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives. BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives. OTHER refers to assets from sources other than DCM, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives. PARENT_VIDEO refers to videos uploaded by the user in DCM and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within DCM. For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative.
    
    Parameters:
    role - role or null for none
  - getSize
```
public Size getSize()
```
    Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
    
    Returns:
    value or null for none
  - setSize
```
public CreativeAsset setSize(Size size)
```
    Size associated with this creative asset. This is a required field when applicable; however for IMAGE and FLASH_INPAGE, creatives if left blank, this field will be automatically set using the actual size of the associated image asset. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER, IMAGE, and all RICH_MEDIA. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE.
    
    Parameters:
    size - size or null for none
  - getSslCompliant
```
public java.lang.Boolean getSslCompliant()
```
    Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
    
    Returns:
    value or null for none
  - setSslCompliant
```
public CreativeAsset setSslCompliant(java.lang.Boolean sslCompliant)
```
    Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT.
    
    Parameters:
    sslCompliant - sslCompliant or null for none
  - getStartTimeType
```
public java.lang.String getStartTimeType()
```
    Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
    
    Returns:
    value or null for none
  - setStartTimeType
```
public CreativeAsset setStartTimeType(java.lang.String startTimeType)
```
    Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
    
    Parameters:
    startTimeType - startTimeType or null for none
  - getStreamingServingUrl
```
public java.lang.String getStreamingServingUrl()
```
    Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
    
    Returns:
    value or null for none
  - setStreamingServingUrl
```
public CreativeAsset setStreamingServingUrl(java.lang.String streamingServingUrl)
```
    Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
    
    Parameters:
    streamingServingUrl - streamingServingUrl or null for none
  - getTransparency
```
public java.lang.Boolean getTransparency()
```
    Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
    
    Returns:
    value or null for none
  - setTransparency
```
public CreativeAsset setTransparency(java.lang.Boolean transparency)
```
    Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
    
    Parameters:
    transparency - transparency or null for none
  - getVerticallyLocked
```
public java.lang.Boolean getVerticallyLocked()
```
    Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
    
    Returns:
    value or null for none
  - setVerticallyLocked
```
public CreativeAsset setVerticallyLocked(java.lang.Boolean verticallyLocked)
```
    Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
    
    Parameters:
    verticallyLocked - verticallyLocked or null for none
  - getVideoDuration
```
public java.lang.Float getVideoDuration()
```
    Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
    
    Returns:
    value or null for none
  - setVideoDuration
```
public CreativeAsset setVideoDuration(java.lang.Float videoDuration)
```
    Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
    
    Parameters:
    videoDuration - videoDuration or null for none
  - getWindowMode
```
public java.lang.String getWindowMode()
```
    Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING.
    
    Returns:
    value or null for none
  - setWindowMode
```
public CreativeAsset setWindowMode(java.lang.String windowMode)
```
    Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING.
    
    Parameters:
    windowMode - windowMode or null for none
  - getZIndex
```
public java.lang.Integer getZIndex()
```
    zIndex value of an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY. Acceptable values are -999999999 to 999999999, inclusive.
    
    Returns:
    value or null for none
  - setZIndex
```
public CreativeAsset setZIndex(java.lang.Integer zIndex)
```
    zIndex value of an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY. Acceptable values are -999999999 to 999999999, inclusive.
    
    Parameters:
    zIndex - zIndex or null for none
  - getZipFilename
```
public java.lang.String getZipFilename()
```
    File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
    
    Returns:
    value or null for none
  - setZipFilename
```
public CreativeAsset setZipFilename(java.lang.String zipFilename)
```
    File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
    
    Parameters:
    zipFilename - zipFilename or null for none
  - getZipFilesize
```
public java.lang.String getZipFilesize()
```
    Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
    
    Returns:
    value or null for none
  - setZipFilesize
```
public CreativeAsset setZipFilesize(java.lang.String zipFilesize)
```
    Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
    
    Parameters:
    zipFilesize - zipFilesize or null for none
  - set
```
public CreativeAsset set(java.lang.String fieldName,
                java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public CreativeAsset clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

DCM/DFA Reporting And Trafficking API v3.0 (revision 1)

Class CreativeAsset

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

Constructor Detail

CreativeAsset

Method Detail

getActionScript3

setActionScript3

getActive

setActive

getAlignment

setAlignment

getArtworkType

setArtworkType

getAssetIdentifier

setAssetIdentifier

getBackupImageExit

setBackupImageExit

getBitRate

setBitRate

getChildAssetType

setChildAssetType

getCollapsedSize

setCollapsedSize

getCompanionCreativeIds

setCompanionCreativeIds

getCustomStartTimeValue

setCustomStartTimeValue

getDetectedFeatures

setDetectedFeatures

getDisplayType

setDisplayType

getDuration

setDuration

getDurationType

setDurationType

getExpandedDimension

setExpandedDimension

getFileSize

setFileSize

getFlashVersion

setFlashVersion

getHideFlashObjects

setHideFlashObjects

getHideSelectionBoxes

setHideSelectionBoxes

getHorizontallyLocked

setHorizontallyLocked

getId

setId

getIdDimensionValue

setIdDimensionValue

getMimeType

setMimeType

getOffset

setOffset

getOrientation

setOrientation

getOriginalBackup

setOriginalBackup

getPosition

setPosition

getPositionLeftUnit

setPositionLeftUnit

getPositionTopUnit

setPositionTopUnit

getProgressiveServingUrl

setProgressiveServingUrl

getPushdown

setPushdown

getPushdownDuration