Skip to content

Commit

Permalink
feat(retail): update the api
Browse files Browse the repository at this point in the history
#### retail:v2

The following keys were added:
- resources.projects.resources.locations.resources.catalogs.resources.models.methods.create (Total Keys: 14)
- resources.projects.resources.locations.resources.catalogs.resources.models.methods.delete (Total Keys: 11)
- resources.projects.resources.locations.resources.catalogs.resources.models.methods.list (Total Keys: 16)
- resources.projects.resources.locations.resources.catalogs.resources.models.methods.patch (Total Keys: 15)
- resources.projects.resources.locations.resources.catalogs.resources.models.methods.pause (Total Keys: 12)
- resources.projects.resources.locations.resources.catalogs.resources.models.methods.resume (Total Keys: 12)
- resources.projects.resources.locations.resources.catalogs.resources.models.methods.tune (Total Keys: 12)
- schemas.GoogleCloudRetailV2CreateModelMetadata (Total Keys: 3)
- schemas.GoogleCloudRetailV2ExperimentInfo (Total Keys: 8)
- schemas.GoogleCloudRetailV2ListModelsResponse (Total Keys: 5)
- schemas.GoogleCloudRetailV2Model (Total Keys: 31)
- schemas.GoogleCloudRetailV2PauseModelRequest (Total Keys: 2)
- schemas.GoogleCloudRetailV2ResumeModelRequest (Total Keys: 2)
- schemas.GoogleCloudRetailV2SearchResponse.properties.experimentInfo (Total Keys: 2)
- schemas.GoogleCloudRetailV2TuneModelMetadata (Total Keys: 3)
- schemas.GoogleCloudRetailV2TuneModelRequest (Total Keys: 2)
- schemas.GoogleCloudRetailV2TuneModelResponse (Total Keys: 2)

#### retail:v2alpha

The following keys were added:
- schemas.GoogleCloudRetailV2CreateModelMetadata (Total Keys: 3)
- schemas.GoogleCloudRetailV2Model (Total Keys: 31)
- schemas.GoogleCloudRetailV2TuneModelMetadata (Total Keys: 3)
- schemas.GoogleCloudRetailV2TuneModelResponse (Total Keys: 2)
- schemas.GoogleCloudRetailV2alphaExperimentInfo (Total Keys: 8)
- schemas.GoogleCloudRetailV2alphaSearchResponse.properties.experimentInfo (Total Keys: 2)

#### retail:v2beta

The following keys were added:
- schemas.GoogleCloudRetailV2CreateModelMetadata (Total Keys: 3)
- schemas.GoogleCloudRetailV2Model (Total Keys: 31)
- schemas.GoogleCloudRetailV2TuneModelMetadata (Total Keys: 3)
- schemas.GoogleCloudRetailV2TuneModelResponse (Total Keys: 2)
- schemas.GoogleCloudRetailV2betaExperimentInfo (Total Keys: 8)
- schemas.GoogleCloudRetailV2betaSearchResponse.properties.experimentInfo (Total Keys: 2)
  • Loading branch information
yoshi-automation committed Jan 24, 2023
1 parent bbeb0f3 commit 79e78d1
Show file tree
Hide file tree
Showing 19 changed files with 1,456 additions and 75 deletions.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

11 changes: 8 additions & 3 deletions docs/dyn/retail_v2.projects.locations.catalogs.html
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,11 @@ <h2>Instance Methods</h2>
</p>
<p class="firstline">Returns the controls Resource.</p>

<p class="toc_element">
<code><a href="retail_v2.projects.locations.catalogs.models.html">models()</a></code>
</p>
<p class="firstline">Returns the models Resource.</p>

<p class="toc_element">
<code><a href="retail_v2.projects.locations.catalogs.operations.html">operations()</a></code>
</p>
Expand Down Expand Up @@ -222,7 +227,7 @@ <h3>Method Details</h3>
&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. If unset, the server behavior defaults to EXACT_SEARCHABLE_DISABLED.
&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.
&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.
&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. For attributes whoes key start with `attributes.`, we refer them as custom attributes. Otherwise they are built-in attributes such as `color` and `brands`.
&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. 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.
&quot;retrievableOption&quot;: &quot;A String&quot;, # If RETRIEVABLE_ENABLED, attribute values are retrievable in the search results. If unset, the server behavior defaults to RETRIEVABLE_DISABLED.
&quot;searchableOption&quot;: &quot;A String&quot;, # 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, otherwise throws INVALID_FORMAT error.
&quot;type&quot;: &quot;A String&quot;, # Output only. The type of this attribute. This is derived from the attribute in Product.attributes.
Expand Down Expand Up @@ -447,7 +452,7 @@ <h3>Method Details</h3>
&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. If unset, the server behavior defaults to EXACT_SEARCHABLE_DISABLED.
&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.
&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.
&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. For attributes whoes key start with `attributes.`, we refer them as custom attributes. Otherwise they are built-in attributes such as `color` and `brands`.
&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. 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.
&quot;retrievableOption&quot;: &quot;A String&quot;, # If RETRIEVABLE_ENABLED, attribute values are retrievable in the search results. If unset, the server behavior defaults to RETRIEVABLE_DISABLED.
&quot;searchableOption&quot;: &quot;A String&quot;, # 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, otherwise throws INVALID_FORMAT error.
&quot;type&quot;: &quot;A String&quot;, # Output only. The type of this attribute. This is derived from the attribute in Product.attributes.
Expand All @@ -473,7 +478,7 @@ <h3>Method Details</h3>
&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. If unset, the server behavior defaults to EXACT_SEARCHABLE_DISABLED.
&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.
&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.
&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. For attributes whoes key start with `attributes.`, we refer them as custom attributes. Otherwise they are built-in attributes such as `color` and `brands`.
&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. 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.
&quot;retrievableOption&quot;: &quot;A String&quot;, # If RETRIEVABLE_ENABLED, attribute values are retrievable in the search results. If unset, the server behavior defaults to RETRIEVABLE_DISABLED.
&quot;searchableOption&quot;: &quot;A String&quot;, # 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, otherwise throws INVALID_FORMAT error.
&quot;type&quot;: &quot;A String&quot;, # Output only. The type of this attribute. This is derived from the attribute in Product.attributes.
Expand Down

0 comments on commit 79e78d1

Please sign in to comment.