Retail V2 API - Class Google::Cloud::Retail::V2::SearchRequest (v1.2.0)

Reference documentation and code samples for the Retail V2 API class Google::Cloud::Retail::V2::SearchRequest.

Request message for SearchService.Search method.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#boost_spec

def boost_spec() -> ::Google::Cloud::Retail::V2::SearchRequest::BoostSpec
Returns

#boost_spec=

def boost_spec=(value) -> ::Google::Cloud::Retail::V2::SearchRequest::BoostSpec
Parameter
Returns

#branch

def branch() -> ::String
Returns
  • (::String) — The branch resource name, such as projects/*/locations/global/catalogs/default_catalog/branches/0.

    Use "default_branch" as the branch ID or leave this field empty, to search products under the default branch.

#branch=

def branch=(value) -> ::String
Parameter
  • value (::String) — The branch resource name, such as projects/*/locations/global/catalogs/default_catalog/branches/0.

    Use "default_branch" as the branch ID or leave this field empty, to search products under the default branch.

Returns
  • (::String) — The branch resource name, such as projects/*/locations/global/catalogs/default_catalog/branches/0.

    Use "default_branch" as the branch ID or leave this field empty, to search products under the default branch.

#canonical_filter

def canonical_filter() -> ::String
Returns
  • (::String) — The default filter that is applied when a user performs a search without checking any filters on the search page.

    The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality.

    For more information about filter syntax, see SearchRequest.filter.

#canonical_filter=

def canonical_filter=(value) -> ::String
Parameter
  • value (::String) — The default filter that is applied when a user performs a search without checking any filters on the search page.

    The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality.

    For more information about filter syntax, see SearchRequest.filter.

Returns
  • (::String) — The default filter that is applied when a user performs a search without checking any filters on the search page.

    The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality.

    For more information about filter syntax, see SearchRequest.filter.

#conversational_search_spec

def conversational_search_spec() -> ::Google::Cloud::Retail::V2::SearchRequest::ConversationalSearchSpec
Returns

#conversational_search_spec=

def conversational_search_spec=(value) -> ::Google::Cloud::Retail::V2::SearchRequest::ConversationalSearchSpec
Parameter
Returns

#dynamic_facet_spec

def dynamic_facet_spec() -> ::Google::Cloud::Retail::V2::SearchRequest::DynamicFacetSpec
Returns
  • (::Google::Cloud::Retail::V2::SearchRequest::DynamicFacetSpec) — Deprecated. Refer to https://cloud.google.com/retail/docs/configs#dynamic to enable dynamic facets. Do not set this field.

    The specification for dynamically generated facets. Notice that only textual facets can be dynamically generated.

#dynamic_facet_spec=

def dynamic_facet_spec=(value) -> ::Google::Cloud::Retail::V2::SearchRequest::DynamicFacetSpec
Parameter
  • value (::Google::Cloud::Retail::V2::SearchRequest::DynamicFacetSpec) — Deprecated. Refer to https://cloud.google.com/retail/docs/configs#dynamic to enable dynamic facets. Do not set this field.

    The specification for dynamically generated facets. Notice that only textual facets can be dynamically generated.

Returns
  • (::Google::Cloud::Retail::V2::SearchRequest::DynamicFacetSpec) — Deprecated. Refer to https://cloud.google.com/retail/docs/configs#dynamic to enable dynamic facets. Do not set this field.

    The specification for dynamically generated facets. Notice that only textual facets can be dynamically generated.

#entity

def entity() -> ::String
Returns
  • (::String) — The entity for customers that may run multiple different entities, domains, sites or regions, for example, Google US, Google Ads, Waymo, google.com, youtube.com, etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity.

#entity=

def entity=(value) -> ::String
Parameter
  • value (::String) — The entity for customers that may run multiple different entities, domains, sites or regions, for example, Google US, Google Ads, Waymo, google.com, youtube.com, etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity.
Returns
  • (::String) — The entity for customers that may run multiple different entities, domains, sites or regions, for example, Google US, Google Ads, Waymo, google.com, youtube.com, etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity.

#facet_specs

def facet_specs() -> ::Array<::Google::Cloud::Retail::V2::SearchRequest::FacetSpec>
Returns

#facet_specs=

def facet_specs=(value) -> ::Array<::Google::Cloud::Retail::V2::SearchRequest::FacetSpec>
Parameter
Returns

#filter

def filter() -> ::String
Returns
  • (::String) — The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products being filtered. Filter expression is case-sensitive. For more information, see Filter.

    If this field is unrecognizable, an INVALID_ARGUMENT is returned.

#filter=

def filter=(value) -> ::String
Parameter
  • value (::String) — The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products being filtered. Filter expression is case-sensitive. For more information, see Filter.

    If this field is unrecognizable, an INVALID_ARGUMENT is returned.

Returns
  • (::String) — The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products being filtered. Filter expression is case-sensitive. For more information, see Filter.

    If this field is unrecognizable, an INVALID_ARGUMENT is returned.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — The labels applied to a resource must meet the following requirements:

    • Each resource can have multiple labels, up to a maximum of 64.
    • Each label must be a key-value pair.
    • Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
    • Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
    • The key portion of a label must be unique. However, you can use the same key with multiple resources.
    • Keys must start with a lowercase letter or international character.

    For more information, see Requirements for labels in the Resource Manager documentation.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — The labels applied to a resource must meet the following requirements:

    • Each resource can have multiple labels, up to a maximum of 64.
    • Each label must be a key-value pair.
    • Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
    • Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
    • The key portion of a label must be unique. However, you can use the same key with multiple resources.
    • Keys must start with a lowercase letter or international character.

    For more information, see Requirements for labels in the Resource Manager documentation.

Returns
  • (::Google::Protobuf::Map{::String => ::String}) — The labels applied to a resource must meet the following requirements:

    • Each resource can have multiple labels, up to a maximum of 64.
    • Each label must be a key-value pair.
    • Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
    • Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
    • The key portion of a label must be unique. However, you can use the same key with multiple resources.
    • Keys must start with a lowercase letter or international character.

    For more information, see Requirements for labels in the Resource Manager documentation.

#offset

def offset() -> ::Integer
Returns
  • (::Integer) — A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Products deemed by the API as relevant) in search results. This field is only considered if page_token is unset.

    If this field is negative, an INVALID_ARGUMENT is returned.

#offset=

def offset=(value) -> ::Integer
Parameter
  • value (::Integer) — A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Products deemed by the API as relevant) in search results. This field is only considered if page_token is unset.

    If this field is negative, an INVALID_ARGUMENT is returned.

Returns
  • (::Integer) — A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Products deemed by the API as relevant) in search results. This field is only considered if page_token is unset.

    If this field is negative, an INVALID_ARGUMENT is returned.

#order_by

def order_by() -> ::String
Returns
  • (::String) — The order in which products are returned. Products can be ordered by a field in an Product object. Leave it unset if ordered by relevance. OrderBy expression is case-sensitive. For more information, see Order.

    If this field is unrecognizable, an INVALID_ARGUMENT is returned.

#order_by=

def order_by=(value) -> ::String
Parameter
  • value (::String) — The order in which products are returned. Products can be ordered by a field in an Product object. Leave it unset if ordered by relevance. OrderBy expression is case-sensitive. For more information, see Order.

    If this field is unrecognizable, an INVALID_ARGUMENT is returned.

Returns
  • (::String) — The order in which products are returned. Products can be ordered by a field in an Product object. Leave it unset if ordered by relevance. OrderBy expression is case-sensitive. For more information, see Order.

    If this field is unrecognizable, an INVALID_ARGUMENT is returned.

#page_categories

def page_categories() -> ::Array<::String>
Returns
  • (::Array<::String>) — The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.page_categories;

    To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s).

    Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: "pageCategories" : ["Sales > 2017 Black Friday Deals"].

#page_categories=

def page_categories=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.page_categories;

    To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s).

    Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: "pageCategories" : ["Sales > 2017 Black Friday Deals"].

Returns
  • (::Array<::String>) — The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.page_categories;

    To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s).

    Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: "pageCategories" : ["Sales > 2017 Black Friday Deals"].

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — Maximum number of Products to return. If unspecified, defaults to a reasonable value. The maximum allowed value is

    1. Values above 120 will be coerced to 120.

    If this field is negative, an INVALID_ARGUMENT is returned.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — Maximum number of Products to return. If unspecified, defaults to a reasonable value. The maximum allowed value is

    1. Values above 120 will be coerced to 120.

    If this field is negative, an INVALID_ARGUMENT is returned.

Returns
  • (::Integer) — Maximum number of Products to return. If unspecified, defaults to a reasonable value. The maximum allowed value is

    1. Values above 120 will be coerced to 120.

    If this field is negative, an INVALID_ARGUMENT is returned.

#page_token

def page_token() -> ::String
Returns

#page_token=

def page_token=(value) -> ::String
Parameter
Returns

#personalization_spec

def personalization_spec() -> ::Google::Cloud::Retail::V2::SearchRequest::PersonalizationSpec
Returns

#personalization_spec=

def personalization_spec=(value) -> ::Google::Cloud::Retail::V2::SearchRequest::PersonalizationSpec
Parameter
Returns

#placement

def placement() -> ::String
Returns
  • (::String) — Required. The resource name of the Retail Search serving config, such as projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config or the name of the legacy placement resource, such as projects/*/locations/global/catalogs/default_catalog/placements/default_search. This field is used to identify the serving config name and the set of models that are used to make the search.

