Class: Google::Apis::DfareportingV3_3::Creative

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dfareporting_v3_3/classes.rb,
generated/google/apis/dfareporting_v3_3/representations.rb,
generated/google/apis/dfareporting_v3_3/representations.rb

Overview

Contains properties of a Creative.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Creative

Returns a new instance of Creative.



3159
3160
3161
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 3159

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

Instance Attribute Details

#account_id ⇒ Fixnum

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:

  • (Fixnum) 


2705
2706
2707
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2705

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) 


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

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) 


2717
2718
2719
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2717

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


2726
2727
2728
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2726

def ad_tag_keys
  @ad_tag_keys
end

#additional_sizes ⇒ Array<Google::Apis::DfareportingV3_3::Size>

Additional sizes associated with a responsive creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. Applicable to DISPLAY creatives when the primary asset type is HTML_IMAGE. Corresponds to the JSON property additionalSizes

Returns:



2734
2735
2736
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2734

def additional_sizes
  @additional_sizes
end

#advertiser_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


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

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) 


2747
2748
2749
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2747

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) 


2753
2754
2755
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2753

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) 


2760
2761
2762
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2760

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) 


2766
2767
2768
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2766

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) 


2772
2773
2774
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2772

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 autoAdvanceImages

Returns:

  • (Boolean) 


2778
2779
2780
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2778

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) 


2786
2787
2788
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2786

def background_color
  @background_color
end

#backup_image_click_through_url ⇒ Google::Apis::DfareportingV3_3::CreativeClickThroughUrl

Click-through URL Corresponds to the JSON property backupImageClickThroughUrl

Returns:



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

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


2804
2805
2806
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2804

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) 


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

def backup_image_reporting_label
  @backup_image_reporting_label
end

#backup_image_target_window ⇒ Google::Apis::DfareportingV3_3::TargetWindow

Target Window. Corresponds to the JSON property backupImageTargetWindow

Returns:



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

def backup_image_target_window
  @backup_image_target_window
end

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



2831
2832
2833
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2831

def click_tags
  @click_tags
end

#commercial_id ⇒ String

Industry standard ID assigned to creative for reach and frequency. Applicable to INSTREAM_VIDEO_REDIRECT creatives. Corresponds to the JSON property commercialId

Returns:

  • (String) 


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

def commercial_id
  @commercial_id
end

#companion_creatives ⇒ Array<Fixnum>

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

Returns:

  • (Array<Fixnum>) 


2845
2846
2847
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2845

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. IN_STREAM_AUDIO refers to rendering in in-stream audio ads developed with the VAST standard. Applicable to all creative types. Acceptable values are: - "APP"

  • "APP_INTERSTITIAL" - "IN_STREAM_VIDEO" - "IN_STREAM_AUDIO" - "DISPLAY" - " DISPLAY_INTERSTITIAL" Corresponds to the JSON property compatibility

Returns:

  • (Array<String>) 


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

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) 


2869
2870
2871
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2869

def convert_flash_to_html5
  @convert_flash_to_html5
end

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



2878
2879
2880
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2878

def counter_custom_events
  @counter_custom_events
end

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



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

def creative_asset_selection
  @creative_asset_selection
end

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



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

def creative_assets
  @creative_assets
end

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

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

Returns:



2896
2897
2898
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2896

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


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

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) 


2914
2915
2916
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2914

def dynamic_asset_selection
  @dynamic_asset_selection
end

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



2925
2926
2927
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2925

def exit_custom_events
  @exit_custom_events
end

#fs_command ⇒ Google::Apis::DfareportingV3_3::FsCommand

FsCommand. Corresponds to the JSON property fsCommand

Returns:



2930
2931
2932
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2930

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


2937
2938
2939
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2937

def html_code
  @html_code
end

#html_code_locked ⇒ Boolean Also known as: html_code_locked?

Whether HTML code is generated by Campaign Manager 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) 


2944
2945
2946
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2944

def html_code_locked
  @html_code_locked
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


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

def id
  @id
end

#id_dimension_value ⇒ Google::Apis::DfareportingV3_3::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue

Returns:



2956
2957
2958
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2956

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) 


