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.methods.exportAnalyticsMetrics (Total Keys: 12)
- schemas.GoogleCloudRetailV2BigQueryOutputResult (Total Keys: 4)
- schemas.GoogleCloudRetailV2ExportAnalyticsMetricsRequest (Total Keys: 4)
- schemas.GoogleCloudRetailV2ExportAnalyticsMetricsResponse (Total Keys: 6)
- schemas.GoogleCloudRetailV2ExportErrorsConfig (Total Keys: 3)
- schemas.GoogleCloudRetailV2ExportMetadata (Total Keys: 6)
- schemas.GoogleCloudRetailV2GcsOutputResult (Total Keys: 3)
- schemas.GoogleCloudRetailV2OutputConfig (Total Keys: 12)
- schemas.GoogleCloudRetailV2OutputResult (Total Keys: 6)

#### retail:v2alpha

The following keys were added:
- schemas.GoogleCloudRetailV2BigQueryOutputResult (Total Keys: 4)
- schemas.GoogleCloudRetailV2ExportAnalyticsMetricsResponse (Total Keys: 6)
- schemas.GoogleCloudRetailV2ExportErrorsConfig (Total Keys: 3)
- schemas.GoogleCloudRetailV2ExportMetadata (Total Keys: 6)
- schemas.GoogleCloudRetailV2GcsOutputResult (Total Keys: 3)
- schemas.GoogleCloudRetailV2OutputResult (Total Keys: 6)

#### retail:v2beta

The following keys were added:
- schemas.GoogleCloudRetailV2BigQueryOutputResult (Total Keys: 4)
- schemas.GoogleCloudRetailV2ExportAnalyticsMetricsResponse (Total Keys: 6)
- schemas.GoogleCloudRetailV2ExportErrorsConfig (Total Keys: 3)
- schemas.GoogleCloudRetailV2ExportMetadata (Total Keys: 6)
- schemas.GoogleCloudRetailV2GcsOutputResult (Total Keys: 3)
- schemas.GoogleCloudRetailV2OutputResult (Total Keys: 6)
  • Loading branch information
yoshi-automation committed Feb 13, 2024
1 parent 2cd64ff commit 88b499c
Show file tree
Hide file tree
Showing 58 changed files with 498 additions and 64 deletions.
2 changes: 1 addition & 1 deletion docs/dyn/retail_v2.html
Expand Up @@ -72,7 +72,7 @@

</style>

<h1><a href="retail_v2.html">Retail API</a></h1>
<h1><a href="retail_v2.html">Vertex AI Search for Retail API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="retail_v2.projects.html">projects()</a></code>
Expand Down
2 changes: 1 addition & 1 deletion docs/dyn/retail_v2.projects.html
Expand Up @@ -72,7 +72,7 @@

</style>

<h1><a href="retail_v2.html">Retail API</a> . <a href="retail_v2.projects.html">projects</a></h1>
<h1><a href="retail_v2.html">Vertex AI Search for Retail API</a> . <a href="retail_v2.projects.html">projects</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="retail_v2.projects.locations.html">locations()</a></code>
Expand Down
Expand Up @@ -72,7 +72,7 @@

</style>

<h1><a href="retail_v2.html">Retail API</a> . <a href="retail_v2.projects.html">projects</a> . <a href="retail_v2.projects.locations.html">locations</a> . <a href="retail_v2.projects.locations.catalogs.html">catalogs</a> . <a href="retail_v2.projects.locations.catalogs.attributesConfig.html">attributesConfig</a></h1>
<h1><a href="retail_v2.html">Vertex AI Search for Retail API</a> . <a href="retail_v2.projects.html">projects</a> . <a href="retail_v2.projects.locations.html">locations</a> . <a href="retail_v2.projects.locations.catalogs.html">catalogs</a> . <a href="retail_v2.projects.locations.catalogs.attributesConfig.html">attributesConfig</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#addCatalogAttribute">addCatalogAttribute(attributesConfig, body=None, x__xgafv=None)</a></code></p>
Expand Down
Expand Up @@ -72,7 +72,7 @@

</style>

