Class: Google::Apis::DfareportingV2_3::Creative

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

Contains properties of a Creative.

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) ⇒ Creative

Returns a new instance of Creative.



2710
2711
2712
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2710

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

Instance Attribute Details

#account_id ⇒ String

Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types. Corresponds to the JSON property accountId

Returns:

  • (String) 


2300
2301
2302
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2300

def 
  @account_id
end

#active ⇒ Boolean Also known as: active?

Whether the creative is active. Applicable to all creative types. Corresponds to the JSON property active

Returns:

  • (Boolean) 


2305
2306
2307
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2305

def active
  @active
end

#ad_parameters ⇒ String

Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID. Corresponds to the JSON property adParameters

Returns:

  • (String) 


2312
2313
2314
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2312

def ad_parameters
  @ad_parameters
end

#ad_tag_keys ⇒ Array<String>

Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. Corresponds to the JSON property adTagKeys

Returns:

  • (Array<String>) 


2321
2322
2323
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2321

def ad_tag_keys
  @ad_tag_keys
end

#advertiser_id ⇒ String

Advertiser ID of this creative. This is a required field. Applicable to all creative types. Corresponds to the JSON property advertiserId

Returns:

  • (String) 


2327
2328
2329
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2327

def advertiser_id
  @advertiser_id
end

#allow_script_access ⇒ Boolean Also known as: allow_script_access?

Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE. Corresponds to the JSON property allowScriptAccess

Returns:

  • (Boolean) 


2334
2335
2336
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2334

def allow_script_access
  @allow_script_access
end

#archived ⇒ Boolean Also known as: archived?

Whether the creative is archived. Applicable to all creative types. Corresponds to the JSON property archived

Returns:

  • (Boolean) 


2340
2341
2342
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2340

def archived
  @archived
end

#artwork_type ⇒ String

Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. Corresponds to the JSON property artworkType

Returns:

  • (String) 


2347
2348
2349
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2347

def artwork_type
  @artwork_type
end

#authoring_source ⇒ String

Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types. Corresponds to the JSON property authoringSource

Returns:

  • (String) 


2353
2354
2355
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2353

def authoring_source
  @authoring_source
end

#authoring_tool ⇒ String

Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER. Corresponds to the JSON property authoringTool

Returns:

  • (String) 


2359
2360
2361
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2359

def authoring_tool
  @authoring_tool
end

#auto_advance_images ⇒ Boolean Also known as: auto_advance_images?

Whether images are automatically advanced for enhanced image creatives. Applicable to the following creative types: ENHANCED_IMAGE. Corresponds to the JSON property auto_advance_images

Returns:

  • (Boolean) 


2365
2366
2367
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2365

def auto_advance_images
  @auto_advance_images
end

#background_color ⇒ String

The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE. Corresponds to the JSON property backgroundColor

Returns:

  • (String) 


2373
2374
2375
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2373

def background_color
  @background_color
end

#backup_image_click_through_url ⇒ String

Click-through URL for backup image. Applicable to the following creative types: FLASH_INPAGE, and HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE. Corresponds to the JSON property backupImageClickThroughUrl

Returns:

  • (String) 


2380
2381
2382
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2380

def backup_image_click_through_url
  @backup_image_click_through_url
end

#backup_image_features ⇒ Array<String>

List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by DCM for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE. Corresponds to the JSON property backupImageFeatures

Returns:

  • (Array<String>) 


2393
2394
2395
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2393

def backup_image_features
  @backup_image_features
end

#backup_image_reporting_label ⇒ String

Reporting label used for HTML5 banner backup image. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE. Corresponds to the JSON property backupImageReportingLabel

Returns:

  • (String) 


2399
2400
2401
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2399

def backup_image_reporting_label
  @backup_image_reporting_label
end

#backup_image_target_window ⇒ Google::Apis::DfareportingV2_3::TargetWindow

Target Window. Corresponds to the JSON property backupImageTargetWindow

