View Source API Reference google_api_recommendation_engine v0.4.6
Modules
API client metadata for GoogleApi.RecommendationEngine.V1beta1.
API calls for all endpoints tagged Projects
.
Handle Tesla connections for GoogleApi.RecommendationEngine.V1beta1.
Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
Metadata for TriggerCatalogRejoin method.
Response message for TriggerCatalogRejoin method.
Metadata associated with a tune operation.
Response associated with a tune operation.
BigQuery source import data from.
The catalog configuration. Next ID: 5.
The inline source for the input config for ImportCatalogItems method.
CatalogItem captures all metadata information of items to be recommended.
Category represents catalog item category hierarchy.
Configures the catalog level that users send events to, and the level at which predictions are made.
Request message for the CreatePredictionApiKeyRegistration
method.
User event details shared by all recommendation types.
FeatureMap represents extra features that customers want to include in the recommendation model for catalogs/user events as categorical/numerical features.
A list of float features.
A list of string features.
Google Cloud Storage location for input content. format.
Catalog item thumbnail/detail image.
Request message for Import methods.
Response of the ImportCatalogItemsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
Configuration of destination for Import related errors.
Metadata related to the progress of the Import operation. This will be returned by the google.longrunning.Operation.metadata field.
Request message for the ImportUserEvents request.
Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
The input config source.
Response message for ListCatalogItems method.
Response for ListCatalogs method.
Response message for the ListPredictionApiKeyRegistrations
.
Response message for ListUserEvents method.
Request message for Predict method. Full resource name of the format: {name=projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/placements/*}
The id of the recommendation engine placement. This id is used to identify the set of models that will be used to make the prediction. We currently support three placements with the following IDs by default: // shopping_cart
: Predicts items frequently bought together with one or more catalog items in the same shopping session. Commonly displayed after add-to-cart
event, on product detail pages, or on the shopping cart page. home_page
: Predicts the next product that a user will most likely engage with or purchase based on the shopping or viewing history of the specified userId
or visitorId
. For example - Recommendations for you. product_detail
: Predicts the next product that a user will most likely engage with or purchase. The prediction is based on the shopping or viewing history of the specified userId
or visitorId
and its relevance to a specified CatalogItem
. Typically used on product detail pages. For example - More items like this. recently_viewed_default
: Returns up to 75 items recently viewed by the specified userId
or visitorId
, most recent ones first. Returns nothing if neither of them has viewed any items yet. For example - Recently viewed. The full list of available placements can be seen at https://console.cloud.google.com/recommendation/catalogs/default_catalog/placements
Response message for predict method.
PredictionResult represents the recommendation prediction results.
Registered Api Key.
ProductCatalogItem captures item metadata specific to retail products.
Exact product price.
Product price range when there are a range of prices for different variations of the same product.
Detailed product information associated with a user event.
ProductEventDetail captures user event information specific to retail products.
A transaction represents the entire purchase transaction.
Metadata related to the progress of the PurgeUserEvents operation. This will be returned by the google.longrunning.Operation.metadata field.
Request message for PurgeUserEvents method.
Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.
Metadata for RejoinUserEvents method.
Request message for CatalogRejoin method.
Response message for RejoinUserEvents method.
UserEvent captures all metadata information recommendation engine needs to know about how end users interact with customers' website.
A summary of import result. The UserEventImportSummary summarizes the import status for user events.
The inline source for the input config for ImportUserEvents method.
Information of end users.
The response message for Operations.ListOperations.
This resource represents a long-running operation that is the result of a network API call.
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
The Status
type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status
message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.