Class: Google::Apis::DfareportingV2_3::CreativeAsset

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dfareporting_v2_3/classes.rb,
generated/google/apis/dfareporting_v2_3/representations.rb,
generated/google/apis/dfareporting_v2_3/representations.rb

Overview

Creative Asset.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ CreativeAsset

Returns a new instance of CreativeAsset.


3072
3073
3074
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 3072

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#action_script3Boolean Also known as: action_script3?

Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE. Corresponds to the JSON property actionScript3

Returns:

  • (Boolean)

2786
2787
2788
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2786

def action_script3
  @action_script3
end

#activeBoolean Also known as: active?

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

Returns:

  • (Boolean)

2794
2795
2796
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2794

def active
  @active
end

#alignmentString

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

Returns:

  • (String)

2801
2802
2803
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2801

def alignment
  @alignment
end

#artwork_typeString

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

Returns:

  • (String)

2807
2808
2809
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2807

def artwork_type
  @artwork_type
end

#asset_identifierGoogle::Apis::DfareportingV2_3::CreativeAssetId

Creative Asset ID. Corresponds to the JSON property assetIdentifier


2812
2813
2814
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2812

def asset_identifier
  @asset_identifier
end

#backup_image_exitGoogle::Apis::DfareportingV2_3::CreativeCustomEvent

Creative Custom Event. Corresponds to the JSON property backupImageExit


2817
2818
2819
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2817

def backup_image_exit
  @backup_image_exit
end

#bit_rateFixnum

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

Returns:

  • (Fixnum)

2823
2824
2825
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2823

def bit_rate
  @bit_rate
end

#child_asset_typeString

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

Returns:

  • (String)

2829
2830
2831
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2829

def child_asset_type
  @child_asset_type
end

#collapsed_sizeGoogle::Apis::DfareportingV2_3::Size

Represents the dimensions of ads, placements, creatives, or creative assets. Corresponds to the JSON property collapsedSize


2834
2835
2836
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2834

def collapsed_size
  @collapsed_size
end

#custom_start_time_valueFixnum

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

Returns:

  • (Fixnum)

2840
2841
2842
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2840

def custom_start_time_value
  @custom_start_time_value
end

#detected_featuresArray<String>

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

Returns:

  • (Array<String>)

2849
2850
2851
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2849

def detected_features
  @detected_features
end

#display_typeString

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

Returns:

  • (String)

2855
2856
2857
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2855

def display_type
  @display_type
end

#durationFixnum

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

Returns:

  • (Fixnum)

2861
2862
2863
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2861

def duration
  @duration
end

#duration_typeString

Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA. Corresponds to the JSON property durationType

Returns:

  • (String)

2867
2868
2869
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2867

def duration_type
  @duration_type
end

#expanded_dimensionGoogle::Apis::DfareportingV2_3::Size

Represents the dimensions of ads, placements, creatives, or creative assets. Corresponds to the JSON property expandedDimension


2872
2873
2874
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2872

def expanded_dimension
  @expanded_dimension
end

#file_sizeString

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

Returns:

  • (String)

2879
2880
2881
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2879

def file_size
  @file_size
end

#flash_versionFixnum

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 ENHANCED_BANNER when the primary asset type is not HTML_IMAGE. Corresponds to the JSON property flashVersion

Returns:

  • (Fixnum)

2886
2887
2888
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2886

def flash_version
  @flash_version
end

#hide_flash_objectsBoolean Also known as: hide_flash_objects?

Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA. Corresponds to the JSON property hideFlashObjects

Returns:

  • (Boolean)

2892
2893
2894
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2892

def hide_flash_objects
  @hide_flash_objects
end

#hide_selection_boxesBoolean Also known as: hide_selection_boxes?

Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA. Corresponds to the JSON property hideSelectionBoxes

Returns:

  • (Boolean)

2899
2900
2901
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2899

def hide_selection_boxes
  @hide_selection_boxes
end

#horizontally_lockedBoolean Also known as: horizontally_locked?

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

Returns:

  • (Boolean)

2906
2907
2908
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2906

def horizontally_locked
  @horizontally_locked
end

#idString

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

Returns:

  • (String)

2914
2915
2916
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2914

def id
  @id
end

#mime_typeString

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

Returns:

  • (String)

2920
2921
2922
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2920

def mime_type
  @mime_type
end

#offsetGoogle::Apis::DfareportingV2_3::OffsetPosition

Offset Position. Corresponds to the JSON property offset


2925
2926
2927
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2925

def offset
  @offset
end

#original_backupBoolean Also known as: original_backup?

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

Returns:

  • (Boolean)

2931
2932
2933
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2931

def original_backup
  @original_backup
end

#positionGoogle::Apis::DfareportingV2_3::OffsetPosition

Offset Position. Corresponds to the JSON property position


2937
2938
2939
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2937

def position
  @position
end

#position_left_unitString

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

Returns:

  • (String)

2943
2944
2945
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2943

def position_left_unit
  @position_left_unit
end

#position_top_unitString

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

Returns:

  • (String)

2950
2951
2952
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2950

def position_top_unit
  @position_top_unit
end

#progressive_serving_urlString

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

Returns:

  • (String)

2956
2957
2958
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2956

def progressive_serving_url
  @progressive_serving_url
end

#pushdownBoolean Also known as: 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. Corresponds to the JSON property pushdown

Returns:

  • (Boolean)