Returns:



2404
2405
2406
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2404

def backup_image_target_window
  @backup_image_target_window
end

#click_tags ⇒ Array<Google::Apis::DfareportingV2_3::ClickTag>

Click tags of the creative. For ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For ENHANCED_IMAGE creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: ENHANCED_IMAGE, FLASH_INPAGE HTML5_BANNER. Applicable to ENHANCED_BANNER when the primary asset type is not HTML_IMAGE. Corresponds to the JSON property clickTags

Returns:



2420
2421
2422
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2420

def click_tags
  @click_tags
end

#commercial_id ⇒ String

Industry standard ID assigned to creative for reach and frequency. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID. Corresponds to the JSON property commercialId

Returns:

  • (String) 


2426
2427
2428
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2426

def commercial_id
  @commercial_id
end

#companion_creatives ⇒ Array<String>

List of companion creatives assigned to an in-Stream videocreative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID. Corresponds to the JSON property companionCreatives

Returns:

  • (Array<String>) 


2433
2434
2435
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2433

def companion_creatives
  @companion_creatives
end

#compatibility ⇒ Array<String>

Compatibilities associated with this creative. This is a read-only field. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types. Acceptable values are:

  • "APP"
  • "APP_INTERSTITIAL"
  • "IN_STREAM_VIDEO"
  • "WEB"
  • "WEB_INTERSTITIAL" Corresponds to the JSON property compatibility

Returns:

  • (Array<String>) 


2448
2449
2450
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2448

def compatibility
  @compatibility
end

#convert_flash_to_html5 ⇒ Boolean Also known as: convert_flash_to_html5?

Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. 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 convertFlashToHtml5

Returns:

  • (Boolean) 


2457
2458
2459
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2457

def convert_flash_to_html5
  @convert_flash_to_html5
end

#counter_custom_events ⇒ Array<Google::Apis::DfareportingV2_3::CreativeCustomEvent>

List of counter events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Corresponds to the JSON property counterCustomEvents

Returns:



2465
2466
2467
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2465

def counter_custom_events
  @counter_custom_events
end

#creative_assets ⇒ Array<Google::Apis::DfareportingV2_3::CreativeAsset>

Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT Corresponds to the JSON property creativeAssets

Returns:



2472
2473
2474
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2472

def creative_assets
  @creative_assets
end

#creative_field_assignments ⇒ Array<Google::Apis::DfareportingV2_3::CreativeFieldAssignment>

Creative field assignments for this creative. Applicable to all creative types. Corresponds to the JSON property creativeFieldAssignments

Returns:



2477
2478
2479
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2477

def creative_field_assignments
  @creative_field_assignments
end

#custom_key_values ⇒ Array<String>

Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. Corresponds to the JSON property customKeyValues

Returns:

  • (Array<String>) 


2486
2487
2488
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2486

def custom_key_values
  @custom_key_values
end

#exit_custom_events ⇒ Array<Google::Apis::DfareportingV2_3::CreativeCustomEvent>

List of exit events configured for the creative. For ENHANCED_BANNER and ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags, For ENHANCED_BANNER, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE. Corresponds to the JSON property exitCustomEvents

Returns:



2496
2497
2498
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2496

def exit_custom_events
  @exit_custom_events
end

#fs_command ⇒ Google::Apis::DfareportingV2_3::FsCommand

FsCommand. Corresponds to the JSON property fsCommand

Returns:



2501
2502
2503
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2501

def fs_command
  @fs_command
end

#html_code ⇒ String

HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is false. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA. Corresponds to the JSON property htmlCode

Returns:

  • (String) 


2508
2509
2510
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2508

def html_code
  @html_code
end

#html_code_locked ⇒ Boolean Also known as: html_code_locked?

Whether HTML code is DCM-generated or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Corresponds to the JSON property htmlCodeLocked

Returns:

  • (Boolean) 


