Class: Google::Apis::ContentV2_1::SearchRequest

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

Overview

Request message for the ReportService.Search method.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ SearchRequest

Returns a new instance of SearchRequest.



12658
12659
12660
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 12658

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

Instance Attribute Details

#page_size ⇒ Fixnum

Number of ReportRows to retrieve in a single page. Defaults to the maximum of

  1. Values above 1000 are coerced to 1000. Corresponds to the JSON property pageSize

Returns:

  • (Fixnum) 


12643
12644
12645
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 12643

def page_size
  @page_size
end

#page_token ⇒ String

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

Returns:

  • (String) 


12650
12651
12652
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 12650

def page_token
  @page_token
end

#query ⇒ String

Required. Search query that defines performance metrics to retrieve and dimensions according to which the metrics are to be segmented. Corresponds to the JSON property query

Returns:

  • (String) 


12656
12657
12658
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 12656

def query
  @query
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



12663
12664
12665
12666
12667
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 12663

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)
end