Note:
This documentation is for version 1.4.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"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["`Google.Cloud.Retail.V2` is a .NET client library for the Retail API, designed for early access users who have been registered in the program."],["The latest version of this library is 2.12.0, but this documentation is specifically for version 1.4.0, with potential sample compatibility issues in other versions."],["Installation involves using NuGet to add the `Google.Cloud.Retail.V2` package to your .NET project."],["Authentication is automatic on Google Cloud Platform; otherwise, you can authenticate using a service account JSON file and the `GOOGLE_APPLICATION_CREDENTIALS` environment variable."],["The library provides multiple client classes, including `CatalogServiceClient`, `CompletionServiceClient`, `PredictionServiceClient`, `ProductServiceClient`, `SearchServiceClient`, and `UserEventServiceClient`, all accessible via static `Create` or `CreateAsync` methods or through builder classes."]]],[]]
