Class: Google::Apis::DfareportingV2_1::Creative
- Inherits:
-
Object
- Object
- Google::Apis::DfareportingV2_1::Creative
- Includes:
- Core::Hashable
- Defined in:
- generated/google/apis/dfareporting_v2_1/classes.rb,
generated/google/apis/dfareporting_v2_1/representations.rb,
generated/google/apis/dfareporting_v2_1/representations.rb
Overview
Contains properties of a Creative.
Instance Attribute Summary collapse
-
#account_id ⇒ String
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.
-
#advertiser_id ⇒ String
Advertiser ID of this creative.
-
#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_tool ⇒ String
Authoring tool for HTML5 banner creatives.
-
#auto_advance_images ⇒ Boolean
(also: #auto_advance_images?)
Whether images are automatically advanced for enhanced image 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 ⇒ String
Click-through URL for backup image.
-
#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::DfareportingV2_1::TargetWindow
Target Window.
-
#click_tags ⇒ Array<Google::Apis::DfareportingV2_1::ClickTag>
Click tags of the creative.
-
#commercial_id ⇒ String
Industry standard ID assigned to creative for reach and frequency.
-
#companion_creatives ⇒ Array<String>
List of companion creatives assigned to an in-Stream videocreative.
-
#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::DfareportingV2_1::CreativeCustomEvent>
List of counter events configured for the creative.
-
#creative_assets ⇒ Array<Google::Apis::DfareportingV2_1::CreativeAsset>
Assets associated with a creative.
-
#creative_field_assignments ⇒ Array<Google::Apis::DfareportingV2_1::CreativeFieldAssignment>
Creative field assignments for this creative.
-
#custom_key_values ⇒ Array<String>
Custom key-values for a Rich Media creative.
-
#exit_custom_events ⇒ Array<Google::Apis::DfareportingV2_1::CreativeCustomEvent>
List of exit events configured for the creative.
-
#fs_command ⇒ Google::Apis::DfareportingV2_1::FsCommand
FsCommand.
-
#html_code ⇒ String
HTML code for the creative.
-
#html_code_locked ⇒ Boolean
(also: #html_code_locked?)
Whether HTML code is DCM-generated or manually entered.
-
#id ⇒ String
ID of this creative.
-
#id_dimension_value ⇒ Google::Apis::DfareportingV2_1::DimensionValue
Represents a DimensionValue resource.
-
#kind ⇒ String
Identifies what kind of resource this is.
-
#last_modified_info ⇒ Google::Apis::DfareportingV2_1::LastModifiedInfo
Modification timestamp.
-
#latest_trafficked_creative_id ⇒ String
Latest Studio trafficked creative ID associated with rich media and VPAID creatives.
-
#name ⇒ String
Name of the creative.
-
#override_css ⇒ String
Override CSS value for rich media creatives.
-
#redirect_url ⇒ String
URL of hosted image or hosted video or another ad tag.
-
#rendering_id ⇒ String
ID of current rendering version.
-
#rendering_id_dimension_value ⇒ Google::Apis::DfareportingV2_1::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 DoubleClick Studio.
-
#size ⇒ Google::Apis::DfareportingV2_1::Size
Represents the dimensions of ads, placements, creatives, or creative assets.
-
#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.
-
#studio_advertiser_id ⇒ String
Studio advertiser ID associated with rich media and VPAID creatives.
-
#studio_creative_id ⇒ String
Studio creative ID associated with rich media and VPAID creatives.
-
#studio_trafficked_creative_id ⇒ String
Studio trafficked creative ID associated with rich media and VPAID creatives.
-
#subaccount_id ⇒ String
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::DfareportingV2_1::ThirdPartyTrackingUrl>
Third-party URLs for tracking in-stream video creative events.
-
#timer_custom_events ⇒ Array<Google::Apis::DfareportingV2_1::CreativeCustomEvent>
List of timer events configured for the creative.
-
#total_file_size ⇒ String
Combined size of all creative assets.
-
#type ⇒ String
Type of this creative.This is a required field.
-
#version ⇒ Fixnum
The version number helps you keep track of multiple versions of your creative in your reports.
-
#video_description ⇒ String
Description of the video ad.
-
#video_duration ⇒ Float
Creative video duration in seconds.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Creative
constructor
A new instance of Creative.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Creative
Returns a new instance of Creative
2663 2664 2665 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2663 def initialize(**args) update!(**args) end |
Instance Attribute Details
#account_id ⇒ String
Account ID of this creative. This field, if left unset, will be auto-generated
for both insert and update operations. Applicable to all creative types.
Corresponds to the JSON property accountId
2272 2273 2274 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2272 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
2277 2278 2279 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2277 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
2284 2285 2286 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2284 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
2293 2294 2295 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2293 def ad_tag_keys @ad_tag_keys end |
#advertiser_id ⇒ String
Advertiser ID of this creative. This is a required field. Applicable to all
creative types.
Corresponds to the JSON property advertiserId
2299 2300 2301 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2299 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
2306 2307 2308 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2306 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
2312 2313 2314 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2312 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
2319 2320 2321 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2319 def artwork_type @artwork_type 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
2325 2326 2327 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2325 def @authoring_tool end |
#auto_advance_images ⇒ Boolean Also known as: auto_advance_images?
Whether images are automatically advanced for enhanced image creatives.
Applicable to the following creative types: ENHANCED_IMAGE.
Corresponds to the JSON property auto_advance_images
2331 2332 2333 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2331 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
2339 2340 2341 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2339 def background_color @background_color end |
#backup_image_click_through_url ⇒ String
Click-through URL for backup image. Applicable to the following creative types:
ENHANCED_BANNER, FLASH_INPAGE, and HTML5_BANNER.
Corresponds to the JSON property backupImageClickThroughUrl
2345 2346 2347 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2345 def backup_image_click_through_url @backup_image_click_through_url end |
#backup_image_features ⇒ Array<String>
List of feature dependencies that will cause a backup image to be served if
the browser that serves the ad does not support them. Feature dependencies are
features that a browser must be able to support in order to render your HTML5
creative asset correctly. This field is initially auto-generated to contain
all features detected by DCM for all the assets of this creative and can then
be modified by the client. To reset this field, copy over all the
creativeAssets' detected features. Applicable to the following creative types:
ENHANCED_BANNER and HTML5_BANNER.
Corresponds to the JSON property backupImageFeatures
2357 2358 2359 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2357 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: ENHANCED_BANNER.
Corresponds to the JSON property backupImageReportingLabel
2363 2364 2365 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2363 def backup_image_reporting_label @backup_image_reporting_label end |
#backup_image_target_window ⇒ Google::Apis::DfareportingV2_1::TargetWindow
Target Window.
Corresponds to the JSON property backupImageTargetWindow
2368 2369 2370 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2368 def backup_image_target_window @backup_image_target_window end |
#click_tags ⇒ Array<Google::Apis::DfareportingV2_1::ClickTag>
Click tags of the creative. For ENHANCED_BANNER, 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 ENHANCED_IMAGE 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: ENHANCED_BANNER, ENHANCED_IMAGE,
FLASH_INPAGE, HTML5_BANNER.
Corresponds to the JSON property clickTags
2383 2384 2385 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2383 def @click_tags end |
#commercial_id ⇒ String
Industry standard ID assigned to creative for reach and frequency. Applicable
to the following creative types: all INSTREAM_VIDEO and all VPAID.
Corresponds to the JSON property commercialId
2389 2390 2391 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2389 def commercial_id @commercial_id end |
#companion_creatives ⇒ Array<String>
List of companion creatives assigned to an in-Stream videocreative. Acceptable
values include IDs of existing flash and image creatives. Applicable to the
following creative types: all INSTREAM_VIDEO and all VPAID.
Corresponds to the JSON property companionCreatives
2396 2397 2398 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2396 def companion_creatives @companion_creatives end |
#compatibility ⇒ Array<String>
Compatibilities associated with this creative. This is a read-only field. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. Applicable to all creative types. Acceptable values are:
- "APP"
- "APP_INTERSTITIAL"
- "IN_STREAM_VIDEO"
- "WEB"
- "WEB_INTERSTITIAL"
Corresponds to the JSON property
compatibility
2411 2412 2413 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2411 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 types: ENHANCED_BANNER and
FLASH_INPAGE.
Corresponds to the JSON property convertFlashToHtml5
2420 2421 2422 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2420 def convert_flash_to_html5 @convert_flash_to_html5 end |
#counter_custom_events ⇒ Array<Google::Apis::DfareportingV2_1::CreativeCustomEvent>
List of counter events configured for the creative. For ENHANCED_IMAGE
creatives, these are read-only and auto-generated from clickTags. Applicable
to the following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.
Corresponds to the JSON property counterCustomEvents
2428 2429 2430 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2428 def counter_custom_events @counter_custom_events end |
#creative_assets ⇒ Array<Google::Apis::DfareportingV2_1::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
2435 2436 2437 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2435 def creative_assets @creative_assets end |
#creative_field_assignments ⇒ Array<Google::Apis::DfareportingV2_1::CreativeFieldAssignment>
Creative field assignments for this creative. Applicable to all creative types.
Corresponds to the JSON property creativeFieldAssignments
2440 2441 2442 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2440 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
2449 2450 2451 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2449 def custom_key_values @custom_key_values end |
#exit_custom_events ⇒ Array<Google::Apis::DfareportingV2_1::CreativeCustomEvent>
List of exit events configured for the creative. For ENHANCED_BANNER and
ENHANCED_IMAGE creatives, these are read-only and auto-generated from
clickTags, For ENHANCED_BANNER, an event is also created from the
backupImageReportingLabel. Applicable to the following creative types:
ENHANCED_BANNER, ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.
Corresponds to the JSON property exitCustomEvents
2458 2459 2460 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2458 def exit_custom_events @exit_custom_events end |
#fs_command ⇒ Google::Apis::DfareportingV2_1::FsCommand
FsCommand.
Corresponds to the JSON property fsCommand
2463 2464 2465 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2463 def fs_command @fs_command end |
#html_code ⇒ String
HTML code for the creative. This is a required field when applicable. This
field is ignored if htmlCodeLocked is false. Applicable to the following
creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA.
Corresponds to the JSON property htmlCode
2470 2471 2472 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2470 def html_code @html_code end |
#html_code_locked ⇒ Boolean Also known as: html_code_locked?
Whether HTML code is DCM-generated or manually entered. Set to true to ignore
changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE
and HTML5_BANNER.
Corresponds to the JSON property htmlCodeLocked
2477 2478 2479 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2477 def html_code_locked @html_code_locked end |
#id ⇒ String
ID of this creative. This is a read-only, auto-generated field. Applicable to
all creative types.
Corresponds to the JSON property id
2484 2485 2486 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2484 def id @id end |
#id_dimension_value ⇒ Google::Apis::DfareportingV2_1::DimensionValue
Represents a DimensionValue resource.
Corresponds to the JSON property idDimensionValue
2489 2490 2491 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2489 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
2495 2496 2497 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2495 def kind @kind end |
#last_modified_info ⇒ Google::Apis::DfareportingV2_1::LastModifiedInfo
Modification timestamp.
Corresponds to the JSON property lastModifiedInfo
2500 2501 2502 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2500 def last_modified_info @last_modified_info end |
#latest_trafficked_creative_id ⇒ String
Latest Studio trafficked creative ID associated with rich media and VPAID
creatives. This is a read-only field. Applicable to the following creative
types: all RICH_MEDIA, and all VPAID.
Corresponds to the JSON property latestTraffickedCreativeId
2507 2508 2509 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2507 def latest_trafficked_creative_id @latest_trafficked_creative_id end |
#name ⇒ String
Name of the creative. This is a required field and must be less than 256
characters long. Applicable to all creative types.
Corresponds to the JSON property name
2513 2514 2515 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2513 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
2519 2520 2521 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2519 def override_css @override_css end |
#redirect_url ⇒ String
URL of hosted image or hosted video or another ad tag. For
INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL.
The standard for a VAST (Video Ad Serving Template) ad response allows for a
redirect link to another VAST 2.0 or 3.0 call. This is a required field when
applicable. Applicable to the following creative types: INTERNAL_REDIRECT,
INTERSTITIAL_INTERNAL_REDIRECT, REDIRECT, and INSTREAM_VIDEO_REDIRECT
Corresponds to the JSON property redirectUrl
2529 2530 2531 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2529 def redirect_url @redirect_url end |
#rendering_id ⇒ String
ID of current rendering version. This is a read-only field. Applicable to all
creative types.
Corresponds to the JSON property renderingId
2535 2536 2537 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2535 def rendering_id @rendering_id end |
#rendering_id_dimension_value ⇒ Google::Apis::DfareportingV2_1::DimensionValue
Represents a DimensionValue resource.
Corresponds to the JSON property renderingIdDimensionValue
2540 2541 2542 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2540 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
2547 2548 2549 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2547 def required_flash_plugin_version @required_flash_plugin_version end |
#required_flash_version ⇒ Fixnum
The internal Flash version for this creative as calculated by DoubleClick
Studio. This is a read-only field. Applicable to the following creative types:
FLASH_INPAGE, ENHANCED_BANNER, all RICH_MEDIA, and all VPAID.
Corresponds to the JSON property requiredFlashVersion
2554 2555 2556 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2554 def required_flash_version @required_flash_version end |
#size ⇒ Google::Apis::DfareportingV2_1::Size
Represents the dimensions of ads, placements, creatives, or creative assets.
Corresponds to the JSON property size
2559 2560 2561 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2559 def size @size end |
#skippable ⇒ Boolean Also known as: skippable?
Whether the user can choose to skip the creative. Applicable to the following
creative types: all INSTREAM_VIDEO and all VPAID.
Corresponds to the JSON property skippable
2565 2566 2567 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2565 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
2572 2573 2574 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2572 def ssl_compliant @ssl_compliant end |
#studio_advertiser_id ⇒ String
Studio advertiser ID associated with rich media and VPAID creatives. This is a
read-only field. Applicable to the following creative types: all RICH_MEDIA,
and all VPAID.
Corresponds to the JSON property studioAdvertiserId
2580 2581 2582 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2580 def studio_advertiser_id @studio_advertiser_id end |
#studio_creative_id ⇒ String
Studio creative ID associated with rich media and VPAID creatives. This is a
read-only field. Applicable to the following creative types: all RICH_MEDIA,
and all VPAID.
Corresponds to the JSON property studioCreativeId
2587 2588 2589 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2587 def studio_creative_id @studio_creative_id end |
#studio_trafficked_creative_id ⇒ String
Studio trafficked creative ID associated with rich media and VPAID creatives.
This is a read-only field. Applicable to the following creative types: all
RICH_MEDIA, and all VPAID.
Corresponds to the JSON property studioTraffickedCreativeId
2594 2595 2596 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2594 def studio_trafficked_creative_id @studio_trafficked_creative_id end |
#subaccount_id ⇒ String
Subaccount ID of this creative. This field, if left unset, will be auto-
generated for both insert and update operations. Applicable to all creative
types.
Corresponds to the JSON property subaccountId
2601 2602 2603 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2601 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
2607 2608 2609 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2607 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
2613 2614 2615 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2613 def third_party_rich_media_impressions_url @third_party_rich_media_impressions_url end |
#third_party_urls ⇒ Array<Google::Apis::DfareportingV2_1::ThirdPartyTrackingUrl>
Third-party URLs for tracking in-stream video creative events. Applicable to
the following creative types: all INSTREAM_VIDEO and all VPAID.
Corresponds to the JSON property thirdPartyUrls
2619 2620 2621 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2619 def third_party_urls @third_party_urls end |
#timer_custom_events ⇒ Array<Google::Apis::DfareportingV2_1::CreativeCustomEvent>
List of timer events configured for the creative. For ENHANCED_IMAGE creatives,
these are read-only and auto-generated from clickTags. Applicable to the
following creative types: ENHANCED_IMAGE, all RICH_MEDIA, and all VPAID.
Corresponds to the JSON property timerCustomEvents
2626 2627 2628 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2626 def timer_custom_events @timer_custom_events end |
#total_file_size ⇒ String
Combined size of all creative assets. This is a read-only field. Applicable to
the following creative types: all RICH_MEDIA, and all VPAID.
Corresponds to the JSON property totalFileSize
2632 2633 2634 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2632 def total_file_size @total_file_size end |
#type ⇒ String
Type of this creative.This is a required field. Applicable to all creative
types.
Corresponds to the JSON property type
2638 2639 2640 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2638 def type @type end |
#version ⇒ Fixnum
The version number helps you keep track of multiple versions of your creative
in your reports. The version number will always be auto-generated during
insert operations to start at 1. For tracking creatives the version cannot be
incremented and will always remain at 1. For all other creative types the
version can be incremented only by 1 during update operations. In addition,
the version will be automatically incremented by 1 when undergoing Rich Media
creative merging. Applicable to all creative types.
Corresponds to the JSON property version
2649 2650 2651 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2649 def version @version end |
#video_description ⇒ String
Description of the video ad. Applicable to the following creative types: all
INSTREAM_VIDEO and all VPAID.
Corresponds to the JSON property videoDescription
2655 2656 2657 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2655 def video_description @video_description end |
#video_duration ⇒ Float
Creative video duration in seconds. This is a read-only field. Applicable to
the following creative types: INSTREAM_VIDEO, all RICH_MEDIA, and all VPAID.
Corresponds to the JSON property videoDuration
2661 2662 2663 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2661 def video_duration @video_duration end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 |
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 2668 def update!(**args) @account_id = args[:account_id] unless args[:account_id].nil? @active = args[:active] unless args[:active].nil? @ad_parameters = args[:ad_parameters] unless args[:ad_parameters].nil? @ad_tag_keys = args[:ad_tag_keys] unless args[:ad_tag_keys].nil? @advertiser_id = args[:advertiser_id] unless args[:advertiser_id].nil? @allow_script_access = args[:allow_script_access] unless args[:allow_script_access].nil? @archived = args[:archived] unless args[:archived].nil? @artwork_type = args[:artwork_type] unless args[:artwork_type].nil? @authoring_tool = args[:authoring_tool] unless args[:authoring_tool].nil? @auto_advance_images = args[:auto_advance_images] unless args[:auto_advance_images].nil? @background_color = args[:background_color] unless args[:background_color].nil? @backup_image_click_through_url = args[:backup_image_click_through_url] unless args[:backup_image_click_through_url].nil? @backup_image_features = args[:backup_image_features] unless args[:backup_image_features].nil? @backup_image_reporting_label = args[:backup_image_reporting_label] unless args[:backup_image_reporting_label].nil? @backup_image_target_window = args[:backup_image_target_window] unless args[:backup_image_target_window].nil? @click_tags = args[:click_tags] unless args[:click_tags].nil? @commercial_id = args[:commercial_id] unless args[:commercial_id].nil? @companion_creatives = args[:companion_creatives] unless args[:companion_creatives].nil? @compatibility = args[:compatibility] unless args[:compatibility].nil? @convert_flash_to_html5 = args[:convert_flash_to_html5] unless args[:convert_flash_to_html5].nil? @counter_custom_events = args[:counter_custom_events] unless args[:counter_custom_events].nil? @creative_assets = args[:creative_assets] unless args[:creative_assets].nil? @creative_field_assignments = args[:creative_field_assignments] unless args[:creative_field_assignments].nil? @custom_key_values = args[:custom_key_values] unless args[:custom_key_values].nil? @exit_custom_events = args[:exit_custom_events] unless args[:exit_custom_events].nil? @fs_command = args[:fs_command] unless args[:fs_command].nil? @html_code = args[:html_code] unless args[:html_code].nil? @html_code_locked = args[:html_code_locked] unless args[:html_code_locked].nil? @id = args[:id] unless args[:id].nil? @id_dimension_value = args[:id_dimension_value] unless args[:id_dimension_value].nil? @kind = args[:kind] unless args[:kind].nil? @last_modified_info = args[:last_modified_info] unless args[:last_modified_info].nil? @latest_trafficked_creative_id = args[:latest_trafficked_creative_id] unless args[:latest_trafficked_creative_id].nil? @name = args[:name] unless args[:name].nil? @override_css = args[:override_css] unless args[:override_css].nil? @redirect_url = args[:redirect_url] unless args[:redirect_url].nil? @rendering_id = args[:rendering_id] unless args[:rendering_id].nil? @rendering_id_dimension_value = args[:rendering_id_dimension_value] unless args[:rendering_id_dimension_value].nil? @required_flash_plugin_version = args[:required_flash_plugin_version] unless args[:required_flash_plugin_version].nil? @required_flash_version = args[:required_flash_version] unless args[:required_flash_version].nil? @size = args[:size] unless args[:size].nil? @skippable = args[:skippable] unless args[:skippable].nil? @ssl_compliant = args[:ssl_compliant] unless args[:ssl_compliant].nil? @studio_advertiser_id = args[:studio_advertiser_id] unless args[:studio_advertiser_id].nil? @studio_creative_id = args[:studio_creative_id] unless args[:studio_creative_id].nil? @studio_trafficked_creative_id = args[:studio_trafficked_creative_id] unless args[:studio_trafficked_creative_id].nil? @subaccount_id = args[:subaccount_id] unless args[:subaccount_id].nil? @third_party_backup_image_impressions_url = args[:third_party_backup_image_impressions_url] unless args[:third_party_backup_image_impressions_url].nil? @third_party_rich_media_impressions_url = args[:third_party_rich_media_impressions_url] unless args[:third_party_rich_media_impressions_url].nil? @third_party_urls = args[:third_party_urls] unless args[:third_party_urls].nil? @timer_custom_events = args[:timer_custom_events] unless args[:timer_custom_events].nil? @total_file_size = args[:total_file_size] unless args[:total_file_size].nil? @type = args[:type] unless args[:type].nil? @version = args[:version] unless args[:version].nil? @video_description = args[:video_description] unless args[:video_description].nil? @video_duration = args[:video_duration] unless args[:video_duration].nil? end |