Skip to content

Commit 6dc53af

Browse files
feat(retail): update the api
#### retail:v2 The following keys were added: - schemas.GoogleCloudRetailV2betaExportAnalyticsMetricsResponse (Total Keys: 6) #### retail:v2alpha The following keys were added: - schemas.GoogleCloudRetailV2betaExportAnalyticsMetricsResponse (Total Keys: 6) #### retail:v2beta The following keys were added: - resources.projects.resources.locations.resources.catalogs.methods.exportAnalyticsMetrics (Total Keys: 12) - schemas.GoogleCloudRetailV2betaExportAnalyticsMetricsRequest (Total Keys: 4) - schemas.GoogleCloudRetailV2betaExportAnalyticsMetricsResponse (Total Keys: 6) - schemas.GoogleCloudRetailV2betaOutputConfig (Total Keys: 12)
1 parent 4490a59 commit 6dc53af

File tree

4 files changed

+212
-3
lines changed

4 files changed

+212
-3
lines changed

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

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,9 @@ <h2>Instance Methods</h2>
125125
<p class="toc_element">
126126
<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>
127127
<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>
128+
<p class="toc_element">
129+
<code><a href="#exportAnalyticsMetrics">exportAnalyticsMetrics(catalog, body=None, x__xgafv=None)</a></code></p>
130+
<p class="firstline">Exports analytics metrics. `Operation.response` is of type `ExportAnalyticsMetricsResponse`. `Operation.metadata` is of type `ExportMetadata`.</p>
128131
<p class="toc_element">
129132
<code><a href="#getAttributesConfig">getAttributesConfig(name, x__xgafv=None)</a></code></p>
130133
<p class="firstline">Gets an AttributesConfig.</p>
@@ -206,6 +209,58 @@ <h3>Method Details</h3>
206209
}</pre>
207210
</div>
208211