<h1><a href="retail_v2.html">Retail API</a> . <a href="retail_v2.projects.html">projects</a> . <a href="retail_v2.projects.locations.html">locations</a> . <a href="retail_v2.projects.locations.catalogs.html">catalogs</a> . <a href="retail_v2.projects.locations.catalogs.branches.html">branches</a></h1>
<h1><a href="retail_v2.html">Vertex AI Search for Retail API</a> . <a href="retail_v2.projects.html">projects</a> . <a href="retail_v2.projects.locations.html">locations</a> . <a href="retail_v2.projects.locations.catalogs.html">catalogs</a> . <a href="retail_v2.projects.locations.catalogs.branches.html">branches</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="retail_v2.projects.locations.catalogs.branches.operations.html">operations()</a></code>
Expand Down
Expand Up @@ -72,7 +72,7 @@

</style>

<h1><a href="retail_v2.html">Retail API</a> . <a href="retail_v2.projects.html">projects</a> . <a href="retail_v2.projects.locations.html">locations</a> . <a href="retail_v2.projects.locations.catalogs.html">catalogs</a> . <a href="retail_v2.projects.locations.catalogs.branches.html">branches</a> . <a href="retail_v2.projects.locations.catalogs.branches.operations.html">operations</a></h1>
<h1><a href="retail_v2.html">Vertex AI Search for Retail API</a> . <a href="retail_v2.projects.html">projects</a> . <a href="retail_v2.projects.locations.html">locations</a> . <a href="retail_v2.projects.locations.catalogs.html">catalogs</a> . <a href="retail_v2.projects.locations.catalogs.branches.html">branches</a> . <a href="retail_v2.projects.locations.catalogs.branches.operations.html">operations</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
Expand Down
Expand Up @@ -72,7 +72,7 @@

</style>

<h1><a href="retail_v2.html">Retail API</a> . <a href="retail_v2.projects.html">projects</a> . <a href="retail_v2.projects.locations.html">locations</a> . <a href="retail_v2.projects.locations.catalogs.html">catalogs</a> . <a href="retail_v2.projects.locations.catalogs.branches.html">branches</a> . <a href="retail_v2.projects.locations.catalogs.branches.products.html">products</a></h1>
<h1><a href="retail_v2.html">Vertex AI Search for Retail API</a> . <a href="retail_v2.projects.html">projects</a> . <a href="retail_v2.projects.locations.html">locations</a> . <a href="retail_v2.projects.locations.catalogs.html">catalogs</a> . <a href="retail_v2.projects.locations.catalogs.branches.html">branches</a> . <a href="retail_v2.projects.locations.catalogs.branches.products.html">products</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#addFulfillmentPlaces">addFulfillmentPlaces(product, body=None, x__xgafv=None)</a></code></p>
Expand Down
Expand Up @@ -72,7 +72,7 @@

</style>

<h1><a href="retail_v2.html">Retail API</a> . <a href="retail_v2.projects.html">projects</a> . <a href="retail_v2.projects.locations.html">locations</a> . <a href="retail_v2.projects.locations.catalogs.html">catalogs</a> . <a href="retail_v2.projects.locations.catalogs.completionData.html">completionData</a></h1>
<h1><a href="retail_v2.html">Vertex AI Search for Retail API</a> . <a href="retail_v2.projects.html">projects</a> . <a href="retail_v2.projects.locations.html">locations</a> . <a href="retail_v2.projects.locations.catalogs.html">catalogs</a> . <a href="retail_v2.projects.locations.catalogs.completionData.html">completionData</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
Expand Down
Expand Up @@ -72,7 +72,7 @@

</style>

<h1><a href="retail_v2.html">Retail API</a> . <a href="retail_v2.projects.html">projects</a> . <a href="retail_v2.projects.locations.html">locations</a> . <a href="retail_v2.projects.locations.catalogs.html">catalogs</a> . <a href="retail_v2.projects.locations.catalogs.controls.html">controls</a></h1>
<h1><a href="retail_v2.html">Vertex AI Search for Retail API</a> . <a href="retail_v2.projects.html">projects</a> . <a href="retail_v2.projects.locations.html">locations</a> . <a href="retail_v2.projects.locations.catalogs.html">catalogs</a> . <a href="retail_v2.projects.locations.catalogs.controls.html">controls</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
Expand Down
57 changes: 56 additions & 1 deletion docs/dyn/retail_v2.projects.locations.catalogs.html
Expand Up @@ -72,7 +72,7 @@

