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.



4718
4719
4720
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4718

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

Instance Attribute Details

#annotate_click_eventGoogle::Apis::DfareportingV3_4::CustomEventClickAnnotation

Annotate a click event. Corresponds to the JSON property annotateClickEvent



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

def annotate_click_event
  @annotate_click_event
end

#annotate_impression_eventGoogle::Apis::DfareportingV3_4::CustomEventImpressionAnnotation

Annotate an impression. Corresponds to the JSON property annotateImpressionEvent



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

def annotate_impression_event
  @annotate_impression_event
end

#custom_variablesArray<Google::Apis::DfareportingV3_4::CustomVariable>

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



4681
4682
4683
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4681

def custom_variables
  @custom_variables
end

#event_typeString

The type of event. If INSERT, the fields in insertEvent need to be populated. If ANNOTATE, the fields in either annotateClickEvent or annotateImpressionEvent need to be populated. Corresponds to the JSON property eventType

Returns:

  • (String)


4688
4689
4690
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4688

def event_type
  @event_type
end

#floodlight_configuration_idFixnum

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

Returns:

  • (Fixnum)


4694
4695
4696
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4694

def floodlight_configuration_id
  @floodlight_configuration_id
end

#insert_eventGoogle::Apis::DfareportingV3_4::CustomEventInsert

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



4699
4700
4701
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4699

def insert_event
  @insert_event
end

#kindString

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

Returns:

  • (String)


4705
4706
4707
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4705

def kind
  @kind
end

#ordinalString

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

Returns:

  • (String)


4710
4711
4712
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4710

def ordinal
  @ordinal
end

#timestamp_microsFixnum

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

Returns:

  • (Fixnum)


4716
4717
4718
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4716

def timestamp_micros
  @timestamp_micros
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 4723

def update!(**args)
  @annotate_click_event = args[:annotate_click_event] if args.key?(:annotate_click_event)
  @annotate_impression_event = args[:annotate_impression_event] if args.key?(:annotate_impression_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