Class: Google::Shopping::Merchant::Reports::V1beta::SearchRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/shopping/merchant/reports/v1beta/reports.rb

Overview

Request message for the ReportService.Search method.

Instance Attribute Summary collapse

Instance Attribute Details

#page_size ⇒ ::Integer

Returns Optional. Number of ReportRows to retrieve in a single page. Defaults to

  1. Values above 5000 are coerced to 5000.

Returns:

  • (::Integer) —

    Optional. Number of ReportRows to retrieve in a single page. Defaults to

    1. Values above 5000 are coerced to 5000.


47
48
49
50
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 47

class SearchRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::String

Returns Optional. 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.

Returns:

  • (::String) —

    Optional. 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.



47
48
49
50
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 47

class SearchRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

Returns Required. Id of the account making the call. Must be a standalone account or an MCA subaccount. Format: accounts/{account}.

Returns:

  • (::String) —

    Required. Id of the account making the call. Must be a standalone account or an MCA subaccount. Format: accounts/{account}



47
48
49
50
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 47

class SearchRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#query ⇒ ::String

Returns Required. Query that defines a report to be retrieved.

For details on how to construct your query, see the Query Language guide. For the full list of available tables and fields, see the Available fields.

Returns:

  • (::String) —

    Required. Query that defines a report to be retrieved.

    For details on how to construct your query, see the Query Language guide. For the full list of available tables and fields, see the Available fields.



47
48
49
50
 
# File 'proto_docs/google/shopping/merchant/reports/v1beta/reports.rb', line 47

class SearchRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end