class Google::Apis::DfareportingV2_1::CreativeAsset

Creative Asset.

Attributes

action_script3[RW]

Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE and ENHANCED_BANNER. Corresponds to the JSON property `actionScript3` @return [Boolean]

action_script3?[RW]

Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE and ENHANCED_BANNER. Corresponds to the JSON property `actionScript3` @return [Boolean]

active[RW]

Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. Corresponds to the JSON property `active` @return [Boolean]

active?[RW]

Whether the video asset is active. This is a read-only field for VPAID_NON_LINEAR assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. Corresponds to the JSON property `active` @return [Boolean]

alignment[RW]

Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_MULTI_FLOATING. Corresponds to the JSON property `alignment` @return [String]

artwork_type[RW]

Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. Corresponds to the JSON property `artworkType` @return [String]

asset_identifier[RW]

Creative Asset ID. Corresponds to the JSON property `assetIdentifier` @return [Google::Apis::DfareportingV2_1::CreativeAssetId]

backup_image_exit[RW]

Creative Custom Event. Corresponds to the JSON property `backupImageExit` @return [Google::Apis::DfareportingV2_1::CreativeCustomEvent]

bit_rate[RW]

Detected bit-rate for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. Corresponds to the JSON property `bitRate` @return [Fixnum]

child_asset_type[RW]

Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID. Corresponds to the JSON property `childAssetType` @return [String]

collapsed_size[RW]

Represents the dimensions of ads, placements, creatives, or creative assets. Corresponds to the JSON property `collapsedSize` @return [Google::Apis::DfareportingV2_1::Size]

custom_start_time_value[RW]

Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA. Corresponds to the JSON property `customStartTimeValue` @return [Fixnum]

detected_features[RW]

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: ENHANCED_BANNER and HTML5_BANNER. Corresponds to the JSON property `detectedFeatures` @return [Array<String>]

display_type[RW]

Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. Corresponds to the JSON property `displayType` @return [String]

duration[RW]

Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_VIDEO and VPAID_LINEAR. Corresponds to the JSON property `duration` @return [Fixnum]

duration_type[RW]

Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA. Corresponds to the JSON property `durationType` @return [String]

expanded_dimension[RW]

Represents the dimensions of ads, placements, creatives, or creative assets. Corresponds to the JSON property `expandedDimension` @return [Google::Apis::DfareportingV2_1::Size]

file_size[RW]

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. Corresponds to the JSON property `fileSize` @return [String]

flash_version[RW]

Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID. Corresponds to the JSON property `flashVersion` @return [Fixnum]

hide_flash_objects[RW]

Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA. Corresponds to the JSON property `hideFlashObjects` @return [Boolean]

hide_flash_objects?[RW]

Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA. Corresponds to the JSON property `hideFlashObjects` @return [Boolean]

hide_selection_boxes[RW]

Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA. Corresponds to the JSON property `hideSelectionBoxes` @return [Boolean]

hide_selection_boxes?[RW]

Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA. Corresponds to the JSON property `hideSelectionBoxes` @return [Boolean]

horizontally_locked[RW]

Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. Corresponds to the JSON property `horizontallyLocked` @return [Boolean]

horizontally_locked?[RW]

Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. Corresponds to the JSON property `horizontallyLocked` @return [Boolean]

id[RW]

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. Corresponds to the JSON property `id` @return [String]

mime_type[RW]

Detected MIME type for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. Corresponds to the JSON property `mimeType` @return [String]

offset[RW]

Offset Position. Corresponds to the JSON property `offset` @return [Google::Apis::DfareportingV2_1::OffsetPosition]

original_backup[RW]

Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA. Corresponds to the JSON property `originalBackup` @return [Boolean]

original_backup?[RW]

Whether the backup asset is original or changed by the user in DCM. Applicable to the following creative types: all RICH_MEDIA. Corresponds to the JSON property `originalBackup` @return [Boolean]

position[RW]

Offset Position. Corresponds to the JSON property `position` @return [Google::Apis::DfareportingV2_1::OffsetPosition]

position_left_unit[RW]

Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. Corresponds to the JSON property `positionLeftUnit` @return [String]

position_top_unit[RW]

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. Corresponds to the JSON property `positionTopUnit` @return [String]

progressive_serving_url[RW]

Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. Corresponds to the JSON property `progressiveServingUrl` @return [String]

pushdown[RW]

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 Google::Apis::DfareportingV2_1::Size#width matches size.width, and the Google::Apis::DfareportingV2_1::Size#height is less than size.height. Corresponds to the JSON property `pushdown` @return [Boolean]

pushdown?[RW]

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 Google::Apis::DfareportingV2_1::Size#width matches size.width, and the Google::Apis::DfareportingV2_1::Size#height is less than size.height. Corresponds to the JSON property `pushdown` @return [Boolean]

pushdown_duration[RW]

Pushdown duration in seconds for an asset. Must be between 0 and 9.99. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the Google::Apis::DfareportingV2_1::Size#width matches size.width, and the Google::Apis::DfareportingV2_1::Size#height is less than size.height. Corresponds to the JSON property `pushdownDuration` @return [Float]

role[RW]

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 ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, IMAGE, IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives. BACKUP_IMAGE applies to ENHANCED_BANNER, FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. 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 creatives. TRANSCODED_VIDEO refers to videos transcoded by DCM from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR creatives. ALTERNATE_VIDEO refers to the DCM representation of child asset videos from Studio, and is applicable to VPAID_LINEAR creatives. These cannot be added or removed within DCM. For VPAID_LINEAR 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 creative. Corresponds to the JSON property `role` @return [String]

