From 88b499c1561560120b746f9e966904974f6e5693 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 13 Feb 2024 07:08:41 +0000 Subject: [PATCH] feat(retail): update the api #### 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) --- docs/dyn/retail_v2.html | 2 +- docs/dyn/retail_v2.projects.html | 2 +- ...s.locations.catalogs.attributesConfig.html | 2 +- ....projects.locations.catalogs.branches.html | 2 +- ...ocations.catalogs.branches.operations.html | 2 +- ....locations.catalogs.branches.products.html | 2 +- ...cts.locations.catalogs.completionData.html | 2 +- ....projects.locations.catalogs.controls.html | 2 +- ...retail_v2.projects.locations.catalogs.html | 57 +++++- ...v2.projects.locations.catalogs.models.html | 2 +- ...rojects.locations.catalogs.operations.html | 2 +- ...rojects.locations.catalogs.placements.html | 2 +- ...cts.locations.catalogs.servingConfigs.html | 2 +- ...rojects.locations.catalogs.userEvents.html | 2 +- docs/dyn/retail_v2.projects.locations.html | 2 +- ...tail_v2.projects.locations.operations.html | 2 +- docs/dyn/retail_v2.projects.operations.html | 2 +- docs/dyn/retail_v2alpha.html | 2 +- docs/dyn/retail_v2alpha.projects.html | 2 +- ...s.locations.catalogs.attributesConfig.html | 2 +- ....projects.locations.catalogs.branches.html | 2 +- ...ocations.catalogs.branches.operations.html | 2 +- ...ts.locations.catalogs.branches.places.html | 2 +- ...s.catalogs.branches.places.operations.html | 2 +- ....locations.catalogs.branches.products.html | 2 +- ...cts.locations.catalogs.completionData.html | 2 +- ....projects.locations.catalogs.controls.html | 2 +- ...l_v2alpha.projects.locations.catalogs.html | 2 +- ...s.catalogs.merchantCenterAccountLinks.html | 2 +- ...ha.projects.locations.catalogs.models.html | 2 +- ...rojects.locations.catalogs.operations.html | 2 +- ...rojects.locations.catalogs.placements.html | 2 +- ...cts.locations.catalogs.servingConfigs.html | 2 +- ...rojects.locations.catalogs.userEvents.html | 2 +- .../retail_v2alpha.projects.locations.html | 2 +- ...v2alpha.projects.locations.operations.html | 2 +- .../retail_v2alpha.projects.operations.html | 2 +- ...retail_v2alpha.projects.retailProject.html | 2 +- docs/dyn/retail_v2beta.html | 2 +- docs/dyn/retail_v2beta.projects.html | 2 +- ...s.locations.catalogs.attributesConfig.html | 2 +- ....projects.locations.catalogs.branches.html | 2 +- ...ocations.catalogs.branches.operations.html | 2 +- ....locations.catalogs.branches.products.html | 2 +- ...cts.locations.catalogs.completionData.html | 2 +- ....projects.locations.catalogs.controls.html | 2 +- ...il_v2beta.projects.locations.catalogs.html | 2 +- ...ta.projects.locations.catalogs.models.html | 2 +- ...rojects.locations.catalogs.operations.html | 2 +- ...rojects.locations.catalogs.placements.html | 2 +- ...cts.locations.catalogs.servingConfigs.html | 2 +- ...rojects.locations.catalogs.userEvents.html | 2 +- .../dyn/retail_v2beta.projects.locations.html | 2 +- ..._v2beta.projects.locations.operations.html | 2 +- .../retail_v2beta.projects.operations.html | 2 +- .../discovery_cache/documents/retail.v2.json | 191 +++++++++++++++++- .../documents/retail.v2alpha.json | 103 +++++++++- .../documents/retail.v2beta.json | 103 +++++++++- 58 files changed, 498 insertions(+), 64 deletions(-) diff --git a/docs/dyn/retail_v2.html b/docs/dyn/retail_v2.html index 7a2b0fb885f..b0a764a9fc5 100644 --- a/docs/dyn/retail_v2.html +++ b/docs/dyn/retail_v2.html @@ -72,7 +72,7 @@ -

Retail API

+

Vertex AI Search for Retail API

Instance Methods

projects() diff --git a/docs/dyn/retail_v2.projects.html b/docs/dyn/retail_v2.projects.html index fd98c8797c5..f522737a5a8 100644 --- a/docs/dyn/retail_v2.projects.html +++ b/docs/dyn/retail_v2.projects.html @@ -72,7 +72,7 @@ -

Retail API . projects

+

Vertex AI Search for Retail API . projects

Instance Methods

locations() diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.attributesConfig.html b/docs/dyn/retail_v2.projects.locations.catalogs.attributesConfig.html index 5a9e37011ed..e66a6c125af 100644 --- a/docs/dyn/retail_v2.projects.locations.catalogs.attributesConfig.html +++ b/docs/dyn/retail_v2.projects.locations.catalogs.attributesConfig.html @@ -72,7 +72,7 @@ -

Retail API . projects . locations . catalogs . attributesConfig

+

Vertex AI Search for Retail API . projects . locations . catalogs . attributesConfig

Instance Methods

addCatalogAttribute(attributesConfig, body=None, x__xgafv=None)

diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.branches.html b/docs/dyn/retail_v2.projects.locations.catalogs.branches.html index 753b64dd435..e21189cbf53 100644 --- a/docs/dyn/retail_v2.projects.locations.catalogs.branches.html +++ b/docs/dyn/retail_v2.projects.locations.catalogs.branches.html @@ -72,7 +72,7 @@ -

Retail API . projects . locations . catalogs . branches

+

Vertex AI Search for Retail API . projects . locations . catalogs . branches

Instance Methods

operations() diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.branches.operations.html b/docs/dyn/retail_v2.projects.locations.catalogs.branches.operations.html index ac74ceb8ce7..0127f50c674 100644 --- a/docs/dyn/retail_v2.projects.locations.catalogs.branches.operations.html +++ b/docs/dyn/retail_v2.projects.locations.catalogs.branches.operations.html @@ -72,7 +72,7 @@ -

Retail API . projects . locations . catalogs . branches . operations

+

Vertex AI Search for Retail API . projects . locations . catalogs . branches . operations

Instance Methods

close()

diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.branches.products.html b/docs/dyn/retail_v2.projects.locations.catalogs.branches.products.html index daeae5afe34..486261704ba 100644 --- a/docs/dyn/retail_v2.projects.locations.catalogs.branches.products.html +++ b/docs/dyn/retail_v2.projects.locations.catalogs.branches.products.html @@ -72,7 +72,7 @@ -

Retail API . projects . locations . catalogs . branches . products

+

Vertex AI Search for Retail API . projects . locations . catalogs . branches . products

Instance Methods

addFulfillmentPlaces(product, body=None, x__xgafv=None)

diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.completionData.html b/docs/dyn/retail_v2.projects.locations.catalogs.completionData.html index 75e4d982204..487cf8052b1 100644 --- a/docs/dyn/retail_v2.projects.locations.catalogs.completionData.html +++ b/docs/dyn/retail_v2.projects.locations.catalogs.completionData.html @@ -72,7 +72,7 @@ -

Retail API . projects . locations . catalogs . completionData

+

Vertex AI Search for Retail API . projects . locations . catalogs . completionData

Instance Methods

close()

diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.controls.html b/docs/dyn/retail_v2.projects.locations.catalogs.controls.html index 1b99aa954a0..416a7207dda 100644 --- a/docs/dyn/retail_v2.projects.locations.catalogs.controls.html +++ b/docs/dyn/retail_v2.projects.locations.catalogs.controls.html @@ -72,7 +72,7 @@ -

Retail API . projects . locations . catalogs . controls

+

Vertex AI Search for Retail API . projects . locations . catalogs . controls

Instance Methods

close()

diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.html b/docs/dyn/retail_v2.projects.locations.catalogs.html index e39d8b3000a..2c389b998bc 100644 --- a/docs/dyn/retail_v2.projects.locations.catalogs.html +++ b/docs/dyn/retail_v2.projects.locations.catalogs.html @@ -72,7 +72,7 @@ -

Retail API . projects . locations . catalogs

+

Vertex AI Search for Retail API . projects . locations . catalogs

Instance Methods

attributesConfig() @@ -125,6 +125,9 @@

Instance Methods

completeQuery(catalog, dataset=None, deviceType=None, entity=None, languageCodes=None, maxSuggestions=None, query=None, visitorId=None, x__xgafv=None)

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.

+

+ exportAnalyticsMetrics(catalog, body=None, x__xgafv=None)

+

Exports analytics metrics. `Operation.response` is of type `ExportAnalyticsMetricsResponse`. `Operation.metadata` is of type `ExportMetadata`.

getAttributesConfig(name, x__xgafv=None)

Gets an AttributesConfig.

@@ -206,6 +209,58 @@