#placement=

def placement=(value) -> ::String
Parameter
  • value (::String) — Required. The resource name of the Retail Search serving config, such as projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config or the name of the legacy placement resource, such as projects/*/locations/global/catalogs/default_catalog/placements/default_search. This field is used to identify the serving config name and the set of models that are used to make the search.
Returns
  • (::String) — Required. The resource name of the Retail Search serving config, such as projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config or the name of the legacy placement resource, such as projects/*/locations/global/catalogs/default_catalog/placements/default_search. This field is used to identify the serving config name and the set of models that are used to make the search.

#query

def query() -> ::String
Returns
  • (::String) — Raw search query.

    If this field is empty, the request is considered a category browsing request and returned results are based on filter and page_categories.

#query=

def query=(value) -> ::String
Parameter
  • value (::String) — Raw search query.

    If this field is empty, the request is considered a category browsing request and returned results are based on filter and page_categories.

Returns
  • (::String) — Raw search query.

    If this field is empty, the request is considered a category browsing request and returned results are based on filter and page_categories.

#query_expansion_spec

def query_expansion_spec() -> ::Google::Cloud::Retail::V2::SearchRequest::QueryExpansionSpec
Returns

#query_expansion_spec=

def query_expansion_spec=(value) -> ::Google::Cloud::Retail::V2::SearchRequest::QueryExpansionSpec
Parameter
Returns

