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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/index.d.ts +5 -5
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://retail.googleapis.com/$discovery/rest?version=v2
12
- // Revision: 20260716
12
+ // Revision: 20260723
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -134,7 +134,7 @@ declare namespace gapi.client {
134
134
  }
135
135
  interface GoogleCloudRetailV2alphaEnrollSolutionMetadata {}
136
136
  interface GoogleCloudRetailV2alphaEnrollSolutionResponse {
137
- /** Retail API solution that the project has enrolled. */
137
+ /** AI Commerce Search API solution that the project has enrolled. */
138
138
  enrolledSolution?:
139
139
  | 'SOLUTION_TYPE_UNSPECIFIED'
140
140
  | 'SOLUTION_TYPE_RECOMMENDATION'
@@ -2007,7 +2007,7 @@ declare namespace gapi.client {
2007
2007
  updateMask?: string;
2008
2008
  }
2009
2009
  interface GoogleCloudRetailV2UserEvent {
2010
- /** 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. */
2010
+ /** 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. */
2011
2011
  attributes?: {[P in string]: GoogleCloudRetailV2CustomAttribute};
2012
2012
  /** 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. */
2013
2013
  attributionToken?: string;
@@ -2021,7 +2021,7 @@ declare namespace gapi.client {
2021
2021
  eventTime?: string;
2022
2022
  /** 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. */
2023
2023
  eventType?: string;
2024
- /** 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). */
2024
+ /** 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). */
2025
2025
  experimentIds?: string[];
2026
2026
  /** 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. */
2027
2027
  filter?: string;
@@ -4440,7 +4440,7 @@ declare namespace gapi.client {
4440
4440
  ): Request<GoogleCloudRetailV2SearchResponse>;
4441
4441
  }
4442
4442
  interface UserEventsResource {
4443
- /** 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. */
4443
+ /** 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. */
4444
4444
  collect(request: {
4445
4445
  /** V1 error format. */
4446
4446
  '$.xgafv'?: '1' | '2';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.retail-v2",
3
- "version": "0.3.20260716",
3
+ "version": "0.3.20260723",
4
4
  "description": "TypeScript typings for Vertex AI Search for commerce API v2",
5
5
  "repository": {
6
6
  "type": "git",