Class: Google::Apis::DfareportingV3_1::Report::PathToConversionCriteria::ReportProperties

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dfareporting_v3_1/classes.rb,
generated/google/apis/dfareporting_v3_1/representations.rb,
generated/google/apis/dfareporting_v3_1/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



10345
10346
10347
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 10345

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) 


10286
10287
10288
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 10286

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) 


10293
10294
10295
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 10293

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) 


10298
10299
10300
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 10298

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) 


10306
10307
10308
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 10306

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) 


10314
10315
10316
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 10314

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) 


10323
10324
10325
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 10323

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) 


10331
10332
10333
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 10331

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) 


10337
10338
10339
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 10337

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) 


10342
10343
10344
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 10342

def pivot_on_interaction_path
  @pivot_on_interaction_path
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 10350

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