Class: Google::Apis::Searchads360V0::GoogleAdsSearchads360V0ServicesSearchSearchAds360StreamRequest

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.SearchStream.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAdsSearchads360V0ServicesSearchSearchAds360StreamRequest

Returns a new instance of GoogleAdsSearchads360V0ServicesSearchSearchAds360StreamRequest.



4688
4689
4690
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4688

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

Instance Attribute Details

#batch_size ⇒ Fixnum

The number of rows that are returned in each stream response batch. When too large batch is requested, the server may decide to further limit the number of returned rows. Corresponds to the JSON property batchSize

Returns:

  • (Fixnum) 


4674
4675
4676
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4674

def batch_size
  @batch_size
end

#query ⇒ String

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

Returns:

  • (String) 


4679
4680
4681
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4679

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


4686
4687
4688
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4686

def summary_row_setting
  @summary_row_setting
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4693
4694
4695
4696
4697
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4693

def update!(**args)
  @batch_size = args[:batch_size] if args.key?(:batch_size)
  @query = args[:query] if args.key?(:query)
  @summary_row_setting = args[:summary_row_setting] if args.key?(:summary_row_setting)
end