Reference documentation and code samples for the Google Cloud Retail V2 Client class CatalogAttribute.
Catalog level attribute config for an attribute. For example, if customers want to enable/disable facet for a specific attribute.
Generated from protobuf message google.cloud.retail.v2.CatalogAttribute
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ key
string
Required. Attribute name. For example: color
, brands
, attributes.custom_attribute
, such as attributes.xyz
. To be indexable, the attribute name can contain only alpha-numeric characters and underscores. For example, an attribute named attributes.abc_xyz
can be indexed, but an attribute named attributes.abc-xyz
cannot be indexed.
↳ in_use
bool
Output only. Indicates whether this attribute has been used by any products. True
if at least one Product
is using this attribute in Product.attributes
. Otherwise, this field is False
. CatalogAttribute
can be pre-loaded by using CatalogService.AddCatalogAttribute
, CatalogService.ImportCatalogAttributes
, or CatalogService.UpdateAttributesConfig
APIs. This field is False
for pre-loaded CatalogAttribute
s. Only pre-loaded CatalogAttribute
s that are neither in use by products nor predefined can be deleted. CatalogAttribute
s that are either in use by products or are predefined cannot be deleted; however, their configuration properties will reset to default values upon removal request. After catalog changes, it takes about 10 minutes for this field to update.
↳ type
int
Output only. The type of this attribute. This is derived from the attribute in Product.attributes .
↳ indexable_option
int
When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values are indexed so that it can be filtered, faceted, or boosted in SearchService.Search .
↳ dynamic_facetable_option
int
If DYNAMIC_FACETABLE_ENABLED, attribute values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if CatalogAttribute.indexable_option is INDEXABLE_DISABLED. Otherwise, an INVALID_ARGUMENT error is returned.
↳ searchable_option
int
When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if SEARCHABLE_ENABLED, attribute values are searchable by text queries in SearchService.Search . If SEARCHABLE_ENABLED but attribute type is numerical, attribute values will not be searchable by text queries in SearchService.Search , as there are no text values associated to numerical attributes.
getKey
Required. Attribute name.
For example: color
, brands
, attributes.custom_attribute
, such as attributes.xyz
.
To be indexable, the attribute name can contain only alpha-numeric
characters and underscores. For example, an attribute named attributes.abc_xyz
can be indexed, but an attribute named attributes.abc-xyz
cannot be indexed.
Generated from protobuf field string key = 1 [(.google.api.field_behavior) = REQUIRED];
string
setKey
Required. Attribute name.
For example: color
, brands
, attributes.custom_attribute
, such as attributes.xyz
.
To be indexable, the attribute name can contain only alpha-numeric
characters and underscores. For example, an attribute named attributes.abc_xyz
can be indexed, but an attribute named attributes.abc-xyz
cannot be indexed.
Generated from protobuf field string key = 1 [(.google.api.field_behavior) = REQUIRED];
var
string
$this
getInUse
Output only. Indicates whether this attribute has been used by any
products. True
if at least one Product
is using this attribute in Product.attributes
. Otherwise,
this field is False
.
CatalogAttribute
can be
pre-loaded by using CatalogService.AddCatalogAttribute
, CatalogService.ImportCatalogAttributes
, or CatalogService.UpdateAttributesConfig
APIs. This field is False
for pre-loaded CatalogAttribute
s.
Only pre-loaded CatalogAttribute
s that are
neither in use by products nor predefined can be deleted. CatalogAttribute
s that are
either in use by products or are predefined cannot be deleted; however,
their configuration properties will reset to default values upon removal
request.
After catalog changes, it takes about 10 minutes for this field to update.
Generated from protobuf field bool in_use = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
bool
setInUse
Output only. Indicates whether this attribute has been used by any
products. True
if at least one Product
is using this attribute in Product.attributes
. Otherwise,
this field is False
.
CatalogAttribute
can be
pre-loaded by using CatalogService.AddCatalogAttribute
, CatalogService.ImportCatalogAttributes
, or CatalogService.UpdateAttributesConfig
APIs. This field is False
for pre-loaded CatalogAttribute
s.
Only pre-loaded CatalogAttribute
s that are
neither in use by products nor predefined can be deleted. CatalogAttribute
s that are
either in use by products or are predefined cannot be deleted; however,
their configuration properties will reset to default values upon removal
request.
After catalog changes, it takes about 10 minutes for this field to update.
Generated from protobuf field bool in_use = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
bool
$this
getType
Output only. The type of this attribute. This is derived from the attribute in Product.attributes .
Generated from protobuf field .google.cloud.retail.v2.CatalogAttribute.AttributeType type = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
int
setType
Output only. The type of this attribute. This is derived from the attribute in Product.attributes .
Generated from protobuf field .google.cloud.retail.v2.CatalogAttribute.AttributeType type = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
int
$this
getIndexableOption
When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values are indexed so that it can be filtered, faceted, or boosted in SearchService.Search .
Generated from protobuf field .google.cloud.retail.v2.CatalogAttribute.IndexableOption indexable_option = 5;
int
setIndexableOption
When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values are indexed so that it can be filtered, faceted, or boosted in SearchService.Search .
Generated from protobuf field .google.cloud.retail.v2.CatalogAttribute.IndexableOption indexable_option = 5;
var
int
$this
getDynamicFacetableOption
If DYNAMIC_FACETABLE_ENABLED, attribute values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if CatalogAttribute.indexable_option is INDEXABLE_DISABLED. Otherwise, an INVALID_ARGUMENT error is returned.
Generated from protobuf field .google.cloud.retail.v2.CatalogAttribute.DynamicFacetableOption dynamic_facetable_option = 6;
int
setDynamicFacetableOption
If DYNAMIC_FACETABLE_ENABLED, attribute values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if CatalogAttribute.indexable_option is INDEXABLE_DISABLED. Otherwise, an INVALID_ARGUMENT error is returned.
Generated from protobuf field .google.cloud.retail.v2.CatalogAttribute.DynamicFacetableOption dynamic_facetable_option = 6;
var
int
$this
getSearchableOption
When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if SEARCHABLE_ENABLED, attribute values are searchable by text queries in SearchService.Search .
If SEARCHABLE_ENABLED but attribute type is numerical, attribute values will not be searchable by text queries in SearchService.Search , as there are no text values associated to numerical attributes.
Generated from protobuf field .google.cloud.retail.v2.CatalogAttribute.SearchableOption searchable_option = 7;
int
setSearchableOption
When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if SEARCHABLE_ENABLED, attribute values are searchable by text queries in SearchService.Search .
If SEARCHABLE_ENABLED but attribute type is numerical, attribute values will not be searchable by text queries in SearchService.Search , as there are no text values associated to numerical attributes.
Generated from protobuf field .google.cloud.retail.v2.CatalogAttribute.SearchableOption searchable_option = 7;
var
int
$this
