Class: Google::Apis::DfareportingV2_7::CreativeAsset

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dfareporting_v2_7/classes.rb,
generated/google/apis/dfareporting_v2_7/representations.rb,
generated/google/apis/dfareporting_v2_7/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



3422
3423
3424
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3422

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 type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. Corresponds to the JSON property actionScript3

Returns:

  • (Boolean) 


3119
3120
3121
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3119

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_VIDEO assets. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. Corresponds to the JSON property active

Returns:

  • (Boolean) 


3127
3128
3129
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3127

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_DISPLAY_MULTI_FLOATING_INTERSTITIAL. Corresponds to the JSON property alignment

Returns:

  • (String) 


3134
3135
3136
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3134

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) 


3140
3141
3142
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3140

def artwork_type
  @artwork_type
end

#asset_identifier ⇒ Google::Apis::DfareportingV2_7::CreativeAssetId

Creative Asset ID. Corresponds to the JSON property assetIdentifier

Returns:



3145
3146
3147
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3145

def asset_identifier
  @asset_identifier
end

#backup_image_exit ⇒ Google::Apis::DfareportingV2_7::CreativeCustomEvent

Creative Custom Event. Corresponds to the JSON property backupImageExit

Returns:



3150
3151
3152
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3150

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) 


3156
3157
3158
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3156

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) 


3162
3163
3164
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3162

def child_asset_type
  @child_asset_type
end

#collapsed_size ⇒ Google::Apis::DfareportingV2_7::Size

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

Returns:



3167
3168
3169
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3167

def collapsed_size
  @collapsed_size
end

#companion_creative_ids ⇒ Array<Fixnum>

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. Corresponds to the JSON property companionCreativeIds

Returns:

  • (Array<Fixnum>) 


3175
3176
3177
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3175

def companion_creative_ids
  @companion_creative_ids
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. Value must be greater than or equal to 0. Corresponds to the JSON property customStartTimeValue

Returns:

  • (Fixnum) 


3182
3183
3184
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3182

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: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. Corresponds to the JSON property detectedFeatures

Returns:

  • (Array<String>) 


3191
3192
3193
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3191

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) 


3197
3198
3199
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3197

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_VIDEO. Value must be greater than or equal to 1. Corresponds to the JSON property duration

Returns:

  • (Fixnum) 


3204
3205
3206
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3204

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) 


3210
3211
3212
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3210

def duration_type
  @duration_type
end

#expanded_dimension ⇒ Google::Apis::DfareportingV2_7::Size

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

Returns:



3215
3216
3217
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3215

def expanded_dimension
  @expanded_dimension
end

#file_size ⇒ Fixnum

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:

  • (Fixnum) 


3222
3223
3224
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3222

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, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. Corresponds to the JSON property flashVersion

Returns:

  • (Fixnum) 


3229
3230
3231
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3229

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) 


3235
3236
3237
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3235

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) 


3242
3243
3244
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3242

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) 


3249
3250
3251
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3249

def horizontally_locked
  @horizontally_locked
end

#id ⇒ Fixnum

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:

  • (Fixnum) 


3257
3258
3259
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3257

def id
  @id
end

#id_dimension_value ⇒ Google::Apis::DfareportingV2_7::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue

Returns:



3262
3263
3264
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3262

def id_dimension_value
  @id_dimension_value
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) 


3268
3269
3270
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3268

def mime_type
  @mime_type
end

#offset ⇒ Google::Apis::DfareportingV2_7::OffsetPosition

Offset Position. Corresponds to the JSON property offset

Returns:



3273
3274
3275
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3273

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) 


3279
3280
3281
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3279

def original_backup
  @original_backup
end

#position ⇒ Google::Apis::DfareportingV2_7::OffsetPosition

Offset Position. Corresponds to the JSON property position

Returns:



3285
3286
3287
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3285

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) 


3291
3292
3293
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3291

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) 


3298
3299
3300
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3298

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) 


3304
3305
3306
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3304

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) 


3312
3313
3314
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3312

def pushdown
  @pushdown
end

#pushdown_duration ⇒ Float

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. Corresponds to the JSON property pushdownDuration

Returns:

  • (Float) 


3322
3323
3324
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3322

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 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. Corresponds to the JSON property role

Returns:

  • (String) 


3348
3349
3350
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3348

def role
  @role
end

#size ⇒ Google::Apis::DfareportingV2_7::Size

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

Returns:



3353
3354
3355
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3353

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) 


3359
3360
3361
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3359

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) 


3366
3367
3368
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3366

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) 


3372
3373
3374
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3372

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) 


3378
3379
3380
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3378

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) 


3385
3386
3387
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3385

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) 


3392
3393
3394
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3392

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_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING. Corresponds to the JSON property windowMode

Returns:

  • (String) 


3399
3400
3401
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3399

def window_mode
  @window_mode
end

#z_index ⇒ Fixnum

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. Corresponds to the JSON property zIndex

Returns:

  • (Fixnum) 


3408
3409
3410
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3408

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) 


3414
3415
3416
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3414

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) 


3420
3421
3422
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3420

def zip_filesize
  @zip_filesize
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3427

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)
  @companion_creative_ids = args[:companion_creative_ids] if args.key?(:companion_creative_ids)
  @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)
  @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value)
  @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