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.



3809
3810
3811
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 3809

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) 


3795
3796
3797
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 3795

def batch_size
  @batch_size
end

#query ⇒ String

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

Returns:

  • (String) 


3800
3801
3802
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 3800

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) 


3807
3808
3809
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 3807

def summary_row_setting
  @summary_row_setting
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3814
3815
3816
3817
3818
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 3814

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