Class GoogleCloudRetailV2CatalogAttribute

Catalog level attribute config for an attribute. For example, if customers want to enable/disable facet for a specific attribute.

Inheritance
object
GoogleCloudRetailV2CatalogAttribute
Implements
Inherited Members
Namespace: Google.Apis.CloudRetail.v2.Data
Assembly: Google.Apis.CloudRetail.v2.dll
Syntax
public class GoogleCloudRetailV2CatalogAttribute : IDirectResponseSchema

Properties

DynamicFacetableOption

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. Must be specified, otherwise throws INVALID_FORMAT error.

Declaration
[JsonProperty("dynamicFacetableOption")]
public virtual string DynamicFacetableOption { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

ExactSearchableOption

If EXACT_SEARCHABLE_ENABLED, attribute values will be exact searchable. This property only applies to textual custom attributes and requires indexable set to enabled to enable exact-searchable. If unset, the server behavior defaults to EXACT_SEARCHABLE_DISABLED.

Declaration
[JsonProperty("exactSearchableOption")]
public virtual string ExactSearchableOption { get; set; }
Property Value
Type Description
string

FacetConfig

Contains facet options.

Declaration
[JsonProperty("facetConfig")]
public virtual GoogleCloudRetailV2CatalogAttributeFacetConfig FacetConfig { get; set; }
Property Value
Type Description
GoogleCloudRetailV2CatalogAttributeFacetConfig

InUse

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 or CatalogService.UpdateAttributesConfig APIs. This field is False for pre-loaded CatalogAttributes. Only pre-loaded catalog attributes that are neither in use by products nor predefined can be deleted. Catalog attributes that are either in use by products or are predefined attributes 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.

Declaration
[JsonProperty("inUse")]
public virtual bool? InUse { get; set; }
Property Value
Type Description
bool?

IndexableOption

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. Must be specified when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.

Declaration
[JsonProperty("indexableOption")]
public virtual string IndexableOption { get; set; }
Property Value
Type Description
string

Key

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. If the attribute key starts with attributes., then the attribute is a custom attribute. Attributes such as brands, patterns, and title are built-in and called system attributes.

Declaration
[JsonProperty("key")]
public virtual string Key { get; set; }
Property Value
Type Description
string

RetrievableOption

If RETRIEVABLE_ENABLED, attribute values are retrievable in the search results. If unset, the server behavior defaults to RETRIEVABLE_DISABLED.

Declaration
[JsonProperty("retrievableOption")]
public virtual string RetrievableOption { get; set; }
Property Value
Type Description
string

SearchableOption

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. Must be specified, when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.

Declaration
[JsonProperty("searchableOption")]
public virtual string SearchableOption { get; set; }
Property Value
Type Description
string

Type

Output only. The type of this attribute. This is derived from the attribute in Product.attributes.

Declaration
[JsonProperty("type")]
public virtual string Type { get; set; }
Property Value
Type Description
string

Implements