Class: Google::Apis::DfareportingV2_3::CreativeAssignment

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

Overview

Creative Assignment.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ CreativeAssignment

Returns a new instance of CreativeAssignment.



3322
3323
3324
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 3322

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

Instance Attribute Details

#active ⇒ Boolean Also known as: active?

Whether this creative assignment is active. When true, the creative will be included in the ad's rotation. Corresponds to the JSON property active

Returns:

  • (Boolean) 


3236
3237
3238
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 3236

def active
  @active
end

#apply_event_tags ⇒ Boolean Also known as: apply_event_tags?

Whether applicable event tags should fire when this creative assignment is rendered. If this value is unset when the ad is inserted or updated, it will default to true for all creative types EXCEPT for INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO. Corresponds to the JSON property applyEventTags

Returns:

  • (Boolean) 


3245
3246
3247
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 3245

def apply_event_tags
  @apply_event_tags
end

#click_through_url ⇒ Google::Apis::DfareportingV2_3::ClickThroughUrl

Click-through URL Corresponds to the JSON property clickThroughUrl

Returns:



3251
3252
3253
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 3251

def click_through_url
  @click_through_url
end

#companion_creative_overrides ⇒ Array<Google::Apis::DfareportingV2_3::CompanionClickThroughOverride>

Companion creative overrides for this creative assignment. Applicable to video ads. Corresponds to the JSON property companionCreativeOverrides

Returns:



3257
3258
3259
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 3257

def companion_creative_overrides
  @companion_creative_overrides
end

#creative_group_assignments ⇒ Array<Google::Apis::DfareportingV2_3::CreativeGroupAssignment>

Creative group assignments for this creative assignment. Only one assignment per creative group number is allowed for a maximum of two assignments. Corresponds to the JSON property creativeGroupAssignments

Returns:



3263
3264
3265
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 3263

def creative_group_assignments
  @creative_group_assignments
end

#creative_id ⇒ String

ID of the creative to be assigned. This is a required field. Corresponds to the JSON property creativeId

Returns:

  • (String) 


3268
3269
3270
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 3268

def creative_id
  @creative_id
end

#creative_id_dimension_value ⇒ Google::Apis::DfareportingV2_3::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property creativeIdDimensionValue

Returns:



3273
3274
3275
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 3273

def creative_id_dimension_value
  @creative_id_dimension_value
end

#end_time ⇒ DateTime

Date and time that the assigned creative should stop serving. Must be later than the start time. Corresponds to the JSON property endTime

Returns:

  • (DateTime) 


3279
3280
3281
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 3279

def end_time
  @end_time
end

#rich_media_exit_overrides ⇒ Array<Google::Apis::DfareportingV2_3::RichMediaExitOverride>

Rich media exit overrides for this creative assignment. Applicable when the creative type is any of the following:

  • RICH_MEDIA_INPAGE
  • RICH_MEDIA_INPAGE_FLOATING
  • RICH_MEDIA_IM_EXPAND
  • RICH_MEDIA_EXPANDING
  • RICH_MEDIA_INTERSTITIAL_FLOAT
  • RICH_MEDIA_MOBILE_IN_APP
  • RICH_MEDIA_MULTI_FLOATING
  • RICH_MEDIA_PEEL_DOWN
  • ADVANCED_BANNER
  • VPAID_LINEAR
  • VPAID_NON_LINEAR Corresponds to the JSON property richMediaExitOverrides

Returns:



3296
3297
3298
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 3296

def rich_media_exit_overrides
  @rich_media_exit_overrides
end

#sequence ⇒ Fixnum

Sequence number of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_SEQUENTIAL. Corresponds to the JSON property sequence

Returns:

  • (Fixnum) 


3302
3303
3304
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 3302

def sequence
  @sequence
end

#ssl_compliant ⇒ Boolean Also known as: ssl_compliant?

Whether the creative to be assigned is SSL-compliant. This is a read-only field that is auto-generated when the ad is inserted or updated. Corresponds to the JSON property sslCompliant

Returns:

  • (Boolean) 


3308
3309
3310
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 3308

def ssl_compliant
  @ssl_compliant
end

#start_time ⇒ DateTime

Date and time that the assigned creative should start serving. Corresponds to the JSON property startTime

Returns:

  • (DateTime) 


3314
3315
3316
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 3314

def start_time
  @start_time
end

#weight ⇒ Fixnum

Weight of the creative assignment, applicable when the rotation type is CREATIVE_ROTATION_TYPE_RANDOM. Corresponds to the JSON property weight

Returns:

  • (Fixnum) 


3320
3321
3322
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 3320

def weight
  @weight
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 3327

def update!(**args)
  @active = args[:active] if args.key?(:active)
  @apply_event_tags = args[:apply_event_tags] if args.key?(:apply_event_tags)
  @click_through_url = args[:click_through_url] if args.key?(:click_through_url)
  @companion_creative_overrides = args[:companion_creative_overrides] if args.key?(:companion_creative_overrides)
  @creative_group_assignments = args[:creative_group_assignments] if args.key?(:creative_group_assignments)
  @creative_id = args[:creative_id] if args.key?(:creative_id)
  @creative_id_dimension_value = args[:creative_id_dimension_value] if args.key?(:creative_id_dimension_value)
  @end_time = args[:end_time] if args.key?(:end_time)
  @rich_media_exit_overrides = args[:rich_media_exit_overrides] if args.key?(:rich_media_exit_overrides)
  @sequence = args[:sequence] if args.key?(:sequence)
  @ssl_compliant = args[:ssl_compliant] if args.key?(:ssl_compliant)
  @start_time = args[:start_time] if args.key?(:start_time)
  @weight = args[:weight] if args.key?(:weight)
end