Class: Google::Apis::DfareportingV2_7::Creative

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

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



3037
3038
3039
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3037

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) 


2594
2595
2596
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 2594

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) 


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

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) 


2606
2607
2608
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 2606

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


2615
2616
2617
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 2615

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) 


2621
2622
2623
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 2621

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) 


2628
2629
2630
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 2628

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) 


2634
2635
2636
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 2634

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) 


2641
2642
2643
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 2641

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) 


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

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) 


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

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) 


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

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) 


2667
2668
2669
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 2667

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) 


2674
2675
2676
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 2674

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


2687
2688
2689
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 2687

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) 


2694
2695
2696
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 2694

def backup_image_reporting_label
  @backup_image_reporting_label
end

#backup_image_target_window ⇒ Google::Apis::DfareportingV2_7::TargetWindow

Target Window. Corresponds to the JSON property backupImageTargetWindow

Returns:



2699
2700
2701
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 2699

def backup_image_target_window
  @backup_image_target_window
end

#click_tags ⇒ Array<Google::Apis::DfareportingV2_7::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:



2714
2715
2716
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 2714

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) 


2720
2721
2722
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 2720

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


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

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


2746
2747
2748
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 2746

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) 


2755
2756
2757
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 2755

def convert_flash_to_html5
  @convert_flash_to_html5
end

#counter_custom_events ⇒ Array<Google::Apis::DfareportingV2_7::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:



2764
2765
2766
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 2764

def counter_custom_events
  @counter_custom_events
end

#creative_asset_selection ⇒ Google::Apis::DfareportingV2_7::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:



2770
2771
2772
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 2770

def creative_asset_selection
  @creative_asset_selection
end

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



2777
2778
2779
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 2777

def creative_assets
  @creative_assets
end

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

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

Returns:



2782
2783
2784
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 2782

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


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

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) 


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

def dynamic_asset_selection
  @dynamic_asset_selection
end

#exit_custom_events ⇒ Array<Google::Apis::DfareportingV2_7::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:



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

def exit_custom_events
  @exit_custom_events
end

#fs_command ⇒ Google::Apis::DfareportingV2_7::FsCommand

FsCommand. Corresponds to the JSON property fsCommand

Returns:



2816
2817
2818
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 2816

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) 


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

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) 


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

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) 


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

def id
  @id
end

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

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue

Returns:



2842
2843
2844
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 2842

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) 


2848
2849
2850
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 2848

def kind
  @kind
end

#last_modified_info ⇒ Google::Apis::DfareportingV2_7::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property lastModifiedInfo

Returns:



2853
2854
2855
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 2853

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) 


2860
2861
2862
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 2860

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) 


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

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) 


2872
2873
2874
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 2872

def override_css
  @override_css
end

#progress_offset ⇒ Google::Apis::DfareportingV2_7::VideoOffset

Video Offset Corresponds to the JSON property progressOffset

Returns:



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

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


2887
2888
2889
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 2887

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) 


2893
2894
2895
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 2893

def rendering_id
  @rendering_id
end

#rendering_id_dimension_value ⇒ Google::Apis::DfareportingV2_7::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property renderingIdDimensionValue

Returns:



2898
2899
2900
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 2898

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) 


2905
2906
2907
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 2905

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) 


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

def required_flash_version
  @required_flash_version
end

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

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

Returns:



2918
2919
2920
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 2918

def size
  @size
end

#skip_offset ⇒ Google::Apis::DfareportingV2_7::VideoOffset

Video Offset Corresponds to the JSON property skipOffset

Returns:



2923
2924
2925
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 2923

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


2929
2930
2931
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 2929

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) 


2936
2937
2938
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 2936

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) 


2943
2944
2945
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 2943

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) 


2951
2952
2953
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 2951

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) 


2958
2959
2960
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 2958

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) 


2965
2966
2967
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 2965

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) 


2972
2973
2974
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 2972

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) 


2978
2979
2980
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 2978

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) 


2984
2985
2986
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 2984

def third_party_rich_media_impressions_url
  @third_party_rich_media_impressions_url
end

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



2990
2991
2992
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 2990

def third_party_urls
  @third_party_urls
end

#timer_custom_events ⇒ Array<Google::Apis::DfareportingV2_7::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:



2998
2999
3000
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 2998

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) 


3004
3005
3006
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3004

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) 


3012
3013
3014
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3012

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) 


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

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) 


3029
3030
3031
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3029

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) 


3035
3036
3037
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3035

def video_duration
  @video_duration
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 3042

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