Class: Google::Apis::DfareportingV2_1::CreativeAssignment

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

Creative Assignment.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ CreativeAssignment

Returns a new instance of CreativeAssignment.



3270
3271
3272
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 3270

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) 


3184
3185
3186
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 3184

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) 


3193
3194
3195
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 3193

def apply_event_tags
  @apply_event_tags
end

#click_through_url ⇒ Google::Apis::DfareportingV2_1::ClickThroughUrl

Click-through URL Corresponds to the JSON property clickThroughUrl

Returns:



3199
3200
3201
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 3199

def click_through_url
  @click_through_url
end

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

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

Returns:



3205
3206
3207
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 3205

def companion_creative_overrides
  @companion_creative_overrides
end

#creative_group_assignments ⇒ Array<Google::Apis::DfareportingV2_1::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:



3211
3212
3213
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 3211

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) 


3216
3217
3218
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 3216

def creative_id
  @creative_id
end

#creative_id_dimension_value ⇒ Google::Apis::DfareportingV2_1::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property creativeIdDimensionValue

Returns:



3221
3222
3223
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 3221

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) 


3227
3228
3229
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 3227

def end_time
  @end_time
end

#rich_media_exit_overrides ⇒ Array<Google::Apis::DfareportingV2_1::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:



3244
3245
3246
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 3244

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) 


3250
3251
3252
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 3250

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) 


3256
3257
3258
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 3256

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) 


3262
3263
3264
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 3262

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) 


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

def weight
  @weight
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 3275

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