Class: Google::Apis::DfareportingV3_4::CustomEvent

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

Experimental feature (no support provided) A custom event represents a third party impression, a third party click, an annotation on a first party impression, or an annotation on a first party click.

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

Returns a new instance of CustomEvent.



4678
4679
4680
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4678

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

Instance Attribute Details

#annotate_click_event ⇒ Google::Apis::DfareportingV3_4::CustomEventClickAnnotation

Annotate a click event. Corresponds to the JSON property annotateClickEvent

Returns:



4636
4637
4638
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4636

def annotate_click_event
  @annotate_click_event
end

#custom_variables ⇒ Array<Google::Apis::DfareportingV3_4::CustomVariable>

Custom variables associated with the event. Corresponds to the JSON property customVariables

Returns:



4641
4642
4643
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4641

def custom_variables
  @custom_variables
end

#event_type ⇒ String

The type of event. If INSERT, the fields in insertEvent need to be populated. If ANNOTATE_CLICK, the fields in annotateClickEvent need to be populated. A custom event cannot have both insertEvent and annotateClickEvent populated. Corresponds to the JSON property eventType

Returns:

  • (String) 


4648
4649
4650
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4648

def event_type
  @event_type
end

#floodlight_configuration_id ⇒ Fixnum

Floodlight configuration ID of the advertiser the event is linked to. This is a required field. Corresponds to the JSON property floodlightConfigurationId

Returns:

  • (Fixnum) 


4654
4655
4656
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4654

def floodlight_configuration_id
  @floodlight_configuration_id
end

#insert_event ⇒ Google::Apis::DfareportingV3_4::CustomEventInsert

Custom event to be inserted. Corresponds to the JSON property insertEvent

Returns:



4659
4660
4661
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4659

def insert_event
  @insert_event
end

#kind ⇒ String

Identifies what kind of resource this is. Value: the fixed string " dfareporting#customEvent". Corresponds to the JSON property kind

Returns:

  • (String) 


4665
4666
4667
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4665

def kind
  @kind
end

#ordinal ⇒ String

The ordinal of this custom event. This is a required field. Corresponds to the JSON property ordinal

Returns:

  • (String) 


4670
4671
4672
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4670

def ordinal
  @ordinal
end

#timestamp_micros ⇒ Fixnum

The timestamp of this custom event, in Unix epoch micros. This is a required field. Corresponds to the JSON property timestampMicros

Returns:

  • (Fixnum) 


4676
4677
4678
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4676

def timestamp_micros
  @timestamp_micros
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4683

def update!(**args)
  @annotate_click_event = args[:annotate_click_event] if args.key?(:annotate_click_event)
  @custom_variables = args[:custom_variables] if args.key?(:custom_variables)
  @event_type = args[:event_type] if args.key?(:event_type)
  @floodlight_configuration_id = args[:floodlight_configuration_id] if args.key?(:floodlight_configuration_id)
  @insert_event = args[:insert_event] if args.key?(:insert_event)
  @kind = args[:kind] if args.key?(:kind)
  @ordinal = args[:ordinal] if args.key?(:ordinal)
  @timestamp_micros = args[:timestamp_micros] if args.key?(:timestamp_micros)
end