size[RW]

Represents the dimensions of ads, placements, creatives, or creative assets. Corresponds to the JSON property `size` @return [Google::Apis::DfareportingV2_1::Size]

ssl_compliant[RW]

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. Corresponds to the JSON property `sslCompliant` @return [Boolean]

ssl_compliant?[RW]

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. Corresponds to the JSON property `sslCompliant` @return [Boolean]

start_time_type[RW]

Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA. Corresponds to the JSON property `startTimeType` @return [String]

streaming_serving_url[RW]

Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. Corresponds to the JSON property `streamingServingUrl` @return [String]

transparency[RW]

Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets. Corresponds to the JSON property `transparency` @return [Boolean]

transparency?[RW]

Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets. Corresponds to the JSON property `transparency` @return [Boolean]

vertically_locked[RW]

Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. Corresponds to the JSON property `verticallyLocked` @return [Boolean]

vertically_locked?[RW]

Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. Corresponds to the JSON property `verticallyLocked` @return [Boolean]

video_duration[RW]

Detected video duration for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. Corresponds to the JSON property `videoDuration` @return [Float]

window_mode[RW]

Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_INPAGE, and RICH_MEDIA_INPAGE_FLOATING. Corresponds to the JSON property `windowMode` @return [String]

z_index[RW]

zIndex value of an asset. This is a read-only field. 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. Corresponds to the JSON property `zIndex` @return [Fixnum]

zip_filename[RW]

File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER. Corresponds to the JSON property `zipFilename` @return [String]

zip_filesize[RW]

Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER. Corresponds to the JSON property `zipFilesize` @return [String]

Public Class Methods

new(**args) click to toggle source
# File generated/google/apis/dfareporting_v2_1/classes.rb, line 3023
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File generated/google/apis/dfareporting_v2_1/classes.rb, line 3028
def update!(**args)
  @action_script3 = args[:action_script3] unless args[:action_script3].nil?
  @active = args[:active] unless args[:active].nil?
  @alignment = args[:alignment] unless args[:alignment].nil?
  @artwork_type = args[:artwork_type] unless args[:artwork_type].nil?
  @asset_identifier = args[:asset_identifier] unless args[:asset_identifier].nil?
  @backup_image_exit = args[:backup_image_exit] unless args[:backup_image_exit].nil?
  @bit_rate = args[:bit_rate] unless args[:bit_rate].nil?
  @child_asset_type = args[:child_asset_type] unless args[:child_asset_type].nil?
  @collapsed_size = args[:collapsed_size] unless args[:collapsed_size].nil?
  @custom_start_time_value = args[:custom_start_time_value] unless args[:custom_start_time_value].nil?
  @detected_features = args[:detected_features] unless args[:detected_features].nil?
  @display_type = args[:display_type] unless args[:display_type].nil?
  @duration = args[:duration] unless args[:duration].nil?
  @duration_type = args[:duration_type] unless args[:duration_type].nil?
  @expanded_dimension = args[:expanded_dimension] unless args[:expanded_dimension].nil?
  @file_size = args[:file_size] unless args[:file_size].nil?
  @flash_version = args[:flash_version] unless args[:flash_version].nil?
  @hide_flash_objects = args[:hide_flash_objects] unless args[:hide_flash_objects].nil?
  @hide_selection_boxes = args[:hide_selection_boxes] unless args[:hide_selection_boxes].nil?
  @horizontally_locked = args[:horizontally_locked] unless args[:horizontally_locked].nil?
  @id = args[:id] unless args[:id].nil?
  @mime_type = args[:mime_type] unless args[:mime_type].nil?
  @offset = args[:offset] unless args[:offset].nil?
  @original_backup = args[:original_backup] unless args[:original_backup].nil?
  @position = args[:position] unless args[:position].nil?
  @position_left_unit = args[:position_left_unit] unless args[:position_left_unit].nil?
  @position_top_unit = args[:position_top_unit] unless args[:position_top_unit].nil?
  @progressive_serving_url = args[:progressive_serving_url] unless args[:progressive_serving_url].nil?
  @pushdown = args[:pushdown] unless args[:pushdown].nil?
  @pushdown_duration = args[:pushdown_duration] unless args[:pushdown_duration].nil?
  @role = args[:role] unless args[:role].nil?
  @size = args[:size] unless args[:size].nil?
  @ssl_compliant = args[:ssl_compliant] unless args[:ssl_compliant].nil?
  @start_time_type = args[:start_time_type] unless args[:start_time_type].nil?
  @streaming_serving_url = args[:streaming_serving_url] unless args[:streaming_serving_url].nil?
  @transparency = args[:transparency] unless args[:transparency].nil?
  @vertically_locked = args[:vertically_locked] unless args[:vertically_locked].nil?
  @video_duration = args[:video_duration] unless args[:video_duration].nil?
  @window_mode = args[:window_mode] unless args[:window_mode].nil?
  @z_index = args[:z_index] unless args[:z_index].nil?
  @zip_filename = args[:zip_filename] unless args[:zip_filename].nil?
  @zip_filesize = args[:zip_filesize] unless args[:zip_filesize].nil?
end