Class: Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesForecast

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

Overview

Forecasted traffic metrics for the planned products and targeting.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAdsSearchads360V23ServicesForecast

Returns a new instance of GoogleAdsSearchads360V23ServicesForecast.



40242
40243
40244
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 40242

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

Instance Attribute Details

#conversions ⇒ Float

The number of conversions. This metric is only available for DEMAND_GEN plannable products. See https://support.google.com/google-ads/answer/2375431 for more information on conversions. Corresponds to the JSON property conversions

Returns:

  • (Float) 


40160
40161
40162
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 40160

def conversions
  @conversions
end

#effective_frequency_breakdowns ⇒ Array<Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesEffectiveFrequencyBreakdown>

A list of effective frequency forecasts. The list is ordered starting with 1+ and ending with the value set in GenerateReachForecastRequest. effective_frequency_limit. If no effective_frequency_limit was set, this list will be empty. Corresponds to the JSON property effectiveFrequencyBreakdowns

Returns:



40168
40169
40170
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 40168

def effective_frequency_breakdowns
  @effective_frequency_breakdowns
end

#on_target_coview_impressions ⇒ Fixnum

Number of ad impressions that exactly matches the Targeting including co- viewers. Corresponds to the JSON property onTargetCoviewImpressions

Returns:

  • (Fixnum) 


40174
40175
40176
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 40174

def on_target_coview_impressions
  @on_target_coview_impressions
end

#on_target_coview_reach ⇒ Fixnum

Number of unique people reached that exactly matches the Targeting including co-viewers. Corresponds to the JSON property onTargetCoviewReach

Returns:

  • (Fixnum) 


40180
40181
40182
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 40180

def on_target_coview_reach
  @on_target_coview_reach
end

#on_target_impressions ⇒ Fixnum

Number of ad impressions that exactly matches the Targeting. Corresponds to the JSON property onTargetImpressions

Returns:

  • (Fixnum) 


40185
40186
40187
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 40185

def on_target_impressions
  @on_target_impressions
end

#on_target_reach ⇒ Fixnum

Number of unique people reached at least GenerateReachForecastRequest. min_effective_frequency or GenerateReachForecastRequest. effective_frequency_limit times that exactly matches the Targeting. Note that a minimum number of unique people must be reached in order for data to be reported. If the minimum number is not met, the on_target_reach value will be rounded to 0. Corresponds to the JSON property onTargetReach

Returns:

  • (Fixnum) 


40195
40196
40197
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 40195

def on_target_reach
  @on_target_reach
end

#total_coview_impressions ⇒ Fixnum

Total number of ad impressions including co-viewers. This includes impressions that may fall outside the specified Targeting, due to insufficient information on signed-in users. Corresponds to the JSON property totalCoviewImpressions

Returns:

  • (Fixnum) 


40202
40203
40204
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 40202

def total_coview_impressions
  @total_coview_impressions
end

#total_coview_reach ⇒ Fixnum

Number of unique people reached including co-viewers. This includes people that may fall outside the specified Targeting. Corresponds to the JSON property totalCoviewReach

Returns:

  • (Fixnum) 


40208
40209
40210
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 40208

def total_coview_reach
  @total_coview_reach
end

#total_impressions ⇒ Fixnum

Total number of ad impressions. This includes impressions that may fall outside the specified Targeting, due to insufficient information on signed-in users. Corresponds to the JSON property totalImpressions

Returns:

  • (Fixnum) 


40215
40216
40217
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 40215

def total_impressions
  @total_impressions
end

#total_reach ⇒ Fixnum

Total number of unique people reached at least GenerateReachForecastRequest. min_effective_frequency or GenerateReachForecastRequest. effective_frequency_limit times. This includes people that may fall outside the specified Targeting. Note that a minimum number of unique people must be reached in order for data to be reported. If the minimum number is not met, the total_reach value will be rounded to 0. Corresponds to the JSON property totalReach

Returns:

  • (Fixnum) 


40225
40226
40227
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 40225

def total_reach
  @total_reach
end

#trueview_views ⇒ Fixnum

Number of ad views forecasted for the specified product and targeting. A TrueView View is counted when a viewer views a larger portion or the entirety of an ad beyond an impression. See https://support.google.com/google-ads/ answer/2375431 for more information on TrueView Views. Corresponds to the JSON property trueviewViews

Returns:

  • (Fixnum) 


40233
40234
40235
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 40233

def trueview_views
  @trueview_views
end

#viewable_impressions ⇒ Fixnum

Number of times the ad's impressions were considered viewable. See https:// support.google.com/google-ads/answer/7029393 for more information about what makes an ad viewable and how viewability is measured. Corresponds to the JSON property viewableImpressions

Returns:

  • (Fixnum) 


40240
40241
40242
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 40240

def viewable_impressions
  @viewable_impressions
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



40247
40248
40249
40250
40251
40252
40253
40254
40255
40256
40257
40258
40259
40260
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 40247

def update!(**args)
  @conversions = args[:conversions] if args.key?(:conversions)
  @effective_frequency_breakdowns = args[:effective_frequency_breakdowns] if args.key?(:effective_frequency_breakdowns)
  @on_target_coview_impressions = args[:on_target_coview_impressions] if args.key?(:on_target_coview_impressions)
  @on_target_coview_reach = args[:on_target_coview_reach] if args.key?(:on_target_coview_reach)
  @on_target_impressions = args[:on_target_impressions] if args.key?(:on_target_impressions)
  @on_target_reach = args[:on_target_reach] if args.key?(:on_target_reach)
  @total_coview_impressions = args[:total_coview_impressions] if args.key?(:total_coview_impressions)
  @total_coview_reach = args[:total_coview_reach] if args.key?(:total_coview_reach)
  @total_impressions = args[:total_impressions] if args.key?(:total_impressions)
  @total_reach = args[:total_reach] if args.key?(:total_reach)
  @trueview_views = args[:trueview_views] if args.key?(:trueview_views)
  @viewable_impressions = args[:viewable_impressions] if args.key?(:viewable_impressions)
end