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



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

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

Instance Attribute Details

#clicks_lookback_windowFixnum

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)


10284
10285
10286
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 10284

def clicks_lookback_window
  @clicks_lookback_window
end

#impressions_lookback_windowFixnum

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)


10291
10292
10293
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 10291

def impressions_lookback_window
  @impressions_lookback_window
end

#include_attributed_ip_conversionsBoolean Also known as: include_attributed_ip_conversions?

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

Returns:

  • (Boolean)


10296
10297
10298
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 10296

def include_attributed_ip_conversions
  @include_attributed_ip_conversions
end

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)


10304
10305
10306
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 10304

def include_unattributed_cookie_conversions
  @include_unattributed_cookie_conversions
end

#include_unattributed_ip_conversionsBoolean 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)


10312
10313
10314
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 10312

def include_unattributed_ip_conversions
  @include_unattributed_ip_conversions
end

#maximum_click_interactionsFixnum

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)


10321
10322
10323
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 10321

def maximum_click_interactions
  @maximum_click_interactions
end

#maximum_impression_interactionsFixnum

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)


10329
10330
10331
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 10329

def maximum_impression_interactions
  @maximum_impression_interactions
end

#maximum_interaction_gapFixnum

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)


10335
10336
10337
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 10335

def maximum_interaction_gap
  @maximum_interaction_gap
end

#pivot_on_interaction_pathBoolean Also known as: pivot_on_interaction_path?

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

Returns:

  • (Boolean)


10340
10341
10342
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 10340

def pivot_on_interaction_path
  @pivot_on_interaction_path
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



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

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