Method Details

} +
+ exportAnalyticsMetrics(catalog, body=None, x__xgafv=None) +
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.
+  "filter": "A String", # 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"`
+  "outputConfig": { # The output configuration setting. # Required. The output location of the data.
+    "bigqueryDestination": { # The BigQuery output destination configuration. # The BigQuery location where the output is to be written to.
+      "datasetId": "A String", # Required. The ID of a BigQuery Dataset.
+      "tableIdPrefix": "A String", # Required. The prefix of exported BigQuery tables.
+      "tableType": "A String", # Required. Describes the table type. The following values are supported: * `table`: A BigQuery native table. * `view`: A virtual table defined by a SQL query.
+    },
+    "gcsDestination": { # The Google Cloud Storage output destination configuration. # The Google Cloud Storage location where the output is to be written to.
+      "outputUriPrefix": "A String", # 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.
+  "done": 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.
+  "error": { # 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.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # 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.
+  },
+  "metadata": { # 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.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # 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}`.
+  "response": { # 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`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+
getAttributesConfig(name, x__xgafv=None)
Gets an AttributesConfig.
diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.models.html b/docs/dyn/retail_v2.projects.locations.catalogs.models.html
index 682873faca8..c74e59000b7 100644
--- a/docs/dyn/retail_v2.projects.locations.catalogs.models.html
+++ b/docs/dyn/retail_v2.projects.locations.catalogs.models.html
@@ -72,7 +72,7 @@
 
 
 
-

Retail API . projects . locations . catalogs . models

+

Vertex AI Search for Retail API . projects . locations . catalogs . models

Instance Methods

close()

diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.operations.html b/docs/dyn/retail_v2.projects.locations.catalogs.operations.html index 24fb7477b94..b1fe8586ce3 100644 --- a/docs/dyn/retail_v2.projects.locations.catalogs.operations.html +++ b/docs/dyn/retail_v2.projects.locations.catalogs.operations.html @@ -72,7 +72,7 @@ -

Retail API . projects . locations . catalogs . operations

+

Vertex AI Search for Retail API . projects . locations . catalogs . operations

Instance Methods

close()

diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.placements.html b/docs/dyn/retail_v2.projects.locations.catalogs.placements.html index 5eef57b6566..b76ebad39ff 100644 --- a/docs/dyn/retail_v2.projects.locations.catalogs.placements.html +++ b/docs/dyn/retail_v2.projects.locations.catalogs.placements.html @@ -72,7 +72,7 @@ -

Retail API . projects . locations . catalogs . placements

+

Vertex AI Search for Retail API . projects . locations . catalogs . placements

Instance Methods

close()

diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.servingConfigs.html b/docs/dyn/retail_v2.projects.locations.catalogs.servingConfigs.html index 5f6c8db9d79..ce423c95200 100644 --- a/docs/dyn/retail_v2.projects.locations.catalogs.servingConfigs.html +++ b/docs/dyn/retail_v2.projects.locations.catalogs.servingConfigs.html @@ -72,7 +72,7 @@ -

Retail API . projects . locations . catalogs . servingConfigs

+

Vertex AI Search for Retail API . projects . locations . catalogs . servingConfigs

Instance Methods

addControl(servingConfig, body=None, x__xgafv=None)

diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.userEvents.html b/docs/dyn/retail_v2.projects.locations.catalogs.userEvents.html index af44acbecae..31be8f364bc 100644 --- a/docs/dyn/retail_v2.projects.locations.catalogs.userEvents.html +++ b/docs/dyn/retail_v2.projects.locations.catalogs.userEvents.html @@ -72,7 +72,7 @@ -

Retail API . projects . locations . catalogs . userEvents

+

Vertex AI Search for Retail API . projects . locations . catalogs . userEvents

Instance Methods

close()

diff --git a/docs/dyn/retail_v2.projects.locations.html b/docs/dyn/retail_v2.projects.locations.html index 2f7c748edf6..93aaf64ba8d 100644 --- a/docs/dyn/retail_v2.projects.locations.html +++ b/docs/dyn/retail_v2.projects.locations.html @@ -72,7 +72,7 @@ -

Retail API . projects . locations

+

Vertex AI Search for Retail API . projects . locations

Instance Methods

catalogs() diff --git a/docs/dyn/retail_v2.projects.locations.operations.html b/docs/dyn/retail_v2.projects.locations.operations.html index b5d233e1a4a..5e7593179f9 100644 --- a/docs/dyn/retail_v2.projects.locations.operations.html +++ b/docs/dyn/retail_v2.projects.locations.operations.html @@ -72,7 +72,7 @@ -

Retail API . projects . locations . operations

+

Vertex AI Search for Retail API . projects . locations . operations

Instance Methods

close()

diff --git a/docs/dyn/retail_v2.projects.operations.html b/docs/dyn/retail_v2.projects.operations.html index 98962f3864f..f4ad4fe4beb 100644 --- a/docs/dyn/retail_v2.projects.operations.html +++ b/docs/dyn/retail_v2.projects.operations.html @@ -72,7 +72,7 @@ -

Retail API . projects . operations

+

Vertex AI Search for Retail API . projects . operations

Instance Methods

close()

diff --git a/docs/dyn/retail_v2alpha.html b/docs/dyn/retail_v2alpha.html index 86a9f38465e..abfc06583b4 100644 --- a/docs/dyn/retail_v2alpha.html +++ b/docs/dyn/retail_v2alpha.html @@ -72,7 +72,7 @@ -

Retail API

+

Vertex AI Search for Retail API

Instance Methods

projects() diff --git a/docs/dyn/retail_v2alpha.projects.html b/docs/dyn/retail_v2alpha.projects.html index 5ee53717c00..8d1c00cf5fa 100644 --- a/docs/dyn/retail_v2alpha.projects.html +++ b/docs/dyn/retail_v2alpha.projects.html @@ -72,7 +72,7 @@ -

Retail API . projects

+

Vertex AI Search for Retail API . projects

Instance Methods

locations() diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.attributesConfig.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.attributesConfig.html index 8fffce75a66..cfb1907f379 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.attributesConfig.html +++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.attributesConfig.html @@ -72,7 +72,7 @@ -

Retail API . projects . locations . catalogs . attributesConfig

+

Vertex AI Search for Retail API . projects . locations . catalogs . attributesConfig

Instance Methods

addCatalogAttribute(attributesConfig, body=None, x__xgafv=None)

diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.html index 22759934b45..bd15b5bd940 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.html +++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.html @@ -72,7 +72,7 @@ -

Retail API . projects . locations . catalogs . branches

+

Vertex AI Search for Retail API . projects . locations . catalogs . branches

Instance Methods

operations() diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.operations.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.operations.html index d30754454fe..733a43b6add 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.operations.html +++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.operations.html @@ -72,7 +72,7 @@ -

Retail API . projects . locations . catalogs . branches . operations

+

Vertex AI Search for Retail API . projects . locations . catalogs . branches . operations

Instance Methods

close()

diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.places.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.places.html index 4e8856eecf6..0bf39abe85a 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.places.html +++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.places.html @@ -72,7 +72,7 @@ -

Retail API . projects . locations . catalogs . branches . places

+

Vertex AI Search for Retail API . projects . locations . catalogs . branches . places

Instance Methods

operations() diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.places.operations.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.places.operations.html index 3b7422a5077..ba3aa6c2ca1 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.places.operations.html +++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.places.operations.html @@ -72,7 +72,7 @@ -

Retail API . projects . locations . catalogs . branches . places . operations

+

Vertex AI Search for Retail API . projects . locations . catalogs . branches . places . operations

Instance Methods

close()

diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.products.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.products.html index e45a7ece7d5..f684760cde6 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.products.html +++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.products.html @@ -72,7 +72,7 @@ -

Retail API . projects . locations . catalogs . branches . products

+

Vertex AI Search for Retail API . projects . locations . catalogs . branches . products

Instance Methods

addFulfillmentPlaces(product, body=None, x__xgafv=None)

diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.completionData.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.completionData.html index 609410bb5e0..aff55a5e439 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.completionData.html +++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.completionData.html @@ -72,7 +72,7 @@ -

Retail API . projects . locations . catalogs . completionData

+

Vertex AI Search for Retail API . projects . locations . catalogs . completionData

Instance Methods

close()

diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.controls.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.controls.html index c97811b1c27..da6fea28afc 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.controls.html +++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.controls.html @@ -72,7 +72,7 @@ -

Retail API . projects . locations . catalogs . controls

+

Vertex AI Search for Retail API . projects . locations . catalogs . controls

Instance Methods

close()

diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.html index 1ccab756b84..62c1232323a 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.html +++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.html @@ -72,7 +72,7 @@ -

Retail API . projects . locations . catalogs

+

Vertex AI Search for Retail API . projects . locations . catalogs

Instance Methods

attributesConfig() diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.merchantCenterAccountLinks.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.merchantCenterAccountLinks.html index cf3640950f4..2cba0063d8f 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.merchantCenterAccountLinks.html +++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.merchantCenterAccountLinks.html @@ -72,7 +72,7 @@ -

Retail API . projects . locations . catalogs . merchantCenterAccountLinks

+

Vertex AI Search for Retail API . projects . locations . catalogs . merchantCenterAccountLinks

Instance Methods

close()

diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.models.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.models.html index 666822459eb..3678d808e9c 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.models.html +++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.models.html @@ -72,7 +72,7 @@ -

Retail API . projects . locations . catalogs . models

+

Vertex AI Search for Retail API . projects . locations . catalogs . models

Instance Methods

close()

diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.operations.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.operations.html index 9cbea5abf4f..ac1cf32ea6a 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.operations.html +++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.operations.html @@ -72,7 +72,7 @@ -

Retail API . projects . locations . catalogs . operations

+

Vertex AI Search for Retail API . projects . locations . catalogs . operations

Instance Methods

close()

diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html index 14c6f1593fa..9e04556dbb6 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html +++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html @@ -72,7 +72,7 @@ -

Retail API . projects . locations . catalogs . placements

+

Vertex AI Search for Retail API . projects . locations . catalogs . placements

Instance Methods

close()

diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.servingConfigs.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.servingConfigs.html index 1a31248ff5e..b2b33334a81 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.servingConfigs.html +++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.servingConfigs.html @@ -72,7 +72,7 @@ -

Retail API . projects . locations . catalogs . servingConfigs

+

Vertex AI Search for Retail API . projects . locations . catalogs . servingConfigs

Instance Methods

addControl(servingConfig, body=None, x__xgafv=None)

diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.userEvents.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.userEvents.html index e254408b9fa..97eec8c3198 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.userEvents.html +++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.userEvents.html @@ -72,7 +72,7 @@ -

Retail API . projects . locations . catalogs . userEvents

+

Vertex AI Search for Retail API . projects . locations . catalogs . userEvents

Instance Methods

close()

diff --git a/docs/dyn/retail_v2alpha.projects.locations.html b/docs/dyn/retail_v2alpha.projects.locations.html index 685edb216a5..74411644b88 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.html +++ b/docs/dyn/retail_v2alpha.projects.locations.html @@ -72,7 +72,7 @@ -

Retail API . projects . locations

+

Vertex AI Search for Retail API . projects . locations

Instance Methods

catalogs() diff --git a/docs/dyn/retail_v2alpha.projects.locations.operations.html b/docs/dyn/retail_v2alpha.projects.locations.operations.html index bae6bff2766..9a108ff68ca 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.operations.html +++ b/docs/dyn/retail_v2alpha.projects.locations.operations.html @@ -72,7 +72,7 @@ -

Retail API . projects . locations . operations

+

Vertex AI Search for Retail API . projects . locations . operations

Instance Methods

close()

diff --git a/docs/dyn/retail_v2alpha.projects.operations.html b/docs/dyn/retail_v2alpha.projects.operations.html index b8486947aa0..93861be6a76 100644 --- a/docs/dyn/retail_v2alpha.projects.operations.html +++ b/docs/dyn/retail_v2alpha.projects.operations.html @@ -72,7 +72,7 @@ -

Retail API . projects . operations

+

Vertex AI Search for Retail API . projects . operations

Instance Methods

close()

diff --git a/docs/dyn/retail_v2alpha.projects.retailProject.html b/docs/dyn/retail_v2alpha.projects.retailProject.html index 1e6ceeef23b..d3fef18e4c4 100644 --- a/docs/dyn/retail_v2alpha.projects.retailProject.html +++ b/docs/dyn/retail_v2alpha.projects.retailProject.html @@ -72,7 +72,7 @@ -

Retail API . projects . retailProject

+

Vertex AI Search for Retail API . projects . retailProject

Instance Methods

acceptTerms(project, body=None, x__xgafv=None)

diff --git a/docs/dyn/retail_v2beta.html b/docs/dyn/retail_v2beta.html index da62609a763..44223fb47be 100644 --- a/docs/dyn/retail_v2beta.html +++ b/docs/dyn/retail_v2beta.html @@ -72,7 +72,7 @@ -

Retail API

+

Vertex AI Search for Retail API

Instance Methods

projects() diff --git a/docs/dyn/retail_v2beta.projects.html b/docs/dyn/retail_v2beta.projects.html index 07853ff1de2..b5ceaf5afd5 100644 --- a/docs/dyn/retail_v2beta.projects.html +++ b/docs/dyn/retail_v2beta.projects.html @@ -72,7 +72,7 @@ -

Retail API . projects

+

Vertex AI Search for Retail API . projects

Instance Methods

locations() diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.attributesConfig.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.attributesConfig.html index a25dece6266..4821a3066cc 100644 --- a/docs/dyn/retail_v2beta.projects.locations.catalogs.attributesConfig.html +++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.attributesConfig.html @@ -72,7 +72,7 @@ -

Retail API . projects . locations . catalogs . attributesConfig

+

Vertex AI Search for Retail API . projects . locations . catalogs . attributesConfig

Instance Methods

addCatalogAttribute(attributesConfig, body=None, x__xgafv=None)

diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.branches.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.branches.html index efb65d40f18..6b2e2045723 100644 --- a/docs/dyn/retail_v2beta.projects.locations.catalogs.branches.html +++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.branches.html @@ -72,7 +72,7 @@ -

Retail API . projects . locations . catalogs . branches

+

Vertex AI Search for Retail API . projects . locations . catalogs . branches

Instance Methods

operations() diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.branches.operations.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.branches.operations.html index b7f1c1b3a8b..376f35e7761 100644 --- a/docs/dyn/retail_v2beta.projects.locations.catalogs.branches.operations.html +++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.branches.operations.html @@ -72,7 +72,7 @@ -

Retail API . projects . locations . catalogs . branches . operations

+

Vertex AI Search for Retail API . projects . locations . catalogs . branches . operations

Instance Methods

close()

diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.branches.products.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.branches.products.html index e03503a4daa..3dd3c00ed62 100644 --- a/docs/dyn/retail_v2beta.projects.locations.catalogs.branches.products.html +++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.branches.products.html @@ -72,7 +72,7 @@ -

Retail API . projects . locations . catalogs . branches . products

+

Vertex AI Search for Retail API . projects . locations . catalogs . branches . products

Instance Methods

addFulfillmentPlaces(product, body=None, x__xgafv=None)

diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.completionData.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.completionData.html index 6bc19267eff..c462d49d5ad 100644 --- a/docs/dyn/retail_v2beta.projects.locations.catalogs.completionData.html +++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.completionData.html @@ -72,7 +72,7 @@ -

Retail API . projects . locations . catalogs . completionData

+

Vertex AI Search for Retail API . projects . locations . catalogs . completionData

Instance Methods

close()

diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.controls.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.controls.html index ac1628c6433..37cce960854 100644 --- a/docs/dyn/retail_v2beta.projects.locations.catalogs.controls.html +++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.controls.html @@ -72,7 +72,7 @@ -

Retail API . projects . locations . catalogs . controls

+

Vertex AI Search for Retail API . projects . locations . catalogs . controls

Instance Methods

close()

diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.html index c6c0e19e68e..0276f3a9950 100644 --- a/docs/dyn/retail_v2beta.projects.locations.catalogs.html +++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.html @@ -72,7 +72,7 @@ -

Retail API . projects . locations . catalogs

+

Vertex AI Search for Retail API . projects . locations . catalogs

Instance Methods

attributesConfig() diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.models.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.models.html index 69b59417a2d..b3aad82e054 100644 --- a/docs/dyn/retail_v2beta.projects.locations.catalogs.models.html +++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.models.html @@ -72,7 +72,7 @@ -

Retail API . projects . locations . catalogs . models

+

Vertex AI Search for Retail API . projects . locations . catalogs . models

Instance Methods

close()

diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.operations.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.operations.html index 0c43038e7d3..3c86ff147c9 100644 --- a/docs/dyn/retail_v2beta.projects.locations.catalogs.operations.html +++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.operations.html @@ -72,7 +72,7 @@ -

Retail API . projects . locations . catalogs . operations

+

Vertex AI Search for Retail API . projects . locations . catalogs . operations

Instance Methods

close()

diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.placements.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.placements.html index b457095a48c..e4579e109f2 100644 --- a/docs/dyn/retail_v2beta.projects.locations.catalogs.placements.html +++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.placements.html @@ -72,7 +72,7 @@ -

Retail API . projects . locations . catalogs . placements

+

Vertex AI Search for Retail API . projects . locations . catalogs . placements

Instance Methods

close()

diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.servingConfigs.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.servingConfigs.html index dc1ebc021dc..f296bbb4829 100644 --- a/docs/dyn/retail_v2beta.projects.locations.catalogs.servingConfigs.html +++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.servingConfigs.html @@ -72,7 +72,7 @@ -

Retail API . projects . locations . catalogs . servingConfigs

+

Vertex AI Search for Retail API . projects . locations . catalogs . servingConfigs

Instance Methods

addControl(servingConfig, body=None, x__xgafv=None)

diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.userEvents.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.userEvents.html index 71f01de0ccd..f6477c276bf 100644 --- a/docs/dyn/retail_v2beta.projects.locations.catalogs.userEvents.html +++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.userEvents.html @@ -72,7 +72,7 @@ -

Retail API . projects . locations . catalogs . userEvents

+

Vertex AI Search for Retail API . projects . locations . catalogs . userEvents

Instance Methods

close()

diff --git a/docs/dyn/retail_v2beta.projects.locations.html b/docs/dyn/retail_v2beta.projects.locations.html index 07185da7510..ef3bc16cefb 100644 --- a/docs/dyn/retail_v2beta.projects.locations.html +++ b/docs/dyn/retail_v2beta.projects.locations.html @@ -72,7 +72,7 @@ -

Retail API . projects . locations

+

Vertex AI Search for Retail API . projects . locations

Instance Methods

catalogs() diff --git a/docs/dyn/retail_v2beta.projects.locations.operations.html b/docs/dyn/retail_v2beta.projects.locations.operations.html index 34af41ff22b..d9b10e87c8c 100644 --- a/docs/dyn/retail_v2beta.projects.locations.operations.html +++ b/docs/dyn/retail_v2beta.projects.locations.operations.html @@ -72,7 +72,7 @@ -

Retail API . projects . locations . operations

+

Vertex AI Search for Retail API . projects . locations . operations

Instance Methods

close()

diff --git a/docs/dyn/retail_v2beta.projects.operations.html b/docs/dyn/retail_v2beta.projects.operations.html index 07ee90f576c..df3f6264abd 100644 --- a/docs/dyn/retail_v2beta.projects.operations.html +++ b/docs/dyn/retail_v2beta.projects.operations.html @@ -72,7 +72,7 @@ -

Retail API . projects . operations

+

Vertex AI Search for Retail API . projects . operations

Instance Methods

close()

diff --git a/googleapiclient/discovery_cache/documents/retail.v2.json b/googleapiclient/discovery_cache/documents/retail.v2.json index b537301c65a..d3a650c03b7 100644 --- a/googleapiclient/discovery_cache/documents/retail.v2.json +++ b/googleapiclient/discovery_cache/documents/retail.v2.json @@ -12,7 +12,7 @@ "baseUrl": "https://retail.googleapis.com/", "batchPath": "batch", "canonicalName": "Cloud Retail", -"description": "Cloud Retail service enables customers to build end-to-end personalized recommendation systems without requiring a high level of expertise in machine learning, recommendation system, or Google Cloud.", +"description": "Vertex AI Search for Retail API is made up of Retail Search, Browse and Recommendations. These discovery AI solutions help you implement personalized search, browse and recommendations, based on machine learning models, across your websites and mobile applications.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/recommendations", "fullyEncodeReservedExpansion": true, @@ -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": "v2/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": "v2/{+catalog}:exportAnalyticsMetrics", +"request": { +"$ref": "GoogleCloudRetailV2ExportAnalyticsMetricsRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "getAttributesConfig": { "description": "Gets an AttributesConfig.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/attributesConfig", @@ -2059,7 +2087,7 @@ } } }, -"revision": "20240129", +"revision": "20240212", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -2367,6 +2395,21 @@ }, "type": "object" }, +"GoogleCloudRetailV2BigQueryOutputResult": { +"description": "A BigQuery output result.", +"id": "GoogleCloudRetailV2BigQueryOutputResult", +"properties": { +"datasetId": { +"description": "The ID of a BigQuery Dataset.", +"type": "string" +}, +"tableId": { +"description": "The ID of a BigQuery Table.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudRetailV2BigQuerySource": { "description": "BigQuery source import data from.", "id": "GoogleCloudRetailV2BigQuerySource", @@ -2998,6 +3041,71 @@ }, "type": "object" }, +"GoogleCloudRetailV2ExportAnalyticsMetricsRequest": { +"description": "Request message for the `ExportAnalyticsMetrics` method.", +"id": "GoogleCloudRetailV2ExportAnalyticsMetricsRequest", +"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": "GoogleCloudRetailV2OutputConfig", +"description": "Required. The output location of the data." +} +}, +"type": "object" +}, +"GoogleCloudRetailV2ExportAnalyticsMetricsResponse": { +"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": "GoogleCloudRetailV2ExportAnalyticsMetricsResponse", +"properties": { +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"errorsConfig": { +"$ref": "GoogleCloudRetailV2ExportErrorsConfig", +"description": "This field is never set." +}, +"outputResult": { +"$ref": "GoogleCloudRetailV2OutputResult", +"description": "Output result indicating where the data were exported to." +} +}, +"type": "object" +}, +"GoogleCloudRetailV2ExportErrorsConfig": { +"description": "Configuration of destination for Export related errors.", +"id": "GoogleCloudRetailV2ExportErrorsConfig", +"properties": { +"gcsPrefix": { +"description": "Google Cloud Storage path for import errors. This must be an empty, existing Cloud Storage bucket. Export errors will be written to a file in this bucket, one per line, as a JSON-encoded `google.rpc.Status` message.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudRetailV2ExportMetadata": { +"description": "Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudRetailV2ExportMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudRetailV2FulfillmentInfo": { "description": "Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods.", "id": "GoogleCloudRetailV2FulfillmentInfo", @@ -3016,6 +3124,17 @@ }, "type": "object" }, +"GoogleCloudRetailV2GcsOutputResult": { +"description": "A Gcs output result.", +"id": "GoogleCloudRetailV2GcsOutputResult", +"properties": { +"outputUri": { +"description": "The uri of Gcs output", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudRetailV2GcsSource": { "description": "Google Cloud Storage location for input content.", "id": "GoogleCloudRetailV2GcsSource", @@ -3575,6 +3694,72 @@ }, "type": "object" }, +"GoogleCloudRetailV2OutputConfig": { +"description": "The output configuration setting.", +"id": "GoogleCloudRetailV2OutputConfig", +"properties": { +"bigqueryDestination": { +"$ref": "GoogleCloudRetailV2OutputConfigBigQueryDestination", +"description": "The BigQuery location where the output is to be written to." +}, +"gcsDestination": { +"$ref": "GoogleCloudRetailV2OutputConfigGcsDestination", +"description": "The Google Cloud Storage location where the output is to be written to." +} +}, +"type": "object" +}, +"GoogleCloudRetailV2OutputConfigBigQueryDestination": { +"description": "The BigQuery output destination configuration.", +"id": "GoogleCloudRetailV2OutputConfigBigQueryDestination", +"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" +}, +"GoogleCloudRetailV2OutputConfigGcsDestination": { +"description": "The Google Cloud Storage output destination configuration.", +"id": "GoogleCloudRetailV2OutputConfigGcsDestination", +"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" +}, +"GoogleCloudRetailV2OutputResult": { +"description": "Output result that stores the information about where the exported data is stored.", +"id": "GoogleCloudRetailV2OutputResult", +"properties": { +"bigqueryResult": { +"description": "The BigQuery location where the result is stored.", +"items": { +"$ref": "GoogleCloudRetailV2BigQueryOutputResult" +}, +"type": "array" +}, +"gcsResult": { +"description": "The Google Cloud Storage location where the result is stored.", +"items": { +"$ref": "GoogleCloudRetailV2GcsOutputResult" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudRetailV2PauseModelRequest": { "description": "Request for pausing training of a model.", "id": "GoogleCloudRetailV2PauseModelRequest", @@ -7103,7 +7288,7 @@ } }, "servicePath": "", -"title": "Retail API", +"title": "Vertex AI Search for Retail API", "version": "v2", "version_module": true } \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/retail.v2alpha.json b/googleapiclient/discovery_cache/documents/retail.v2alpha.json index 53db0260066..a93c4708fcd 100644 --- a/googleapiclient/discovery_cache/documents/retail.v2alpha.json +++ b/googleapiclient/discovery_cache/documents/retail.v2alpha.json @@ -12,7 +12,7 @@ "baseUrl": "https://retail.googleapis.com/", "batchPath": "batch", "canonicalName": "Cloud Retail", -"description": "Cloud Retail service enables customers to build end-to-end personalized recommendation systems without requiring a high level of expertise in machine learning, recommendation system, or Google Cloud.", +"description": "Vertex AI Search for Retail API is made up of Retail Search, Browse and Recommendations. These discovery AI solutions help you implement personalized search, browse and recommendations, based on machine learning models, across your websites and mobile applications.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/recommendations", "fullyEncodeReservedExpansion": true, @@ -2416,7 +2416,7 @@ } } }, -"revision": "20240129", +"revision": "20240212", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -2593,6 +2593,21 @@ "properties": {}, "type": "object" }, +"GoogleCloudRetailV2BigQueryOutputResult": { +"description": "A BigQuery output result.", +"id": "GoogleCloudRetailV2BigQueryOutputResult", +"properties": { +"datasetId": { +"description": "The ID of a BigQuery Dataset.", +"type": "string" +}, +"tableId": { +"description": "The ID of a BigQuery Table.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudRetailV2CreateModelMetadata": { "description": "Metadata associated with a create operation.", "id": "GoogleCloudRetailV2CreateModelMetadata", @@ -2604,6 +2619,67 @@ }, "type": "object" }, +"GoogleCloudRetailV2ExportAnalyticsMetricsResponse": { +"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": "GoogleCloudRetailV2ExportAnalyticsMetricsResponse", +"properties": { +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"errorsConfig": { +"$ref": "GoogleCloudRetailV2ExportErrorsConfig", +"description": "This field is never set." +}, +"outputResult": { +"$ref": "GoogleCloudRetailV2OutputResult", +"description": "Output result indicating where the data were exported to." +} +}, +"type": "object" +}, +"GoogleCloudRetailV2ExportErrorsConfig": { +"description": "Configuration of destination for Export related errors.", +"id": "GoogleCloudRetailV2ExportErrorsConfig", +"properties": { +"gcsPrefix": { +"description": "Google Cloud Storage path for import errors. This must be an empty, existing Cloud Storage bucket. Export errors will be written to a file in this bucket, one per line, as a JSON-encoded `google.rpc.Status` message.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudRetailV2ExportMetadata": { +"description": "Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudRetailV2ExportMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudRetailV2GcsOutputResult": { +"description": "A Gcs output result.", +"id": "GoogleCloudRetailV2GcsOutputResult", +"properties": { +"outputUri": { +"description": "The uri of Gcs output", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudRetailV2ImportCompletionDataResponse": { "description": "Response of the ImportCompletionDataRequest. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", "id": "GoogleCloudRetailV2ImportCompletionDataResponse", @@ -2885,6 +2961,27 @@ }, "type": "object" }, +"GoogleCloudRetailV2OutputResult": { +"description": "Output result that stores the information about where the exported data is stored.", +"id": "GoogleCloudRetailV2OutputResult", +"properties": { +"bigqueryResult": { +"description": "The BigQuery location where the result is stored.", +"items": { +"$ref": "GoogleCloudRetailV2BigQueryOutputResult" +}, +"type": "array" +}, +"gcsResult": { +"description": "The Google Cloud Storage location where the result is stored.", +"items": { +"$ref": "GoogleCloudRetailV2GcsOutputResult" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudRetailV2PurgeMetadata": { "description": "Metadata related to the progress of the Purge operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudRetailV2PurgeMetadata", @@ -7868,7 +7965,7 @@ } }, "servicePath": "", -"title": "Retail API", +"title": "Vertex AI Search for Retail API", "version": "v2alpha", "version_module": true } \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/retail.v2beta.json b/googleapiclient/discovery_cache/documents/retail.v2beta.json index 5af6259e5ea..16ae6e9e474 100644 --- a/googleapiclient/discovery_cache/documents/retail.v2beta.json +++ b/googleapiclient/discovery_cache/documents/retail.v2beta.json @@ -12,7 +12,7 @@ "baseUrl": "https://retail.googleapis.com/", "batchPath": "batch", "canonicalName": "Cloud Retail", -"description": "Cloud Retail service enables customers to build end-to-end personalized recommendation systems without requiring a high level of expertise in machine learning, recommendation system, or Google Cloud.", +"description": "Vertex AI Search for Retail API is made up of Retail Search, Browse and Recommendations. These discovery AI solutions help you implement personalized search, browse and recommendations, based on machine learning models, across your websites and mobile applications.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/recommendations", "fullyEncodeReservedExpansion": true, @@ -2115,7 +2115,7 @@ } } }, -"revision": "20240129", +"revision": "20240212", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -2292,6 +2292,21 @@ "properties": {}, "type": "object" }, +"GoogleCloudRetailV2BigQueryOutputResult": { +"description": "A BigQuery output result.", +"id": "GoogleCloudRetailV2BigQueryOutputResult", +"properties": { +"datasetId": { +"description": "The ID of a BigQuery Dataset.", +"type": "string" +}, +"tableId": { +"description": "The ID of a BigQuery Table.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudRetailV2CreateModelMetadata": { "description": "Metadata associated with a create operation.", "id": "GoogleCloudRetailV2CreateModelMetadata", @@ -2303,6 +2318,67 @@ }, "type": "object" }, +"GoogleCloudRetailV2ExportAnalyticsMetricsResponse": { +"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": "GoogleCloudRetailV2ExportAnalyticsMetricsResponse", +"properties": { +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"errorsConfig": { +"$ref": "GoogleCloudRetailV2ExportErrorsConfig", +"description": "This field is never set." +}, +"outputResult": { +"$ref": "GoogleCloudRetailV2OutputResult", +"description": "Output result indicating where the data were exported to." +} +}, +"type": "object" +}, +"GoogleCloudRetailV2ExportErrorsConfig": { +"description": "Configuration of destination for Export related errors.", +"id": "GoogleCloudRetailV2ExportErrorsConfig", +"properties": { +"gcsPrefix": { +"description": "Google Cloud Storage path for import errors. This must be an empty, existing Cloud Storage bucket. Export errors will be written to a file in this bucket, one per line, as a JSON-encoded `google.rpc.Status` message.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudRetailV2ExportMetadata": { +"description": "Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudRetailV2ExportMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudRetailV2GcsOutputResult": { +"description": "A Gcs output result.", +"id": "GoogleCloudRetailV2GcsOutputResult", +"properties": { +"outputUri": { +"description": "The uri of Gcs output", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudRetailV2ImportCompletionDataResponse": { "description": "Response of the ImportCompletionDataRequest. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", "id": "GoogleCloudRetailV2ImportCompletionDataResponse", @@ -2584,6 +2660,27 @@ }, "type": "object" }, +"GoogleCloudRetailV2OutputResult": { +"description": "Output result that stores the information about where the exported data is stored.", +"id": "GoogleCloudRetailV2OutputResult", +"properties": { +"bigqueryResult": { +"description": "The BigQuery location where the result is stored.", +"items": { +"$ref": "GoogleCloudRetailV2BigQueryOutputResult" +}, +"type": "array" +}, +"gcsResult": { +"description": "The Google Cloud Storage location where the result is stored.", +"items": { +"$ref": "GoogleCloudRetailV2GcsOutputResult" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudRetailV2PurgeMetadata": { "description": "Metadata related to the progress of the Purge operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudRetailV2PurgeMetadata", @@ -7345,7 +7442,7 @@ } }, "servicePath": "", -"title": "Retail API", +"title": "Vertex AI Search for Retail API", "version": "v2beta", "version_module": true } \ No newline at end of file