2964
2965
2966
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2964

def pushdown
  @pushdown
end

#pushdown_durationFloat

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 collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height. Corresponds to the JSON property pushdownDuration

Returns:

  • (Float)

2974
2975
2976
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2974

def pushdown_duration
  @pushdown_duration
end

#roleString

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_VIDEO 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

Returns:

  • (String)

2999
3000
3001
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2999

def role
  @role
end

#sizeGoogle::Apis::DfareportingV2_3::Size

Represents the dimensions of ads, placements, creatives, or creative assets. Corresponds to the JSON property size


3004
3005
3006
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 3004

def size
  @size
end

#ssl_compliantBoolean Also known as: ssl_compliant?

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

Returns:

  • (Boolean)

3010
3011
3012
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 3010

def ssl_compliant
  @ssl_compliant
end

#start_time_typeString

Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA. Corresponds to the JSON property startTimeType

Returns:

  • (String)

3017
3018
3019
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 3017

def start_time_type
  @start_time_type
end

#streaming_serving_urlString

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

Returns:

  • (String)

3023
3024
3025
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 3023

def streaming_serving_url
  @streaming_serving_url
end

#transparencyBoolean Also known as: transparency?

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

Returns:

  • (Boolean)

3029
3030
3031
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 3029

def transparency
  @transparency
end

#vertically_lockedBoolean Also known as: vertically_locked?

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

Returns:

  • (Boolean)

3036
3037
3038
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 3036

def vertically_locked
  @vertically_locked
end

#video_durationFloat

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

Returns:

  • (Float)

3043
3044
3045
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 3043

def video_duration
  @video_duration
end

#window_modeString

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

Returns:

  • (String)

3050
3051
3052
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 3050

def window_mode
  @window_mode
end

#z_indexFixnum

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

Returns:

  • (Fixnum)

3058
3059
3060
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 3058

def z_index
  @z_index
end

#zip_filenameString

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

Returns:

  • (String)

3064
3065
3066
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 3064

def zip_filename
  @zip_filename
end

#zip_filesizeString

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

Returns:

  • (String)

3070
3071
3072
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 3070

def zip_filesize
  @zip_filesize
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 3077

def update!(**args)
  @action_script3 = args[:action_script3] if args.key?(:action_script3)
  @active = args[:active] if args.key?(:active)
  @alignment = args[:alignment] if args.key?(:alignment)
  @artwork_type = args[:artwork_type] if args.key?(:artwork_type)
  @asset_identifier = args[:asset_identifier] if args.key?(:asset_identifier)
  @backup_image_exit = args[:backup_image_exit] if args.key?(:backup_image_exit)
  @bit_rate = args[:bit_rate] if args.key?(:bit_rate)
  @child_asset_type = args[:child_asset_type] if args.key?(:child_asset_type)
  @collapsed_size = args[:collapsed_size] if args.key?(:collapsed_size)
  @custom_start_time_value = args[:custom_start_time_value] if args.key?(:custom_start_time_value)
  @detected_features = args[:detected_features] if args.key?(:detected_features)
  @display_type = args[:display_type] if args.key?(:display_type)
  @duration = args[:duration] if args.key?(:duration)
  @duration_type = args[:duration_type] if args.key?(:duration_type)
  @expanded_dimension = args[:expanded_dimension] if args.key?(:expanded_dimension)
  @file_size = args[:file_size] if args.key?(:file_size)
  @flash_version = args[:flash_version] if args.key?(:flash_version)
  @hide_flash_objects = args[:hide_flash_objects] if args.key?(:hide_flash_objects)
  @hide_selection_boxes = args[:hide_selection_boxes] if args.key?(:hide_selection_boxes)
  @horizontally_locked = args[:horizontally_locked] if args.key?(:horizontally_locked)
  @id = args[:id] if args.key?(:id)
  @mime_type = args[:mime_type] if args.key?(:mime_type)
  @offset = args[:offset] if args.key?(:offset)
  @original_backup = args[:original_backup] if args.key?(:original_backup)
  @position = args[:position] if args.key?(:position)
  @position_left_unit = args[:position_left_unit] if args.key?(:position_left_unit)
  @position_top_unit = args[:position_top_unit] if args.key?(:position_top_unit)
  @progressive_serving_url = args[:progressive_serving_url] if args.key?(:progressive_serving_url)
  @pushdown = args[:pushdown] if args.key?(:pushdown)
  @pushdown_duration = args[:pushdown_duration] if args.key?(:pushdown_duration)
  @role = args[:role] if args.key?(:role)
  @size = args[:size] if args.key?(:size)
  @ssl_compliant = args[:ssl_compliant] if args.key?(:ssl_compliant)
  @start_time_type = args[:start_time_type] if args.key?(:start_time_type)
  @streaming_serving_url = args[:streaming_serving_url] if args.key?(:streaming_serving_url)
  @transparency = args[:transparency] if args.key?(:transparency)
  @vertically_locked = args[:vertically_locked] if args.key?(:vertically_locked)
  @video_duration = args[:video_duration] if args.key?(:video_duration)
  @window_mode = args[:window_mode] if args.key?(:window_mode)
  @z_index = args[:z_index] if args.key?(:z_index)
  @zip_filename = args[:zip_filename] if args.key?(:zip_filename)
  @zip_filesize = args[:zip_filesize] if args.key?(:zip_filesize)
end