Note:
This documentation is for version 2.2.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\u003eThe latest version of the .NET client library for the Retail API is 2.12.0, with the current documentation focusing on version 2.2.0.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eGoogle.Cloud.Retail.V2\u003c/code\u003e is a .NET client library that provides access to the Retail API, but is currently limited to users in the early access program.\u003c/p\u003e\n"],["\u003cp\u003eTo gain access to the API, users must apply through the contact page as it is protected by an allow-list.\u003c/p\u003e\n"],["\u003cp\u003eAuthentication is automatic on the Google Cloud Platform, otherwise users can authenticate using a service account JSON file and the \u003ccode\u003eGOOGLE_APPLICATION_CREDENTIALS\u003c/code\u003e environment variable.\u003c/p\u003e\n"],["\u003cp\u003eThe library offers multiple client classes, including \u003ccode\u003eCatalogServiceClient\u003c/code\u003e, \u003ccode\u003eCompletionServiceClient\u003c/code\u003e, and \u003ccode\u003eUserEventServiceClient\u003c/code\u003e, each accessible via static \u003ccode\u003eCreate\u003c/code\u003e or \u003ccode\u003eCreateAsync\u003c/code\u003e methods, or through respective builder classes for custom configurations.\u003c/p\u003e\n"]]],[],null,[]]
