Class: Google::Apis::DfareportingV2_1::CreativeAsset

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

Overview

Creative Asset.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ CreativeAsset

Returns a new instance of CreativeAsset.



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

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

Instance Attribute Details

#action_script3 ⇒ Boolean Also known as: action_script3?

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

Returns:

  • (Boolean) 


2737
2738
2739
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2737

def action_script3
  @action_script3
end

#active ⇒ Boolean 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) 


2745
2746
2747
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2745

def active
  @active
end

#alignment ⇒ String

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) 


2752
2753
2754
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2752

def alignment
  @alignment
end

#artwork_type ⇒ String

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) 


2758
2759
2760
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2758

def artwork_type
  @artwork_type
end

#asset_identifier ⇒ Google::Apis::DfareportingV2_1::CreativeAssetId

Creative Asset ID. Corresponds to the JSON property assetIdentifier

Returns:



2763
2764
2765
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2763

def asset_identifier
  @asset_identifier
end

#backup_image_exit ⇒ Google::Apis::DfareportingV2_1::CreativeCustomEvent

Creative Custom Event. Corresponds to the JSON property backupImageExit

Returns:



2768
2769
2770
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2768

def backup_image_exit
  @backup_image_exit
end

#bit_rate ⇒ Fixnum

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) 


2774
2775
2776
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2774

def bit_rate
  @bit_rate
end

#child_asset_type ⇒ String

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) 


2780
2781
2782
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2780

def child_asset_type
  @child_asset_type
end

#collapsed_size ⇒ Google::Apis::DfareportingV2_1::Size

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

Returns:



2785
2786
2787
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2785

def collapsed_size
  @collapsed_size
end

#custom_start_time_value ⇒ Fixnum

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) 


2791
2792
2793
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2791

def custom_start_time_value
  @custom_start_time_value
end

#detected_features ⇒ Array<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>) 


2800
2801
2802
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2800

def detected_features
  @detected_features
end

#display_type ⇒ String

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) 


2806
2807
2808
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2806

def display_type
  @display_type
end

#duration ⇒ Fixnum

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) 


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

def duration
  @duration
end

#duration_type ⇒ String

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) 


2818
2819
2820
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2818

def duration_type
  @duration_type
end

#expanded_dimension ⇒ Google::Apis::DfareportingV2_1::Size

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

Returns:



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

def expanded_dimension
  @expanded_dimension
end

#file_size ⇒ String

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) 


2830
2831
2832
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2830

def file_size
  @file_size
end

#flash_version ⇒ Fixnum

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

Returns:

  • (Fixnum) 


2837
2838
2839
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2837

def flash_version
  @flash_version
end

#hide_flash_objects ⇒ Boolean 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) 


2843
2844
2845
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2843

def hide_flash_objects
  @hide_flash_objects
end

#hide_selection_boxes ⇒ Boolean 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) 


2850
2851
2852
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2850

def hide_selection_boxes
  @hide_selection_boxes
end

#horizontally_locked ⇒ Boolean 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) 


2857
2858
2859
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2857

def horizontally_locked
  @horizontally_locked
end

#id ⇒ String

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) 


2865
2866
2867
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2865

def id
  @id
end

#mime_type ⇒ String

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) 


2871
2872
2873
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2871

def mime_type
  @mime_type
end

#offset ⇒ Google::Apis::DfareportingV2_1::OffsetPosition

Offset Position. Corresponds to the JSON property offset

Returns:



2876
2877
2878
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2876

def offset
  @offset
end

#original_backup ⇒ Boolean 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) 


2882
2883
2884
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2882

def original_backup
  @original_backup
end

#position ⇒ Google::Apis::DfareportingV2_1::OffsetPosition

Offset Position. Corresponds to the JSON property position

Returns:



2888
2889
2890
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2888

def position
  @position
end

#position_left_unit ⇒ String

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) 


2894
2895
2896
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2894

def position_left_unit
  @position_left_unit
end

#position_top_unit ⇒ String

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) 


2901
2902
2903
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2901

def position_top_unit
  @position_top_unit
end

#progressive_serving_url ⇒ String

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) 


2907
2908
2909
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2907

def progressive_serving_url
  @progressive_serving_url
end

#pushdown ⇒ Boolean 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) 


2915
2916
2917
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2915

def pushdown
  @pushdown
end

#pushdown_duration ⇒ Float

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) 


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

def pushdown_duration
  @pushdown_duration
end

#role ⇒ String

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

Returns:

  • (String) 


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

def role
  @role
end

#size ⇒ Google::Apis::DfareportingV2_1::Size

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

Returns:



2955
2956
2957
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2955

def size
  @size
end

#ssl_compliant ⇒ Boolean 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) 


2961
2962
2963
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2961

def ssl_compliant
  @ssl_compliant
end

#start_time_type ⇒ String

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) 


2968
2969
2970
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2968

def start_time_type
  @start_time_type
end

#streaming_serving_url ⇒ String

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) 


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

def streaming_serving_url
  @streaming_serving_url
end

#transparency ⇒ Boolean 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) 


2980
2981
2982
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2980

def transparency
  @transparency
end

#vertically_locked ⇒ Boolean 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) 


2987
2988
2989
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2987

def vertically_locked
  @vertically_locked
end

#video_duration ⇒ Float

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) 


2994
2995
2996
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2994

def video_duration
  @video_duration
end

#window_mode ⇒ String

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) 


3001
3002
3003
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 3001

def window_mode
  @window_mode
end

#z_index ⇒ Fixnum

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) 


3009
3010
3011
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 3009

def z_index
  @z_index
end

#zip_filename ⇒ String

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) 


3015
3016
3017
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 3015

def zip_filename
  @zip_filename
end

#zip_filesize ⇒ String

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) 


3021
3022
3023
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 3021

def zip_filesize
  @zip_filesize
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
 
# 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