Class: Google::Apis::DfareportingV4::Creative

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Creative

Returns a new instance of Creative.



3680
3681
3682
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3680

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

Instance Attribute Details

#account_id ⇒ Fixnum

Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types. Corresponds to the JSON property accountId

Returns:

  • (Fixnum) 


3222
3223
3224
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3222

def 
  @account_id
end

#active ⇒ Boolean Also known as: active?

Whether the creative is active. Applicable to all creative types. Corresponds to the JSON property active

Returns:

  • (Boolean) 


3227
3228
3229
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3227

def active
  @active
end

#ad_parameters ⇒ String

Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID. Corresponds to the JSON property adParameters

Returns:

  • (String) 


3234
3235
3236
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3234

def ad_parameters
  @ad_parameters
end

#ad_tag_keys ⇒ Array<String>

Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. Corresponds to the JSON property adTagKeys

Returns:

  • (Array<String>) 


3243
3244
3245
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3243

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

Returns:



3251
3252
3253
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3251

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

Returns:

  • (Fixnum) 


3257
3258
3259
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3257

def advertiser_id
  @advertiser_id
end

#allow_script_access ⇒ Boolean Also known as: allow_script_access?

Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE. Corresponds to the JSON property allowScriptAccess

Returns:

  • (Boolean) 


3264
3265
3266
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3264

def allow_script_access
  @allow_script_access
end

#archived ⇒ Boolean Also known as: archived?

Whether the creative is archived. Applicable to all creative types. Corresponds to the JSON property archived

Returns:

  • (Boolean) 


3270
3271
3272
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3270

def archived
  @archived
end

#artwork_type ⇒ String

Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. Corresponds to the JSON property artworkType

Returns:

  • (String) 


3277
3278
3279
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3277

def artwork_type
  @artwork_type
end

#authoring_source ⇒ String

Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types. Corresponds to the JSON property authoringSource

Returns:

  • (String) 


3283
3284
3285
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3283

def authoring_source
  @authoring_source
end

#authoring_tool ⇒ String

Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER. Corresponds to the JSON property authoringTool

Returns:

  • (String) 


3289
3290
3291
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3289

def authoring_tool
  @authoring_tool
end

#auto_advance_images ⇒ Boolean Also known as: auto_advance_images?

Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY. Corresponds to the JSON property autoAdvanceImages

Returns:

  • (Boolean) 


3295
3296
3297
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3295

def auto_advance_images
  @auto_advance_images
end

#background_color ⇒ String

The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE. Corresponds to the JSON property backgroundColor

Returns:

  • (String) 


3303
3304
3305
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3303

def background_color
  @background_color
end

#backup_image_click_through_url ⇒ Google::Apis::DfareportingV4::CreativeClickThroughUrl

Click-through URL Corresponds to the JSON property backupImageClickThroughUrl

Returns:



3308
3309
3310
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3308

def backup_image_click_through_url
  @backup_image_click_through_url
end

#backup_image_features ⇒ Array<String>

List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by Campaign Manager for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. Corresponds to the JSON property backupImageFeatures

Returns:

  • (Array<String>) 


3321
3322
3323
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3321

def backup_image_features
  @backup_image_features
end

#backup_image_reporting_label ⇒ String

Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE. Corresponds to the JSON property backupImageReportingLabel

Returns:

  • (String) 


3328
3329
3330
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3328

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

Returns:



3333
3334
3335
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3333

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

Returns:



3348
3349
3350
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3348

def click_tags
  @click_tags
end

#commercial_id ⇒ String

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

Returns:

  • (String) 


3354
3355
3356
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3354

def commercial_id
  @commercial_id
end

#companion_creatives ⇒ Array<Fixnum>

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

Returns:

  • (Array<Fixnum>) 


3362
3363
3364
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3362

def companion_creatives
  @companion_creatives
end

#compatibility ⇒ Array<String>

Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. IN_STREAM_AUDIO refers to rendering in in-stream audio ads developed with the VAST standard. Applicable to all creative types. Acceptable values are: - "APP"

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

Returns:

  • (Array<String>) 