#search_mode

def search_mode() -> ::Google::Cloud::Retail::V2::SearchRequest::SearchMode
Returns

#search_mode=

def search_mode=(value) -> ::Google::Cloud::Retail::V2::SearchRequest::SearchMode
Parameter
Returns

#spell_correction_spec

def spell_correction_spec() -> ::Google::Cloud::Retail::V2::SearchRequest::SpellCorrectionSpec
Returns

#spell_correction_spec=

def spell_correction_spec=(value) -> ::Google::Cloud::Retail::V2::SearchRequest::SpellCorrectionSpec
Parameter
Returns

#tile_navigation_spec

def tile_navigation_spec() -> ::Google::Cloud::Retail::V2::SearchRequest::TileNavigationSpec
Returns

#tile_navigation_spec=

def tile_navigation_spec=(value) -> ::Google::Cloud::Retail::V2::SearchRequest::TileNavigationSpec
Parameter
Returns

#user_info

def user_info() -> ::Google::Cloud::Retail::V2::UserInfo
Returns

#user_info=

def user_info=(value) -> ::Google::Cloud::Retail::V2::UserInfo
Parameter
Returns

#variant_rollup_keys

def variant_rollup_keys() -> ::Array<::String>
Returns

#variant_rollup_keys=

def variant_rollup_keys=(value) -> ::Array<::String>
Parameter
Returns

#visitor_id

def visitor_id() -> ::String
Returns
  • (::String) — Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website.

    This should be the same identifier as UserEvent.visitor_id.

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

#visitor_id=

def visitor_id=(value) -> ::String
Parameter
  • value (::String) — Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website.

    This should be the same identifier as UserEvent.visitor_id.

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

Returns
  • (::String) — Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website.

    This should be the same identifier as UserEvent.visitor_id.

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