Class: Google::Apis::DfareportingV3_4::CreativeCustomEvent

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dfareporting_v3_4/classes.rb,
generated/google/apis/dfareporting_v3_4/representations.rb,
generated/google/apis/dfareporting_v3_4/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.



4141
4142
4143
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4141

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

Instance Attribute Details

#advertiser_custom_event_idFixnum

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

Returns:

  • (Fixnum)


4091
4092
4093
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4091

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)


4096
4097
4098
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4096

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)


4101
4102
4103
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4101

def advertiser_custom_event_type
  @advertiser_custom_event_type
end

#artwork_labelString

Artwork label column, used to link events in Campaign Manager 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)


4107
4108
4109
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4107

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)


4112
4113
4114
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4112

def artwork_type
  @artwork_type
end

#exit_click_through_urlGoogle::Apis::DfareportingV3_4::CreativeClickThroughUrl

Click-through URL Corresponds to the JSON property exitClickThroughUrl



4117
4118
4119
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4117

def exit_click_through_url
  @exit_click_through_url
end

#idFixnum

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

Returns:

  • (Fixnum)


4123
4124
4125
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4123

def id
  @id
end

Popup Window Properties. Corresponds to the JSON property popupWindowProperties



4128
4129
4130
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4128

def popup_window_properties
  @popup_window_properties
end

#target_typeString

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

Returns:

  • (String)


4133
4134
4135
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4133

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)


4139
4140
4141
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4139

def video_reporting_id
  @video_reporting_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4146

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_click_through_url = args[:exit_click_through_url] if args.key?(:exit_click_through_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