Class: Google::Apis::DfareportingV2_8::CreativeCustomEvent

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



3923
3924
3925
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 3923

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

Instance Attribute Details

#advertiser_custom_event_id ⇒ Fixnum

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:

  • (Fixnum) 


3873
3874
3875
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 3873

def advertiser_custom_event_id
  @advertiser_custom_event_id
end

#advertiser_custom_event_name ⇒ String

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

Returns:

  • (String) 


3878
3879
3880
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 3878

def advertiser_custom_event_name
  @advertiser_custom_event_name
end

#advertiser_custom_event_type ⇒ String

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

Returns:

  • (String) 


3883
3884
3885
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 3883

def advertiser_custom_event_type
  @advertiser_custom_event_type
end

#artwork_label ⇒ String

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) 


3889
3890
3891
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 3889

def artwork_label
  @artwork_label
end

#artwork_type ⇒ String

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

Returns:

  • (String) 


3894
3895
3896
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 3894

def artwork_type
  @artwork_type
end

#exit_url ⇒ String

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

Returns:

  • (String) 


3899
3900
3901
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 3899

def exit_url
  @exit_url
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


3905
3906
3907
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 3905

def id
  @id
end

#popup_window_properties ⇒ Google::Apis::DfareportingV2_8::PopupWindowProperties

Popup Window Properties. Corresponds to the JSON property popupWindowProperties

Returns:



3910
3911
3912
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 3910

def popup_window_properties
  @popup_window_properties
end

#target_type ⇒ String

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

Returns:

  • (String) 


3915
3916
3917
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 3915

def target_type
  @target_type
end

#video_reporting_id ⇒ String

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) 


3921
3922
3923
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 3921

def video_reporting_id
  @video_reporting_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 3928

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