- Resource: AttributesConfig
- CatalogAttribute
- AttributeType
- IndexableOption
- DynamicFacetableOption
- SearchableOption
- ExactSearchableOption
- RetrievableOption
- AttributeConfigLevel
- Methods
Resource: AttributesConfig
Catalog level attribute config.
JSON representation |
---|
{ "name": string, "catalogAttributes": { string: { object ( |
Fields | |
---|---|
name |
Required. Immutable. The fully qualified resource name of the attribute config. Format: |
catalogAttributes |
Enable attribute(s) config at catalog level. For example, indexable, dynamicFacetable, or searchable for each attribute. The key is catalog attribute's name. For example: The maximum number of catalog attributes allowed in a request is 1000. |
attributeConfigLevel |
Output only. The |
CatalogAttribute
Catalog level attribute config for an attribute. For example, if customers want to enable/disable facet for a specific attribute.
JSON representation |
---|
{ "key": string, "inUse": boolean, "type": enum ( |
Fields | |
---|---|
key |
Required. Attribute name. For example: If the attribute key starts with |
inUse |
Output only. Indicates whether this attribute has been used by any products.
Only pre-loaded After catalog changes, it takes about 10 minutes for this field to update. |
type |
Output only. The type of this attribute. This is derived from the attribute in |
indexableOption |
When Must be specified when |
dynamicFacetableOption |
If DYNAMIC_FACETABLE_ENABLED, attribute values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if Must be specified, otherwise throws INVALID_FORMAT error. |
searchableOption |
When If SEARCHABLE_ENABLED but attribute type is numerical, attribute values will not be searchable by text queries in Must be specified, when |
recommendationsFilteringOption |
When |
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 |
retrievableOption |
If RETRIEVABLE_ENABLED, attribute values are retrievable in the search results. If unset, the server behavior defaults to |
AttributeType
The type of an attribute.
Enums | |
---|---|
UNKNOWN |
The type of the attribute is unknown. Used when type cannot be derived from attribute that is not |
TEXTUAL |
Textual attribute. |
NUMERICAL |
Numerical attribute. |
IndexableOption
The status of the indexable option of a catalog attribute.
Enums | |
---|---|
INDEXABLE_OPTION_UNSPECIFIED |
Value used when unset. |
INDEXABLE_ENABLED |
Indexable option enabled for an attribute. |
INDEXABLE_DISABLED |
Indexable option disabled for an attribute. |
DynamicFacetableOption
The status of the dynamic facetable option of a catalog attribute.
Enums | |
---|---|
DYNAMIC_FACETABLE_OPTION_UNSPECIFIED |
Value used when unset. |
DYNAMIC_FACETABLE_ENABLED |
Dynamic facetable option enabled for an attribute. |
DYNAMIC_FACETABLE_DISABLED |
Dynamic facetable option disabled for an attribute. |
SearchableOption
The status of the searchable option of a catalog attribute.
Enums | |
---|---|
SEARCHABLE_OPTION_UNSPECIFIED |
Value used when unset. |
SEARCHABLE_ENABLED |
Searchable option enabled for an attribute. |
SEARCHABLE_DISABLED |
Searchable option disabled for an attribute. |
ExactSearchableOption
The status of the exact-searchable option of a catalog attribute.
Enums | |
---|---|
EXACT_SEARCHABLE_OPTION_UNSPECIFIED |
Value used when unset. |
EXACT_SEARCHABLE_ENABLED |
Exact searchable option enabled for an attribute. |
EXACT_SEARCHABLE_DISABLED |
Exact searchable option disabled for an attribute. |
RetrievableOption
The status of the retrievable option of a catalog attribute.
Enums | |
---|---|
RETRIEVABLE_OPTION_UNSPECIFIED |
Value used when unset. |
RETRIEVABLE_ENABLED |
Retrievable option enabled for an attribute. |
RETRIEVABLE_DISABLED |
Retrievable option disabled for an attribute. |
AttributeConfigLevel
At which level we offer configuration for attributes.
Enums | |
---|---|
ATTRIBUTE_CONFIG_LEVEL_UNSPECIFIED |
Value used when unset. In this case, server behavior defaults to CATALOG_LEVEL_ATTRIBUTE_CONFIG . |
PRODUCT_LEVEL_ATTRIBUTE_CONFIG |
At this level, we honor the attribute configurations set in Product.attributes . |
CATALOG_LEVEL_ATTRIBUTE_CONFIG |
At this level, we honor the attribute configurations set in CatalogConfig.attribute_configs . |
Methods |
|
---|---|
|
Adds the specified CatalogAttribute to the AttributesConfig . |
|
Removes all specified CatalogAttribute s from the AttributesConfig . |
|
Removes the specified CatalogAttribute from the AttributesConfig . |
|
Replaces the specified CatalogAttribute in the AttributesConfig by updating the catalog attribute with the same CatalogAttribute.key . |