Package Classes (0.11.0)

Summary of entries of Classes for recommendationengine.

Classes

CatalogServiceAsyncClient

Service for ingesting catalog information of the customer'swebsite.

CatalogServiceClient

Service for ingesting catalog information of the customer'swebsite.

ListCatalogItemsAsyncPager

A pager for iterating throughlist_catalog_items requests.

This class thinly wraps an initialListCatalogItemsResponse object, andprovides an__aiter__ method to iterate through itscatalog_items field.

If there are more pages, the__aiter__ method will make additionalListCatalogItems requests and continue to iteratethrough thecatalog_items field on thecorresponding responses.

All the usualListCatalogItemsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

ListCatalogItemsPager

A pager for iterating throughlist_catalog_items requests.

This class thinly wraps an initialListCatalogItemsResponse object, andprovides an__iter__ method to iterate through itscatalog_items field.

If there are more pages, the__iter__ method will make additionalListCatalogItems requests and continue to iteratethrough thecatalog_items field on thecorresponding responses.

All the usualListCatalogItemsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

PredictionApiKeyRegistryAsyncClient

Service for registering API keys for use with thepredictmethod. If you use an API key to request predictions, you must firstregister the API key. Otherwise, your prediction request isrejected. If you use OAuth to authenticate yourpredict methodcall, you do not need to register an API key. You can register up to20 API keys per project.

PredictionApiKeyRegistryClient

Service for registering API keys for use with thepredictmethod. If you use an API key to request predictions, you must firstregister the API key. Otherwise, your prediction request isrejected. If you use OAuth to authenticate yourpredict methodcall, you do not need to register an API key. You can register up to20 API keys per project.

ListPredictionApiKeyRegistrationsAsyncPager

A pager for iterating throughlist_prediction_api_key_registrations requests.

This class thinly wraps an initialListPredictionApiKeyRegistrationsResponse object, andprovides an__aiter__ method to iterate through itsprediction_api_key_registrations field.

If there are more pages, the__aiter__ method will make additionalListPredictionApiKeyRegistrations requests and continue to iteratethrough theprediction_api_key_registrations field on thecorresponding responses.

All the usualListPredictionApiKeyRegistrationsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

ListPredictionApiKeyRegistrationsPager

A pager for iterating throughlist_prediction_api_key_registrations requests.

This class thinly wraps an initialListPredictionApiKeyRegistrationsResponse object, andprovides an__iter__ method to iterate through itsprediction_api_key_registrations field.

If there are more pages, the__iter__ method will make additionalListPredictionApiKeyRegistrations requests and continue to iteratethrough theprediction_api_key_registrations field on thecorresponding responses.

All the usualListPredictionApiKeyRegistrationsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

PredictionServiceAsyncClient

Service for making recommendation prediction.

PredictionServiceClient

Service for making recommendation prediction.

PredictAsyncPager

A pager for iterating throughpredict requests.

This class thinly wraps an initialPredictResponse object, andprovides an__aiter__ method to iterate through itsresults field.

If there are more pages, the__aiter__ method will make additionalPredict requests and continue to iteratethrough theresults field on thecorresponding responses.

All the usualPredictResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

PredictPager

A pager for iterating throughpredict requests.

This class thinly wraps an initialPredictResponse object, andprovides an__iter__ method to iterate through itsresults field.

If there are more pages, the__iter__ method will make additionalPredict requests and continue to iteratethrough theresults field on thecorresponding responses.

All the usualPredictResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

UserEventServiceAsyncClient

Service for ingesting end user actions on the customerwebsite.

UserEventServiceClient

Service for ingesting end user actions on the customerwebsite.

ListUserEventsAsyncPager

A pager for iterating throughlist_user_events requests.

This class thinly wraps an initialListUserEventsResponse object, andprovides an__aiter__ method to iterate through itsuser_events field.

If there are more pages, the__aiter__ method will make additionalListUserEvents requests and continue to iteratethrough theuser_events field on thecorresponding responses.

All the usualListUserEventsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

ListUserEventsPager

A pager for iterating throughlist_user_events requests.

This class thinly wraps an initialListUserEventsResponse object, andprovides an__iter__ method to iterate through itsuser_events field.

If there are more pages, the__iter__ method will make additionalListUserEvents requests and continue to iteratethrough theuser_events field on thecorresponding responses.

All the usualListUserEventsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

CatalogInlineSource

The inline source for the input config for ImportCatalogItemsmethod.

CatalogItem

CatalogItem captures all metadata information of items to berecommended.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CategoryHierarchy

Category represents catalog item category hierarchy.

