Skip to content

Commit d20e0ce

Browse files
feat(retail): update the api
#### retail:v2 The following keys were added: - schemas.GoogleCloudRetailV2CompleteQueryResponse.properties.attributeResults (Total Keys: 2) - schemas.GoogleCloudRetailV2CompleteQueryResponseAttributeResult (Total Keys: 4) #### retail:v2alpha The following keys were added: - resources.projects.resources.locations.resources.catalogs.resources.branches.resources.products.methods.export (Total Keys: 12) - schemas.GoogleCloudRetailV2alphaExportProductsRequest (Total Keys: 4) #### retail:v2beta The following keys were added: - resources.projects.methods.getAlertConfig (Total Keys: 11) - resources.projects.methods.updateAlertConfig (Total Keys: 15) - resources.projects.resources.locations.resources.catalogs.resources.branches.resources.products.methods.export (Total Keys: 12) - schemas.GoogleCloudRetailV2betaAlertConfig (Total Keys: 14) - schemas.GoogleCloudRetailV2betaCompleteQueryResponse.properties.attributeResults (Total Keys: 2) - schemas.GoogleCloudRetailV2betaCompleteQueryResponseAttributeResult (Total Keys: 4) - schemas.GoogleCloudRetailV2betaExportProductsRequest (Total Keys: 4)
1 parent ec3d352 commit d20e0ce

10 files changed

+465
-9
lines changed

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

+7
Original file line numberDiff line numberDiff line change
@@ -184,6 +184,13 @@ <h3>Method Details</h3>
184184
An object of the form:
185185