212+
<div class="method">
213+
<code class="details" id="exportAnalyticsMetrics">exportAnalyticsMetrics(catalog, body=None, x__xgafv=None)</code>
214+
<pre>Exports analytics metrics. `Operation.response` is of type `ExportAnalyticsMetricsResponse`. `Operation.metadata` is of type `ExportMetadata`.
215+
216+
Args:
217+
catalog: string, Required. Full resource name of the parent catalog. Expected format: `projects/*/locations/*/catalogs/*` (required)
218+
body: object, The request body.
219+
The object takes the form of:
220+
221+
{ # Request message for the `ExportAnalyticsMetrics` method.
222+
&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;`
223+
&quot;outputConfig&quot;: { # The output configuration setting. # Required. The output location of the data.
224+
&quot;bigqueryDestination&quot;: { # The BigQuery output destination configuration. # The BigQuery location where the output is to be written to.
225+
&quot;datasetId&quot;: &quot;A String&quot;, # Required. The ID of a BigQuery Dataset.
226+
&quot;tableIdPrefix&quot;: &quot;A String&quot;, # Required. The prefix of exported BigQuery tables.
227+
&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.
228+
},
229+
&quot;gcsDestination&quot;: { # The Google Cloud Storage output destination configuration. # The Google Cloud Storage location where the output is to be written to.
230+
&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
231+
},
232+
},
233+
}
234+
235+
x__xgafv: string, V1 error format.
236+
Allowed values
237+
1 - v1 error format
238+
2 - v2 error format
239+
240+
Returns:
241+
An object of the form:
242+
243+
{ # This resource represents a long-running operation that is the result of a network API call.
244+
&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.
245+
&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.
246+
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
247+
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
248+
{
249+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
250+
},
251+
],
252+
&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.
253+
},
254+
&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.
255+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
256+
},
257+
&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}`.
258+
&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`.
259+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
260+
},
261+
}</pre>
262+
</div>
263+
209264
<div class="method">
210265
<code class="details" id="getAttributesConfig">getAttributesConfig(name, x__xgafv=None)</code>
211266
<pre>Gets an AttributesConfig.

googleapiclient/discovery_cache/documents/retail.v2.json

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2059,7 +2059,7 @@
20592059
}
20602060
}
20612061
},
2062-
"revision": "20240109",
2062+
"revision": "20240118",
20632063
"rootUrl": "https://retail.googleapis.com/",
20642064
"schemas": {
20652065
"GoogleApiHttpBody": {
@@ -6328,6 +6328,28 @@
63286328
},
63296329
"type": "object"
63306330
},
6331+
"GoogleCloudRetailV2betaExportAnalyticsMetricsResponse": {
6332+
"description": "Response of the ExportAnalyticsMetricsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.",
6333+
"id": "GoogleCloudRetailV2betaExportAnalyticsMetricsResponse",
6334+
"properties": {
6335+
"errorSamples": {
6336+
"description": "A sample of errors encountered while processing the request.",
6337+
"items": {
6338+
"$ref": "GoogleRpcStatus"
6339+
},
6340+
"type": "array"
6341+
},
6342+
"errorsConfig": {
6343+
"$ref": "GoogleCloudRetailV2betaExportErrorsConfig",
6344+
"description": "This field is never set."
6345+
},
6346+
"outputResult": {
6347+
"$ref": "GoogleCloudRetailV2betaOutputResult",
6348+
"description": "Output result indicating where the data were exported to."
6349+
}
6350+
},
6351+
"type": "object"
6352+
},
63316353
"GoogleCloudRetailV2betaExportErrorsConfig": {
63326354
"description": "Configuration of destination for Export related errors.",
63336355
"id": "GoogleCloudRetailV2betaExportErrorsConfig",

googleapiclient/discovery_cache/documents/retail.v2alpha.json

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2416,7 +2416,7 @@
24162416
}
24172417
}
24182418
},
2419-
"revision": "20240109",
2419+
"revision": "20240118",
24202420
"rootUrl": "https://retail.googleapis.com/",
24212421
"schemas": {
24222422
"GoogleApiHttpBody": {
@@ -7093,6 +7093,28 @@
70937093
},
70947094
"type": "object"
70957095
},
7096+
"GoogleCloudRetailV2betaExportAnalyticsMetricsResponse": {
7097+
"description": "Response of the ExportAnalyticsMetricsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.",
7098+
"id": "GoogleCloudRetailV2betaExportAnalyticsMetricsResponse",
7099+
"properties": {
7100+
"errorSamples": {
7101+
"description": "A sample of errors encountered while processing the request.",
7102+
"items": {
7103+
"$ref": "GoogleRpcStatus"
7104+
},
7105+
"type": "array"
7106+
},
7107+
"errorsConfig": {
7108+
"$ref": "GoogleCloudRetailV2betaExportErrorsConfig",
7109+
"description": "This field is never set."
7110+
},
7111+
"outputResult": {
7112+
"$ref": "GoogleCloudRetailV2betaOutputResult",
7113+
"description": "Output result indicating where the data were exported to."
7114+
}
7115+
},
7116+
"type": "object"
7117+
},
70967118
"GoogleCloudRetailV2betaExportErrorsConfig": {
70977119
"description": "Configuration of destination for Export related errors.",
70987120
"id": "GoogleCloudRetailV2betaExportErrorsConfig",

googleapiclient/discovery_cache/documents/retail.v2beta.json

Lines changed: 111 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,34 @@
173173
"https://www.googleapis.com/auth/cloud-platform"
174174
]
175175
},
176+
"exportAnalyticsMetrics": {
177+
"description": "Exports analytics metrics. `Operation.response` is of type `ExportAnalyticsMetricsResponse`. `Operation.metadata` is of type `ExportMetadata`.",
178+
"flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}:exportAnalyticsMetrics",
179+
"httpMethod": "POST",
180+
"id": "retail.projects.locations.catalogs.exportAnalyticsMetrics",
181+
"parameterOrder": [
182+
"catalog"
183+
],
184+
"parameters": {
185+
"catalog": {
186+
"description": "Required. Full resource name of the parent catalog. Expected format: `projects/*/locations/*/catalogs/*`",
187+
"location": "path",
188+
"pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$",
189+
"required": true,
190+
"type": "string"
191+
}
192+
},
193+
"path": "v2beta/{+catalog}:exportAnalyticsMetrics",
194+
"request": {
195+
"$ref": "GoogleCloudRetailV2betaExportAnalyticsMetricsRequest"
196+
},
197+
"response": {
198+
"$ref": "GoogleLongrunningOperation"
199+
},
200+
"scopes": [
201+
"https://www.googleapis.com/auth/cloud-platform"
202+
]
203+
},
176204
"getAttributesConfig": {
177205
"description": "Gets an AttributesConfig.",
178206
"flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/attributesConfig",
@@ -2087,7 +2115,7 @@
20872115
}
20882116
}
20892117
},
2090-
"revision": "20240109",
2118+
"revision": "20240118",
20912119
"rootUrl": "https://retail.googleapis.com/",
20922120
"schemas": {
20932121
"GoogleApiHttpBody": {
@@ -4391,6 +4419,43 @@
43914419
},
43924420
"type": "object"
43934421
},
4422+
"GoogleCloudRetailV2betaExportAnalyticsMetricsRequest": {
4423+
"description": "Request message for the `ExportAnalyticsMetrics` method.",
4424+
"id": "GoogleCloudRetailV2betaExportAnalyticsMetricsRequest",
4425+
"properties": {
4426+
"filter": {
4427+
"description": "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 > \"2012-04-23T18:25:43.511Z\" timestamp < \"2012-04-23T18:30:43.511Z\"` * Example 2: `timestamp > \"2012-04-23T18:25:43.511Z\"`",
4428+
"type": "string"
4429+
},
4430+
"outputConfig": {
4431+
"$ref": "GoogleCloudRetailV2betaOutputConfig",
4432+
"description": "Required. The output location of the data."
4433+
}
4434+
},
4435+
"type": "object"
4436+
},
4437+
"GoogleCloudRetailV2betaExportAnalyticsMetricsResponse": {
4438+
"description": "Response of the ExportAnalyticsMetricsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.",
4439+
"id": "GoogleCloudRetailV2betaExportAnalyticsMetricsResponse",
4440+
"properties": {
4441+
"errorSamples": {
4442+
"description": "A sample of errors encountered while processing the request.",
4443+
"items": {
4444+
"$ref": "GoogleRpcStatus"
4445+
},
4446+
"type": "array"
4447+
},
4448+
"errorsConfig": {
4449+
"$ref": "GoogleCloudRetailV2betaExportErrorsConfig",
4450+
"description": "This field is never set."
4451+
},
4452+
"outputResult": {
4453+
"$ref": "GoogleCloudRetailV2betaOutputResult",
4454+
"description": "Output result indicating where the data were exported to."
4455+
}
4456+
},
4457+
"type": "object"
4458+
},
43944459
"GoogleCloudRetailV2betaExportErrorsConfig": {
43954460
"description": "Configuration of destination for Export related errors.",
43964461
"id": "GoogleCloudRetailV2betaExportErrorsConfig",
@@ -5202,6 +5267,51 @@
52025267
},
52035268
"type": "object"
52045269
},
5270+
"GoogleCloudRetailV2betaOutputConfig": {
5271+
"description": "The output configuration setting.",
5272+
"id": "GoogleCloudRetailV2betaOutputConfig",
5273+
"properties": {
5274+
"bigqueryDestination": {
5275+
"$ref": "GoogleCloudRetailV2betaOutputConfigBigQueryDestination",
5276+
"description": "The BigQuery location where the output is to be written to."
5277+
},
5278+
"gcsDestination": {
5279+
"$ref": "GoogleCloudRetailV2betaOutputConfigGcsDestination",
5280+
"description": "The Google Cloud Storage location where the output is to be written to."
5281+
}
5282+
},
5283+
"type": "object"
5284+
},
5285+
"GoogleCloudRetailV2betaOutputConfigBigQueryDestination": {
5286+
"description": "The BigQuery output destination configuration.",
5287+
"id": "GoogleCloudRetailV2betaOutputConfigBigQueryDestination",
5288+
"properties": {
5289+
"datasetId": {
5290+
"description": "Required. The ID of a BigQuery Dataset.",
5291+
"type": "string"
5292+
},
5293+
"tableIdPrefix": {
5294+
"description": "Required. The prefix of exported BigQuery tables.",
5295+
"type": "string"
5296+
},
5297+
"tableType": {
5298+
"description": "Required. Describes the table type. The following values are supported: * `table`: A BigQuery native table. * `view`: A virtual table defined by a SQL query.",
5299+
"type": "string"
5300+
}
5301+
},
5302+
"type": "object"
5303+
},
5304+
"GoogleCloudRetailV2betaOutputConfigGcsDestination": {
5305+
"description": "The Google Cloud Storage output destination configuration.",
5306+
"id": "GoogleCloudRetailV2betaOutputConfigGcsDestination",
5307+
"properties": {
5308+
"outputUriPrefix": {
5309+
"description": "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",
5310+
"type": "string"
5311+
}
5312+
},
5313+
"type": "object"
5314+
},
52055315
"GoogleCloudRetailV2betaOutputResult": {
52065316
"description": "Output result that stores the information about where the exported data is stored.",
52075317
"id": "GoogleCloudRetailV2betaOutputResult",

0 commit comments

Comments
 (0)