2962
2963
2964
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2962

def kind
  @kind
end

#last_modified_info ⇒ Google::Apis::DfareportingV3_3::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property lastModifiedInfo

Returns:



2967
2968
2969
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2967

def last_modified_info
  @last_modified_info
end

#latest_trafficked_creative_id ⇒ Fixnum

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:

  • (Fixnum) 


2974
2975
2976
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2974

def latest_trafficked_creative_id
  @latest_trafficked_creative_id
end

#media_description ⇒ String

Description of the audio or video ad. Applicable to the following creative types: all INSTREAM_VIDEO, INSTREAM_AUDIO, and all VPAID. Corresponds to the JSON property mediaDescription

Returns:

  • (String) 


2980
2981
2982
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2980

def media_description
  @media_description
end

#media_duration ⇒ Float

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

Returns:

  • (Float) 


2987
2988
2989
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2987

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


2993
2994
2995
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2993

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) 


2999
3000
3001
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 2999

def override_css
  @override_css
end

#progress_offset ⇒ Google::Apis::DfareportingV3_3::VideoOffset

Video Offset Corresponds to the JSON property progressOffset

Returns:



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

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) 


3014
3015
3016
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 3014

def redirect_url
  @redirect_url
end

#rendering_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


3020
3021
3022
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 3020

def rendering_id
  @rendering_id
end

#rendering_id_dimension_value ⇒ Google::Apis::DfareportingV3_3::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property renderingIdDimensionValue

Returns:



3025
3026
3027
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 3025

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) 


3032
3033
3034
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 3032

def required_flash_plugin_version
  @required_flash_plugin_version
end

#required_flash_version ⇒ Fixnum

The internal Flash version for this creative as calculated by 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) 


3040
3041
3042
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 3040

def required_flash_version
  @required_flash_version
end

#size ⇒ Google::Apis::DfareportingV3_3::Size

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

Returns:



3045
3046
3047
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 3045

def size
  @size
end

#skip_offset ⇒ Google::Apis::DfareportingV3_3::VideoOffset

Video Offset Corresponds to the JSON property skipOffset

Returns:



3050
3051
3052
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 3050

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) 


3056
3057
3058
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 3056

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) 


3063
3064
3065
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 3063

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) 


3070
3071
3072
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 3070

def ssl_override
  @ssl_override
end

#studio_advertiser_id ⇒ Fixnum

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:

  • (Fixnum) 


3078
3079
3080
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 3078

def studio_advertiser_id
  @studio_advertiser_id
end

#studio_creative_id ⇒ Fixnum

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:

  • (Fixnum) 


3085
3086
3087
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 3085

def studio_creative_id
  @studio_creative_id
end

#studio_trafficked_creative_id ⇒ Fixnum

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:

  • (Fixnum) 


3092
3093
3094
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 3092

def studio_trafficked_creative_id
  @studio_trafficked_creative_id
end

#subaccount_id ⇒ Fixnum

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:

  • (Fixnum) 


3099
3100
3101
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 3099

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) 


3105
3106
3107
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 3105

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) 


3111
3112
3113
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 3111

def third_party_rich_media_impressions_url
  @third_party_rich_media_impressions_url
end

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

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

Returns:



3118
3119
3120
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 3118

def third_party_urls
  @third_party_urls
end

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



3126
3127
3128
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 3126

def timer_custom_events
  @timer_custom_events
end

#total_file_size ⇒ Fixnum

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:

  • (Fixnum) 


3132
3133
3134
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 3132

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) 


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

def type
  @type
end

#universal_ad_id ⇒ Google::Apis::DfareportingV3_3::UniversalAdId

A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID. Corresponds to the JSON property universalAdId

Returns:



3146
3147
3148
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 3146

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


3157
3158
3159
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 3157

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 3164

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)
  @additional_sizes = args[:additional_sizes] if args.key?(:additional_sizes)
  @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)
  @media_description = args[:media_description] if args.key?(:media_description)
  @media_duration = args[:media_duration] if args.key?(:media_duration)
  @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)
  @universal_ad_id = args[:universal_ad_id] if args.key?(:universal_ad_id)
  @version = args[:version] if args.key?(:version)
end