3377
3378
3379
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3377

def compatibility
  @compatibility
end

#convert_flash_to_html5 ⇒ Boolean Also known as: convert_flash_to_html5?

Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. Corresponds to the JSON property convertFlashToHtml5

Returns:

  • (Boolean) 


3386
3387
3388
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3386

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

Returns:



3395
3396
3397
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3395

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

Returns:



3401
3402
3403
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3401

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

Returns:



3408
3409
3410
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3408

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

Returns:



3413
3414
3415
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3413

def creative_field_assignments
  @creative_field_assignments
end

#custom_key_values ⇒ Array<String>

Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. Corresponds to the JSON property customKeyValues

Returns:

  • (Array<String>) 


3422
3423
3424
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3422

def custom_key_values
  @custom_key_values
end

#dynamic_asset_selection ⇒ Boolean Also known as: dynamic_asset_selection?

Set this to true to enable the use of rules to target individual assets in this creative. When set to true creativeAssetSelection must be set. This also controls asset-level companions. When this is true, companion creatives should be assigned to creative assets. Learn more. Applicable to INSTREAM_VIDEO creatives. Corresponds to the JSON property dynamicAssetSelection

Returns:

  • (Boolean) 


3431
3432
3433
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3431

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

Returns:



3442
3443
3444
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3442

def exit_custom_events
  @exit_custom_events
end

#fs_command ⇒ Google::Apis::DfareportingV4::FsCommand

FsCommand. Corresponds to the JSON property fsCommand

Returns:



3447
3448
3449
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3447

def fs_command
  @fs_command
end

#html_code ⇒ String

HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is true. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA. Corresponds to the JSON property htmlCode

Returns:

  • (String) 


3454
3455
3456
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3454

def html_code
  @html_code
end

#html_code_locked ⇒ Boolean Also known as: html_code_locked?

Whether HTML code is generated by Campaign Manager or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. Corresponds to the JSON property htmlCodeLocked

Returns:

  • (Boolean) 


3461
3462
3463
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3461

def html_code_locked
  @html_code_locked
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


3468
3469
3470
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3468

def id
  @id
end

#id_dimension_value ⇒ Google::Apis::DfareportingV4::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue

Returns:



3473
3474
3475
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3473

def id_dimension_value
  @id_dimension_value
end

#kind ⇒ String

Identifies what kind of resource this is. Value: the fixed string " dfareporting#creative". Corresponds to the JSON property kind

Returns:

  • (String) 


3479
3480
3481
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3479

def kind
  @kind
end

#last_modified_info ⇒ Google::Apis::DfareportingV4::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property lastModifiedInfo

Returns:



3484
3485
3486
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3484

def last_modified_info
  @last_modified_info
end

#latest_trafficked_creative_id ⇒ Fixnum

Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. Corresponds to the JSON property latestTraffickedCreativeId

Returns:

  • (Fixnum) 


3491
3492
3493
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3491

def latest_trafficked_creative_id
  @latest_trafficked_creative_id
end

#media_description ⇒ String

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

Returns:

  • (String) 


3497
3498
3499
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3497

def media_description
  @media_description
end

#media_duration ⇒ Float

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

Returns:

  • (Float) 


3504
3505
3506
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3504

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

Returns:

  • (String) 


3510
3511
3512
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3510

def name
  @name
end

#oba_icon ⇒ Google::Apis::DfareportingV4::ObaIcon

Online Behavioral Advertiser icon. Corresponds to the JSON property obaIcon

Returns:



3515
3516
3517
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3515

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

Returns:

  • (String) 


3521
3522
3523
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3521

def override_css
  @override_css
end

#progress_offset ⇒ Google::Apis::DfareportingV4::VideoOffset

Video Offset Corresponds to the JSON property progressOffset

Returns:



3526
3527
3528
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3526

def progress_offset
  @progress_offset
end

#redirect_url ⇒ String

URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT Corresponds to the JSON property redirectUrl

Returns:

  • (String) 


3536
3537
3538
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3536

def redirect_url
  @redirect_url
end

#rendering_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


