@maxim_mazurok/gapi.client.retail-v2alpha 0.3.20260716 → 0.3.20260723

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://retail.googleapis.com/$discovery/rest?version=v2alpha
-// Revision: 20260716
+// Revision: 20260723
 
 /// <reference types="gapi.client" />
 
@@ -574,7 +574,7 @@ declare namespace gapi.client {
         | 'SOLUTION_TYPE_SEARCH';
     }
     interface GoogleCloudRetailV2alphaEnrollSolutionResponse {
-      /** Retail API solution that the project has enrolled. */
+      /** AI Commerce Search API solution that the project has enrolled. */
       enrolledSolution?:
         | 'SOLUTION_TYPE_UNSPECIFIED'
         | 'SOLUTION_TYPE_RECOMMENDATION'
@@ -828,7 +828,7 @@ declare namespace gapi.client {
       nextPageToken?: string;
     }
     interface GoogleCloudRetailV2alphaListEnrolledSolutionsResponse {
-      /** Retail API solutions that the project has enrolled. */
+      /** AI Commerce Search API solutions that the project has enrolled. */
       enrolledSolutions?:
         | 'SOLUTION_TYPE_UNSPECIFIED'
         | 'SOLUTION_TYPE_RECOMMENDATION'
@@ -1261,7 +1261,7 @@ declare namespace gapi.client {
       merchantCenterProductIdField?: string;
     }
     interface GoogleCloudRetailV2alphaProject {
-      /** Output only. Retail API solutions that the project has enrolled. */
+      /** Output only. AI Commerce Search API solutions that the project has enrolled. */
       enrolledSolutions?:
         | 'SOLUTION_TYPE_UNSPECIFIED'
         | 'SOLUTION_TYPE_RECOMMENDATION'
@@ -1836,7 +1836,7 @@ declare namespace gapi.client {
       updateMask?: string;
     }
     interface GoogleCloudRetailV2alphaUserEvent {
-      /** Extra user event features to include in the recommendation model. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Retail API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways. */
+      /** Extra user event features to include in the recommendation model. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the AI Commerce Search API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is traffic_channel, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways. */
       attributes?: {[P in string]: GoogleCloudRetailV2alphaCustomAttribute};
       /** Highly recommended for user events that are the result of PredictionService.Predict. This field enables accurate attribution of recommendation model performance. The value must be a valid PredictResponse.attribution_token for user events that are the result of PredictionService.Predict. The value must be a valid SearchResponse.attribution_token for user events that are the result of SearchService.Search. This token enables us to accurately attribute page view or purchase back to the event and the particular predict response containing this clicked/purchased product. If user clicks on product K in the recommendation results, pass PredictResponse.attribution_token as a URL parameter to product K's page. When recording events on product K's page, log the PredictResponse.attribution_token to this field. */
       attributionToken?: string;
@@ -1850,7 +1850,7 @@ declare namespace gapi.client {
       eventTime?: string;
       /** Required. User event type. Allowed values are: * `add-to-cart`: Products being added to cart. * `remove-from-cart`: Products being removed from cart. * `category-page-view`: Special pages such as sale or promotion pages viewed. * `detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage viewed. * `purchase-complete`: User finishing a purchase. * `search`: Product search. * `shopping-cart-page-view`: User viewing a shopping cart. */
       eventType?: string;
-      /** A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (e.g. using Retail API, using different recommendation models). */
+      /** A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups (such as by using AI Commerce Search API, or using different recommendation models). */
       experimentIds?: string[];
       /** The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products being filtered. See SearchRequest.filter for definition and syntax. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. */
       filter?: string;
@@ -4960,7 +4960,7 @@ declare namespace gapi.client {
       ): Request<GoogleCloudRetailV2alphaSearchResponse>;
     }
     interface UserEventsResource {
-      /** Writes a single user event from the browser. For larger user event payload over 16 KB, the POST method should be used instead, otherwise a 400 Bad Request error is returned. This method is used only by the Retail API JavaScript pixel and Google Tag Manager. Users should not call this method directly. */
+      /** Writes a single user event from the browser. For larger user event payload over 16 KB, the POST method should be used instead, otherwise a 400 Bad Request error is returned. This method is used only by the AI Commerce Search API JavaScript pixel and Google Tag Manager. Users should not call this method directly. */
       collect(request: {
         /** V1 error format. */
         '$.xgafv'?: '1' | '2';
@@ -6217,7 +6217,7 @@ declare namespace gapi.client {
       ): Request<GoogleCloudRetailV2alphaProject>;
     }
     interface ProjectsResource {
-      /** The method enrolls a solution of type Retail Search into a project. The Recommendations AI solution type is enrolled by default when your project enables Retail API, so you don't need to call the enrollSolution method for recommendations. */
+      /** The method enrolls a solution of type Retail Search into a project. The Recommendations AI solution type is enrolled by default when your project enables AI Commerce Search API, so you don't need to call the enrollSolution method for recommendations. */
       enrollSolution(request: {
         /** V1 error format. */
         '$.xgafv'?: '1' | '2';
@@ -6329,7 +6329,7 @@ declare namespace gapi.client {
         /** Legacy upload protocol for media (e.g. "media", "multipart"). */
         uploadType?: string;
       }): Request<GoogleCloudRetailV2alphaLoggingConfig>;
-      /** Gets the project. Throws `NOT_FOUND` if the project wasn't initialized for the Retail API service. */
+      /** Gets the project. Throws `NOT_FOUND` if the project wasn't initialized for the AI Commerce Search API service. */
       getRetailProject(request?: {
         /** V1 error format. */
         '$.xgafv'?: '1' | '2';
@@ -6356,7 +6356,7 @@ declare namespace gapi.client {
         /** Legacy upload protocol for media (e.g. "media", "multipart"). */
         uploadType?: string;
       }): Request<GoogleCloudRetailV2alphaProject>;
-      /** Lists all the retail API solutions the project has enrolled. */
+      /** Lists all the AI Commerce Search API solutions the project has enrolled. */
       listEnrolledSolutions(request?: {
         /** V1 error format. */
         '$.xgafv'?: '1' | '2';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.retail-v2alpha",
-  "version": "0.3.20260716",
+  "version": "0.3.20260723",
   "description": "TypeScript typings for Vertex AI Search for commerce API v2alpha",
   "repository": {
     "type": "git",

package/readme.md

@@ -82,7 +82,7 @@ After that you can use Vertex AI Search for commerce API resources: <!-- TODO: m
 
 ```typescript
 /*
-The method enrolls a solution of type Retail Search into a project. The Recommendations AI solution type is enrolled by default when your project enables Retail API, so you don't need to call the enrollSolution method for recommendations.
+The method enrolls a solution of type Retail Search into a project. The Recommendations AI solution type is enrolled by default when your project enables AI Commerce Search API, so you don't need to call the enrollSolution method for recommendations.
 */
 await gapi.client.retail.projects.enrollSolution({project: 'project'});
 
@@ -97,12 +97,12 @@ Gets the LoggingConfig of the requested project.
 await gapi.client.retail.projects.getLoggingConfig({name: 'name'});
 
 /*
-Gets the project. Throws `NOT_FOUND` if the project wasn't initialized for the Retail API service.
+Gets the project. Throws `NOT_FOUND` if the project wasn't initialized for the AI Commerce Search API service.
 */
 await gapi.client.retail.projects.getRetailProject({name: 'name'});
 
 /*
-Lists all the retail API solutions the project has enrolled.
+Lists all the AI Commerce Search API solutions the project has enrolled.
 */
 await gapi.client.retail.projects.listEnrolledSolutions({parent: 'parent'});