186186
{ # Response of the autocomplete query.
187+
&quot;attributeResults&quot;: { # A map of matched attribute suggestions. This field is only available for &quot;cloud-retail&quot; dataset. Current supported keys: * `brands` * `categories`
188+
&quot;a_key&quot;: { # Resource that represents attribute results.
189+
&quot;suggestions&quot;: [
190+
&quot;A String&quot;,
191+
],
192+
},
193+
},
187194
&quot;attributionToken&quot;: &quot;A String&quot;, # A unique complete token. This should be included in the UserEvent.completion_detail for search events resulting from this completion, which enables accurate attribution of complete model performance.
188195
&quot;completionResults&quot;: [ # Results of the matching suggestions. The result list is ordered and the first result is top suggestion.
189196
{ # Resource that represents completion results.

docs/dyn/retail_v2alpha.projects.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ <h3>Method Details</h3>
178178
{ # Project level alert config.
179179
&quot;alertPolicies&quot;: [ # Alert policies for a customer. They must be unique by [AlertPolicy.alert_group]
180180
{ # Alert policy for a customer.
181-
&quot;alertGroup&quot;: &quot;A String&quot;, # The feature that provides alerting capability. Supported value is only `search-data-quality` for now.
181+
&quot;alertGroup&quot;: &quot;A String&quot;, # The feature that provides alerting capability. Supported value: - `search-data-quality` for retail search customers. - `conv-data-quality` for retail conversation customers.
182182
&quot;enrollStatus&quot;: &quot;A String&quot;, # The enrollment status of a customer.
183183
&quot;recipients&quot;: [ # Recipients for the alert policy. One alert policy should not exceed 20 recipients.
184184
{ # Recipient contact information.
@@ -278,7 +278,7 @@ <h3>Method Details</h3>
278278
{ # Project level alert config.
279279
&quot;alertPolicies&quot;: [ # Alert policies for a customer. They must be unique by [AlertPolicy.alert_group]
280280
{ # Alert policy for a customer.
281-
&quot;alertGroup&quot;: &quot;A String&quot;, # The feature that provides alerting capability. Supported value is only `search-data-quality` for now.
281+
&quot;alertGroup&quot;: &quot;A String&quot;, # The feature that provides alerting capability. Supported value: - `search-data-quality` for retail search customers. - `conv-data-quality` for retail conversation customers.
282282
&quot;enrollStatus&quot;: &quot;A String&quot;, # The enrollment status of a customer.
283283
&quot;recipients&quot;: [ # Recipients for the alert policy. One alert policy should not exceed 20 recipients.
284284
{ # Recipient contact information.
@@ -302,7 +302,7 @@ <h3>Method Details</h3>
302302
{ # Project level alert config.
303303
&quot;alertPolicies&quot;: [ # Alert policies for a customer. They must be unique by [AlertPolicy.alert_group]
304304
{ # Alert policy for a customer.
305-
&quot;alertGroup&quot;: &quot;A String&quot;, # The feature that provides alerting capability. Supported value is only `search-data-quality` for now.
305+
&quot;alertGroup&quot;: &quot;A String&quot;, # The feature that provides alerting capability. Supported value: - `search-data-quality` for retail search customers. - `conv-data-quality` for retail conversation customers.
306306
&quot;enrollStatus&quot;: &quot;A String&quot;, # The enrollment status of a customer.
307307
&quot;recipients&quot;: [ # Recipients for the alert policy. One alert policy should not exceed 20 recipients.
308308
{ # Recipient contact information.

docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.products.html

+55
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,9 @@ <h2>Instance Methods</h2>
8989
<p class="toc_element">
9090
<code><a href="#delete">delete(name, force=None, x__xgafv=None)</a></code></p>
9191
<p class="firstline">Deletes a Product.</p>
92+
<p class="toc_element">
93+
<code><a href="#export">export(parent, body=None, x__xgafv=None)</a></code></p>
94+
<p class="firstline">Exports multiple Products.</p>
9295
<p class="toc_element">
9396
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
9497
<p class="firstline">Gets a Product.</p>
@@ -623,6 +626,58 @@ <h3>Method Details</h3>
623626
}</pre>
624627
</div>
625628

629+
<div class="method">
630+
<code class="details" id="export">export(parent, body=None, x__xgafv=None)</code>
631+
<pre>Exports multiple Products.
632+
633+
Args:
634+
parent: string, Required. Resource name of a Branch, and `default_branch` for branch_id component is supported. For example `projects/1234/locations/global/catalogs/default_catalog/branches/default_branch` (required)
635+
body: object, The request body.
636+
The object takes the form of:
637+
638+
{ # Request message for ExportProducts method.
639+
&quot;filter&quot;: &quot;A String&quot;, # A filtering expression to specify restrictions on returned events. The expression is a sequence of terms. Each term applies a restriction to the returned products. Use this expression to restrict results to a specific time range, tag, or stock state or to filter products by product type. For example, `lastModifiedTime &gt; &quot;2012-04-23T18:25:43.511Z&quot; lastModifiedTime&lt;&quot;2012-04-23T18:25:43.511Z&quot; productType=primary` We expect only four types of fields: * `lastModifiedTime`: This can be specified twice, once with a less than operator and once with a greater than operator. The `lastModifiedTime` restriction should result in one, contiguous, valid, last-modified, time range. * `productType`: Supported values are `primary` and `variant`. The Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and must be separated from the `productType` values by a space. * `availability`: Supported values are `IN_STOCK`, `OUT_OF_STOCK`, `PREORDER`, and `BACKORDER`. Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and must be separated from the `availability` values by a space. * `Tag expressions`: Restricts output to products that match all of the specified tags. Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and the operators are separated from the tag values by a space. Also supported is &#x27;`-&quot;tagA&quot;`&#x27;, which is equivalent to &#x27;`NOT &quot;tagA&quot;`&#x27;. Tag values must be double-quoted, UTF-8 encoded strings and have a size limit of 1,000 characters. Some examples of valid filters expressions: * Example 1: `lastModifiedTime &gt; &quot;2012-04-23T18:25:43.511Z&quot; lastModifiedTime &lt; &quot;2012-04-23T18:30:43.511Z&quot;` * Example 2: `lastModifiedTime &gt; &quot;2012-04-23T18:25:43.511Z&quot; productType = &quot;variant&quot;` * Example 3: `tag=(&quot;Red&quot; OR &quot;Blue&quot;) tag=&quot;New-Arrival&quot; tag=(NOT &quot;promotional&quot;) productType = &quot;primary&quot; lastModifiedTime &lt; &quot;2018-04-23T18:30:43.511Z&quot;` * Example 4: `lastModifiedTime &gt; &quot;2012-04-23T18:25:43.511Z&quot;` * Example 5: `availability = (IN_STOCK OR BACKORDER)`
640+
&quot;outputConfig&quot;: { # The output configuration setting. # Required. The output location of the data.
641+
&quot;bigqueryDestination&quot;: { # The BigQuery output destination configuration. # The BigQuery location where the output is to be written to.
642+
&quot;datasetId&quot;: &quot;A String&quot;, # Required. The ID of a BigQuery Dataset.
643+
&quot;tableIdPrefix&quot;: &quot;A String&quot;, # Required. The prefix of exported BigQuery tables.
644+
&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.
645+
},
646+
&quot;gcsDestination&quot;: { # The Google Cloud Storage output destination configuration. # The Google Cloud Storage location where the output is to be written to.
647+
&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
648+
},
649+
},
650+
}
651+
652+
x__xgafv: string, V1 error format.
653+
Allowed values
654+
1 - v1 error format
655+
2 - v2 error format
656+
657+
Returns:
658+
An object of the form:
659+
660+
{ # This resource represents a long-running operation that is the result of a network API call.
661+
&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.
662+
&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.
663+
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
664+
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
665+
{
666+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
667+
},
668+
],
669+
&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.
670+
},
671+
&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.
672+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
673+
},
674+
&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}`.
675+
&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`.
676+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
677+
},
678+
}</pre>
679+
</div>
680+
626681
<div class="method">
627682
<code class="details" id="get">get(name, x__xgafv=None)</code>
628683
<pre>Gets a Product.

docs/dyn/retail_v2alpha.projects.locations.catalogs.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ <h3>Method Details</h3>
191191
{ # Response of the autocomplete query.
192192
&quot;attributeResults&quot;: { # A map of matched attribute suggestions. This field is only available for &quot;cloud-retail&quot; dataset. Current supported keys: * `brands` * `categories`
193193
&quot;a_key&quot;: { # Resource that represents attribute results.
194-
&quot;suggestions&quot;: [ # The list of suggestions for the attribute.
194+
&quot;suggestions&quot;: [
195195
&quot;A String&quot;,
196196
],
197197
},

docs/dyn/retail_v2beta.projects.html

+85
Original file line numberDiff line numberDiff line change
@@ -87,10 +87,95 @@ <h2>Instance Methods</h2>
8787
<p class="toc_element">
8888
<code><a href="#close">close()</a></code></p>
8989
<p class="firstline">Close httplib2 connections.</p>
90+
<p class="toc_element">
91+
<code><a href="#getAlertConfig">getAlertConfig(name, x__xgafv=None)</a></code></p>
92+
<p class="firstline">Get the AlertConfig of the requested project.</p>
93+
<p class="toc_element">
94+
<code><a href="#updateAlertConfig">updateAlertConfig(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
95+
<p class="firstline">Update the alert config of the requested project.</p>
9096
<h3>Method Details</h3>
9197
<div class="method">
9298
<code class="details" id="close">close()</code>
9399
<pre>Close httplib2 connections.</pre>
94100
</div>
95101

102+
<div class="method">
103+
<code class="details" id="getAlertConfig">getAlertConfig(name, x__xgafv=None)</code>
104+
<pre>Get the AlertConfig of the requested project.
105+
106+
Args:
107+
name: string, Required. Full AlertConfig resource name. Format: projects/{project_number}/alertConfig (required)
108+
x__xgafv: string, V1 error format.
109+
Allowed values
110+
1 - v1 error format
111+
2 - v2 error format
112+
113+
Returns:
114+
An object of the form:
115+
116+
{ # Project level alert config.
117+
&quot;alertPolicies&quot;: [ # Alert policies for a customer. They must be unique by [AlertPolicy.alert_group]
118+
{ # Alert policy for a customer.
119+
&quot;alertGroup&quot;: &quot;A String&quot;, # The feature that provides alerting capability. Supported value: - `search-data-quality` for retail search customers. - `conv-data-quality` for retail conversation customers.
120+
&quot;enrollStatus&quot;: &quot;A String&quot;, # The enrollment status of a customer.
121+
&quot;recipients&quot;: [ # Recipients for the alert policy. One alert policy should not exceed 20 recipients.
122+
{ # Recipient contact information.
123+
&quot;emailAddress&quot;: &quot;A String&quot;, # Email address of the recipient.
124+
},
125+
],
126+
},
127+
],
128+
&quot;name&quot;: &quot;A String&quot;, # Required. Immutable. The name of the AlertConfig singleton resource. Format: projects/*/alertConfig
129+
}</pre>
130+
</div>
131+
132+
<div class="method">
133+
<code class="details" id="updateAlertConfig">updateAlertConfig(name, body=None, updateMask=None, x__xgafv=None)</code>
134+
<pre>Update the alert config of the requested project.
135+
136+
Args:
137+
name: string, Required. Immutable. The name of the AlertConfig singleton resource. Format: projects/*/alertConfig (required)
138+
body: object, The request body.
139+
The object takes the form of:
140+
141+
{ # Project level alert config.
142+
&quot;alertPolicies&quot;: [ # Alert policies for a customer. They must be unique by [AlertPolicy.alert_group]
143+
{ # Alert policy for a customer.
144+
&quot;alertGroup&quot;: &quot;A String&quot;, # The feature that provides alerting capability. Supported value: - `search-data-quality` for retail search customers. - `conv-data-quality` for retail conversation customers.
145+
&quot;enrollStatus&quot;: &quot;A String&quot;, # The enrollment status of a customer.
146+
&quot;recipients&quot;: [ # Recipients for the alert policy. One alert policy should not exceed 20 recipients.
147+
{ # Recipient contact information.
148+
&quot;emailAddress&quot;: &quot;A String&quot;, # Email address of the recipient.
149+
},
150+
],
151+
},
152+
],
153+
&quot;name&quot;: &quot;A String&quot;, # Required. Immutable. The name of the AlertConfig singleton resource. Format: projects/*/alertConfig
154+
}
155+
156+
updateMask: string, Indicates which fields in the provided AlertConfig to update. If not set, all supported fields are updated.
157+
x__xgafv: string, V1 error format.
158+
Allowed values
159+
1 - v1 error format
160+
2 - v2 error format
161+
162+
Returns:
163+
An object of the form:
164+
165+
{ # Project level alert config.
166+
&quot;alertPolicies&quot;: [ # Alert policies for a customer. They must be unique by [AlertPolicy.alert_group]
167+
{ # Alert policy for a customer.
168+
&quot;alertGroup&quot;: &quot;A String&quot;, # The feature that provides alerting capability. Supported value: - `search-data-quality` for retail search customers. - `conv-data-quality` for retail conversation customers.
169+
&quot;enrollStatus&quot;: &quot;A String&quot;, # The enrollment status of a customer.
170+
&quot;recipients&quot;: [ # Recipients for the alert policy. One alert policy should not exceed 20 recipients.
171+
{ # Recipient contact information.
172+
&quot;emailAddress&quot;: &quot;A String&quot;, # Email address of the recipient.
173+
},
174+
],
175+
},
176+
],
177+
&quot;name&quot;: &quot;A String&quot;, # Required. Immutable. The name of the AlertConfig singleton resource. Format: projects/*/alertConfig
178+
}</pre>
179+
</div>
180+
96181
</body></html>

0 commit comments

Comments
 (0)