Class: Google::Apis::DfareportingV2_1::CreativeCustomEvent

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 Custom Event.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ CreativeCustomEvent

Returns a new instance of CreativeCustomEvent.


3350
3351
3352
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 3350

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

Instance Attribute Details

#activeBoolean Also known as: active?

Whether the event is active. Corresponds to the JSON property active

Returns:

  • (Boolean)

3299
3300
3301
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 3299

def active
  @active
end

#advertiser_custom_event_nameString

User-entered name for the event. Corresponds to the JSON property advertiserCustomEventName

Returns:

  • (String)

3305
3306
3307
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 3305

def advertiser_custom_event_name
  @advertiser_custom_event_name
end

#advertiser_custom_event_typeString

Type of the event. This is a read-only field. Corresponds to the JSON property advertiserCustomEventType

Returns:

  • (String)

3310
3311
3312
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 3310

def advertiser_custom_event_type
  @advertiser_custom_event_type
end

#artwork_labelString

Artwork label column, used to link events in DCM back to events in Studio. This is a required field and should not be modified after insertion. Corresponds to the JSON property artworkLabel

Returns:

  • (String)

3316
3317
3318
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 3316

def artwork_label
  @artwork_label
end

#artwork_typeString

Artwork type used by the creative.This is a read-only field. Corresponds to the JSON property artworkType

Returns:

  • (String)

3321
3322
3323
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 3321

def artwork_type
  @artwork_type
end

#exit_urlString

Exit URL of the event. This field is used only for exit events. Corresponds to the JSON property exitUrl

Returns:

  • (String)

3326
3327
3328
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 3326

def exit_url
  @exit_url
end

#idString

ID of this event. This is a required field and should not be modified after insertion. Corresponds to the JSON property id

Returns:

  • (String)

3332
3333
3334
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 3332

def id
  @id
end

Popup Window Properties. Corresponds to the JSON property popupWindowProperties


3337
3338
3339
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 3337

def popup_window_properties
  @popup_window_properties
end

#target_typeString

Target type used by the event. Corresponds to the JSON property targetType

Returns:

  • (String)

3342
3343
3344
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 3342

def target_type
  @target_type
end

#video_reporting_idString

Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field. Corresponds to the JSON property videoReportingId

Returns:

  • (String)

3348
3349
3350
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 3348

def video_reporting_id
  @video_reporting_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 3355

def update!(**args)
  @active = args[:active] unless args[:active].nil?
  @advertiser_custom_event_name = args[:advertiser_custom_event_name] unless args[:advertiser_custom_event_name].nil?
  @advertiser_custom_event_type = args[:advertiser_custom_event_type] unless args[:advertiser_custom_event_type].nil?
  @artwork_label = args[:artwork_label] unless args[:artwork_label].nil?
  @artwork_type = args[:artwork_type] unless args[:artwork_type].nil?
  @exit_url = args[:exit_url] unless args[:exit_url].nil?
  @id = args[:id] unless args[:id].nil?
  @popup_window_properties = args[:popup_window_properties] unless args[:popup_window_properties].nil?
  @target_type = args[:target_type] unless args[:target_type].nil?
  @video_reporting_id = args[:video_reporting_id] unless args[:video_reporting_id].nil?
end