Java idiomatic client for Cloud Retail.

• Product Documentation
• Client Library Documentation

If you are using Maven, add this to your pom.xml file:

<dependency>
  <groupId>com.google.cloud</groupId>
  <artifactId>google-cloud-retail</artifactId>
  <version>2.1.0</version>
</dependency>

If you are using Gradle without BOM, add this to your dependencies

implementation 'com.google.cloud:google-cloud-retail:2.1.0'

If you are using SBT, add this to your dependencies

libraryDependencies += "com.google.cloud" % "google-cloud-retail" % "2.1.0"

See the Authentication section in the base directory's README.

The client application making API calls must be granted authorization scopes required for the desired Cloud Retail APIs, and the authenticated principal must have the IAM role(s) required to access GCP resources using the Cloud Retail API calls.

You will need a Google Cloud Platform Console project with the Cloud Retail API enabled. You will need to enable billing to use Google Cloud Retail. Follow these instructions to get your project set up. You will also need to set up the local development environment by installing the Google Cloud SDK and running the following commands in command line: gcloud auth login and gcloud config set project [YOUR PROJECT ID].

You'll need to obtain the google-cloud-retail library. See the Quickstart section to add google-cloud-retail as a dependency in your code.

Cloud Retail Retail solutions API.

See the Cloud Retail client library docs to learn how to use this Cloud Retail Client Library.

Samples are in the samples/ directory.

Sample	Source Code	Try it
Import User Events Big Query	source code
Import User Events Gcs	source code
Import User Events Inline	source code
Purge User Event	source code
Rejoin User Event	source code
Write User Event	source code
Events Create Big Query Table	source code
Events Create Gcs Bucket	source code
Create Test Resources	source code
Remove Test Resources	source code
Add Fulfillment Places	source code
Create Product	source code
Crud Product	source code
Delete Product	source code
Get Product	source code
Import Products Big Query Table	source code
Import Products Gcs	source code
Import Products Inline Source	source code
Remove Fulfillment Places	source code
Set Inventory	source code
Update Product	source code
Products Create Bigquery Table	source code
Products Create Gcs Bucket	source code
Search Simple Query	source code
Search With Boost Spec	source code
Search With Facet Spec	source code
Search With Filtering	source code
Search With Ordering	source code
Search With Pagination	source code
Search With Query Expansion Spec	source code
Setup Cleanup	source code

To get help, follow the instructions in the shared Troubleshooting document.

Cloud Retail uses gRPC for the transport layer.

Java 8 or above is required for using this client.

Google's Java client libraries, Google Cloud Client Libraries and Google Cloud API Libraries, follow the Oracle Java SE support roadmap (see the Oracle Java SE Product Releases section).

In general, new feature development occurs with support for the lowest Java LTS version covered by Oracle's Premier Support (which typically lasts 5 years from initial General Availability). If the minimum required JVM for a given library is changed, it is accompanied by a semver major release.

Java 11 and (in September 2021) Java 17 are the best choices for new development.

Google tests its client libraries with all current LTS versions covered by Oracle's Extended Support (which typically lasts 8 years from initial General Availability).

Google's client libraries support legacy versions of Java runtimes with long term stable libraries that don't receive feature updates on a best efforts basis as it may not be possible to backport all patches.

Google provides updates on a best efforts basis to apps that continue to use Java 7, though apps might need to upgrade to current versions of the library that supports their JVM.

The latest versions and the supported Java versions are identified on the individual GitHub repository github.com/GoogleAPIs/java-SERVICENAME and on google-cloud-java.

This library follows Semantic Versioning.

Contributions to this library are always welcome and highly encouraged.

See CONTRIBUTING for more information how to get started.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See Code of Conduct for more information.

Apache 2.0 - See LICENSE for more information.

Java Version	Status
Java 8
Java 8 OSX
Java 8 Windows
Java 11

Java is a registered trademark of Oracle and/or its affiliates.