Class: Google::Apis::Searchads360V0::GoogleAdsSearchads360V0ServicesSearchSearchAds360Request

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

Overview

Request message for SearchAds360Service.Search.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAdsSearchads360V0ServicesSearchSearchAds360Request

Returns a new instance of GoogleAdsSearchads360V0ServicesSearchSearchAds360Request.



3720
3721
3722
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 3720

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

Instance Attribute Details

#page_size ⇒ Fixnum

Number of elements to retrieve in a single page. When too large a page is requested, the server may decide to further limit the number of returned resources. Corresponds to the JSON property pageSize

Returns:

  • (Fixnum) 


3686
3687
3688
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 3686

def page_size
  @page_size
end

#page_token ⇒ String

Token of the page to retrieve. If not specified, the first page of results will be returned. Use the value obtained from next_page_token in the previous response in order to request the next page of results. Corresponds to the JSON property pageToken

Returns:

  • (String) 


3693
3694
3695
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 3693

def page_token
  @page_token
end

#query ⇒ String

Required. The query string. Corresponds to the JSON property query

Returns:

  • (String) 


3698
3699
3700
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 3698

def query
  @query
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) 


3704
3705
3706
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 3704

def return_total_results_count
  @return_total_results_count
end

#summary_row_setting ⇒ String

Determines whether a summary row will be returned. By default, summary row is not returned. If requested, the summary row will be sent in a response by itself after all other query results are returned. Corresponds to the JSON property summaryRowSetting

Returns:

  • (String) 


3712
3713
3714
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 3712

def summary_row_setting
  @summary_row_setting
end

#validate_only ⇒ Boolean Also known as: validate_only?

If true, the request is validated but not executed. Corresponds to the JSON property validateOnly

Returns:

  • (Boolean) 


3717
3718
3719
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 3717

def validate_only
  @validate_only
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3725
3726
3727
3728
3729
3730
3731
3732
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 3725

def update!(**args)
  @page_size = args[:page_size] if args.key?(:page_size)
  @page_token = args[:page_token] if args.key?(:page_token)
  @query = args[:query] if args.key?(:query)
  @return_total_results_count = args[:return_total_results_count] if args.key?(:return_total_results_count)
  @summary_row_setting = args[:summary_row_setting] if args.key?(:summary_row_setting)
  @validate_only = args[:validate_only] if args.key?(:validate_only)
end