Skip to content

Commit 3bb82b6

Browse files
1 parent 4f682d8 commit 3bb82b6

File tree

823 files changed

+3012
-1079
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

823 files changed

+3012
-1079
lines changed

clients/google-api-services-retail/v2/2.0.0/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
# Vertex AI Search for Retail API Client Library for Java
1+
# Vertex AI Search for commerce API Client Library for Java
22

3-
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.
3+
Vertex AI Search for commerce 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.
44

5-
This page contains information about getting started with the Vertex AI Search for Retail API
5+
This page contains information about getting started with the Vertex AI Search for commerce API
66
using the Google API Client Library for Java. In addition, you may be interested
77
in the following documentation:
88

9-
* Browse the [Javadoc reference for the Vertex AI Search for Retail API][javadoc]
9+
* Browse the [Javadoc reference for the Vertex AI Search for commerce API][javadoc]
1010
* Read the [Developer's Guide for the Google API Client Library for Java][google-api-client].
11-
* Interact with this API in your browser using the [APIs Explorer for the Vertex AI Search for Retail API][api-explorer]
11+
* Interact with this API in your browser using the [APIs Explorer for the Vertex AI Search for commerce API][api-explorer]
1212

1313
## Installation
1414

@@ -22,7 +22,7 @@ Add the following lines to your `pom.xml` file:
2222
<dependency>
2323
<groupId>com.google.apis</groupId>
2424
<artifactId>google-api-services-retail</artifactId>
25-
<version>v2-rev20250107-2.0.0</version>
25+
<version>v2-rev20250320-2.0.0</version>
2626
</dependency>
2727
</dependencies>
2828
</project>
@@ -35,7 +35,7 @@ repositories {
3535
mavenCentral()
3636
}
3737
dependencies {
38-
implementation 'com.google.apis:google-api-services-retail:v2-rev20250107-2.0.0'
38+
implementation 'com.google.apis:google-api-services-retail:v2-rev20250320-2.0.0'
3939
}
4040
```
4141

clients/google-api-services-retail/v2/2.0.0/com/google/api/services/retail/v2/CloudRetail.java

Lines changed: 49 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
* Service definition for CloudRetail (v2).
2121
*
2222
* <p>
23-
* 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.
23+
* Vertex AI Search for commerce 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.
2424
* </p>
2525
*
2626
* <p>
@@ -49,7 +49,7 @@ public class CloudRetail extends com.google.api.client.googleapis.services.json.
4949
com.google.api.client.googleapis.GoogleUtils.MAJOR_VERSION >= 2,
5050
"You are currently running with version %s of google-api-client. " +
5151
"You need at least version 1.31.1 of google-api-client to run version " +
52-
"2.0.0 of the Vertex AI Search for Retail API library.", com.google.api.client.googleapis.GoogleUtils.VERSION);
52+
"2.0.0 of the Vertex AI Search for commerce API library.", com.google.api.client.googleapis.GoogleUtils.VERSION);
5353
}
5454

5555
/**
@@ -341,34 +341,34 @@ public CompleteQuery setCatalog(java.lang.String catalog) {
341341

342342
/**
343343
* Determines which dataset to use for fetching completion. "user-data" will use the
344-
* imported dataset through CompletionService.ImportCompletionData. "cloud-retail" will
345-
* use the dataset generated by cloud retail based on user events. If leave empty, it will
346-
* use the "user-data". Current supported values: * user-data * cloud-retail: This option
347-
* requires enabling auto-learning function first. See
348-
* [guidelines](https://cloud.google.com/retail/docs/completion-overview#generated-
344+
* dataset imported through CompletionService.ImportCompletionData. `cloud-retail` will
345+
* use the dataset generated by Cloud Retail based on user events. If left empty,
346+
* completions will be fetched from the `user-data` dataset. Current supported values: *
347+
* user-data * cloud-retail: This option requires enabling auto-learning function first.
348+
* See [guidelines](https://cloud.google.com/retail/docs/completion-overview#generated-
349349
* completion-dataset).
350350
*/
351351
@com.google.api.client.util.Key
352352
private java.lang.String dataset;
353353

354-
/** Determines which dataset to use for fetching completion. "user-data" will use the imported dataset
355-
through CompletionService.ImportCompletionData. "cloud-retail" will use the dataset generated by
356-
cloud retail based on user events. If leave empty, it will use the "user-data". Current supported
357-
values: * user-data * cloud-retail: This option requires enabling auto-learning function first. See
358-
[guidelines](https://cloud.google.com/retail/docs/completion-overview#generated-completion-
359-
dataset).
354+
/** Determines which dataset to use for fetching completion. "user-data" will use the dataset imported
355+
through CompletionService.ImportCompletionData. `cloud-retail` will use the dataset generated by
356+
Cloud Retail based on user events. If left empty, completions will be fetched from the `user-data`
357+
dataset. Current supported values: * user-data * cloud-retail: This option requires enabling auto-
358+
learning function first. See [guidelines](https://cloud.google.com/retail/docs/completion-
359+
overview#generated-completion-dataset).
360360
*/
361361
public java.lang.String getDataset() {
362362
return dataset;
363363
}
364364

365365
/**
366366
* Determines which dataset to use for fetching completion. "user-data" will use the
367-
* imported dataset through CompletionService.ImportCompletionData. "cloud-retail" will
368-
* use the dataset generated by cloud retail based on user events. If leave empty, it will
369-
* use the "user-data". Current supported values: * user-data * cloud-retail: This option
370-
* requires enabling auto-learning function first. See
371-
* [guidelines](https://cloud.google.com/retail/docs/completion-overview#generated-
367+
* dataset imported through CompletionService.ImportCompletionData. `cloud-retail` will
368+
* use the dataset generated by Cloud Retail based on user events. If left empty,
369+
* completions will be fetched from the `user-data` dataset. Current supported values: *
370+
* user-data * cloud-retail: This option requires enabling auto-learning function first.
371+
* See [guidelines](https://cloud.google.com/retail/docs/completion-overview#generated-
372372
* completion-dataset).
373373
*/
374374
public CompleteQuery setDataset(java.lang.String dataset) {
@@ -409,21 +409,21 @@ public CompleteQuery setDeviceType(java.lang.String deviceType) {
409409

410410
/**
411411
* If true, attribute suggestions are enabled and provided in the response. This field is
412-
* only available for the "cloud-retail" dataset.
412+
* only available for the `cloud-retail` dataset.
413413
*/
414414
@com.google.api.client.util.Key
415415
private java.lang.Boolean enableAttributeSuggestions;
416416

417417
/** If true, attribute suggestions are enabled and provided in the response. This field is only
418-
available for the "cloud-retail" dataset.
418+
available for the `cloud-retail` dataset.
419419
*/
420420
public java.lang.Boolean getEnableAttributeSuggestions() {
421421
return enableAttributeSuggestions;
422422
}
423423

424424
/**
425425
* If true, attribute suggestions are enabled and provided in the response. This field is
426-
* only available for the "cloud-retail" dataset.
426+
* only available for the `cloud-retail` dataset.
427427
*/
428428
public CompleteQuery setEnableAttributeSuggestions(java.lang.Boolean enableAttributeSuggestions) {
429429
this.enableAttributeSuggestions = enableAttributeSuggestions;
@@ -434,14 +434,22 @@ public CompleteQuery setEnableAttributeSuggestions(java.lang.Boolean enableAttri
434434
* The entity for customers who run multiple entities, domains, sites, or regions, for
435435
* example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. If this
436436
* is set, it must be an exact match with UserEvent.entity to get per-entity autocomplete
437-
* results.
437+
* results. This field will be applied to `completion_results` only. It has no effect on
438+
* the `attribute_results`. Also, this entity should be limited to 256 characters, if too
439+
* long, it will be truncated to 256 characters in both generation and serving time, and
440+
* may lead to mis-match. To ensure it works, please set the entity with string within 256
441+
* characters.
438442
*/
439443
@com.google.api.client.util.Key
440444
private java.lang.String entity;
441445

442446
/** The entity for customers who run multiple entities, domains, sites, or regions, for example,
443447
`Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. If this is set, it must be an
444-
exact match with UserEvent.entity to get per-entity autocomplete results.
448+
exact match with UserEvent.entity to get per-entity autocomplete results. This field will be
449+
applied to `completion_results` only. It has no effect on the `attribute_results`. Also, this
450+
entity should be limited to 256 characters, if too long, it will be truncated to 256 characters in
451+
both generation and serving time, and may lead to mis-match. To ensure it works, please set the
452+
entity with string within 256 characters.
445453
*/
446454
public java.lang.String getEntity() {
447455
return entity;
@@ -451,7 +459,11 @@ public java.lang.String getEntity() {
451459
* The entity for customers who run multiple entities, domains, sites, or regions, for
452460
* example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. If this
453461
* is set, it must be an exact match with UserEvent.entity to get per-entity autocomplete
454-
* results.
462+
* results. This field will be applied to `completion_results` only. It has no effect on
463+
* the `attribute_results`. Also, this entity should be limited to 256 characters, if too
464+
* long, it will be truncated to 256 characters in both generation and serving time, and
465+
* may lead to mis-match. To ensure it works, please set the entity with string within 256
466+
* characters.
455467
*/
456468
public CompleteQuery setEntity(java.lang.String entity) {
457469
this.entity = entity;
@@ -544,30 +556,30 @@ public CompleteQuery setQuery(java.lang.String query) {
544556
}
545557

546558
/**
547-
* Required field. A unique identifier for tracking visitors. For example, this could be
548-
* implemented with an HTTP cookie, which should be able to uniquely identify a visitor on
549-
* a single device. This unique identifier should not change if the visitor logs in or out
550-
* of the website. The field must be a UTF-8 encoded string with a length limit of 128
559+
* Recommended field. A unique identifier for tracking visitors. For example, this could
560+
* be implemented with an HTTP cookie, which should be able to uniquely identify a visitor
561+
* on a single device. This unique identifier should not change if the visitor logs in or
562+
* out of the website. The field must be a UTF-8 encoded string with a length limit of 128
551563
* characters. Otherwise, an INVALID_ARGUMENT error is returned.
552564
*/
553565
@com.google.api.client.util.Key
554566
private java.lang.String visitorId;
555567

556-
/** Required field. A unique identifier for tracking visitors. For example, this could be implemented
557-
with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This
558-
unique identifier should not change if the visitor logs in or out of the website. The field must be
559-
a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error
560-
is returned.
568+
/** Recommended field. A unique identifier for tracking visitors. For example, this could be
569+
implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single
570+
device. This unique identifier should not change if the visitor logs in or out of the website. The
571+
field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an
572+
INVALID_ARGUMENT error is returned.
561573
*/
562574
public java.lang.String getVisitorId() {
563575
return visitorId;
564576
}
565577

566578
/**
567-
* Required field. A unique identifier for tracking visitors. For example, this could be
568-
* implemented with an HTTP cookie, which should be able to uniquely identify a visitor on
569-
* a single device. This unique identifier should not change if the visitor logs in or out
570-
* of the website. The field must be a UTF-8 encoded string with a length limit of 128
579+
* Recommended field. A unique identifier for tracking visitors. For example, this could
580+
* be implemented with an HTTP cookie, which should be able to uniquely identify a visitor
581+
* on a single device. This unique identifier should not change if the visitor logs in or
582+
* out of the website. The field must be a UTF-8 encoded string with a length limit of 128
571583
* characters. Otherwise, an INVALID_ARGUMENT error is returned.
572584
*/
573585
public CompleteQuery setVisitorId(java.lang.String visitorId) {

clients/google-api-services-retail/v2/2.0.0/com/google/api/services/retail/v2/CloudRetailScopes.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
package com.google.api.services.retail.v2;
1818

1919
/**
20-
* Available OAuth 2.0 scopes for use with the Vertex AI Search for Retail API.
20+
* Available OAuth 2.0 scopes for use with the Vertex AI Search for commerce API.
2121
*
2222
* @since 1.4
2323
*/

clients/google-api-services-retail/v2/2.0.0/com/google/api/services/retail/v2/model/GoogleApiHttpBody.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
* handled, all other features will continue to work unchanged.
3333
*
3434
* <p> This is the Java data model class that specifies how to parse/serialize into the JSON that is
35-
* transmitted over HTTP when working with the Vertex AI Search for Retail API. For a detailed
35+
* transmitted over HTTP when working with the Vertex AI Search for commerce API. For a detailed
3636
* explanation see:
3737
* <a href="https://developers.google.com/api-client-library/java/google-http-java-client/json">https://developers.google.com/api-client-library/java/google-http-java-client/json</a>
3838
* </p>

clients/google-api-services-retail/v2/2.0.0/com/google/api/services/retail/v2/model/GoogleCloudRetailLoggingErrorContext.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
* A description of the context in which an error occurred.
2121
*
2222
* <p> This is the Java data model class that specifies how to parse/serialize into the JSON that is
23-
* transmitted over HTTP when working with the Vertex AI Search for Retail API. For a detailed
23+
* transmitted over HTTP when working with the Vertex AI Search for commerce API. For a detailed
2424
* explanation see:
2525
* <a href="https://developers.google.com/api-client-library/java/google-http-java-client/json">https://developers.google.com/api-client-library/java/google-http-java-client/json</a>
2626
* </p>

clients/google-api-services-retail/v2/2.0.0/com/google/api/services/retail/v2/model/GoogleCloudRetailLoggingErrorLog.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
* google.devtools.clouderrorreporting.v1beta1.ReportedErrorEvent.
2222
*
2323
* <p> This is the Java data model class that specifies how to parse/serialize into the JSON that is
24-
* transmitted over HTTP when working with the Vertex AI Search for Retail API. For a detailed
24+
* transmitted over HTTP when working with the Vertex AI Search for commerce API. For a detailed
2525
* explanation see:
2626
* <a href="https://developers.google.com/api-client-library/java/google-http-java-client/json">https://developers.google.com/api-client-library/java/google-http-java-client/json</a>
2727
* </p>

clients/google-api-services-retail/v2/2.0.0/com/google/api/services/retail/v2/model/GoogleCloudRetailLoggingHttpRequestContext.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
* HTTP request data that is related to a reported error.
2121
*
2222
* <p> This is the Java data model class that specifies how to parse/serialize into the JSON that is
23-
* transmitted over HTTP when working with the Vertex AI Search for Retail API. For a detailed
23+
* transmitted over HTTP when working with the Vertex AI Search for commerce API. For a detailed
2424
* explanation see:
2525
* <a href="https://developers.google.com/api-client-library/java/google-http-java-client/json">https://developers.google.com/api-client-library/java/google-http-java-client/json</a>
2626
* </p>

clients/google-api-services-retail/v2/2.0.0/com/google/api/services/retail/v2/model/GoogleCloudRetailLoggingImportErrorContext.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
* "google.cloud.retail.v2.EventService.ImportUserEvents".
2323
*
2424
* <p> This is the Java data model class that specifies how to parse/serialize into the JSON that is
25-
* transmitted over HTTP when working with the Vertex AI Search for Retail API. For a detailed
25+
* transmitted over HTTP when working with the Vertex AI Search for commerce API. For a detailed
2626
* explanation see:
2727
* <a href="https://developers.google.com/api-client-library/java/google-http-java-client/json">https://developers.google.com/api-client-library/java/google-http-java-client/json</a>
2828
* </p>

clients/google-api-services-retail/v2/2.0.0/com/google/api/services/retail/v2/model/GoogleCloudRetailLoggingServiceContext.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
* Describes a running service that sends errors.
2121
*
2222
* <p> This is the Java data model class that specifies how to parse/serialize into the JSON that is
23-
* transmitted over HTTP when working with the Vertex AI Search for Retail API. For a detailed
23+
* transmitted over HTTP when working with the Vertex AI Search for commerce API. For a detailed
2424
* explanation see:
2525
* <a href="https://developers.google.com/api-client-library/java/google-http-java-client/json">https://developers.google.com/api-client-library/java/google-http-java-client/json</a>
2626
* </p>

clients/google-api-services-retail/v2/2.0.0/com/google/api/services/retail/v2/model/GoogleCloudRetailLoggingSourceLocation.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
* Indicates a location in the source code of the service for which errors are reported.
2121
*
2222
* <p> This is the Java data model class that specifies how to parse/serialize into the JSON that is
23-
* transmitted over HTTP when working with the Vertex AI Search for Retail API. For a detailed
23+
* transmitted over HTTP when working with the Vertex AI Search for commerce API. For a detailed
2424
* explanation see:
2525
* <a href="https://developers.google.com/api-client-library/java/google-http-java-client/json">https://developers.google.com/api-client-library/java/google-http-java-client/json</a>
2626
* </p>

0 commit comments

Comments
 (0)