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)
googleapis · Jan 23, 2024 · 6dc53af · 6dc53af
1 parent 4490a59
commit 6dc53af
Show file tree

Hide file tree

Showing 4 changed files with 212 additions and 3 deletions.
diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.html
@@ -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>
@@ -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.

diff --git a/googleapiclient/discovery_cache/documents/retail.v2.json b/googleapiclient/discovery_cache/documents/retail.v2.json
@@ -2059,7 +2059,7 @@
 }
 }
 },
-"revision": "20240109",
+"revision": "20240118",
 "rootUrl": "https://retail.googleapis.com/",
 "schemas": {
 "GoogleApiHttpBody": {
@@ -6328,6 +6328,28 @@
 },
 "type": "object"
 },
+"GoogleCloudRetailV2betaExportAnalyticsMetricsResponse": {
+"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.",
+"id": "GoogleCloudRetailV2betaExportAnalyticsMetricsResponse",
+"properties": {
+"errorSamples": {
+"description": "A sample of errors encountered while processing the request.",
+"items": {
+"$ref": "GoogleRpcStatus"
+},
+"type": "array"
+},
+"errorsConfig": {
+"$ref": "GoogleCloudRetailV2betaExportErrorsConfig",
+"description": "This field is never set."
+},
+"outputResult": {
+"$ref": "GoogleCloudRetailV2betaOutputResult",
+"description": "Output result indicating where the data were exported to."
+}
+},
+"type": "object"
+},
 "GoogleCloudRetailV2betaExportErrorsConfig": {
 "description": "Configuration of destination for Export related errors.",
 "id": "GoogleCloudRetailV2betaExportErrorsConfig",

diff --git a/googleapiclient/discovery_cache/documents/retail.v2alpha.json b/googleapiclient/discovery_cache/documents/retail.v2alpha.json
@@ -2416,7 +2416,7 @@
 }
 }
 },
-"revision": "20240109",
+"revision": "20240118",
 "rootUrl": "https://retail.googleapis.com/",
 "schemas": {
 "GoogleApiHttpBody": {
@@ -7093,6 +7093,28 @@
 },
 "type": "object"
 },
+"GoogleCloudRetailV2betaExportAnalyticsMetricsResponse": {
+"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.",
+"id": "GoogleCloudRetailV2betaExportAnalyticsMetricsResponse",
+"properties": {
+"errorSamples": {
+"description": "A sample of errors encountered while processing the request.",
+"items": {
+"$ref": "GoogleRpcStatus"
+},
+"type": "array"
+},
+"errorsConfig": {
+"$ref": "GoogleCloudRetailV2betaExportErrorsConfig",
+"description": "This field is never set."
+},
+"outputResult": {
+"$ref": "GoogleCloudRetailV2betaOutputResult",
+"description": "Output result indicating where the data were exported to."
+}
+},
+"type": "object"
+},
 "GoogleCloudRetailV2betaExportErrorsConfig": {
 "description": "Configuration of destination for Export related errors.",
 "id": "GoogleCloudRetailV2betaExportErrorsConfig",

diff --git a/googleapiclient/discovery_cache/documents/retail.v2beta.json b/googleapiclient/discovery_cache/documents/retail.v2beta.json
@@ -173,6 +173,34 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"exportAnalyticsMetrics": {
+"description": "Exports analytics metrics. `Operation.response` is of type `ExportAnalyticsMetricsResponse`. `Operation.metadata` is of type `ExportMetadata`.",
+"flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}:exportAnalyticsMetrics",
+"httpMethod": "POST",
+"id": "retail.projects.locations.catalogs.exportAnalyticsMetrics",
+"parameterOrder": [
+"catalog"
+],
+"parameters": {
+"catalog": {
+"description": "Required. Full resource name of the parent catalog. Expected format: `projects/*/locations/*/catalogs/*`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v2beta/{+catalog}:exportAnalyticsMetrics",
+"request": {
+"$ref": "GoogleCloudRetailV2betaExportAnalyticsMetricsRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "getAttributesConfig": {
 "description": "Gets an AttributesConfig.",
 "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/attributesConfig",
@@ -2087,7 +2115,7 @@
 }
 }
 },
-"revision": "20240109",
+"revision": "20240118",
 "rootUrl": "https://retail.googleapis.com/",
 "schemas": {
 "GoogleApiHttpBody": {
@@ -4391,6 +4419,43 @@
 },
 "type": "object"
 },
+"GoogleCloudRetailV2betaExportAnalyticsMetricsRequest": {
+"description": "Request message for the `ExportAnalyticsMetrics` method.",
+"id": "GoogleCloudRetailV2betaExportAnalyticsMetricsRequest",
+"properties": {
+"filter": {
+"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\"`",
+"type": "string"
+},
+"outputConfig": {
+"$ref": "GoogleCloudRetailV2betaOutputConfig",
+"description": "Required. The output location of the data."
+}
+},
+"type": "object"
+},
+"GoogleCloudRetailV2betaExportAnalyticsMetricsResponse": {
+"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.",
+"id": "GoogleCloudRetailV2betaExportAnalyticsMetricsResponse",
+"properties": {
+"errorSamples": {
+"description": "A sample of errors encountered while processing the request.",
+"items": {
+"$ref": "GoogleRpcStatus"
+},
+"type": "array"
+},
+"errorsConfig": {
+"$ref": "GoogleCloudRetailV2betaExportErrorsConfig",
+"description": "This field is never set."
+},
+"outputResult": {
+"$ref": "GoogleCloudRetailV2betaOutputResult",
+"description": "Output result indicating where the data were exported to."
+}
+},
+"type": "object"
+},
 "GoogleCloudRetailV2betaExportErrorsConfig": {
 "description": "Configuration of destination for Export related errors.",
 "id": "GoogleCloudRetailV2betaExportErrorsConfig",
@@ -5202,6 +5267,51 @@
 },
 "type": "object"
 },
+"GoogleCloudRetailV2betaOutputConfig": {
+"description": "The output configuration setting.",
+"id": "GoogleCloudRetailV2betaOutputConfig",
+"properties": {
+"bigqueryDestination": {
+"$ref": "GoogleCloudRetailV2betaOutputConfigBigQueryDestination",
+"description": "The BigQuery location where the output is to be written to."
+},
+"gcsDestination": {
+"$ref": "GoogleCloudRetailV2betaOutputConfigGcsDestination",
+"description": "The Google Cloud Storage location where the output is to be written to."
+}
+},
+"type": "object"
+},
+"GoogleCloudRetailV2betaOutputConfigBigQueryDestination": {
+"description": "The BigQuery output destination configuration.",
+"id": "GoogleCloudRetailV2betaOutputConfigBigQueryDestination",
+"properties": {
+"datasetId": {
+"description": "Required. The ID of a BigQuery Dataset.",
+"type": "string"
+},
+"tableIdPrefix": {
+"description": "Required. The prefix of exported BigQuery tables.",
+"type": "string"
+},
+"tableType": {
+"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.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudRetailV2betaOutputConfigGcsDestination": {
+"description": "The Google Cloud Storage output destination configuration.",
+"id": "GoogleCloudRetailV2betaOutputConfigGcsDestination",
+"properties": {
+"outputUriPrefix": {
+"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",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudRetailV2betaOutputResult": {
 "description": "Output result that stores the information about where the exported data is stored.",
 "id": "GoogleCloudRetailV2betaOutputResult",