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.



12920
12921
12922
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 12920

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) 


12905
12906
12907
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 12905

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) 


12912
12913
12914
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 12912

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. Corresponds to the JSON property query

Returns:

  • (String) 


12918
12919
12920
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 12918

def query
  @query
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



12925
12926
12927
12928
12929
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 12925

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