Class: Google::Apis::DfareportingV2_1::Report::PathToConversionCriteria::ReportProperties

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable
Defined in:
generated/google/apis/dfareporting_v2_1/classes.rb,
generated/google/apis/dfareporting_v2_1/representations.rb,
generated/google/apis/dfareporting_v2_1/representations.rb

Overview

The properties of the report.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ ReportProperties

Returns a new instance of ReportProperties



9311
9312
9313
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 9311

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) 


9252
9253
9254
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 9252

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) 


9259
9260
9261
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 9259

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) 


9264
9265
9266
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 9264

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) 


9272
9273
9274
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 9272

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) 


9280
9281
9282
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 9280

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) 


9289
9290
9291
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 9289

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) 


9297
9298
9299
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 9297

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) 


9303
9304
9305
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 9303

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) 


9308
9309
9310
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 9308

def pivot_on_interaction_path
  @pivot_on_interaction_path
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 9316

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