Note:
This documentation is for version 2.1.0 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...").
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:
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-21 UTC."],[[["The `Google.Cloud.Retail.V2` library is a .NET client for the Retail API, currently in early access and only available to registered users."],["The documentation provided is specifically for version `2.1.0` of the library, and users should note that samples may not be compatible with other versions, which range from version 1.0.0 up to 2.12.0."],["Authentication with the API on the Google Cloud Platform requires no special steps, but for other environments, setting the `GOOGLE_APPLICATION_CREDENTIALS` environment variable with a service account JSON file is recommended."],["The library provides several client classes for interacting with different aspects of the Retail API, including `CatalogServiceClient`, `CompletionServiceClient`, `PredictionServiceClient`, `ProductServiceClient`, `SearchServiceClient`, and `UserEventServiceClient`."],["Client instances can be created using static `Create` or `CreateAsync` methods, or by using a builder class, and these instances are thread-safe, making a single instance per application sufficient in most cases."]]],[]]