2515
2516
2517
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2515

def html_code_locked
  @html_code_locked
end

#id ⇒ String

ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types. Corresponds to the JSON property id

Returns:

  • (String) 


2522
2523
2524
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2522

def id
  @id
end

#id_dimension_value ⇒ Google::Apis::DfareportingV2_3::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue

Returns:



2527
2528
2529
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2527

def id_dimension_value
  @id_dimension_value
end

#kind ⇒ String

Identifies what kind of resource this is. Value: the fixed string " dfareporting#creative". Corresponds to the JSON property kind

Returns:

  • (String) 


2533
2534
2535
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2533

def kind
  @kind
end

#last_modified_info ⇒ Google::Apis::DfareportingV2_3::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property lastModifiedInfo

Returns:



2538
2539
2540
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2538

def last_modified_info
  @last_modified_info
end

#latest_trafficked_creative_id ⇒ String

Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. Corresponds to the JSON property latestTraffickedCreativeId

Returns:

  • (String) 


2545
2546
2547
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2545

def latest_trafficked_creative_id
  @latest_trafficked_creative_id
end

#name ⇒ String

Name of the creative. This is a required field and must be less than 256 characters long. Applicable to all creative types. Corresponds to the JSON property name

Returns:

  • (String) 


2551
2552
2553
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2551

def name
  @name
end

#override_css ⇒ String

Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA. Corresponds to the JSON property overrideCss

Returns:

  • (String) 


2557
2558
2559
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2557

def override_css
  @override_css
end

#redirect_url ⇒ String

URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, REDIRECT, and INSTREAM_VIDEO_REDIRECT Corresponds to the JSON property redirectUrl

Returns:

  • (String) 


2567
2568
2569
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2567

def redirect_url
  @redirect_url
end

#rendering_id ⇒ String

ID of current rendering version. This is a read-only field. Applicable to all creative types. Corresponds to the JSON property renderingId

Returns:

  • (String) 


2573
2574
2575
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2573

def rendering_id
  @rendering_id
end

#rendering_id_dimension_value ⇒ Google::Apis::DfareportingV2_3::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property renderingIdDimensionValue

Returns:



2578
2579
2580
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2578

def rendering_id_dimension_value
  @rendering_id_dimension_value
end

#required_flash_plugin_version ⇒ String

The minimum required Flash plugin version for this creative. For example, 11.2. 202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. Corresponds to the JSON property requiredFlashPluginVersion

Returns:

  • (String) 


2585
2586
2587
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2585

def required_flash_plugin_version
  @required_flash_plugin_version
end

#required_flash_version ⇒ Fixnum

The internal Flash version for this creative as calculated by DoubleClick Studio. 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 requiredFlashVersion

Returns:

  • (Fixnum) 


2593
2594
2595
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2593

def required_flash_version
  @required_flash_version
end

#size ⇒ Google::Apis::DfareportingV2_3::Size

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

Returns:



2598
2599
2600
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2598

def size
  @size
end

#skippable ⇒ Boolean Also known as: skippable?

Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID. Corresponds to the JSON property skippable

Returns:

  • (Boolean) 


2604
2605
2606
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2604

def skippable
  @skippable
end

#ssl_compliant ⇒ Boolean Also known as: ssl_compliant?

Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types. Corresponds to the JSON property sslCompliant

Returns:

  • (Boolean) 


2611
2612
2613
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2611

def ssl_compliant
  @ssl_compliant
end

#ssl_override ⇒ Boolean Also known as: ssl_override?

Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types. Corresponds to the JSON property sslOverride

Returns:

  • (Boolean) 


2618
2619
2620
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2618

def ssl_override
  @ssl_override
end

#studio_advertiser_id ⇒ String

Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. Corresponds to the JSON property studioAdvertiserId

Returns:

  • (String) 


2626
2627
2628
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2626

def studio_advertiser_id
  @studio_advertiser_id
end

