Class: Google::Apis::DfareportingV2_6::Creative

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



2985
2986
2987
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2985

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) 


2552
2553
2554
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2552

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) 


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

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) 


2564
2565
2566
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2564

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


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

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) 


2579
2580
2581
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2579

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) 


2586
2587
2588
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2586

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) 


2592
2593
2594
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2592

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) 


2599
2600
2601
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2599

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) 


2605
2606
2607
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2605

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) 


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

def authoring_tool
  @authoring_tool
end

#auto_advance_images ⇒ Boolean Also known as: auto_advance_images?

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

Returns:

  • (Boolean) 


2617
2618
2619
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2617

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) 


2625
2626
2627
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2625

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

Returns:

  • (String) 


2632
2633
2634
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2632

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

Returns:

  • (Array<String>) 


2645
2646
2647
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2645

def backup_image_features
  @backup_image_features
end

#backup_image_reporting_label ⇒ String

Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE. Corresponds to the JSON property backupImageReportingLabel

Returns:

  • (String) 


2652
2653
2654
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2652

def backup_image_reporting_label
  @backup_image_reporting_label
end

#backup_image_target_window ⇒ Google::Apis::DfareportingV2_6::TargetWindow

Target Window. Corresponds to the JSON property backupImageTargetWindow

Returns:



2657
2658
2659
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2657

def backup_image_target_window
  @backup_image_target_window
end

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

Click tags of the creative. For DISPLAY, 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 DISPLAY_IMAGE_GALLERY 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: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. Corresponds to the JSON property clickTags

Returns:



2672
2673
2674
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2672

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) 


2678
2679
2680
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2678

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 VPAID and all INSTREAM_VIDEO with dynamicAssetSelection set to false. Corresponds to the JSON property companionCreatives

Returns:

  • (Array<String>) 


2686
2687
2688
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2686

def companion_creatives
  @companion_creatives
end

#compatibility ⇒ Array<String>

Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. 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"
  • "DISPLAY"
  • "DISPLAY_INTERSTITIAL" Corresponds to the JSON property compatibility

Returns:

  • (Array<String>) 


2704
2705
2706
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2704

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

Returns:

  • (Boolean) 


2713
2714
2715
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2713

def convert_flash_to_html5
  @convert_flash_to_html5
end

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

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

Returns:



2722
2723
2724
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2722

def counter_custom_events
  @counter_custom_events
end

#creative_asset_selection ⇒ Google::Apis::DfareportingV2_6::CreativeAssetSelection

Encapsulates the list of rules for asset selection and a default asset in case none of the rules match. Applicable to INSTREAM_VIDEO creatives. Corresponds to the JSON property creativeAssetSelection

Returns:



2728
2729
2730
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2728

def creative_asset_selection
  @creative_asset_selection
end

#creative_assets ⇒ Array<Google::Apis::DfareportingV2_6::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:



2735
2736
2737
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2735

def creative_assets
  @creative_assets
end

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

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

Returns:



2740
2741
2742
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2740

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


2749
2750
2751
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2749

def custom_key_values
  @custom_key_values
end

#dynamic_asset_selection ⇒ Boolean Also known as: dynamic_asset_selection?

Set this to true to enable the use of rules to target individual assets in this creative. When set to true creativeAssetSelection must be set. This also controls asset-level companions. When this is true, companion creatives should be assigned to creative assets. Learn more. Applicable to INSTREAM_VIDEO creatives. Corresponds to the JSON property dynamicAssetSelection

Returns:

  • (Boolean) 


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

def dynamic_asset_selection
  @dynamic_asset_selection
end

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

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

Returns:



2769
2770
2771
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2769

def exit_custom_events
  @exit_custom_events
end

#fs_command ⇒ Google::Apis::DfareportingV2_6::FsCommand

FsCommand. Corresponds to the JSON property fsCommand

Returns:



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

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) 


2781
2782
2783
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2781

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) 


2788
2789
2790
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2788

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) 


2795
2796
2797
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2795

def id
  @id
end

#id_dimension_value ⇒ Google::Apis::DfareportingV2_6::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue

Returns:



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

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) 


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

def kind
  @kind
end

#last_modified_info ⇒ Google::Apis::DfareportingV2_6::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property lastModifiedInfo

Returns:



2811
2812
2813
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2811

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) 


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

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) 


2824
2825
2826
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2824

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) 


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

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: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT Corresponds to the JSON property redirectUrl

Returns:

  • (String) 


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

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) 


2846
2847
2848
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2846

def rendering_id
  @rendering_id
end

#rendering_id_dimension_value ⇒ Google::Apis::DfareportingV2_6::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property renderingIdDimensionValue

Returns:



2851
2852
2853
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2851

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) 


2858
2859
2860
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2858

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

Returns:

  • (Fixnum) 


2866
2867
2868
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2866

def required_flash_version
  @required_flash_version
end

#size ⇒ Google::Apis::DfareportingV2_6::Size

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

Returns:



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

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) 


2877
2878
2879
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2877

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) 


2884
2885
2886
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2884

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) 


2891
2892
2893
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2891

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) 


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

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) 


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

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) 


2913
2914
2915
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2913

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) 


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

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) 


2926
2927
2928
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2926

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) 


2932
2933
2934
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2932

def third_party_rich_media_impressions_url
  @third_party_rich_media_impressions_url
end

#third_party_urls ⇒ Array<Google::Apis::DfareportingV2_6::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:



2938
2939
2940
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2938

def third_party_urls
  @third_party_urls
end

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

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

Returns:



2946
2947
2948
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2946

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) 


2952
2953
2954
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2952

def total_file_size
  @total_file_size
end

#type ⇒ String

Type of this creative. This is a required field. Applicable to all creative types. Note: FLASH_INPAGE, HTML5_BANNER, and IMAGE are only used for existing creatives. New creatives should use DISPLAY as a replacement for these types. Corresponds to the JSON property type

Returns:

  • (String) 


2960
2961
2962
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2960

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) 


2971
2972
2973
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2971

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) 


2977
2978
2979
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2977

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) 


2983
2984
2985
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2983

def video_duration
  @video_duration
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 2990

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