Retail API C++ Client Library
An idiomatic C++ client library for the Retail API. Cloud Retail service enables customers to build end-to-end personalized recommendation systems without requiring a high level of expertise in machine learning, recommendation system, or Google Cloud.
While this library is GA, please note Google Cloud C++ client libraries do not follow Semantic Versioning.
Quickstart
The following shows the code that you'll run in the google/cloud/retail/quickstart/
directory, which should give you a taste of the Retail API C++ client library API.
#include "google/cloud/retail/v2/catalog_client.h"
#include <iostream>
int main(int argc, char* argv[]) try {
if (argc != 2) {
std::cerr << "Usage: " << argv[0] << " project-id\n";
return 1;
}
namespace retail = ::google::cloud::retail_v2;
auto client =
retail::CatalogServiceClient(retail::MakeCatalogServiceConnection());
// The service only accepts "global" as the location for ListCatalogs()
auto const location =
"projects/" + std::string(argv[1]) + "/locations/global";
for (auto r : client.ListCatalogs(location)) {
if (!r) throw std::move(r).status();
std::cout << r->DebugString() << "\n";
}
return 0;
} catch (google::cloud::Status const& status) {
std::cerr << "google::cloud::Status thrown: " << status << "\n";
return 1;
}
Main classes
This library offers multiple *Client
classes, which are listed below. Each one of these classes exposes all the RPCs for a gRPC service
as member functions of the class. This library groups multiple gRPC services because they are part of the same product or are often used together. A typical example may be the administrative and data plane operations for a single product.
The library also has other classes that provide helpers, configuration parameters, and infrastructure to mock the *Client
classes when testing your application.
retail_v2::CatalogServiceClient
retail_v2::CompletionServiceClient
retail_v2::ControlServiceClient
retail_v2::ModelServiceClient
retail_v2::PredictionServiceClient
retail_v2::ProductServiceClient
retail_v2::SearchServiceClient
retail_v2::ServingConfigServiceClient
retail_v2::UserEventServiceClient
More Information
- Error Handling - describes how the library reports errors.
- How to Override the Default Endpoint - describes how to override the default endpoint.
- How to Override the Authentication Credentials - describes how to change the authentication credentials used by the library.
- Override Retry, Backoff, and Idempotency Policies - describes how to change the default retry policies.
- Environment Variables - describes environment variables that can configure the behavior of the library.