Google.Cloud.Retail.V2

Google.Cloud.Retail.V2 is a.NET client library for the Retail API.

Note: early access users only

This package is currently protected by an allow-list, and will not work for customers who are not registered in the early access programme.

Please use the contact page to apply for access.

Note: This documentation is for version 1.0.0-beta01 of the library. Some samples may not work with other versions.

Installation

Install the Google.Cloud.Retail.V2 package from NuGet. Add it to your project in the normal way (for example by right-clicking on the project in Visual Studio and choosing "Manage NuGet Packages..."). Please ensure you enable pre-release packages (for example, in the Visual Studio NuGet user interface, check the "Include prerelease" box). Some of the following samples might only work with the latest pre-release version (1.0.0-beta01) of Google.Cloud.Retail.V2.

Authentication

When running on Google Cloud Platform, no action needs to be taken to authenticate.

Otherwise, the simplest way of authenticating your API calls is to download a service account JSON file then set the GOOGLE_APPLICATION_CREDENTIALS environment variable to refer to it. The credentials will automatically be used to authenticate. See the Getting Started With Authentication guide for more details.

Getting started

All operations are performed through the following client classes:

• CatalogServiceClient
• PredictionServiceClient
• ProductServiceClient
• UserEventServiceClient

Create a client instance by calling the static Create or CreateAsync methods. Alternatively, use the builder class associated with each client class (e.g. CatalogServiceClientBuilder for CatalogServiceClient) as an easy way of specifying custom credentials, settings, or a custom endpoint. Clients are thread-safe, and we recommend using a single instance across your entire application unless you have a particular need to configure multiple client objects separately.