#studio_creative_id ⇒ String

Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. Corresponds to the JSON property studioCreativeId

Returns:

  • (String) 


2633
2634
2635
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2633

def studio_creative_id
  @studio_creative_id
end

#studio_trafficked_creative_id ⇒ String

Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. Corresponds to the JSON property studioTraffickedCreativeId

Returns:

  • (String) 


2640
2641
2642
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2640

def studio_trafficked_creative_id
  @studio_trafficked_creative_id
end

#subaccount_id ⇒ String

Subaccount ID of this creative. This field, if left unset, will be auto- generated for both insert and update operations. Applicable to all creative types. Corresponds to the JSON property subaccountId

Returns:

  • (String) 


2647
2648
2649
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2647

def subaccount_id
  @subaccount_id
end

#third_party_backup_image_impressions_url ⇒ String

Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA. Corresponds to the JSON property thirdPartyBackupImageImpressionsUrl

Returns:

  • (String) 


2653
2654
2655
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2653

def third_party_backup_image_impressions_url
  @third_party_backup_image_impressions_url
end

#third_party_rich_media_impressions_url ⇒ String

Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA. Corresponds to the JSON property thirdPartyRichMediaImpressionsUrl

Returns:

  • (String) 


2659
2660
2661
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2659

def third_party_rich_media_impressions_url
  @third_party_rich_media_impressions_url
end

#third_party_urls ⇒ Array<Google::Apis::DfareportingV2_3::ThirdPartyTrackingUrl>

Third-party URLs for tracking in-stream video creative events. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID. Corresponds to the JSON property thirdPartyUrls

Returns:



2665
2666
2667
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2665

def third_party_urls
  @third_party_urls
end

#timer_custom_events ⇒ Array<Google::Apis::DfareportingV2_3::CreativeCustomEvent>

List of timer events configured for the creative. For ENHANCED_IMAGE creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID. Applicable to ENHANCED_BANNER when the primary asset is not HTML_IMAGE. Corresponds to the JSON property timerCustomEvents

Returns:



2673
2674
2675
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2673

def timer_custom_events
  @timer_custom_events
end

#total_file_size ⇒ String

Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. Corresponds to the JSON property totalFileSize

Returns:

  • (String) 


2679
2680
2681
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2679

def total_file_size
  @total_file_size
end

#type ⇒ String

Type of this creative.This is a required field. Applicable to all creative types. Corresponds to the JSON property type

Returns:

  • (String) 


2685
2686
2687
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2685

def type
  @type
end

#version ⇒ Fixnum

The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types. Corresponds to the JSON property version

Returns:

  • (Fixnum) 


2696
2697
2698
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2696

def version
  @version
end

#video_description ⇒ String

Description of the video ad. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID. Corresponds to the JSON property videoDescription

Returns:

  • (String) 


2702
2703
2704
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2702

def video_description
  @video_description
end

#video_duration ⇒ Float

Creative video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID. Corresponds to the JSON property videoDuration

Returns:

  • (Float) 


2708
2709
2710
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2708

def video_duration
  @video_duration
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 2715

