public static final class SearchRequest.FacetSpec.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.Builder> implements SearchRequest.FacetSpecOrBuilder
A facet specification to perform faceted search.Protobuf type
google.cloud.retail.v2.SearchRequest.FacetSpec| Modifier and Type | Method and Description |
|---|---|
SearchRequest.FacetSpec.Builder |
addAllExcludedFilterKeys(Iterable<String> values)
List of keys to exclude when faceting.
|
SearchRequest.FacetSpec.Builder |
addExcludedFilterKeys(String value)
List of keys to exclude when faceting.
|
SearchRequest.FacetSpec.Builder |
addExcludedFilterKeysBytes(com.google.protobuf.ByteString value)
List of keys to exclude when faceting.
|
SearchRequest.FacetSpec.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
SearchRequest.FacetSpec |
build() |
SearchRequest.FacetSpec |
buildPartial() |
SearchRequest.FacetSpec.Builder |
clear() |
SearchRequest.FacetSpec.Builder |
clearEnableDynamicPosition()
Enables dynamic position for this facet.
|
SearchRequest.FacetSpec.Builder |
clearExcludedFilterKeys()
List of keys to exclude when faceting.
|
SearchRequest.FacetSpec.Builder |
clearFacetKey()
Required.
|
SearchRequest.FacetSpec.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
SearchRequest.FacetSpec.Builder |
clearLimit()
Maximum of facet values that should be returned for this facet.
|
SearchRequest.FacetSpec.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
SearchRequest.FacetSpec.Builder |
clone() |
SearchRequest.FacetSpec |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
boolean |
getEnableDynamicPosition()
Enables dynamic position for this facet.
|
String |
getExcludedFilterKeys(int index)
List of keys to exclude when faceting.
|
com.google.protobuf.ByteString |
getExcludedFilterKeysBytes(int index)
List of keys to exclude when faceting.
|
int |
getExcludedFilterKeysCount()
List of keys to exclude when faceting.
|
com.google.protobuf.ProtocolStringList |
getExcludedFilterKeysList()
List of keys to exclude when faceting.
|
SearchRequest.FacetSpec.FacetKey |
getFacetKey()
Required.
|
SearchRequest.FacetSpec.FacetKey.Builder |
getFacetKeyBuilder()
Required.
|
SearchRequest.FacetSpec.FacetKeyOrBuilder |
getFacetKeyOrBuilder()
Required.
|
int |
getLimit()
Maximum of facet values that should be returned for this facet.
|
boolean |
hasFacetKey()
Required.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
SearchRequest.FacetSpec.Builder |
mergeFacetKey(SearchRequest.FacetSpec.FacetKey value)
Required.
|
SearchRequest.FacetSpec.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
SearchRequest.FacetSpec.Builder |
mergeFrom(com.google.protobuf.Message other) |
SearchRequest.FacetSpec.Builder |
mergeFrom(SearchRequest.FacetSpec other) |
SearchRequest.FacetSpec.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
SearchRequest.FacetSpec.Builder |
setEnableDynamicPosition(boolean value)
Enables dynamic position for this facet.
|
SearchRequest.FacetSpec.Builder |
setExcludedFilterKeys(int index,
String value)
List of keys to exclude when faceting.
|
SearchRequest.FacetSpec.Builder |
setFacetKey(SearchRequest.FacetSpec.FacetKey.Builder builderForValue)
Required.
|
SearchRequest.FacetSpec.Builder |
setFacetKey(SearchRequest.FacetSpec.FacetKey value)
Required.
|
SearchRequest.FacetSpec.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
SearchRequest.FacetSpec.Builder |
setLimit(int value)
Maximum of facet values that should be returned for this facet.
|
SearchRequest.FacetSpec.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
SearchRequest.FacetSpec.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.Builder>public SearchRequest.FacetSpec.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.Builder>public SearchRequest.FacetSpec getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic SearchRequest.FacetSpec build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic SearchRequest.FacetSpec buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic SearchRequest.FacetSpec.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.Builder>public SearchRequest.FacetSpec.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.Builder>public SearchRequest.FacetSpec.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.Builder>public SearchRequest.FacetSpec.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.Builder>public SearchRequest.FacetSpec.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.Builder>public SearchRequest.FacetSpec.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.Builder>public SearchRequest.FacetSpec.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchRequest.FacetSpec.Builder>public SearchRequest.FacetSpec.Builder mergeFrom(SearchRequest.FacetSpec other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.Builder>public SearchRequest.FacetSpec.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchRequest.FacetSpec.Builder>IOExceptionpublic boolean hasFacetKey()
Required. The facet key specification.
.google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey facet_key = 1 [(.google.api.field_behavior) = REQUIRED];
hasFacetKey in interface SearchRequest.FacetSpecOrBuilderpublic SearchRequest.FacetSpec.FacetKey getFacetKey()
Required. The facet key specification.
.google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey facet_key = 1 [(.google.api.field_behavior) = REQUIRED];
getFacetKey in interface SearchRequest.FacetSpecOrBuilderpublic SearchRequest.FacetSpec.Builder setFacetKey(SearchRequest.FacetSpec.FacetKey value)
Required. The facet key specification.
.google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey facet_key = 1 [(.google.api.field_behavior) = REQUIRED];
public SearchRequest.FacetSpec.Builder setFacetKey(SearchRequest.FacetSpec.FacetKey.Builder builderForValue)
Required. The facet key specification.
.google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey facet_key = 1 [(.google.api.field_behavior) = REQUIRED];
public SearchRequest.FacetSpec.Builder mergeFacetKey(SearchRequest.FacetSpec.FacetKey value)
Required. The facet key specification.
.google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey facet_key = 1 [(.google.api.field_behavior) = REQUIRED];
public SearchRequest.FacetSpec.Builder clearFacetKey()
Required. The facet key specification.
.google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey facet_key = 1 [(.google.api.field_behavior) = REQUIRED];
public SearchRequest.FacetSpec.FacetKey.Builder getFacetKeyBuilder()
Required. The facet key specification.
.google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey facet_key = 1 [(.google.api.field_behavior) = REQUIRED];
public SearchRequest.FacetSpec.FacetKeyOrBuilder getFacetKeyOrBuilder()
Required. The facet key specification.
.google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey facet_key = 1 [(.google.api.field_behavior) = REQUIRED];
getFacetKeyOrBuilder in interface SearchRequest.FacetSpecOrBuilderpublic int getLimit()
Maximum of facet values that should be returned for this facet. If unspecified, defaults to 50. The maximum allowed value is 300. Values above 300 will be coerced to 300. If this field is negative, an INVALID_ARGUMENT is returned.
int32 limit = 2;getLimit in interface SearchRequest.FacetSpecOrBuilderpublic SearchRequest.FacetSpec.Builder setLimit(int value)
Maximum of facet values that should be returned for this facet. If unspecified, defaults to 50. The maximum allowed value is 300. Values above 300 will be coerced to 300. If this field is negative, an INVALID_ARGUMENT is returned.
int32 limit = 2;value - The limit to set.public SearchRequest.FacetSpec.Builder clearLimit()
Maximum of facet values that should be returned for this facet. If unspecified, defaults to 50. The maximum allowed value is 300. Values above 300 will be coerced to 300. If this field is negative, an INVALID_ARGUMENT is returned.
int32 limit = 2;public com.google.protobuf.ProtocolStringList getExcludedFilterKeysList()
List of keys to exclude when faceting.
By default,
[FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key]
is not excluded from the filter unless it is listed in this field.
Listing a facet key in this field allows its values to appear as facet
results, even when they are filtered out of search results. Using this
field does not affect what search results are returned.
For example, suppose there are 100 products with the color facet "Red"
and 200 products with the color facet "Blue". A query containing the
filter "colorFamilies:ANY("Red")" and having "colorFamilies" as
[FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key]
would by default return only "Red" products in the search results, and
also return "Red" with count 100 as the only color facet. Although there
are also blue products available, "Blue" would not be shown as an
available facet value.
If "colorFamilies" is listed in "excludedFilterKeys", then the query
returns the facet values "Red" with count 100 and "Blue" with count
200, because the "colorFamilies" key is now excluded from the filter.
Because this field doesn't affect search results, the search results
are still correctly filtered to return only "Red" products.
A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error
is returned.
repeated string excluded_filter_keys = 3;getExcludedFilterKeysList in interface SearchRequest.FacetSpecOrBuilderpublic int getExcludedFilterKeysCount()
List of keys to exclude when faceting.
By default,
[FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key]
is not excluded from the filter unless it is listed in this field.
Listing a facet key in this field allows its values to appear as facet
results, even when they are filtered out of search results. Using this
field does not affect what search results are returned.
For example, suppose there are 100 products with the color facet "Red"
and 200 products with the color facet "Blue". A query containing the
filter "colorFamilies:ANY("Red")" and having "colorFamilies" as
[FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key]
would by default return only "Red" products in the search results, and
also return "Red" with count 100 as the only color facet. Although there
are also blue products available, "Blue" would not be shown as an
available facet value.
If "colorFamilies" is listed in "excludedFilterKeys", then the query
returns the facet values "Red" with count 100 and "Blue" with count
200, because the "colorFamilies" key is now excluded from the filter.
Because this field doesn't affect search results, the search results
are still correctly filtered to return only "Red" products.
A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error
is returned.
repeated string excluded_filter_keys = 3;getExcludedFilterKeysCount in interface SearchRequest.FacetSpecOrBuilderpublic String getExcludedFilterKeys(int index)
List of keys to exclude when faceting.
By default,
[FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key]
is not excluded from the filter unless it is listed in this field.
Listing a facet key in this field allows its values to appear as facet
results, even when they are filtered out of search results. Using this
field does not affect what search results are returned.
For example, suppose there are 100 products with the color facet "Red"
and 200 products with the color facet "Blue". A query containing the
filter "colorFamilies:ANY("Red")" and having "colorFamilies" as
[FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key]
would by default return only "Red" products in the search results, and
also return "Red" with count 100 as the only color facet. Although there
are also blue products available, "Blue" would not be shown as an
available facet value.
If "colorFamilies" is listed in "excludedFilterKeys", then the query
returns the facet values "Red" with count 100 and "Blue" with count
200, because the "colorFamilies" key is now excluded from the filter.
Because this field doesn't affect search results, the search results
are still correctly filtered to return only "Red" products.
A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error
is returned.
repeated string excluded_filter_keys = 3;getExcludedFilterKeys in interface SearchRequest.FacetSpecOrBuilderindex - The index of the element to return.public com.google.protobuf.ByteString getExcludedFilterKeysBytes(int index)
List of keys to exclude when faceting.
By default,
[FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key]
is not excluded from the filter unless it is listed in this field.
Listing a facet key in this field allows its values to appear as facet
results, even when they are filtered out of search results. Using this
field does not affect what search results are returned.
For example, suppose there are 100 products with the color facet "Red"
and 200 products with the color facet "Blue". A query containing the
filter "colorFamilies:ANY("Red")" and having "colorFamilies" as
[FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key]
would by default return only "Red" products in the search results, and
also return "Red" with count 100 as the only color facet. Although there
are also blue products available, "Blue" would not be shown as an
available facet value.
If "colorFamilies" is listed in "excludedFilterKeys", then the query
returns the facet values "Red" with count 100 and "Blue" with count
200, because the "colorFamilies" key is now excluded from the filter.
Because this field doesn't affect search results, the search results
are still correctly filtered to return only "Red" products.
A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error
is returned.
repeated string excluded_filter_keys = 3;getExcludedFilterKeysBytes in interface SearchRequest.FacetSpecOrBuilderindex - The index of the value to return.public SearchRequest.FacetSpec.Builder setExcludedFilterKeys(int index, String value)
List of keys to exclude when faceting.
By default,
[FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key]
is not excluded from the filter unless it is listed in this field.
Listing a facet key in this field allows its values to appear as facet
results, even when they are filtered out of search results. Using this
field does not affect what search results are returned.
For example, suppose there are 100 products with the color facet "Red"
and 200 products with the color facet "Blue". A query containing the
filter "colorFamilies:ANY("Red")" and having "colorFamilies" as
[FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key]
would by default return only "Red" products in the search results, and
also return "Red" with count 100 as the only color facet. Although there
are also blue products available, "Blue" would not be shown as an
available facet value.
If "colorFamilies" is listed in "excludedFilterKeys", then the query
returns the facet values "Red" with count 100 and "Blue" with count
200, because the "colorFamilies" key is now excluded from the filter.
Because this field doesn't affect search results, the search results
are still correctly filtered to return only "Red" products.
A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error
is returned.
repeated string excluded_filter_keys = 3;index - The index to set the value at.value - The excludedFilterKeys to set.public SearchRequest.FacetSpec.Builder addExcludedFilterKeys(String value)
List of keys to exclude when faceting.
By default,
[FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key]
is not excluded from the filter unless it is listed in this field.
Listing a facet key in this field allows its values to appear as facet
results, even when they are filtered out of search results. Using this
field does not affect what search results are returned.
For example, suppose there are 100 products with the color facet "Red"
and 200 products with the color facet "Blue". A query containing the
filter "colorFamilies:ANY("Red")" and having "colorFamilies" as
[FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key]
would by default return only "Red" products in the search results, and
also return "Red" with count 100 as the only color facet. Although there
are also blue products available, "Blue" would not be shown as an
available facet value.
If "colorFamilies" is listed in "excludedFilterKeys", then the query
returns the facet values "Red" with count 100 and "Blue" with count
200, because the "colorFamilies" key is now excluded from the filter.
Because this field doesn't affect search results, the search results
are still correctly filtered to return only "Red" products.
A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error
is returned.
repeated string excluded_filter_keys = 3;value - The excludedFilterKeys to add.public SearchRequest.FacetSpec.Builder addAllExcludedFilterKeys(Iterable<String> values)
List of keys to exclude when faceting.
By default,
[FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key]
is not excluded from the filter unless it is listed in this field.
Listing a facet key in this field allows its values to appear as facet
results, even when they are filtered out of search results. Using this
field does not affect what search results are returned.
For example, suppose there are 100 products with the color facet "Red"
and 200 products with the color facet "Blue". A query containing the
filter "colorFamilies:ANY("Red")" and having "colorFamilies" as
[FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key]
would by default return only "Red" products in the search results, and
also return "Red" with count 100 as the only color facet. Although there
are also blue products available, "Blue" would not be shown as an
available facet value.
If "colorFamilies" is listed in "excludedFilterKeys", then the query
returns the facet values "Red" with count 100 and "Blue" with count
200, because the "colorFamilies" key is now excluded from the filter.
Because this field doesn't affect search results, the search results
are still correctly filtered to return only "Red" products.
A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error
is returned.
repeated string excluded_filter_keys = 3;values - The excludedFilterKeys to add.public SearchRequest.FacetSpec.Builder clearExcludedFilterKeys()
List of keys to exclude when faceting.
By default,
[FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key]
is not excluded from the filter unless it is listed in this field.
Listing a facet key in this field allows its values to appear as facet
results, even when they are filtered out of search results. Using this
field does not affect what search results are returned.
For example, suppose there are 100 products with the color facet "Red"
and 200 products with the color facet "Blue". A query containing the
filter "colorFamilies:ANY("Red")" and having "colorFamilies" as
[FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key]
would by default return only "Red" products in the search results, and
also return "Red" with count 100 as the only color facet. Although there
are also blue products available, "Blue" would not be shown as an
available facet value.
If "colorFamilies" is listed in "excludedFilterKeys", then the query
returns the facet values "Red" with count 100 and "Blue" with count
200, because the "colorFamilies" key is now excluded from the filter.
Because this field doesn't affect search results, the search results
are still correctly filtered to return only "Red" products.
A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error
is returned.
repeated string excluded_filter_keys = 3;public SearchRequest.FacetSpec.Builder addExcludedFilterKeysBytes(com.google.protobuf.ByteString value)
List of keys to exclude when faceting.
By default,
[FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key]
is not excluded from the filter unless it is listed in this field.
Listing a facet key in this field allows its values to appear as facet
results, even when they are filtered out of search results. Using this
field does not affect what search results are returned.
For example, suppose there are 100 products with the color facet "Red"
and 200 products with the color facet "Blue". A query containing the
filter "colorFamilies:ANY("Red")" and having "colorFamilies" as
[FacetKey.key][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.key]
would by default return only "Red" products in the search results, and
also return "Red" with count 100 as the only color facet. Although there
are also blue products available, "Blue" would not be shown as an
available facet value.
If "colorFamilies" is listed in "excludedFilterKeys", then the query
returns the facet values "Red" with count 100 and "Blue" with count
200, because the "colorFamilies" key is now excluded from the filter.
Because this field doesn't affect search results, the search results
are still correctly filtered to return only "Red" products.
A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error
is returned.
repeated string excluded_filter_keys = 3;value - The bytes of the excludedFilterKeys to add.public boolean getEnableDynamicPosition()
Enables dynamic position for this facet. If set to true, the position of
this facet among all facets in the response is determined by Google
Retail Search. It will be ordered together with dynamic facets if dynamic
facets is enabled. If set to false, the position of this facet in the
response will be the same as in the request, and it will be ranked before
the facets with dynamic position enable and all dynamic facets.
For example, you may always want to have rating facet returned in
the response, but it's not necessarily to always display the rating facet
at the top. In that case, you can set enable_dynamic_position to true so
that the position of rating facet in response will be determined by
Google Retail Search.
Another example, assuming you have the following facets in the request:
* "rating", enable_dynamic_position = true
* "price", enable_dynamic_position = false
* "brands", enable_dynamic_position = false
And also you have a dynamic facets enable, which will generate a facet
'gender'. Then the final order of the facets in the response can be
("price", "brands", "rating", "gender") or ("price", "brands", "gender",
"rating") depends on how Google Retail Search orders "gender" and
"rating" facets. However, notice that "price" and "brands" will always be
ranked at 1st and 2nd position since their enable_dynamic_position are
false.
bool enable_dynamic_position = 4;getEnableDynamicPosition in interface SearchRequest.FacetSpecOrBuilderpublic SearchRequest.FacetSpec.Builder setEnableDynamicPosition(boolean value)
Enables dynamic position for this facet. If set to true, the position of
this facet among all facets in the response is determined by Google
Retail Search. It will be ordered together with dynamic facets if dynamic
facets is enabled. If set to false, the position of this facet in the
response will be the same as in the request, and it will be ranked before
the facets with dynamic position enable and all dynamic facets.
For example, you may always want to have rating facet returned in
the response, but it's not necessarily to always display the rating facet
at the top. In that case, you can set enable_dynamic_position to true so
that the position of rating facet in response will be determined by
Google Retail Search.
Another example, assuming you have the following facets in the request:
* "rating", enable_dynamic_position = true
* "price", enable_dynamic_position = false
* "brands", enable_dynamic_position = false
And also you have a dynamic facets enable, which will generate a facet
'gender'. Then the final order of the facets in the response can be
("price", "brands", "rating", "gender") or ("price", "brands", "gender",
"rating") depends on how Google Retail Search orders "gender" and
"rating" facets. However, notice that "price" and "brands" will always be
ranked at 1st and 2nd position since their enable_dynamic_position are
false.
bool enable_dynamic_position = 4;value - The enableDynamicPosition to set.public SearchRequest.FacetSpec.Builder clearEnableDynamicPosition()
Enables dynamic position for this facet. If set to true, the position of
this facet among all facets in the response is determined by Google
Retail Search. It will be ordered together with dynamic facets if dynamic
facets is enabled. If set to false, the position of this facet in the
response will be the same as in the request, and it will be ranked before
the facets with dynamic position enable and all dynamic facets.
For example, you may always want to have rating facet returned in
the response, but it's not necessarily to always display the rating facet
at the top. In that case, you can set enable_dynamic_position to true so
that the position of rating facet in response will be determined by
Google Retail Search.
Another example, assuming you have the following facets in the request:
* "rating", enable_dynamic_position = true
* "price", enable_dynamic_position = false
* "brands", enable_dynamic_position = false
And also you have a dynamic facets enable, which will generate a facet
'gender'. Then the final order of the facets in the response can be
("price", "brands", "rating", "gender") or ("price", "brands", "gender",
"rating") depends on how Google Retail Search orders "gender" and
"rating" facets. However, notice that "price" and "brands" will always be
ranked at 1st and 2nd position since their enable_dynamic_position are
false.
bool enable_dynamic_position = 4;public final SearchRequest.FacetSpec.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.Builder>public final SearchRequest.FacetSpec.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.FacetSpec.Builder>Copyright © 2024 Google LLC. All rights reserved.