class Google::Apis::DfareportingV3_4::Creative
Contains properties of a Creative
.
Attributes
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` @return [Fixnum]
Whether the creative is active. Applicable to all creative types. Corresponds to the JSON property `active` @return [Boolean]
Whether the creative is active. Applicable to all creative types. Corresponds to the JSON property `active` @return [Boolean]
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` @return [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` @return [Array<String>]
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` @return [Array<Google::Apis::DfareportingV3_4::Size>]
Advertiser
ID of this creative. This is a required field. Applicable to all creative types. Corresponds to the JSON property `advertiserId` @return [Fixnum]
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` @return [Boolean]
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` @return [Boolean]
Whether the creative is archived. Applicable to all creative types. Corresponds to the JSON property `archived` @return [Boolean]
Whether the creative is archived. Applicable to all creative types. Corresponds to the JSON property `archived` @return [Boolean]
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` @return [String]
Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY. Corresponds to the JSON property `autoAdvanceImages` @return [Boolean]
Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY. Corresponds to the JSON property `autoAdvanceImages` @return [Boolean]
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` @return [String]
Click-through URL Corresponds to the JSON property `backupImageClickThroughUrl` @return [Google::Apis::DfareportingV3_4::CreativeClickThroughUrl]
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` @return [Array<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` @return [String]
Target Window. Corresponds to the JSON property `backupImageTargetWindow` @return [Google::Apis::DfareportingV3_4::TargetWindow]
Industry standard ID assigned to creative for reach and frequency. Applicable to INSTREAM_VIDEO_REDIRECT creatives. Corresponds to the JSON property `commercialId` @return [String]
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` @return [Array<Fixnum>]
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` @return [Array<String>]
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` @return [Boolean]
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` @return [Boolean]
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` @return [Array<Google::Apis::DfareportingV3_4::CreativeCustomEvent>]
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` @return [Google::Apis::DfareportingV3_4::CreativeAssetSelection]
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` @return [Array<Google::Apis::DfareportingV3_4::CreativeAsset>]
Creative
field assignments for this creative. Applicable to all creative types. Corresponds to the JSON property `creativeFieldAssignments` @return [Array<Google::Apis::DfareportingV3_4::CreativeFieldAssignment>]
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` @return [Array<String>]
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` @return [Boolean]
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` @return [Boolean]
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` @return [Array<Google::Apis::DfareportingV3_4::CreativeCustomEvent>]
FsCommand
. Corresponds to the JSON property `fsCommand` @return [Google::Apis::DfareportingV3_4::FsCommand]
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` @return [String]
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` @return [Boolean]
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` @return [Boolean]
ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types. Corresponds to the JSON property `id` @return [Fixnum]
Represents a DimensionValue
resource. Corresponds to the JSON property `idDimensionValue` @return [Google::Apis::DfareportingV3_4::DimensionValue]
Identifies what kind of resource this is. Value: the fixed string “ dfareporting#creative”. Corresponds to the JSON property `kind` @return [String]
Modification timestamp. Corresponds to the JSON property `lastModifiedInfo` @return [Google::Apis::DfareportingV3_4::LastModifiedInfo]
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` @return [Fixnum]
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` @return [String]
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` @return [Float]
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` @return [String]
Online Behavioral Advertiser
icon. Corresponds to the JSON property `obaIcon` @return [Google::Apis::DfareportingV3_4::ObaIcon]
Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA. Corresponds to the JSON property `overrideCss` @return [String]
Video Offset Corresponds to the JSON property `progressOffset` @return [Google::Apis::DfareportingV3_4::VideoOffset]
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` @return [String]
ID of current rendering version. This is a read-only field. Applicable to all creative types. Corresponds to the JSON property `renderingId` @return [Fixnum]
Represents a DimensionValue
resource. Corresponds to the JSON property `renderingIdDimensionValue` @return [Google::Apis::DfareportingV3_4::DimensionValue]
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` @return [String]
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` @return [Fixnum]
Represents the dimensions of ads, placements, creatives, or creative assets. Corresponds to the JSON property `size` @return [Google::Apis::DfareportingV3_4::Size]
Video Offset Corresponds to the JSON property `skipOffset` @return [Google::Apis::DfareportingV3_4::VideoOffset]
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` @return [Boolean]
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` @return [Boolean]
Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types. Corresponds to the JSON property `sslCompliant` @return [Boolean]
Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types. Corresponds to the JSON property `sslCompliant` @return [Boolean]
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` @return [Boolean]
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` @return [Boolean]
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` @return [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` @return [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` @return [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` @return [Fixnum]
Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA. Corresponds to the JSON property `thirdPartyBackupImageImpressionsUrl` @return [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` @return [String]
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` @return [Array<Google::Apis::DfareportingV3_4::ThirdPartyTrackingUrl>]
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` @return [Array<Google::Apis::DfareportingV3_4::CreativeCustomEvent>]
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` @return [Fixnum]
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` @return [String]
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` @return [Google::Apis::DfareportingV3_4::UniversalAdId]
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` @return [Fixnum]
Public Class Methods
# File lib/google/apis/dfareporting_v3_4/classes.rb, line 3307 def initialize(**args) update!(**args) end
Public Instance Methods
Update properties of this object
# File lib/google/apis/dfareporting_v3_4/classes.rb, line 3312 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) @oba_icon = args[:oba_icon] if args.key?(:oba_icon) @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