public interface SearchRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder
| Modifier and Type | Method and Description |
|---|---|
boolean |
containsLabels(String key)
The labels applied to a resource must meet the following requirements:
* Each resource can have multiple labels, up to a maximum of 64.
|
SearchRequest.BoostSpec |
getBoostSpec()
Boost specification to boost certain products.
|
SearchRequest.BoostSpecOrBuilder |
getBoostSpecOrBuilder()
Boost specification to boost certain products.
|
String |
getBranch()
The branch resource name, such as
`projects/*/locations/global/catalogs/default_catalog/branches/0`.
|
com.google.protobuf.ByteString |
getBranchBytes()
The branch resource name, such as
`projects/*/locations/global/catalogs/default_catalog/branches/0`.
|
String |
getCanonicalFilter()
The default filter that is applied when a user performs a search without
checking any filters on the search page.
|
com.google.protobuf.ByteString |
getCanonicalFilterBytes()
The default filter that is applied when a user performs a search without
checking any filters on the search page.
|
SearchRequest.DynamicFacetSpec |
getDynamicFacetSpec()
Deprecated.
google.cloud.retail.v2beta.SearchRequest.dynamic_facet_spec is deprecated. See
google/cloud/retail/v2beta/search_service.proto;l=599
|
SearchRequest.DynamicFacetSpecOrBuilder |
getDynamicFacetSpecOrBuilder()
Deprecated.
|
String |
getEntity()
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.
|
com.google.protobuf.ByteString |
getEntityBytes()
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.
|
SearchRequest.FacetSpec |
getFacetSpecs(int index)
Facet specifications for faceted search.
|
int |
getFacetSpecsCount()
Facet specifications for faceted search.
|
List<SearchRequest.FacetSpec> |
getFacetSpecsList()
Facet specifications for faceted search.
|
SearchRequest.FacetSpecOrBuilder |
getFacetSpecsOrBuilder(int index)
Facet specifications for faceted search.
|
List<? extends SearchRequest.FacetSpecOrBuilder> |
getFacetSpecsOrBuilderList()
Facet specifications for faceted search.
|
String |
getFilter()
The filter syntax consists of an expression language for constructing a
predicate from one or more fields of the products being filtered.
|
com.google.protobuf.ByteString |
getFilterBytes()
The filter syntax consists of an expression language for constructing a
predicate from one or more fields of the products being filtered.
|
Map<String,String> |
getLabels()
Deprecated.
|
int |
getLabelsCount()
The labels applied to a resource must meet the following requirements:
* Each resource can have multiple labels, up to a maximum of 64.
|
Map<String,String> |
getLabelsMap()
The labels applied to a resource must meet the following requirements:
* Each resource can have multiple labels, up to a maximum of 64.
|
String |
getLabelsOrDefault(String key,
String defaultValue)
The labels applied to a resource must meet the following requirements:
* Each resource can have multiple labels, up to a maximum of 64.
|
String |
getLabelsOrThrow(String key)
The labels applied to a resource must meet the following requirements:
* Each resource can have multiple labels, up to a maximum of 64.
|
int |
getOffset()
A 0-indexed integer that specifies the current offset (that is, starting
result location, amongst the [Product][google.cloud.retail.v2beta.Product]s
deemed by the API as relevant) in search results.
|
String |
getOrderBy()
The order in which products are returned.
|
com.google.protobuf.ByteString |
getOrderByBytes()
The order in which products are returned.
|
String |
getPageCategories(int index)
The categories associated with a category page.
|
com.google.protobuf.ByteString |
getPageCategoriesBytes(int index)
The categories associated with a category page.
|
int |
getPageCategoriesCount()
The categories associated with a category page.
|
List<String> |
getPageCategoriesList()
The categories associated with a category page.
|
int |
getPageSize()
Maximum number of [Product][google.cloud.retail.v2beta.Product]s to return.
|
String |
getPageToken()
A page token
[SearchResponse.next_page_token][google.cloud.retail.v2beta.SearchResponse.next_page_token],
received from a previous
[SearchService.Search][google.cloud.retail.v2beta.SearchService.Search]
call.
|
com.google.protobuf.ByteString |
getPageTokenBytes()
A page token
[SearchResponse.next_page_token][google.cloud.retail.v2beta.SearchResponse.next_page_token],
received from a previous
[SearchService.Search][google.cloud.retail.v2beta.SearchService.Search]
call.
|
SearchRequest.PersonalizationSpec |
getPersonalizationSpec()
The specification for personalization.
|
SearchRequest.PersonalizationSpecOrBuilder |
getPersonalizationSpecOrBuilder()
The specification for personalization.
|
String |
getPlacement()
Required.
|
com.google.protobuf.ByteString |
getPlacementBytes()
Required.
|
String |
getQuery()
Raw search query.
|
com.google.protobuf.ByteString |
getQueryBytes()
Raw search query.
|
SearchRequest.QueryExpansionSpec |
getQueryExpansionSpec()
The query expansion specification that specifies the conditions under which
query expansion will occur.
|
SearchRequest.QueryExpansionSpecOrBuilder |
getQueryExpansionSpecOrBuilder()
The query expansion specification that specifies the conditions under which
query expansion will occur.
|
SearchRequest.SearchMode |
getSearchMode()
The search mode of the search request.
|
int |
getSearchModeValue()
The search mode of the search request.
|
SearchRequest.SpellCorrectionSpec |
getSpellCorrectionSpec()
The spell correction specification that specifies the mode under
which spell correction will take effect.
|
SearchRequest.SpellCorrectionSpecOrBuilder |
getSpellCorrectionSpecOrBuilder()
The spell correction specification that specifies the mode under
which spell correction will take effect.
|
UserInfo |
getUserInfo()
User information.
|
UserInfoOrBuilder |
getUserInfoOrBuilder()
User information.
|
String |
getVariantRollupKeys(int index)
The keys to fetch and rollup the matching
[variant][google.cloud.retail.v2beta.Product.Type.VARIANT]
[Product][google.cloud.retail.v2beta.Product]s attributes,
[FulfillmentInfo][google.cloud.retail.v2beta.FulfillmentInfo] or
[LocalInventory][google.cloud.retail.v2beta.LocalInventory]s attributes.
|
com.google.protobuf.ByteString |
getVariantRollupKeysBytes(int index)
The keys to fetch and rollup the matching
[variant][google.cloud.retail.v2beta.Product.Type.VARIANT]
[Product][google.cloud.retail.v2beta.Product]s attributes,
[FulfillmentInfo][google.cloud.retail.v2beta.FulfillmentInfo] or
[LocalInventory][google.cloud.retail.v2beta.LocalInventory]s attributes.
|
int |
getVariantRollupKeysCount()
The keys to fetch and rollup the matching
[variant][google.cloud.retail.v2beta.Product.Type.VARIANT]
[Product][google.cloud.retail.v2beta.Product]s attributes,
[FulfillmentInfo][google.cloud.retail.v2beta.FulfillmentInfo] or
[LocalInventory][google.cloud.retail.v2beta.LocalInventory]s attributes.
|
List<String> |
getVariantRollupKeysList()
The keys to fetch and rollup the matching
[variant][google.cloud.retail.v2beta.Product.Type.VARIANT]
[Product][google.cloud.retail.v2beta.Product]s attributes,
[FulfillmentInfo][google.cloud.retail.v2beta.FulfillmentInfo] or
[LocalInventory][google.cloud.retail.v2beta.LocalInventory]s attributes.
|
String |
getVisitorId()
Required.
|
com.google.protobuf.ByteString |
getVisitorIdBytes()
Required.
|
boolean |
hasBoostSpec()
Boost specification to boost certain products.
|
boolean |
hasDynamicFacetSpec()
Deprecated.
google.cloud.retail.v2beta.SearchRequest.dynamic_facet_spec is deprecated. See
google/cloud/retail/v2beta/search_service.proto;l=599
|
boolean |
hasPersonalizationSpec()
The specification for personalization.
|
boolean |
hasQueryExpansionSpec()
The query expansion specification that specifies the conditions under which
query expansion will occur.
|
boolean |
hasSpellCorrectionSpec()
The spell correction specification that specifies the mode under
which spell correction will take effect.
|
boolean |
hasUserInfo()
User information.
|
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofString getPlacement()
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 will be used to make the search.
string placement = 1 [(.google.api.field_behavior) = REQUIRED];com.google.protobuf.ByteString getPlacementBytes()
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 will be used to make the search.
string placement = 1 [(.google.api.field_behavior) = REQUIRED];String getBranch()
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.
string branch = 2 [(.google.api.resource_reference) = { ... }com.google.protobuf.ByteString getBranchBytes()
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.
string branch = 2 [(.google.api.resource_reference) = { ... }String getQuery()
Raw search query. If this field is empty, the request is considered a category browsing request and returned results are based on [filter][google.cloud.retail.v2beta.SearchRequest.filter] and [page_categories][google.cloud.retail.v2beta.SearchRequest.page_categories].
string query = 3;com.google.protobuf.ByteString getQueryBytes()
Raw search query. If this field is empty, the request is considered a category browsing request and returned results are based on [filter][google.cloud.retail.v2beta.SearchRequest.filter] and [page_categories][google.cloud.retail.v2beta.SearchRequest.page_categories].
string query = 3;String getVisitorId()
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][google.cloud.retail.v2beta.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.
string visitor_id = 4 [(.google.api.field_behavior) = REQUIRED];com.google.protobuf.ByteString getVisitorIdBytes()
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][google.cloud.retail.v2beta.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.
string visitor_id = 4 [(.google.api.field_behavior) = REQUIRED];boolean hasUserInfo()
User information.
.google.cloud.retail.v2beta.UserInfo user_info = 5;UserInfo getUserInfo()
User information.
.google.cloud.retail.v2beta.UserInfo user_info = 5;UserInfoOrBuilder getUserInfoOrBuilder()
User information.
.google.cloud.retail.v2beta.UserInfo user_info = 5;int getPageSize()
Maximum number of [Product][google.cloud.retail.v2beta.Product]s to return. If unspecified, defaults to a reasonable value. The maximum allowed value is 120. Values above 120 will be coerced to 120. If this field is negative, an INVALID_ARGUMENT is returned.
int32 page_size = 7;String getPageToken()
A page token [SearchResponse.next_page_token][google.cloud.retail.v2beta.SearchResponse.next_page_token], received from a previous [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search] call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search] must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
string page_token = 8;com.google.protobuf.ByteString getPageTokenBytes()
A page token [SearchResponse.next_page_token][google.cloud.retail.v2beta.SearchResponse.next_page_token], received from a previous [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search] call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search] must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
string page_token = 8;int getOffset()
A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the [Product][google.cloud.retail.v2beta.Product]s deemed by the API as relevant) in search results. This field is only considered if [page_token][google.cloud.retail.v2beta.SearchRequest.page_token] is unset. If this field is negative, an INVALID_ARGUMENT is returned.
int32 offset = 9;String getFilter()
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. See more details at this [user guide](https://cloud.google.com/retail/docs/filter-and-order#filter). If this field is unrecognizable, an INVALID_ARGUMENT is returned.
string filter = 10;com.google.protobuf.ByteString getFilterBytes()
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. See more details at this [user guide](https://cloud.google.com/retail/docs/filter-and-order#filter). If this field is unrecognizable, an INVALID_ARGUMENT is returned.
string filter = 10;String getCanonicalFilter()
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. For example, if a query does not have enough results, an expanded query with [SearchRequest.canonical_filter][google.cloud.retail.v2beta.SearchRequest.canonical_filter] will be returned as a supplement of the original query. This field is strongly recommended to achieve high search quality. See [SearchRequest.filter][google.cloud.retail.v2beta.SearchRequest.filter] for more details about filter syntax.
string canonical_filter = 28;com.google.protobuf.ByteString getCanonicalFilterBytes()
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. For example, if a query does not have enough results, an expanded query with [SearchRequest.canonical_filter][google.cloud.retail.v2beta.SearchRequest.canonical_filter] will be returned as a supplement of the original query. This field is strongly recommended to achieve high search quality. See [SearchRequest.filter][google.cloud.retail.v2beta.SearchRequest.filter] for more details about filter syntax.
string canonical_filter = 28;String getOrderBy()
The order in which products are returned. Products can be ordered by a field in an [Product][google.cloud.retail.v2beta.Product] object. Leave it unset if ordered by relevance. OrderBy expression is case-sensitive. See more details at this [user guide](https://cloud.google.com/retail/docs/filter-and-order#order). If this field is unrecognizable, an INVALID_ARGUMENT is returned.
string order_by = 11;com.google.protobuf.ByteString getOrderByBytes()
The order in which products are returned. Products can be ordered by a field in an [Product][google.cloud.retail.v2beta.Product] object. Leave it unset if ordered by relevance. OrderBy expression is case-sensitive. See more details at this [user guide](https://cloud.google.com/retail/docs/filter-and-order#order). If this field is unrecognizable, an INVALID_ARGUMENT is returned.
string order_by = 11;List<SearchRequest.FacetSpec> getFacetSpecsList()
Facet specifications for faceted search. If empty, no facets are returned. A maximum of 200 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
repeated .google.cloud.retail.v2beta.SearchRequest.FacetSpec facet_specs = 12;SearchRequest.FacetSpec getFacetSpecs(int index)
Facet specifications for faceted search. If empty, no facets are returned. A maximum of 200 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
repeated .google.cloud.retail.v2beta.SearchRequest.FacetSpec facet_specs = 12;int getFacetSpecsCount()
Facet specifications for faceted search. If empty, no facets are returned. A maximum of 200 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
repeated .google.cloud.retail.v2beta.SearchRequest.FacetSpec facet_specs = 12;List<? extends SearchRequest.FacetSpecOrBuilder> getFacetSpecsOrBuilderList()
Facet specifications for faceted search. If empty, no facets are returned. A maximum of 200 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
repeated .google.cloud.retail.v2beta.SearchRequest.FacetSpec facet_specs = 12;SearchRequest.FacetSpecOrBuilder getFacetSpecsOrBuilder(int index)
Facet specifications for faceted search. If empty, no facets are returned. A maximum of 200 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
repeated .google.cloud.retail.v2beta.SearchRequest.FacetSpec facet_specs = 12;@Deprecated boolean hasDynamicFacetSpec()
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.
.google.cloud.retail.v2beta.SearchRequest.DynamicFacetSpec dynamic_facet_spec = 21 [deprecated = true];
@Deprecated SearchRequest.DynamicFacetSpec getDynamicFacetSpec()
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.
.google.cloud.retail.v2beta.SearchRequest.DynamicFacetSpec dynamic_facet_spec = 21 [deprecated = true];
@Deprecated SearchRequest.DynamicFacetSpecOrBuilder getDynamicFacetSpecOrBuilder()
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.
.google.cloud.retail.v2beta.SearchRequest.DynamicFacetSpec dynamic_facet_spec = 21 [deprecated = true];
boolean hasBoostSpec()
Boost specification to boost certain products. See more details at this [user guide](https://cloud.google.com/retail/docs/boosting). Notice that if both [ServingConfig.boost_control_ids][google.cloud.retail.v2beta.ServingConfig.boost_control_ids] and [SearchRequest.boost_spec][google.cloud.retail.v2beta.SearchRequest.boost_spec] are set, the boost conditions from both places are evaluated. If a search request matches multiple boost conditions, the final boost score is equal to the sum of the boost scores from all matched boost conditions.
.google.cloud.retail.v2beta.SearchRequest.BoostSpec boost_spec = 13;SearchRequest.BoostSpec getBoostSpec()
Boost specification to boost certain products. See more details at this [user guide](https://cloud.google.com/retail/docs/boosting). Notice that if both [ServingConfig.boost_control_ids][google.cloud.retail.v2beta.ServingConfig.boost_control_ids] and [SearchRequest.boost_spec][google.cloud.retail.v2beta.SearchRequest.boost_spec] are set, the boost conditions from both places are evaluated. If a search request matches multiple boost conditions, the final boost score is equal to the sum of the boost scores from all matched boost conditions.
.google.cloud.retail.v2beta.SearchRequest.BoostSpec boost_spec = 13;SearchRequest.BoostSpecOrBuilder getBoostSpecOrBuilder()
Boost specification to boost certain products. See more details at this [user guide](https://cloud.google.com/retail/docs/boosting). Notice that if both [ServingConfig.boost_control_ids][google.cloud.retail.v2beta.ServingConfig.boost_control_ids] and [SearchRequest.boost_spec][google.cloud.retail.v2beta.SearchRequest.boost_spec] are set, the boost conditions from both places are evaluated. If a search request matches multiple boost conditions, the final boost score is equal to the sum of the boost scores from all matched boost conditions.
.google.cloud.retail.v2beta.SearchRequest.BoostSpec boost_spec = 13;boolean hasQueryExpansionSpec()
The query expansion specification that specifies the conditions under which query expansion will occur. See more details at this [user guide](https://cloud.google.com/retail/docs/result-size#query_expansion).
.google.cloud.retail.v2beta.SearchRequest.QueryExpansionSpec query_expansion_spec = 14;
SearchRequest.QueryExpansionSpec getQueryExpansionSpec()
The query expansion specification that specifies the conditions under which query expansion will occur. See more details at this [user guide](https://cloud.google.com/retail/docs/result-size#query_expansion).
.google.cloud.retail.v2beta.SearchRequest.QueryExpansionSpec query_expansion_spec = 14;
SearchRequest.QueryExpansionSpecOrBuilder getQueryExpansionSpecOrBuilder()
The query expansion specification that specifies the conditions under which query expansion will occur. See more details at this [user guide](https://cloud.google.com/retail/docs/result-size#query_expansion).
.google.cloud.retail.v2beta.SearchRequest.QueryExpansionSpec query_expansion_spec = 14;
List<String> getVariantRollupKeysList()
The keys to fetch and rollup the matching [variant][google.cloud.retail.v2beta.Product.Type.VARIANT] [Product][google.cloud.retail.v2beta.Product]s attributes, [FulfillmentInfo][google.cloud.retail.v2beta.FulfillmentInfo] or [LocalInventory][google.cloud.retail.v2beta.LocalInventory]s attributes. The attributes from all the matching [variant][google.cloud.retail.v2beta.Product.Type.VARIANT] [Product][google.cloud.retail.v2beta.Product]s or [LocalInventory][google.cloud.retail.v2beta.LocalInventory]s are merged and de-duplicated. Notice that rollup attributes will lead to extra query latency. Maximum number of keys is 30. For [FulfillmentInfo][google.cloud.retail.v2beta.FulfillmentInfo], a fulfillment type and a fulfillment ID must be provided in the format of "fulfillmentType.fulfillmentId". E.g., in "pickupInStore.store123", "pickupInStore" is fulfillment type and "store123" is the store ID. Supported keys are: * colorFamilies * price * originalPrice * discount * variantId * inventory(place_id,price) * inventory(place_id,original_price) * inventory(place_id,attributes.key), where key is any key in the [Product.local_inventories.attributes][google.cloud.retail.v2beta.LocalInventory.attributes] map. * attributes.key, where key is any key in the [Product.attributes][google.cloud.retail.v2beta.Product.attributes] map. * pickupInStore.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] "pickup-in-store". * shipToStore.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] "ship-to-store". * sameDayDelivery.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] "same-day-delivery". * nextDayDelivery.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] "next-day-delivery". * customFulfillment1.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] "custom-type-1". * customFulfillment2.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] "custom-type-2". * customFulfillment3.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] "custom-type-3". * customFulfillment4.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] "custom-type-4". * customFulfillment5.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] "custom-type-5". If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned.
repeated string variant_rollup_keys = 17;int getVariantRollupKeysCount()
The keys to fetch and rollup the matching [variant][google.cloud.retail.v2beta.Product.Type.VARIANT] [Product][google.cloud.retail.v2beta.Product]s attributes, [FulfillmentInfo][google.cloud.retail.v2beta.FulfillmentInfo] or [LocalInventory][google.cloud.retail.v2beta.LocalInventory]s attributes. The attributes from all the matching [variant][google.cloud.retail.v2beta.Product.Type.VARIANT] [Product][google.cloud.retail.v2beta.Product]s or [LocalInventory][google.cloud.retail.v2beta.LocalInventory]s are merged and de-duplicated. Notice that rollup attributes will lead to extra query latency. Maximum number of keys is 30. For [FulfillmentInfo][google.cloud.retail.v2beta.FulfillmentInfo], a fulfillment type and a fulfillment ID must be provided in the format of "fulfillmentType.fulfillmentId". E.g., in "pickupInStore.store123", "pickupInStore" is fulfillment type and "store123" is the store ID. Supported keys are: * colorFamilies * price * originalPrice * discount * variantId * inventory(place_id,price) * inventory(place_id,original_price) * inventory(place_id,attributes.key), where key is any key in the [Product.local_inventories.attributes][google.cloud.retail.v2beta.LocalInventory.attributes] map. * attributes.key, where key is any key in the [Product.attributes][google.cloud.retail.v2beta.Product.attributes] map. * pickupInStore.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] "pickup-in-store". * shipToStore.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] "ship-to-store". * sameDayDelivery.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] "same-day-delivery". * nextDayDelivery.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] "next-day-delivery". * customFulfillment1.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] "custom-type-1". * customFulfillment2.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] "custom-type-2". * customFulfillment3.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] "custom-type-3". * customFulfillment4.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] "custom-type-4". * customFulfillment5.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] "custom-type-5". If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned.
repeated string variant_rollup_keys = 17;String getVariantRollupKeys(int index)
The keys to fetch and rollup the matching [variant][google.cloud.retail.v2beta.Product.Type.VARIANT] [Product][google.cloud.retail.v2beta.Product]s attributes, [FulfillmentInfo][google.cloud.retail.v2beta.FulfillmentInfo] or [LocalInventory][google.cloud.retail.v2beta.LocalInventory]s attributes. The attributes from all the matching [variant][google.cloud.retail.v2beta.Product.Type.VARIANT] [Product][google.cloud.retail.v2beta.Product]s or [LocalInventory][google.cloud.retail.v2beta.LocalInventory]s are merged and de-duplicated. Notice that rollup attributes will lead to extra query latency. Maximum number of keys is 30. For [FulfillmentInfo][google.cloud.retail.v2beta.FulfillmentInfo], a fulfillment type and a fulfillment ID must be provided in the format of "fulfillmentType.fulfillmentId". E.g., in "pickupInStore.store123", "pickupInStore" is fulfillment type and "store123" is the store ID. Supported keys are: * colorFamilies * price * originalPrice * discount * variantId * inventory(place_id,price) * inventory(place_id,original_price) * inventory(place_id,attributes.key), where key is any key in the [Product.local_inventories.attributes][google.cloud.retail.v2beta.LocalInventory.attributes] map. * attributes.key, where key is any key in the [Product.attributes][google.cloud.retail.v2beta.Product.attributes] map. * pickupInStore.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] "pickup-in-store". * shipToStore.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] "ship-to-store". * sameDayDelivery.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] "same-day-delivery". * nextDayDelivery.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] "next-day-delivery". * customFulfillment1.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] "custom-type-1". * customFulfillment2.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] "custom-type-2". * customFulfillment3.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] "custom-type-3". * customFulfillment4.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] "custom-type-4". * customFulfillment5.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] "custom-type-5". If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned.
repeated string variant_rollup_keys = 17;index - The index of the element to return.com.google.protobuf.ByteString getVariantRollupKeysBytes(int index)
The keys to fetch and rollup the matching [variant][google.cloud.retail.v2beta.Product.Type.VARIANT] [Product][google.cloud.retail.v2beta.Product]s attributes, [FulfillmentInfo][google.cloud.retail.v2beta.FulfillmentInfo] or [LocalInventory][google.cloud.retail.v2beta.LocalInventory]s attributes. The attributes from all the matching [variant][google.cloud.retail.v2beta.Product.Type.VARIANT] [Product][google.cloud.retail.v2beta.Product]s or [LocalInventory][google.cloud.retail.v2beta.LocalInventory]s are merged and de-duplicated. Notice that rollup attributes will lead to extra query latency. Maximum number of keys is 30. For [FulfillmentInfo][google.cloud.retail.v2beta.FulfillmentInfo], a fulfillment type and a fulfillment ID must be provided in the format of "fulfillmentType.fulfillmentId". E.g., in "pickupInStore.store123", "pickupInStore" is fulfillment type and "store123" is the store ID. Supported keys are: * colorFamilies * price * originalPrice * discount * variantId * inventory(place_id,price) * inventory(place_id,original_price) * inventory(place_id,attributes.key), where key is any key in the [Product.local_inventories.attributes][google.cloud.retail.v2beta.LocalInventory.attributes] map. * attributes.key, where key is any key in the [Product.attributes][google.cloud.retail.v2beta.Product.attributes] map. * pickupInStore.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] "pickup-in-store". * shipToStore.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] "ship-to-store". * sameDayDelivery.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] "same-day-delivery". * nextDayDelivery.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] "next-day-delivery". * customFulfillment1.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] "custom-type-1". * customFulfillment2.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] "custom-type-2". * customFulfillment3.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] "custom-type-3". * customFulfillment4.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] "custom-type-4". * customFulfillment5.id, where id is any [FulfillmentInfo.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids] for [FulfillmentInfo.type][google.cloud.retail.v2beta.FulfillmentInfo.type] "custom-type-5". If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned.
repeated string variant_rollup_keys = 17;index - The index of the value to return.List<String> getPageCategoriesList()
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][google.cloud.retail.v2beta.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"].
repeated string page_categories = 23;int getPageCategoriesCount()
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][google.cloud.retail.v2beta.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"].
repeated string page_categories = 23;String getPageCategories(int index)
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][google.cloud.retail.v2beta.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"].
repeated string page_categories = 23;index - The index of the element to return.com.google.protobuf.ByteString getPageCategoriesBytes(int index)
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][google.cloud.retail.v2beta.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"].
repeated string page_categories = 23;index - The index of the value to return.int getSearchModeValue()
The search mode of the search request. If not specified, a single search request triggers both product search and faceted search.
.google.cloud.retail.v2beta.SearchRequest.SearchMode search_mode = 31;SearchRequest.SearchMode getSearchMode()
The search mode of the search request. If not specified, a single search request triggers both product search and faceted search.
.google.cloud.retail.v2beta.SearchRequest.SearchMode search_mode = 31;boolean hasPersonalizationSpec()
The specification for personalization. Notice that if both [ServingConfig.personalization_spec][google.cloud.retail.v2beta.ServingConfig.personalization_spec] and [SearchRequest.personalization_spec][google.cloud.retail.v2beta.SearchRequest.personalization_spec] are set. [SearchRequest.personalization_spec][google.cloud.retail.v2beta.SearchRequest.personalization_spec] will override [ServingConfig.personalization_spec][google.cloud.retail.v2beta.ServingConfig.personalization_spec].
.google.cloud.retail.v2beta.SearchRequest.PersonalizationSpec personalization_spec = 32;
SearchRequest.PersonalizationSpec getPersonalizationSpec()
The specification for personalization. Notice that if both [ServingConfig.personalization_spec][google.cloud.retail.v2beta.ServingConfig.personalization_spec] and [SearchRequest.personalization_spec][google.cloud.retail.v2beta.SearchRequest.personalization_spec] are set. [SearchRequest.personalization_spec][google.cloud.retail.v2beta.SearchRequest.personalization_spec] will override [ServingConfig.personalization_spec][google.cloud.retail.v2beta.ServingConfig.personalization_spec].
.google.cloud.retail.v2beta.SearchRequest.PersonalizationSpec personalization_spec = 32;
SearchRequest.PersonalizationSpecOrBuilder getPersonalizationSpecOrBuilder()
The specification for personalization. Notice that if both [ServingConfig.personalization_spec][google.cloud.retail.v2beta.ServingConfig.personalization_spec] and [SearchRequest.personalization_spec][google.cloud.retail.v2beta.SearchRequest.personalization_spec] are set. [SearchRequest.personalization_spec][google.cloud.retail.v2beta.SearchRequest.personalization_spec] will override [ServingConfig.personalization_spec][google.cloud.retail.v2beta.ServingConfig.personalization_spec].
.google.cloud.retail.v2beta.SearchRequest.PersonalizationSpec personalization_spec = 32;
int getLabelsCount()
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. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
map<string, string> labels = 34;boolean containsLabels(String key)
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. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
map<string, string> labels = 34;@Deprecated Map<String,String> getLabels()
getLabelsMap() instead.Map<String,String> getLabelsMap()
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. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
map<string, string> labels = 34;String getLabelsOrDefault(String key, String defaultValue)
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. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
map<string, string> labels = 34;String getLabelsOrThrow(String key)
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. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
map<string, string> labels = 34;boolean hasSpellCorrectionSpec()
The spell correction specification that specifies the mode under which spell correction will take effect.
optional .google.cloud.retail.v2beta.SearchRequest.SpellCorrectionSpec spell_correction_spec = 35;
SearchRequest.SpellCorrectionSpec getSpellCorrectionSpec()
The spell correction specification that specifies the mode under which spell correction will take effect.
optional .google.cloud.retail.v2beta.SearchRequest.SpellCorrectionSpec spell_correction_spec = 35;
SearchRequest.SpellCorrectionSpecOrBuilder getSpellCorrectionSpecOrBuilder()
The spell correction specification that specifies the mode under which spell correction will take effect.
optional .google.cloud.retail.v2beta.SearchRequest.SpellCorrectionSpec spell_correction_spec = 35;
String getEntity()
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][google.cloud.retail.v2beta.UserEvent.entity] to get search results boosted by entity.
string entity = 38;com.google.protobuf.ByteString getEntityBytes()
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][google.cloud.retail.v2beta.UserEvent.entity] to get search results boosted by entity.
string entity = 38;Copyright © 2024 Google LLC. All rights reserved.