def update!(**args)
  @account_id = args[:account_id] if args.key?(:account_id)
  @active = args[:active] if args.key?(:active)
  @ad_parameters = args[:ad_parameters] if args.key?(:ad_parameters)
  @ad_tag_keys = args[:ad_tag_keys] if args.key?(:ad_tag_keys)
  @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id)
  @allow_script_access = args[:allow_script_access] if args.key?(:allow_script_access)
  @archived = args[:archived] if args.key?(:archived)
  @artwork_type = args[:artwork_type] if args.key?(:artwork_type)
  @authoring_source = args[:authoring_source] if args.key?(:authoring_source)
  @authoring_tool = args[:authoring_tool] if args.key?(:authoring_tool)
  @auto_advance_images = args[:auto_advance_images] if args.key?(:auto_advance_images)
  @background_color = args[:background_color] if args.key?(:background_color)
  @backup_image_click_through_url = args[:backup_image_click_through_url] if args.key?(:backup_image_click_through_url)
  @backup_image_features = args[:backup_image_features] if args.key?(:backup_image_features)
  @backup_image_reporting_label = args[:backup_image_reporting_label] if args.key?(:backup_image_reporting_label)
  @backup_image_target_window = args[:backup_image_target_window] if args.key?(:backup_image_target_window)
  @click_tags = args[:click_tags] if args.key?(:click_tags)
  @commercial_id = args[:commercial_id] if args.key?(:commercial_id)
  @companion_creatives = args[:companion_creatives] if args.key?(:companion_creatives)
  @compatibility = args[:compatibility] if args.key?(:compatibility)
  @convert_flash_to_html5 = args[:convert_flash_to_html5] if args.key?(:convert_flash_to_html5)
  @counter_custom_events = args[:counter_custom_events] if args.key?(:counter_custom_events)
  @creative_assets = args[:creative_assets] if args.key?(:creative_assets)
  @creative_field_assignments = args[:creative_field_assignments] if args.key?(:creative_field_assignments)
  @custom_key_values = args[:custom_key_values] if args.key?(:custom_key_values)
  @exit_custom_events = args[:exit_custom_events] if args.key?(:exit_custom_events)
  @fs_command = args[:fs_command] if args.key?(:fs_command)
  @html_code = args[:html_code] if args.key?(:html_code)
  @html_code_locked = args[:html_code_locked] if args.key?(:html_code_locked)
  @id = args[:id] if args.key?(:id)
  @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value)
  @kind = args[:kind] if args.key?(:kind)
  @last_modified_info = args[:last_modified_info] if args.key?(:last_modified_info)
  @latest_trafficked_creative_id = args[:latest_trafficked_creative_id] if args.key?(:latest_trafficked_creative_id)
  @name = args[:name] if args.key?(:name)
  @override_css = args[:override_css] if args.key?(:override_css)
  @redirect_url = args[:redirect_url] if args.key?(:redirect_url)
  @rendering_id = args[:rendering_id] if args.key?(:rendering_id)
  @rendering_id_dimension_value = args[:rendering_id_dimension_value] if args.key?(:rendering_id_dimension_value)
  @required_flash_plugin_version = args[:required_flash_plugin_version] if args.key?(:required_flash_plugin_version)
  @required_flash_version = args[:required_flash_version] if args.key?(:required_flash_version)
  @size = args[:size] if args.key?(:size)
  @skippable = args[:skippable] if args.key?(:skippable)
  @ssl_compliant = args[:ssl_compliant] if args.key?(:ssl_compliant)
  @ssl_override = args[:ssl_override] if args.key?(:ssl_override)
  @studio_advertiser_id = args[:studio_advertiser_id] if args.key?(:studio_advertiser_id)
  @studio_creative_id = args[:studio_creative_id] if args.key?(:studio_creative_id)
  @studio_trafficked_creative_id = args[:studio_trafficked_creative_id] if args.key?(:studio_trafficked_creative_id)
  @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id)
  @third_party_backup_image_impressions_url = args[:third_party_backup_image_impressions_url] if args.key?(:third_party_backup_image_impressions_url)
  @third_party_rich_media_impressions_url = args[:third_party_rich_media_impressions_url] if args.key?(:third_party_rich_media_impressions_url)
  @third_party_urls = args[:third_party_urls] if args.key?(:third_party_urls)
  @timer_custom_events = args[:timer_custom_events] if args.key?(:timer_custom_events)
  @total_file_size = args[:total_file_size] if args.key?(:total_file_size)
  @type = args[:type] if args.key?(:type)
  @version = args[:version] if args.key?(:version)
  @video_description = args[:video_description] if args.key?(:video_description)
  @video_duration = args[:video_duration] if args.key?(:video_duration)
end