Note:
This documentation is for version 1.6.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."],[[["\u003cp\u003eThis webpage documents the \u003ccode\u003eGoogle.Cloud.Retail.V2\u003c/code\u003e .NET client library, providing access to the Retail API for early access users.\u003c/p\u003e\n"],["\u003cp\u003eThe latest version of this library is 2.12.0, with this documentation specifically covering version 1.6.0, and includes links to documentation for all other versions.\u003c/p\u003e\n"],["\u003cp\u003eInstallation of the library can be achieved through NuGet, and authentication can be done via Google Cloud Platform or using a service account JSON file.\u003c/p\u003e\n"],["\u003cp\u003eThe library's operations are performed through client classes, such as \u003ccode\u003eCatalogServiceClient\u003c/code\u003e, \u003ccode\u003eCompletionServiceClient\u003c/code\u003e, \u003ccode\u003ePredictionServiceClient\u003c/code\u003e, \u003ccode\u003eProductServiceClient\u003c/code\u003e, \u003ccode\u003eSearchServiceClient\u003c/code\u003e, and \u003ccode\u003eUserEventServiceClient\u003c/code\u003e, which are all documented.\u003c/p\u003e\n"],["\u003cp\u003eAccess to this library is restricted to an allow-list and requires users to apply through the contact page.\u003c/p\u003e\n"]]],[],null,[]]