</style>

<h1><a href="retail_v2.html">Retail API</a> . <a href="retail_v2.projects.html">projects</a> . <a href="retail_v2.projects.locations.html">locations</a> . <a href="retail_v2.projects.locations.catalogs.html">catalogs</a></h1>
<h1><a href="retail_v2.html">Vertex AI Search for Retail API</a> . <a href="retail_v2.projects.html">projects</a> . <a href="retail_v2.projects.locations.html">locations</a> . <a href="retail_v2.projects.locations.catalogs.html">catalogs</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="retail_v2.projects.locations.catalogs.attributesConfig.html">attributesConfig()</a></code>
Expand Down Expand Up @@ -125,6 +125,9 @@ <h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#completeQuery">completeQuery(catalog, dataset=None, deviceType=None, entity=None, languageCodes=None, maxSuggestions=None, query=None, visitorId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Completes the specified prefix with keyword suggestions. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.</p>
<p class="toc_element">
<code><a href="#exportAnalyticsMetrics">exportAnalyticsMetrics(catalog, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Exports analytics metrics. `Operation.response` is of type `ExportAnalyticsMetricsResponse`. `Operation.metadata` is of type `ExportMetadata`.</p>
<p class="toc_element">
<code><a href="#getAttributesConfig">getAttributesConfig(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets an AttributesConfig.</p>
Expand Down Expand Up @@ -206,6 +209,58 @@ <h3>Method Details</h3>
}</pre>
</div>

<div class="method">
<code class="details" id="exportAnalyticsMetrics">exportAnalyticsMetrics(catalog, body=None, x__xgafv=None)</code>
<pre>Exports analytics metrics. `Operation.response` is of type `ExportAnalyticsMetricsResponse`. `Operation.metadata` is of type `ExportMetadata`.

Args:
catalog: string, Required. Full resource name of the parent catalog. Expected format: `projects/*/locations/*/catalogs/*` (required)
body: object, The request body.
The object takes the form of:

{ # Request message for the `ExportAnalyticsMetrics` method.
&quot;filter&quot;: &quot;A String&quot;, # A filtering expression to specify restrictions on returned metrics. The expression is a sequence of terms. Each term applies a restriction to the returned metrics. Use this expression to restrict results to a specific time range. Currently we expect only one types of fields: * `timestamp`: This can be specified twice, once with a less than operator and once with a greater than operator. The `timestamp` restriction should result in one, contiguous, valid, `timestamp` range. Some examples of valid filters expressions: * Example 1: `timestamp &gt; &quot;2012-04-23T18:25:43.511Z&quot; timestamp &lt; &quot;2012-04-23T18:30:43.511Z&quot;` * Example 2: `timestamp &gt; &quot;2012-04-23T18:25:43.511Z&quot;`
&quot;outputConfig&quot;: { # The output configuration setting. # Required. The output location of the data.
&quot;bigqueryDestination&quot;: { # The BigQuery output destination configuration. # The BigQuery location where the output is to be written to.
&quot;datasetId&quot;: &quot;A String&quot;, # Required. The ID of a BigQuery Dataset.
&quot;tableIdPrefix&quot;: &quot;A String&quot;, # Required. The prefix of exported BigQuery tables.
&quot;tableType&quot;: &quot;A String&quot;, # Required. Describes the table type. The following values are supported: * `table`: A BigQuery native table. * `view`: A virtual table defined by a SQL query.
},
&quot;gcsDestination&quot;: { # The Google Cloud Storage output destination configuration. # The Google Cloud Storage location where the output is to be written to.
&quot;outputUriPrefix&quot;: &quot;A String&quot;, # Required. The output uri prefix for saving output data to json files. Some mapping examples are as follows: output_uri_prefix sample output(assuming the object is foo.json) ======================== ============================================= gs://bucket/ gs://bucket/foo.json gs://bucket/folder/ gs://bucket/folder/foo.json gs://bucket/folder/item_ gs://bucket/folder/item_foo.json
},
},
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
&quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
&quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
&quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
&quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
&quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
&quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>

<div class="method">
<code class="details" id="getAttributesConfig">getAttributesConfig(name, x__xgafv=None)</code>
<pre>Gets an AttributesConfig.
Expand Down
2 changes: 1 addition & 1 deletion docs/dyn/retail_v2.projects.locations.catalogs.models.html
Expand Up @@ -72,7 +72,7 @@

</style>

<h1><a href="retail_v2.html">Retail API</a> . <a href="retail_v2.projects.html">projects</a> . <a href="retail_v2.projects.locations.html">locations</a> . <a href="retail_v2.projects.locations.catalogs.html">catalogs</a> . <a href="retail_v2.projects.locations.catalogs.models.html">models</a></h1>
<h1><a href="retail_v2.html">Vertex AI Search for Retail API</a> . <a href="retail_v2.projects.html">projects</a> . <a href="retail_v2.projects.locations.html">locations</a> . <a href="retail_v2.projects.locations.catalogs.html">catalogs</a> . <a href="retail_v2.projects.locations.catalogs.models.html">models</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
Expand Down
Expand Up @@ -72,7 +72,7 @@

</style>

<h1><a href="retail_v2.html">Retail API</a> . <a href="retail_v2.projects.html">projects</a> . <a href="retail_v2.projects.locations.html">locations</a> . <a href="retail_v2.projects.locations.catalogs.html">catalogs</a> . <a href="retail_v2.projects.locations.catalogs.operations.html">operations</a></h1>
<h1><a href="retail_v2.html">Vertex AI Search for Retail API</a> . <a href="retail_v2.projects.html">projects</a> . <a href="retail_v2.projects.locations.html">locations</a> . <a href="retail_v2.projects.locations.catalogs.html">catalogs</a> . <a href="retail_v2.projects.locations.catalogs.operations.html">operations</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
Expand Down
Expand Up @@ -72,7 +72,7 @@

</style>

<h1><a href="retail_v2.html">Retail API</a> . <a href="retail_v2.projects.html">projects</a> . <a href="retail_v2.projects.locations.html">locations</a> . <a href="retail_v2.projects.locations.catalogs.html">catalogs</a> . <a href="retail_v2.projects.locations.catalogs.placements.html">placements</a></h1>
<h1><a href="retail_v2.html">Vertex AI Search for Retail API</a> . <a href="retail_v2.projects.html">projects</a> . <a href="retail_v2.projects.locations.html">locations</a> . <a href="retail_v2.projects.locations.catalogs.html">catalogs</a> . <a href="retail_v2.projects.locations.catalogs.placements.html">placements</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
Expand Down
Expand Up @@ -72,7 +72,7 @@

</style>

<h1><a href="retail_v2.html">Retail API</a> . <a href="retail_v2.projects.html">projects</a> . <a href="retail_v2.projects.locations.html">locations</a> . <a href="retail_v2.projects.locations.catalogs.html">catalogs</a> . <a href="retail_v2.projects.locations.catalogs.servingConfigs.html">servingConfigs</a></h1>
<h1><a href="retail_v2.html">Vertex AI Search for Retail API</a> . <a href="retail_v2.projects.html">projects</a> . <a href="retail_v2.projects.locations.html">locations</a> . <a href="retail_v2.projects.locations.catalogs.html">catalogs</a> . <a href="retail_v2.projects.locations.catalogs.servingConfigs.html">servingConfigs</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#addControl">addControl(servingConfig, body=None, x__xgafv=None)</a></code></p>
Expand Down
Expand Up @@ -72,7 +72,7 @@

</style>

<h1><a href="retail_v2.html">Retail API</a> . <a href="retail_v2.projects.html">projects</a> . <a href="retail_v2.projects.locations.html">locations</a> . <a href="retail_v2.projects.locations.catalogs.html">catalogs</a> . <a href="retail_v2.projects.locations.catalogs.userEvents.html">userEvents</a></h1>
<h1><a href="retail_v2.html">Vertex AI Search for Retail API</a> . <a href="retail_v2.projects.html">projects</a> . <a href="retail_v2.projects.locations.html">locations</a> . <a href="retail_v2.projects.locations.catalogs.html">catalogs</a> . <a href="retail_v2.projects.locations.catalogs.userEvents.html">userEvents</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/dyn/retail_v2.projects.locations.html
Expand Up @@ -72,7 +72,7 @@

</style>

<h1><a href="retail_v2.html">Retail API</a> . <a href="retail_v2.projects.html">projects</a> . <a href="retail_v2.projects.locations.html">locations</a></h1>
<h1><a href="retail_v2.html">Vertex AI Search for Retail API</a> . <a href="retail_v2.projects.html">projects</a> . <a href="retail_v2.projects.locations.html">locations</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="retail_v2.projects.locations.catalogs.html">catalogs()</a></code>
Expand Down
2 changes: 1 addition & 1 deletion docs/dyn/retail_v2.projects.locations.operations.html
Expand Up @@ -72,7 +72,7 @@

</style>

<h1><a href="retail_v2.html">Retail API</a> . <a href="retail_v2.projects.html">projects</a> . <a href="retail_v2.projects.locations.html">locations</a> . <a href="retail_v2.projects.locations.operations.html">operations</a></h1>
<h1><a href="retail_v2.html">Vertex AI Search for Retail API</a> . <a href="retail_v2.projects.html">projects</a> . <a href="retail_v2.projects.locations.html">locations</a> . <a href="retail_v2.projects.locations.operations.html">operations</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/dyn/retail_v2.projects.operations.html
Expand Up @@ -72,7 +72,7 @@

</style>

<h1><a href="retail_v2.html">Retail API</a> . <a href="retail_v2.projects.html">projects</a> . <a href="retail_v2.projects.operations.html">operations</a></h1>
<h1><a href="retail_v2.html">Vertex AI Search for Retail API</a> . <a href="retail_v2.projects.html">projects</a> . <a href="retail_v2.projects.operations.html">operations</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
Expand Down
2 changes: 1 addition & 1 deletion docs/dyn/retail_v2alpha.html
Expand Up @@ -72,7 +72,7 @@

</style>

<h1><a href="retail_v2alpha.html">Retail API</a></h1>
<h1><a href="retail_v2alpha.html">Vertex AI Search for Retail API</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="retail_v2alpha.projects.html">projects()</a></code>
Expand Down
2 changes: 1 addition & 1 deletion docs/dyn/retail_v2alpha.projects.html
Expand Up @@ -72,7 +72,7 @@

</style>

<h1><a href="retail_v2alpha.html">Retail API</a> . <a href="retail_v2alpha.projects.html">projects</a></h1>
<h1><a href="retail_v2alpha.html">Vertex AI Search for Retail API</a> . <a href="retail_v2alpha.projects.html">projects</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="retail_v2alpha.projects.locations.html">locations()</a></code>
Expand Down
Expand Up @@ -72,7 +72,7 @@

</style>

<h1><a href="retail_v2alpha.html">Retail API</a> . <a href="retail_v2alpha.projects.html">projects</a> . <a href="retail_v2alpha.projects.locations.html">locations</a> . <a href="retail_v2alpha.projects.locations.catalogs.html">catalogs</a> . <a href="retail_v2alpha.projects.locations.catalogs.attributesConfig.html">attributesConfig</a></h1>
<h1><a href="retail_v2alpha.html">Vertex AI Search for Retail API</a> . <a href="retail_v2alpha.projects.html">projects</a> . <a href="retail_v2alpha.projects.locations.html">locations</a> . <a href="retail_v2alpha.projects.locations.catalogs.html">catalogs</a> . <a href="retail_v2alpha.projects.locations.catalogs.attributesConfig.html">attributesConfig</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#addCatalogAttribute">addCatalogAttribute(attributesConfig, body=None, x__xgafv=None)</a></code></p>
Expand Down

0 comments on commit 88b499c

Please sign in to comment.