Class: Google::Apis::DfareportingV2_5::Report::PathToConversionCriteria::ReportProperties

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

The properties of the report.

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

Returns a new instance of ReportProperties



9727
9728
9729
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9727

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

Instance Attribute Details

#clicks_lookback_window ⇒ Fixnum

DFA checks to see if a click interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90. Corresponds to the JSON property clicksLookbackWindow

Returns:

  • (Fixnum) 


9668
9669
9670
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9668

def clicks_lookback_window
  @clicks_lookback_window
end

#impressions_lookback_window ⇒ Fixnum

DFA checks to see if an impression interaction occurred within the specified period of time before a conversion. By default the value is pulled from Floodlight or you can manually enter a custom value. Valid values: 1-90. Corresponds to the JSON property impressionsLookbackWindow

Returns:

  • (Fixnum) 


9675
9676
9677
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9675

def impressions_lookback_window
  @impressions_lookback_window
end

#include_attributed_ip_conversions ⇒ Boolean Also known as: include_attributed_ip_conversions?

Deprecated: has no effect. Corresponds to the JSON property includeAttributedIPConversions

Returns:

  • (Boolean) 


9680
9681
9682
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9680

def include_attributed_ip_conversions
  @include_attributed_ip_conversions
end

#include_unattributed_cookie_conversions ⇒ Boolean Also known as: include_unattributed_cookie_conversions?

Include conversions of users with a DoubleClick cookie but without an exposure. That means the user did not click or see an ad from the advertiser within the Floodlight group, or that the interaction happened outside the lookback window. Corresponds to the JSON property includeUnattributedCookieConversions

Returns:

  • (Boolean) 


9688
9689
9690
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9688

def include_unattributed_cookie_conversions
  @include_unattributed_cookie_conversions
end

#include_unattributed_ip_conversions ⇒ Boolean Also known as: include_unattributed_ip_conversions?

Include conversions that have no associated cookies and no exposures. It’s therefore impossible to know how the user was exposed to your ads during the lookback window prior to a conversion. Corresponds to the JSON property includeUnattributedIPConversions

Returns:

  • (Boolean) 


9696
9697
9698
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9696

def include_unattributed_ip_conversions
  @include_unattributed_ip_conversions
end

#maximum_click_interactions ⇒ Fixnum

The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report. Corresponds to the JSON property maximumClickInteractions

Returns:

  • (Fixnum) 


9705
9706
9707
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9705

def maximum_click_interactions
  @maximum_click_interactions
end

#maximum_impression_interactions ⇒ Fixnum

The maximum number of click interactions to include in the report. Advertisers currently paying for E2C reports get up to 200 (100 clicks, 100 impressions). If another advertiser in your network is paying for E2C, you can have up to 5 total exposures per report. Corresponds to the JSON property maximumImpressionInteractions

Returns:

  • (Fixnum) 


9713
9714
9715
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9713

def maximum_impression_interactions
  @maximum_impression_interactions
end

#maximum_interaction_gap ⇒ Fixnum

The maximum amount of time that can take place between interactions (clicks or impressions) by the same user. Valid values: 1-90. Corresponds to the JSON property maximumInteractionGap

Returns:

  • (Fixnum) 


9719
9720
9721
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9719

def maximum_interaction_gap
  @maximum_interaction_gap
end

#pivot_on_interaction_path ⇒ Boolean Also known as: pivot_on_interaction_path?

Enable pivoting on interaction path. Corresponds to the JSON property pivotOnInteractionPath

Returns:

  • (Boolean) 


9724
9725
9726
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9724

def pivot_on_interaction_path
  @pivot_on_interaction_path
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9732
9733
9734
9735
9736
9737
9738
9739
9740
9741
9742
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 9732

def update!(**args)
  @clicks_lookback_window = args[:clicks_lookback_window] if args.key?(:clicks_lookback_window)
  @impressions_lookback_window = args[:impressions_lookback_window] if args.key?(:impressions_lookback_window)
  @include_attributed_ip_conversions = args[:include_attributed_ip_conversions] if args.key?(:include_attributed_ip_conversions)
  @include_unattributed_cookie_conversions = args[:include_unattributed_cookie_conversions] if args.key?(:include_unattributed_cookie_conversions)
  @include_unattributed_ip_conversions = args[:include_unattributed_ip_conversions] if args.key?(:include_unattributed_ip_conversions)
  @maximum_click_interactions = args[:maximum_click_interactions] if args.key?(:maximum_click_interactions)
  @maximum_impression_interactions = args[:maximum_impression_interactions] if args.key?(:maximum_impression_interactions)
  @maximum_interaction_gap = args[:maximum_interaction_gap] if args.key?(:maximum_interaction_gap)
  @pivot_on_interaction_path = args[:pivot_on_interaction_path] if args.key?(:pivot_on_interaction_path)
end