CollectUserEventRequest

Request message for CollectUserEvent method.

CreateCatalogItemRequest

Request message for CreateCatalogItem method.

CreatePredictionApiKeyRegistrationRequest

Request message for theCreatePredictionApiKeyRegistrationmethod.

DeleteCatalogItemRequest

Request message for DeleteCatalogItem method.

DeletePredictionApiKeyRegistrationRequest

Request message forDeletePredictionApiKeyRegistration method.

EventDetail

User event details shared by all recommendation types.

FeatureMap

FeatureMap represents extra features that customers want toinclude in the recommendation model for catalogs/user events ascategorical/numerical features.

CategoricalFeaturesEntry

The abstract base class for a message.

FloatList

A list of float features.

NumericalFeaturesEntry

The abstract base class for a message.

StringList

A list of string features.

GcsSource

Google Cloud Storage location for input content.format.

GetCatalogItemRequest

Request message for GetCatalogItem method.

Image

Catalog item thumbnail/detail image.

ImportCatalogItemsRequest

Request message for Import methods.

ImportCatalogItemsResponse

Response of the ImportCatalogItemsRequest. If the longrunning operation is done, then this message is returned by thegoogle.longrunning.Operations.response field if the operationwas successful.

ImportErrorsConfig

Configuration of destination for Import related errors.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ImportMetadata

Metadata related to the progress of the Import operation.This will be returned by thegoogle.longrunning.Operation.metadata field.

ImportUserEventsRequest

Request message for the ImportUserEvents request.

ImportUserEventsResponse

Response of the ImportUserEventsRequest. If the long runningoperation was successful, then this message is returned by thegoogle.longrunning.Operations.response field if the operationwas successful.

InputConfig

The input config source.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ListCatalogItemsRequest

Request message for ListCatalogItems method.

ListCatalogItemsResponse

Response message for ListCatalogItems method.

ListPredictionApiKeyRegistrationsRequest

Request message for theListPredictionApiKeyRegistrations.

ListPredictionApiKeyRegistrationsResponse

Response message for theListPredictionApiKeyRegistrations.

ListUserEventsRequest

Request message for ListUserEvents method.

ListUserEventsResponse

Response message for ListUserEvents method.

PredictRequest

Request message for Predict method.

LabelsEntry

The abstract base class for a message.

ParamsEntry

The abstract base class for a message.

PredictResponse

Response message for predict method.

MetadataEntry

The abstract base class for a message.

PredictionResult

PredictionResult represents the recommendation predictionresults.

ItemMetadataEntry

The abstract base class for a message.

PredictionApiKeyRegistration

Registered Api Key.

ProductCatalogItem

ProductCatalogItem captures item metadata specific to retailproducts.

This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CostsEntry

The abstract base class for a message.

ExactPrice

Exact product price.

PriceRange

Product price range when there are a range of prices fordifferent variations of the same product.

StockState

Item stock state. If this field is unspecified, the item isassumed to be in stock.

ProductDetail

Detailed product information associated with a user event.

ProductEventDetail

ProductEventDetail captures user event information specificto retail products.

PurchaseTransaction

A transaction represents the entire purchase transaction.

CostsEntry

The abstract base class for a message.

TaxesEntry

The abstract base class for a message.

PurgeUserEventsMetadata

Metadata related to the progress of the PurgeUserEventsoperation. This will be returned by thegoogle.longrunning.Operation.metadata field.

PurgeUserEventsRequest

Request message for PurgeUserEvents method.

PurgeUserEventsResponse

Response of the PurgeUserEventsRequest. If the long runningoperation is successfully done, then this message is returned bythe google.longrunning.Operations.response field.

UpdateCatalogItemRequest

Request message for UpdateCatalogItem method.

UserEvent

UserEvent captures all metadata information recommendationengine needs to know about how end users interact withcustomers' website.

EventSource

User event source.

UserEventImportSummary

A summary of import result. The UserEventImportSummarysummarizes the import status for user events.

UserEventInlineSource

The inline source for the input config for ImportUserEventsmethod.

UserInfo

Information of end users.

WriteUserEventRequest

Request message for WriteUserEvent method.

Modules

pagers

API documentation forrecommendationengine_v1beta1.services.catalog_service.pagers module.

pagers

API documentation forrecommendationengine_v1beta1.services.prediction_api_key_registry.pagers module.

pagers

API documentation forrecommendationengine_v1beta1.services.prediction_service.pagers module.

pagers

API documentation forrecommendationengine_v1beta1.services.user_event_service.pagers module.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-10-30 UTC.