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.



13930
13931
13932
# File 'lib/google/apis/content_v2_1/classes.rb', line 13930

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

Instance Attribute Details

#page_sizeFixnum

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)


13913
13914
13915
# File 'lib/google/apis/content_v2_1/classes.rb', line 13913

def page_size
  @page_size
end

#page_tokenString

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)


13920
13921
13922
# File 'lib/google/apis/content_v2_1/classes.rb', line 13920

def page_token
  @page_token
end

#queryString

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)


13928
13929
13930
# File 'lib/google/apis/content_v2_1/classes.rb', line 13928

def query
  @query
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



13935
13936
13937
13938
13939
# File 'lib/google/apis/content_v2_1/classes.rb', line 13935

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