Class: Google::Apis::DfareportingV3_2::CreativeAsset

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



3649
3650
3651
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3649

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

Returns:

  • (Boolean)


3327
3328
3329
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3327

def action_script3
  @action_script3
end

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

Returns:

  • (Boolean)


3335
3336
3337
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3335

def active
  @active
end

#additional_sizesArray<Google::Apis::DfareportingV3_2::Size>

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



3343
3344
3345
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3343

def additional_sizes
  @additional_sizes
end

#alignmentString

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)


3349
3350
3351
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3349

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)


3355
3356
3357
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3355

def artwork_type
  @artwork_type
end

#asset_identifierGoogle::Apis::DfareportingV3_2::CreativeAssetId

Creative Asset ID. Corresponds to the JSON property assetIdentifier



3360
3361
3362
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3360

def asset_identifier
  @asset_identifier
end

#backup_image_exitGoogle::Apis::DfareportingV3_2::CreativeCustomEvent

Creative Custom Event. Corresponds to the JSON property backupImageExit



3365
3366
3367
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3365

def backup_image_exit
  @backup_image_exit
end

#bit_rateFixnum

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

Returns:

  • (Fixnum)


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

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)


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

def child_asset_type
  @child_asset_type
end

#collapsed_sizeGoogle::Apis::DfareportingV3_2::Size

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



3383
3384
3385
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3383

def collapsed_size
  @collapsed_size
end

#companion_creative_idsArray<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>)


3391
3392
3393
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3391

def companion_creative_ids
  @companion_creative_ids
end

#custom_start_time_valueFixnum

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)


3398
3399
3400
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3398

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

Returns:

  • (Array<String>)


3407
3408
3409
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3407

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)


3413
3414
3415
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3413

def display_type
  @display_type
end

#durationFixnum

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

Returns:

  • (Fixnum)


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

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)


3426
3427
3428
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3426

def duration_type
  @duration_type
end

#expanded_dimensionGoogle::Apis::DfareportingV3_2::Size

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



3431
3432
3433
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3431

def expanded_dimension
  @expanded_dimension
end

#file_sizeFixnum

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)


3438
3439
3440
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3438

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

Returns:

  • (Fixnum)


3445
3446
3447
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3445

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)


3451
3452
3453
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3451

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)


3458
3459
3460
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3458

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)


3465
3466
3467
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3465

def horizontally_locked
  @horizontally_locked
end

#idFixnum

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)


3473
3474
3475
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3473

def id
  @id
end

#id_dimension_valueGoogle::Apis::DfareportingV3_2::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue



3478
3479
3480
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3478

def id_dimension_value
  @id_dimension_value
end

#media_durationFloat

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

Returns:

  • (Float)


3485
3486
3487
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3485

def media_duration
  @media_duration
end

#mime_typeString

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

Returns:

  • (String)


3492
3493
3494
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3492

def mime_type
  @mime_type
end

#offsetGoogle::Apis::DfareportingV3_2::OffsetPosition

Offset Position. Corresponds to the JSON property offset



3497
3498
3499
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3497

def offset
  @offset
end

#orientationString

Orientation of video asset. This is a read-only, auto-generated field. Corresponds to the JSON property orientation

Returns:

  • (String)


3502
3503
3504
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3502

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


3508
3509
3510
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3508

def original_backup
  @original_backup
end

#positionGoogle::Apis::DfareportingV3_2::OffsetPosition

Offset Position. Corresponds to the JSON property position



3514
3515
3516
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3514

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)


3520
3521
3522
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3520

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)


3527
3528
3529
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3527

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)


3533
3534
3535
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3533

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)


3541
3542
3543
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3541

def pushdown
  @pushdown
end

#pushdown_durationFloat

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)


3551
3552
3553
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3551

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 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. PARENT_AUDIO refers to audios uploaded by the user in DCM and is applicable to INSTREAM_AUDIO creatives. TRANSCODED_AUDIO refers to audios transcoded by DCM from PARENT_AUDIO assets and is applicable to INSTREAM_AUDIO creatives. Corresponds to the JSON property role

Returns:

  • (String)


3581
3582
3583
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3581

def role
  @role
end

#sizeGoogle::Apis::DfareportingV3_2::Size

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



3586
3587
3588
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3586

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)


3592
3593
3594
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3592

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)


3599
3600
3601
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3599

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)


3605
3606
3607
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3605

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)


3611
3612
3613
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3611

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)


3618
3619
3620
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3618

def vertically_locked
  @vertically_locked
end

#window_modeString

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)


3626
3627
3628
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3626

def window_mode
  @window_mode
end

#z_indexFixnum

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)


3635
3636
3637
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3635

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)


3641
3642
3643
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3641

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)


3647
3648
3649
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3647

def zip_filesize
  @zip_filesize
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 3654

def update!(**args)
  @action_script3 = args[:action_script3] if args.key?(:action_script3)
  @active = args[:active] if args.key?(:active)
  @additional_sizes = args[:additional_sizes] if args.key?(:additional_sizes)
  @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)
  @media_duration = args[:media_duration] if args.key?(:media_duration)
  @mime_type = args[:mime_type] if args.key?(:mime_type)
  @offset = args[:offset] if args.key?(:offset)
  @orientation = args[:orientation] if args.key?(:orientation)
  @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)
  @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