3542
3543
3544
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3542

def rendering_id
  @rendering_id
end

#rendering_id_dimension_value ⇒ Google::Apis::DfareportingV4::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property renderingIdDimensionValue

Returns:



3547
3548
3549
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3547

def rendering_id_dimension_value
  @rendering_id_dimension_value
end

#required_flash_plugin_version ⇒ String

The minimum required Flash plugin version for this creative. For example, 11.2. 202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. Corresponds to the JSON property requiredFlashPluginVersion

Returns:

  • (String) 


3554
3555
3556
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3554

def required_flash_plugin_version
  @required_flash_plugin_version
end

#required_flash_version ⇒ Fixnum

The internal Flash version for this creative as calculated by Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. Corresponds to the JSON property requiredFlashVersion

Returns:

  • (Fixnum) 


3562
3563
3564
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3562

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

Returns:



3567
3568
3569
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3567

def size
  @size
end

#skip_offset ⇒ Google::Apis::DfareportingV4::VideoOffset

Video Offset Corresponds to the JSON property skipOffset

Returns:



3572
3573
3574
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3572

def skip_offset
  @skip_offset
end

#skippable ⇒ Boolean Also known as: skippable?

Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID. Corresponds to the JSON property skippable

Returns:

  • (Boolean) 


3578
3579
3580
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3578

def skippable
  @skippable
end

#ssl_compliant ⇒ Boolean Also known as: ssl_compliant?

Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types. Corresponds to the JSON property sslCompliant

Returns:

  • (Boolean) 


3585
3586
3587
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3585

def ssl_compliant
  @ssl_compliant
end

#ssl_override ⇒ Boolean Also known as: ssl_override?

Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types. Corresponds to the JSON property sslOverride

Returns:

  • (Boolean) 


3592
3593
3594
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3592

def ssl_override
  @ssl_override
end

#studio_advertiser_id ⇒ Fixnum

Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. Corresponds to the JSON property studioAdvertiserId

Returns:

  • (Fixnum) 


3600
3601
3602
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3600

def studio_advertiser_id
  @studio_advertiser_id
end

#studio_creative_id ⇒ Fixnum

Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. Corresponds to the JSON property studioCreativeId

Returns:

  • (Fixnum) 


3607
3608
3609
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3607

def studio_creative_id
  @studio_creative_id
end

#studio_trafficked_creative_id ⇒ Fixnum

Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. Corresponds to the JSON property studioTraffickedCreativeId

Returns:

  • (Fixnum) 


3614
3615
3616
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3614

def studio_trafficked_creative_id
  @studio_trafficked_creative_id
end

#subaccount_id ⇒ Fixnum

Subaccount ID of this creative. This field, if left unset, will be auto- generated for both insert and update operations. Applicable to all creative types. Corresponds to the JSON property subaccountId

Returns:

  • (Fixnum) 


3621
3622
3623
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3621

def subaccount_id
  @subaccount_id
end

#third_party_backup_image_impressions_url ⇒ String

Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA. Corresponds to the JSON property thirdPartyBackupImageImpressionsUrl

Returns:

  • (String) 


3627
3628
3629
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3627

def third_party_backup_image_impressions_url
  @third_party_backup_image_impressions_url
end

#third_party_rich_media_impressions_url ⇒ String

Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA. Corresponds to the JSON property thirdPartyRichMediaImpressionsUrl

Returns:

  • (String) 


3633
3634
3635
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3633

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

Returns:



3640
3641
3642
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3640

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

Returns:



3648
3649
3650
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3648

def timer_custom_events
  @timer_custom_events
end

#total_file_size ⇒ Fixnum

Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. Corresponds to the JSON property totalFileSize

Returns:

  • (Fixnum) 


3654
3655
3656
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3654

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

Returns:

  • (String) 


3661
3662
3663
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3661

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

Returns:



3667
3668
3669
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3667

def universal_ad_id
  @universal_ad_id
end

#version ⇒ Fixnum

The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types. Corresponds to the JSON property version

Returns:

  • (Fixnum) 


3678
3679
3680
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3678

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 3685

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