Class: Google::Apis::DfareportingV2_5::CreativeCustomEvent

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

Overview

Creative Custom Event.

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) ⇒ CreativeCustomEvent

Returns a new instance of CreativeCustomEvent.


3635
3636
3637
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 3635

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

Instance Attribute Details

#advertiser_custom_event_idString

Unique ID of this event used by DDM Reporting and Data Transfer. This is a read-only field. Corresponds to the JSON property advertiserCustomEventId

Returns:

  • (String)

3585
3586
3587
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 3585

def advertiser_custom_event_id
  @advertiser_custom_event_id
end

#advertiser_custom_event_nameString

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

Returns:

  • (String)

3590
3591
3592
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 3590

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)

3595
3596
3597
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 3595

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)

3601
3602
3603
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 3601

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)

3606
3607
3608
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 3606

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)

3611
3612
3613
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 3611

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)

3617
3618
3619
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 3617

def id
  @id
end

Popup Window Properties. Corresponds to the JSON property popupWindowProperties


3622
3623
3624
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 3622

def popup_window_properties
  @popup_window_properties
end

#target_typeString

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

Returns:

  • (String)

3627
3628
3629
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 3627

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)

3633
3634
3635
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 3633

def video_reporting_id
  @video_reporting_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 3640

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