Class: Google::Cloud::DiscoveryEngine::V1::SearchInfo

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/discoveryengine/v1/user_event.rb

Overview

Detailed search information.

Instance Attribute Summary collapse

Instance Attribute Details

#offset ⇒ ::Integer

Returns An integer that specifies the current offset for pagination (the 0-indexed starting location, amongst the products deemed by the API as relevant).

See SearchRequest.offset for definition.

If this field is negative, an INVALID_ARGUMENT is returned.

This can only be set for search events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.

Returns:

  • (::Integer) —

    An integer that specifies the current offset for pagination (the 0-indexed starting location, amongst the products deemed by the API as relevant).

    See SearchRequest.offset for definition.

    If this field is negative, an INVALID_ARGUMENT is returned.

    This can only be set for search events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.



324
325
326
327
 
# File 'proto_docs/google/cloud/discoveryengine/v1/user_event.rb', line 324

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

#order_by ⇒ ::String

Returns The order in which products are returned, if applicable.

See SearchRequest.order_by for definition and syntax.

The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

This can only be set for search events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.

Returns:

  • (::String) —

    The order in which products are returned, if applicable.

    See SearchRequest.order_by for definition and syntax.

    The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

    This can only be set for search events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.



324
325
326
327
 
# File 'proto_docs/google/cloud/discoveryengine/v1/user_event.rb', line 324

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

#search_query ⇒ ::String

Returns The user's search query.

See SearchRequest.query for definition.

The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

At least one of search_query or PageInfo.page_category is required for search events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.

Returns:

  • (::String) —

    The user's search query.

    See SearchRequest.query for definition.

    The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

    At least one of search_query or PageInfo.page_category is required for search events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.



324
325
326
327
 
# File 'proto_docs/google/cloud/discoveryengine/v1/user_event.rb', line 324

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