Class: Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesSearchSettings

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

Indicates search settings in request parameter.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAdsSearchads360V23ServicesSearchSettings

Returns a new instance of GoogleAdsSearchads360V23ServicesSearchSettings.



54965
54966
54967
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 54965

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

Instance Attribute Details

#omit_results ⇒ Boolean Also known as: omit_results?

If true, results will be excluded from the response. Otherwise, results will be returned. Default is false. Corresponds to the JSON property omitResults

Returns:

  • (Boolean) 


54948
54949
54950
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 54948

def omit_results
  @omit_results
end

#return_summary_row ⇒ Boolean Also known as: return_summary_row?

If true, summary row will be included in the response and sent in a response by itself after all other query results are returned. Default is false. Corresponds to the JSON property returnSummaryRow

Returns:

  • (Boolean) 


54955
54956
54957
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 54955

def return_summary_row
  @return_summary_row
end

#return_total_results_count ⇒ Boolean Also known as: return_total_results_count?

If true, the total number of results that match the query ignoring the LIMIT clause will be included in the response. Default is false. Corresponds to the JSON property returnTotalResultsCount

Returns:

  • (Boolean) 


54962
54963
54964
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 54962

def return_total_results_count
  @return_total_results_count
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



54970
54971
54972
54973
54974
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 54970

def update!(**args)
  @omit_results = args[:omit_results] if args.key?(:omit_results)
  @return_summary_row = args[:return_summary_row] if args.key?(:return_summary_row)
  @return_total_results_count = args[:return_total_results_count] if args.key?(:return_total_results_count)
end