Class: Google::Apis::DfareportingV4::Report::PathToConversionCriteria::ReportProperties

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dfareporting_v4/classes.rb,
lib/google/apis/dfareporting_v4/representations.rb,
lib/google/apis/dfareporting_v4/representations.rb

Overview

The properties of the report.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ReportProperties

Returns a new instance of ReportProperties.



11220
11221
11222
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 11220

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

Instance Attribute Details

#clicks_lookback_window ⇒ Fixnum

CM360 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) 


11161
11162
11163
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 11161

def clicks_lookback_window
  @clicks_lookback_window
end

#impressions_lookback_window ⇒ Fixnum

CM360 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) 


11168
11169
11170
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 11168

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) 


11173
11174
11175
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 11173

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) 


11181
11182
11183
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 11181

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) 


11189
11190
11191
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 11189

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) 


11198
11199
11200
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 11198

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) 


11206
11207
11208
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 11206

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) 


11212
11213
11214
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 11212

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) 


11217
11218
11219
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 11217

def pivot_on_interaction_path
  @pivot_on_interaction_path
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11225
11226
11227
11228
11229
11230
11231
11232
11233
11234
11235
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 11225

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