Class: Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesGenerateBenchmarksMetricsRequest

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

Request message for BenchmarksService.GenerateBenchmarksMetrics.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAdsSearchads360V23ServicesGenerateBenchmarksMetricsRequest

Returns a new instance of GoogleAdsSearchads360V23ServicesGenerateBenchmarksMetricsRequest.



40654
40655
40656
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 40654

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

Instance Attribute Details

#application_info ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonAdditionalApplicationInfo

Additional information about the application/tool issuing the request. This field is only used by ContentCreatorInsightsService, AudienceInsightsService, and ReachPlanService APIs. Corresponds to the JSON property applicationInfo

Returns:



40620
40621
40622
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 40620

def application_info
  @application_info
end

#benchmarks_source ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesBenchmarksSource

The source used to generate benchmarks metrics for. The ID of the source can be obtained from BenchmarksService.ListBenchmarksSources. Corresponds to the JSON property benchmarksSource

Returns:



40626
40627
40628
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 40626

def benchmarks_source
  @benchmarks_source
end

#currency_code ⇒ String

Optional. The three-character ISO 4217 currency code. If unspecified, the default currency for monetary values is USD. Corresponds to the JSON property currencyCode

Returns:

  • (String) 


40632
40633
40634
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 40632

def currency_code
  @currency_code
end

#customer_benchmarks_group ⇒ String

The name of the customer being planned for. This is a user-defined value. Corresponds to the JSON property customerBenchmarksGroup

Returns:

  • (String) 


40637
40638
40639
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 40637

def customer_benchmarks_group
  @customer_benchmarks_group
end

#date_range ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonDateRange

A date range. Corresponds to the JSON property dateRange

Returns:



40642
40643
40644
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 40642

def date_range
  @date_range
end

#location ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonLocationInfo

A location criterion. Corresponds to the JSON property location

Returns:



40647
40648
40649
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 40647

def location
  @location
end

#product_filter ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesProductFilter

The type and list of products to aggregate benchmarks metrics over. Corresponds to the JSON property productFilter

Returns:



40652
40653
40654
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 40652

def product_filter
  @product_filter
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



40659
40660
40661
40662
40663
40664
40665
40666
40667
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 40659

def update!(**args)
  @application_info = args[:application_info] if args.key?(:application_info)
  @benchmarks_source = args[:benchmarks_source] if args.key?(:benchmarks_source)
  @currency_code = args[:currency_code] if args.key?(:currency_code)
  @customer_benchmarks_group = args[:customer_benchmarks_group] if args.key?(:customer_benchmarks_group)
  @date_range = args[:date_range] if args.key?(:date_range)
  @location = args[:location] if args.key?(:location)
  @product_filter = args[:product_filter] if args.key?(:product_filter)
end