Class CreativeAsset
Creative Asset.
Inheritance
Implements
Inherited Members
Namespace: Google.Apis.Dfareporting.v3_5.Data
Assembly: Google.Apis.Dfareporting.v3_5.dll
Syntax
public class CreativeAsset : IDirectResponseSchema
Properties
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.
Declaration
[JsonProperty("actionScript3")]
public virtual bool? ActionScript3 { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Active
Whether the video or audio asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
Declaration
[JsonProperty("active")]
public virtual bool? Active { get; set; }
Property Value
Type | Description |
---|---|
bool? |
AdditionalSizes
Additional sizes associated with this creative asset. HTML5 asset generated by compatible software such as GWD will be able to support more sizes this creative asset can render.
Declaration
[JsonProperty("additionalSizes")]
public virtual IList<Size> AdditionalSizes { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IList<T><Size> |
Alignment
Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL .
Declaration
[JsonProperty("alignment")]
public virtual string Alignment { get; set; }
Property Value
Type | Description |
---|---|
string |
ArtworkType
Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
Declaration
[JsonProperty("artworkType")]
public virtual string ArtworkType { get; set; }
Property Value
Type | Description |
---|---|
string |
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.
Declaration
[JsonProperty("assetIdentifier")]
public virtual CreativeAssetId AssetIdentifier { get; set; }
Property Value
Type | Description |
---|---|
CreativeAssetId |
AudioBitRate
Audio stream bit rate in kbps. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
Declaration
[JsonProperty("audioBitRate")]
public virtual int? AudioBitRate { get; set; }
Property Value
Type | Description |
---|---|
int? |
AudioSampleRate
Audio sample bit rate in hertz. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
Declaration
[JsonProperty("audioSampleRate")]
public virtual int? AudioSampleRate { get; set; }
Property Value
Type | Description |
---|---|
int? |
BackupImageExit
Exit event configured for the backup image. Applicable to the following creative types: all RICH_MEDIA.
Declaration
[JsonProperty("backupImageExit")]
public virtual CreativeCustomEvent BackupImageExit { get; set; }
Property Value
Type | Description |
---|---|
CreativeCustomEvent |
BitRate
Detected bit-rate for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
Declaration
[JsonProperty("bitRate")]
public virtual int? BitRate { get; set; }
Property Value
Type | Description |
---|---|
int? |
ChildAssetType
Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID.
Declaration
[JsonProperty("childAssetType")]
public virtual string ChildAssetType { get; set; }
Property Value
Type | Description |
---|---|
string |
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.
Declaration
[JsonProperty("collapsedSize")]
public virtual Size CollapsedSize { get; set; }
Property Value
Type | Description |
---|---|
Size |
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.
Declaration
[JsonProperty("companionCreativeIds")]
public virtual IList<long?> CompanionCreativeIds { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IList<T><long?> |
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.
Declaration
[JsonProperty("customStartTimeValue")]
public virtual int? CustomStartTimeValue { get; set; }
Property Value
Type | Description |
---|---|
int? |
DetectedFeatures
List of feature dependencies for the creative asset that are detected by Campaign Manager. 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.
Declaration
[JsonProperty("detectedFeatures")]
public virtual IList<string> DetectedFeatures { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IList<T><string> |
DisplayType
Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
Declaration
[JsonProperty("displayType")]
public virtual string DisplayType { get; set; }
Property Value
Type | Description |
---|---|
string |
Duration
Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID_LINEAR_VIDEO. Value must be greater than or equal to 1.
Declaration
[JsonProperty("duration")]
public virtual int? Duration { get; set; }
Property Value
Type | Description |
---|---|
int? |
DurationType
Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA.
Declaration
[JsonProperty("durationType")]
public virtual string DurationType { get; set; }
Property Value
Type | Description |
---|---|
string |
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
string |
ExpandedDimension
Detected expanded dimension for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
Declaration
[JsonProperty("expandedDimension")]
public virtual Size ExpandedDimension { get; set; }
Property Value
Type | Description |
---|---|
Size |
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.
Declaration
[JsonProperty("fileSize")]
public virtual long? FileSize { get; set; }
Property Value
Type | Description |
---|---|
long? |
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.
Declaration
[JsonProperty("flashVersion")]
public virtual int? FlashVersion { get; set; }
Property Value
Type | Description |
---|---|
int? |
FrameRate
Video frame rate for video asset in frames per second. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
Declaration
[JsonProperty("frameRate")]
public virtual float? FrameRate { get; set; }
Property Value
Type | Description |
---|---|
float? |
HideFlashObjects
Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
Declaration
[JsonProperty("hideFlashObjects")]
public virtual bool? HideFlashObjects { get; set; }
Property Value
Type | Description |
---|---|
bool? |
HideSelectionBoxes
Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA.
Declaration
[JsonProperty("hideSelectionBoxes")]
public virtual bool? HideSelectionBoxes { get; set; }
Property Value
Type | Description |
---|---|
bool? |
HorizontallyLocked
Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
Declaration
[JsonProperty("horizontallyLocked")]
public virtual bool? HorizontallyLocked { get; set; }
Property Value
Type | Description |
---|---|
bool? |
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.
Declaration
[JsonProperty("id")]
public virtual long? Id { get; set; }
Property Value
Type | Description |
---|---|
long? |
IdDimensionValue
Dimension value for the ID of the asset. This is a read-only, auto-generated field.
Declaration
[JsonProperty("idDimensionValue")]
public virtual DimensionValue IdDimensionValue { get; set; }
Property Value
Type | Description |
---|---|
DimensionValue |
MediaDuration
Detected duration for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
Declaration
[JsonProperty("mediaDuration")]
public virtual float? MediaDuration { get; set; }
Property Value
Type | Description |
---|---|
float? |
MimeType
Detected MIME type for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID.
Declaration
[JsonProperty("mimeType")]
public virtual string MimeType { get; set; }
Property Value
Type | Description |
---|---|
string |
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.
Declaration
[JsonProperty("offset")]
public virtual OffsetPosition Offset { get; set; }
Property Value
Type | Description |
---|---|
OffsetPosition |
Orientation
Orientation of video asset. This is a read-only, auto-generated field.
Declaration
[JsonProperty("orientation")]
public virtual string Orientation { get; set; }
Property Value
Type | Description |
---|---|
string |
OriginalBackup
Whether the backup asset is original or changed by the user in Campaign Manager. Applicable to the following creative types: all RICH_MEDIA.
Declaration
[JsonProperty("originalBackup")]
public virtual bool? OriginalBackup { get; set; }
Property Value
Type | Description |
---|---|
bool? |
PoliteLoad
Whether this asset is used as a polite load asset.
Declaration
[JsonProperty("politeLoad")]
public virtual bool? PoliteLoad { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Position
Offset position for an asset. Applicable to the following creative types: all RICH_MEDIA.
Declaration
[JsonProperty("position")]
public virtual OffsetPosition Position { get; set; }
Property Value
Type | Description |
---|---|
OffsetPosition |
PositionLeftUnit
Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
Declaration
[JsonProperty("positionLeftUnit")]
public virtual string PositionLeftUnit { get; set; }
Property Value
Type | Description |
---|---|
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.
Declaration
[JsonProperty("positionTopUnit")]
public virtual string PositionTopUnit { get; set; }
Property Value
Type | Description |
---|---|
string |
ProgressiveServingUrl
Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
Declaration
[JsonProperty("progressiveServingUrl")]
public virtual string ProgressiveServingUrl { get; set; }
Property Value
Type | Description |
---|---|
string |
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.
Declaration
[JsonProperty("pushdown")]
public virtual bool? Pushdown { get; set; }
Property Value
Type | Description |
---|---|
bool? |
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.
Declaration
[JsonProperty("pushdownDuration")]
public virtual float? PushdownDuration { get; set; }
Property Value
Type | Description |
---|---|
float? |
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 Campaign Manager, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives. PARENT_VIDEO refers to videos uploaded by the user in Campaign Manager and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. TRANSCODED_VIDEO refers to videos transcoded by Campaign Manager from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. ALTERNATE_VIDEO refers to the Campaign Manager representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within Campaign Manager. 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. PARENT_AUDIO refers to audios uploaded by the user in Campaign Manager and is applicable to INSTREAM_AUDIO creatives. TRANSCODED_AUDIO refers to audios transcoded by Campaign Manager from PARENT_AUDIO assets and is applicable to INSTREAM_AUDIO creatives.
Declaration
[JsonProperty("role")]
public virtual string Role { get; set; }
Property Value
Type | Description |
---|---|
string |
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.
Declaration
[JsonProperty("size")]
public virtual Size Size { get; set; }
Property Value
Type | Description |
---|---|
Size |
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.
Declaration
[JsonProperty("sslCompliant")]
public virtual bool? SslCompliant { get; set; }
Property Value
Type | Description |
---|---|
bool? |
StartTimeType
Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA.
Declaration
[JsonProperty("startTimeType")]
public virtual string StartTimeType { get; set; }
Property Value
Type | Description |
---|---|
string |
StreamingServingUrl
Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID.
Declaration
[JsonProperty("streamingServingUrl")]
public virtual string StreamingServingUrl { get; set; }
Property Value
Type | Description |
---|---|
string |
Transparency
Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets.
Declaration
[JsonProperty("transparency")]
public virtual bool? Transparency { get; set; }
Property Value
Type | Description |
---|---|
bool? |
VerticallyLocked
Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA.
Declaration
[JsonProperty("verticallyLocked")]
public virtual bool? VerticallyLocked { get; set; }
Property Value
Type | Description |
---|---|
bool? |
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.
Declaration
[JsonProperty("windowMode")]
public virtual string WindowMode { get; set; }
Property Value
Type | Description |
---|---|
string |
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.
Declaration
[JsonProperty("zIndex")]
public virtual int? ZIndex { get; set; }
Property Value
Type | Description |
---|---|
int? |
ZipFilename
File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
Declaration
[JsonProperty("zipFilename")]
public virtual string ZipFilename { get; set; }
Property Value
Type | Description |
---|---|
string |
ZipFilesize
Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER.
Declaration
[JsonProperty("zipFilesize")]
public virtual string ZipFilesize { get; set; }
Property Value
Type | Description |
---|---|
string |