Skip to content

Commit 32de4a0

Browse files
feat(retail): update the api
#### retail:v2 The following keys were deleted: - schemas.GoogleCloudRetailLoggingImportErrorContext.properties.inventoryActivity.type (Total Keys: 1) - schemas.GoogleCloudRetailLoggingImportErrorContext.properties.order.type (Total Keys: 1) - schemas.GoogleCloudRetailLoggingImportErrorContext.properties.place (Total Keys: 4) The following keys were added: - resources.projects.resources.locations.resources.catalogs.resources.userEvents.methods.collect.parameters.prebuiltRule (Total Keys: 2) - resources.projects.resources.locations.resources.catalogs.resources.userEvents.methods.collect.parameters.rawJson (Total Keys: 2) - schemas.GoogleCloudRetailV2CatalogAttribute.properties.exactSearchableOption.type (Total Keys: 1) - schemas.GoogleCloudRetailV2alphaGcsOutputResult (Total Keys: 3) - schemas.GoogleCloudRetailV2alphaOutputResult.properties.gcsResult (Total Keys: 2) - schemas.GoogleCloudRetailV2betaOutputResult.properties.gcsResult (Total Keys: 2)
1 parent 569cb7e commit 32de4a0

File tree

4 files changed

+80
-34
lines changed

4 files changed

+80
-34
lines changed

docs/dyn/retail_v2.projects.locations.catalogs.attributesConfig.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,7 @@ <h3>Method Details</h3>
9999
{ # Request for CatalogService.AddCatalogAttribute method.
100100
&quot;catalogAttribute&quot;: { # Catalog level attribute config for an attribute. For example, if customers want to enable/disable facet for a specific attribute. # Required. The CatalogAttribute to add.
101101
&quot;dynamicFacetableOption&quot;: &quot;A String&quot;, # 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.
102+
&quot;exactSearchableOption&quot;: &quot;A String&quot;, # 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.
102103
&quot;inUse&quot;: True or False, # 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 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.
103104
&quot;indexableOption&quot;: &quot;A String&quot;, # 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, otherwise throws INVALID_FORMAT error.
104105
&quot;key&quot;: &quot;A String&quot;, # 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.
@@ -120,6 +121,7 @@ <h3>Method Details</h3>
120121
&quot;catalogAttributes&quot;: { # Enable attribute(s) config at catalog level. For example, indexable, dynamic_facetable, or searchable for each attribute. The key is catalog attribute&#x27;s name. For example: `color`, `brands`, `attributes.custom_attribute`, such as `attributes.xyz`. The maximum number of catalog attributes allowed in a request is 1000.
121122
&quot;a_key&quot;: { # Catalog level attribute config for an attribute. For example, if customers want to enable/disable facet for a specific attribute.
122123
&quot;dynamicFacetableOption&quot;: &quot;A String&quot;, # 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.
124+
&quot;exactSearchableOption&quot;: &quot;A String&quot;, # 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.
123125
&quot;inUse&quot;: True or False, # 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 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.
124126
&quot;indexableOption&quot;: &quot;A String&quot;, # 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, otherwise throws INVALID_FORMAT error.
125127
&quot;key&quot;: &quot;A String&quot;, # 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.
@@ -162,6 +164,7 @@ <h3>Method Details</h3>
162164
&quot;catalogAttributes&quot;: { # Enable attribute(s) config at catalog level. For example, indexable, dynamic_facetable, or searchable for each attribute. The key is catalog attribute&#x27;s name. For example: `color`, `brands`, `attributes.custom_attribute`, such as `attributes.xyz`. The maximum number of catalog attributes allowed in a request is 1000.
163165
&quot;a_key&quot;: { # Catalog level attribute config for an attribute. For example, if customers want to enable/disable facet for a specific attribute.
164166
&quot;dynamicFacetableOption&quot;: &quot;A String&quot;, # 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.
167+
&quot;exactSearchableOption&quot;: &quot;A String&quot;, # 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.
165168
&quot;inUse&quot;: True or False, # 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 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.
166169
&quot;indexableOption&quot;: &quot;A String&quot;, # 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, otherwise throws INVALID_FORMAT error.
167170
&quot;key&quot;: &quot;A String&quot;, # 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.
@@ -185,6 +188,7 @@ <h3>Method Details</h3>
185188
{ # Request for CatalogService.ReplaceCatalogAttribute method.
186189
&quot;catalogAttribute&quot;: { # Catalog level attribute config for an attribute. For example, if customers want to enable/disable facet for a specific attribute. # Required. The updated CatalogAttribute.
187190
&quot;dynamicFacetableOption&quot;: &quot;A String&quot;, # 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.
191+
&quot;exactSearchableOption&quot;: &quot;A String&quot;, # 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.
188192
&quot;inUse&quot;: True or False, # 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 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.
189193
&quot;indexableOption&quot;: &quot;A String&quot;, # 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, otherwise throws INVALID_FORMAT error.
190194
&quot;key&quot;: &quot;A String&quot;, # 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.
@@ -207,6 +211,7 @@ <h3>Method Details</h3>
207211
&quot;catalogAttributes&quot;: { # Enable attribute(s) config at catalog level. For example, indexable, dynamic_facetable, or searchable for each attribute. The key is catalog attribute&#x27;s name. For example: `color`, `brands`, `attributes.custom_attribute`, such as `attributes.xyz`. The maximum number of catalog attributes allowed in a request is 1000.
208212
&quot;a_key&quot;: { # Catalog level attribute config for an attribute. For example, if customers want to enable/disable facet for a specific attribute.
209213
&quot;dynamicFacetableOption&quot;: &quot;A String&quot;, # 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.
214+
&quot;exactSearchableOption&quot;: &quot;A String&quot;, # 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.
210215
&quot;inUse&quot;: True or False, # 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 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.
211216
&quot;indexableOption&quot;: &quot;A String&quot;, # 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, otherwise throws INVALID_FORMAT error.
212217
&quot;key&quot;: &quot;A String&quot;, # 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.

0 commit comments

Comments
 (0)