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.



12710
12711
12712
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 12710

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

Instance Attribute Details

#page_size ⇒ Fixnum

Number of ReportRows to retrieve in a single page. Defaults to 1000. Values above 5000 are coerced to 5000. Corresponds to the JSON property pageSize

Returns:

  • (Fixnum) 


12693
12694
12695
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 12693

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) 


12700
12701
12702
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 12700

def page_token
  @page_token
end

#query ⇒ String

Required. Query that defines performance metrics to retrieve and dimensions according to which the metrics are to be segmented. For details on how to construct your query, see the Query Language guide. Corresponds to the JSON property query

Returns:

  • (String) 


12708
12709
12710
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 12708

def query
  @query
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



12715
12716
12717
12718
12719
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 12715

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