Class: Google::Apis::DfareportingV4::Creative
- Inherits:
-
Object
- Object
- Google::Apis::DfareportingV4::Creative
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/dfareporting_v4/classes.rb,
lib/google/apis/dfareporting_v4/representations.rb,
lib/google/apis/dfareporting_v4/representations.rb
Overview
Contains properties of a Creative.
Instance Attribute Summary collapse
-
#account_id ⇒ Fixnum
Account ID of this creative.
-
#active ⇒ Boolean
(also: #active?)
Whether the creative is active.
-
#ad_parameters ⇒ String
Ad parameters user for VPAID creative.
-
#ad_tag_keys ⇒ Array<String>
Keywords for a Rich Media creative.
-
#additional_sizes ⇒ Array<Google::Apis::DfareportingV4::Size>
Additional sizes associated with a responsive creative.
-
#advertiser_id ⇒ Fixnum
Required.
-
#allow_script_access ⇒ Boolean
(also: #allow_script_access?)
Whether script access is allowed for this creative.
-
#archived ⇒ Boolean
(also: #archived?)
Whether the creative is archived.
-
#artwork_type ⇒ String
Type of artwork used for the creative.
-
#authoring_source ⇒ String
Source application where creative was authored.
-
#authoring_tool ⇒ String
Authoring tool for HTML5 banner creatives.
-
#auto_advance_images ⇒ Boolean
(also: #auto_advance_images?)
Whether images are automatically advanced for image gallery creatives.
-
#background_color ⇒ String
The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed.
-
#backup_image_click_through_url ⇒ Google::Apis::DfareportingV4::CreativeClickThroughUrl
Click-through URL Corresponds to the JSON property
backupImageClickThroughUrl
. -
#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.
-
#backup_image_reporting_label ⇒ String
Reporting label used for HTML5 banner backup image.
-
#backup_image_target_window ⇒ Google::Apis::DfareportingV4::TargetWindow
Target Window.
-
#click_tags ⇒ Array<Google::Apis::DfareportingV4::ClickTag>
Click tags of the creative.
-
#commercial_id ⇒ String
Industry standard ID assigned to creative for reach and frequency.
-
#companion_creatives ⇒ Array<Fixnum>
List of companion creatives assigned to an in-Stream video creative.
-
#compatibility ⇒ Array<String>
Compatibilities associated with this creative.
-
#convert_flash_to_html5 ⇒ Boolean
(also: #convert_flash_to_html5?)
Whether Flash assets associated with the creative need to be automatically converted to HTML5.
-
#counter_custom_events ⇒ Array<Google::Apis::DfareportingV4::CreativeCustomEvent>
List of counter events configured for the creative.
-
#creative_asset_selection ⇒ Google::Apis::DfareportingV4::CreativeAssetSelection
Encapsulates the list of rules for asset selection and a default asset in case none of the rules match.
-
#creative_assets ⇒ Array<Google::Apis::DfareportingV4::CreativeAsset>
Assets associated with a creative.
-
#creative_field_assignments ⇒ Array<Google::Apis::DfareportingV4::CreativeFieldAssignment>
Creative field assignments for this creative.
-
#custom_key_values ⇒ Array<String>
Custom key-values for a Rich Media creative.
-
#dynamic_asset_selection ⇒ Boolean
(also: #dynamic_asset_selection?)
Set this to true to enable the use of rules to target individual assets in this creative.
-
#exit_custom_events ⇒ Array<Google::Apis::DfareportingV4::CreativeCustomEvent>
List of exit events configured for the creative.
-
#fs_command ⇒ Google::Apis::DfareportingV4::FsCommand
FsCommand.
-
#html_code ⇒ String
HTML code for the creative.
-
#html_code_locked ⇒ Boolean
(also: #html_code_locked?)
Whether HTML code is generated by Campaign Manager or manually entered.
-
#id ⇒ Fixnum
ID of this creative.
-
#id_dimension_value ⇒ Google::Apis::DfareportingV4::DimensionValue
Represents a DimensionValue resource.
-
#kind ⇒ String
Identifies what kind of resource this is.
-
#last_modified_info ⇒ Google::Apis::DfareportingV4::LastModifiedInfo
Modification timestamp.
-
#latest_trafficked_creative_id ⇒ Fixnum
Latest Studio trafficked creative ID associated with rich media and VPAID creatives.
-
#media_description ⇒ String
Description of the audio or video ad.
-
#media_duration ⇒ Float
Creative audio or video duration in seconds.
-
#name ⇒ String
Required.
-
#oba_icon ⇒ Google::Apis::DfareportingV4::ObaIcon
Online Behavioral Advertiser icon.
-
#override_css ⇒ String
Override CSS value for rich media creatives.
-
#progress_offset ⇒ Google::Apis::DfareportingV4::VideoOffset
Video Offset Corresponds to the JSON property
progressOffset
. -
#redirect_url ⇒ String
URL of hosted image or hosted video or another ad tag.
-
#rendering_id ⇒ Fixnum
ID of current rendering version.
-
#rendering_id_dimension_value ⇒ Google::Apis::DfareportingV4::DimensionValue
Represents a DimensionValue resource.
-
#required_flash_plugin_version ⇒ String
The minimum required Flash plugin version for this creative.
-
#required_flash_version ⇒ Fixnum
The internal Flash version for this creative as calculated by Studio.
-
#size ⇒ Google::Apis::DfareportingV4::Size
Represents the dimensions of ads, placements, creatives, or creative assets.
-
#skip_offset ⇒ Google::Apis::DfareportingV4::VideoOffset
Video Offset Corresponds to the JSON property
skipOffset
. -
#skippable ⇒ Boolean
(also: #skippable?)
Whether the user can choose to skip the creative.
-
#ssl_compliant ⇒ Boolean
(also: #ssl_compliant?)
Whether the creative is SSL-compliant.
-
#ssl_override ⇒ Boolean
(also: #ssl_override?)
Whether creative should be treated as SSL compliant even if the system scan shows it's not.
-
#studio_advertiser_id ⇒ Fixnum
Studio advertiser ID associated with rich media and VPAID creatives.
-
#studio_creative_id ⇒ Fixnum
Studio creative ID associated with rich media and VPAID creatives.
-
#studio_trafficked_creative_id ⇒ Fixnum
Studio trafficked creative ID associated with rich media and VPAID creatives.
-
#subaccount_id ⇒ Fixnum
Subaccount ID of this creative.
-
#third_party_backup_image_impressions_url ⇒ String
Third-party URL used to record backup image impressions.
-
#third_party_rich_media_impressions_url ⇒ String
Third-party URL used to record rich media impressions.
-
#third_party_urls ⇒ Array<Google::Apis::DfareportingV4::ThirdPartyTrackingUrl>
Third-party URLs for tracking in-stream creative events.
-
#timer_custom_events ⇒ Array<Google::Apis::DfareportingV4::CreativeCustomEvent>
List of timer events configured for the creative.
-
#total_file_size ⇒ Fixnum
Combined size of all creative assets.
-
#type ⇒ String
Required.
-
#universal_ad_id ⇒ Google::Apis::DfareportingV4::UniversalAdId
A Universal Ad ID as per the VAST 4.0 spec.
-
#version ⇒ Fixnum
The version number helps you keep track of multiple versions of your creative in your reports.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Creative
constructor
A new instance of Creative.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ Creative
Returns a new instance of Creative.
3591 3592 3593 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3591 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
3133 3134 3135 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3133 def account_id @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
3138 3139 3140 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3138 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
3145 3146 3147 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3145 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
3154 3155 3156 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3154 def ad_tag_keys @ad_tag_keys end |
#additional_sizes ⇒ Array<Google::Apis::DfareportingV4::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
3162 3163 3164 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3162 def additional_sizes @additional_sizes end |
#advertiser_id ⇒ Fixnum
Required. Advertiser ID of this creative. This is a required field. Applicable
to all creative types.
Corresponds to the JSON property advertiserId
3168 3169 3170 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3168 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
3175 3176 3177 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3175 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
3181 3182 3183 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3181 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
3188 3189 3190 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3188 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
3194 3195 3196 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3194 def @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
3200 3201 3202 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3200 def @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
3206 3207 3208 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3206 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
3214 3215 3216 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3214 def background_color @background_color end |
#backup_image_click_through_url ⇒ Google::Apis::DfareportingV4::CreativeClickThroughUrl
Click-through URL
Corresponds to the JSON property backupImageClickThroughUrl
3219 3220 3221 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3219 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
3232 3233 3234 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3232 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
3239 3240 3241 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3239 def backup_image_reporting_label @backup_image_reporting_label end |
#backup_image_target_window ⇒ Google::Apis::DfareportingV4::TargetWindow
Target Window.
Corresponds to the JSON property backupImageTargetWindow
3244 3245 3246 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3244 def backup_image_target_window @backup_image_target_window end |
#click_tags ⇒ Array<Google::Apis::DfareportingV4::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
3259 3260 3261 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3259 def @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
3265 3266 3267 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3265 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
3273 3274 3275 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3273 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
3288 3289 3290 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3288 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
3297 3298 3299 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3297 def convert_flash_to_html5 @convert_flash_to_html5 end |
#counter_custom_events ⇒ Array<Google::Apis::DfareportingV4::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
3306 3307 3308 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3306 def counter_custom_events @counter_custom_events end |
#creative_asset_selection ⇒ Google::Apis::DfareportingV4::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
3312 3313 3314 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3312 def creative_asset_selection @creative_asset_selection end |
#creative_assets ⇒ Array<Google::Apis::DfareportingV4::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
3319 3320 3321 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3319 def creative_assets @creative_assets end |
#creative_field_assignments ⇒ Array<Google::Apis::DfareportingV4::CreativeFieldAssignment>
Creative field assignments for this creative. Applicable to all creative types.
Corresponds to the JSON property creativeFieldAssignments
3324 3325 3326 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3324 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
3333 3334 3335 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3333 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
3342 3343 3344 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3342 def dynamic_asset_selection @dynamic_asset_selection end |
#exit_custom_events ⇒ Array<Google::Apis::DfareportingV4::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
3353 3354 3355 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3353 def exit_custom_events @exit_custom_events end |
#fs_command ⇒ Google::Apis::DfareportingV4::FsCommand
FsCommand.
Corresponds to the JSON property fsCommand
3358 3359 3360 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3358 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
3365 3366 3367 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3365 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
3372 3373 3374 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3372 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
3379 3380 3381 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3379 def id @id end |
#id_dimension_value ⇒ Google::Apis::DfareportingV4::DimensionValue
Represents a DimensionValue resource.
Corresponds to the JSON property idDimensionValue
3384 3385 3386 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3384 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
3390 3391 3392 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3390 def kind @kind end |
#last_modified_info ⇒ Google::Apis::DfareportingV4::LastModifiedInfo
Modification timestamp.
Corresponds to the JSON property lastModifiedInfo
3395 3396 3397 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3395 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
3402 3403 3404 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3402 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
3408 3409 3410 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3408 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
3415 3416 3417 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3415 def media_duration @media_duration end |
#name ⇒ String
Required. Name of the creative. This must be less than 256 characters long.
Applicable to all creative types.
Corresponds to the JSON property name
3421 3422 3423 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3421 def name @name end |
#oba_icon ⇒ Google::Apis::DfareportingV4::ObaIcon
Online Behavioral Advertiser icon.
Corresponds to the JSON property obaIcon
3426 3427 3428 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3426 def oba_icon @oba_icon 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
3432 3433 3434 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3432 def override_css @override_css end |
#progress_offset ⇒ Google::Apis::DfareportingV4::VideoOffset
Video Offset
Corresponds to the JSON property progressOffset
3437 3438 3439 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3437 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
3447 3448 3449 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3447 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
3453 3454 3455 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3453 def rendering_id @rendering_id end |
#rendering_id_dimension_value ⇒ Google::Apis::DfareportingV4::DimensionValue
Represents a DimensionValue resource.
Corresponds to the JSON property renderingIdDimensionValue
3458 3459 3460 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3458 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
3465 3466 3467 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3465 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
3473 3474 3475 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3473 def required_flash_version @required_flash_version end |
#size ⇒ Google::Apis::DfareportingV4::Size
Represents the dimensions of ads, placements, creatives, or creative assets.
Corresponds to the JSON property size
3478 3479 3480 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3478 def size @size end |
#skip_offset ⇒ Google::Apis::DfareportingV4::VideoOffset
Video Offset
Corresponds to the JSON property skipOffset
3483 3484 3485 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3483 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
3489 3490 3491 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3489 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
3496 3497 3498 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3496 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
3503 3504 3505 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3503 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
3511 3512 3513 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3511 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
3518 3519 3520 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3518 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
3525 3526 3527 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3525 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
3532 3533 3534 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3532 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
3538 3539 3540 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3538 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
3544 3545 3546 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3544 def third_party_rich_media_impressions_url @third_party_rich_media_impressions_url end |
#third_party_urls ⇒ Array<Google::Apis::DfareportingV4::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
3551 3552 3553 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3551 def third_party_urls @third_party_urls end |
#timer_custom_events ⇒ Array<Google::Apis::DfareportingV4::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
3559 3560 3561 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3559 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
3565 3566 3567 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3565 def total_file_size @total_file_size end |
#type ⇒ String
Required. Type of this creative. 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
3572 3573 3574 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3572 def type @type end |
#universal_ad_id ⇒ Google::Apis::DfareportingV4::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
3578 3579 3580 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3578 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
3589 3590 3591 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3589 def version @version end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 |
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3596 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 |