Struct google_recommendationengine1_beta1::api::ProjectLocationCatalogEventStorePlacementPredictCall [−][src]
pub struct ProjectLocationCatalogEventStorePlacementPredictCall<'a> { /* fields omitted */ }Expand description
Makes a recommendation prediction. If using API Key based authentication, the API Key must be registered using the PredictionApiKeyRegistry service. Learn more.
A builder for the locations.catalogs.eventStores.placements.predict method supported by a project resource.
It is not used directly, but through a ProjectMethods instance.
Example
Instantiate a resource method builder
use recommendationengine1_beta1::api::GoogleCloudRecommendationengineV1beta1PredictRequest;
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = GoogleCloudRecommendationengineV1beta1PredictRequest::default();
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.projects().locations_catalogs_event_stores_placements_predict(req, "name")
.doit().await;Implementations
Perform the operation you have build so far.
pub fn request(
self,
new_value: GoogleCloudRecommendationengineV1beta1PredictRequest
) -> ProjectLocationCatalogEventStorePlacementPredictCall<'a>
pub fn request(
self,
new_value: GoogleCloudRecommendationengineV1beta1PredictRequest
) -> ProjectLocationCatalogEventStorePlacementPredictCall<'a>
Sets the request property to the given value.
Even though the property as already been set when instantiating this call, we provide this method for API completeness.
pub fn name(
self,
new_value: &str
) -> ProjectLocationCatalogEventStorePlacementPredictCall<'a>
pub fn name(
self,
new_value: &str
) -> ProjectLocationCatalogEventStorePlacementPredictCall<'a>
Required. 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 events, 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/datafeeds/default_catalog/dashboard
Sets the name path property to the given value.
Even though the property as already been set when instantiating this call, we provide this method for API completeness.
pub fn delegate(
self,
new_value: &'a mut dyn Delegate
) -> ProjectLocationCatalogEventStorePlacementPredictCall<'a>
pub fn delegate(
self,
new_value: &'a mut dyn Delegate
) -> ProjectLocationCatalogEventStorePlacementPredictCall<'a>
The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong while executing the actual API request.
It should be used to handle progress information, and to implement a certain level of resilience.
Sets the delegate property to the given value.
pub fn param<T>(
self,
name: T,
value: T
) -> ProjectLocationCatalogEventStorePlacementPredictCall<'a> where
T: AsRef<str>,
pub fn param<T>(
self,
name: T,
value: T
) -> ProjectLocationCatalogEventStorePlacementPredictCall<'a> where
T: AsRef<str>,
Set any additional parameter of the query string used in the request. It should be used to set parameters which are not yet available through their own setters.
Please note that this method must not be used to set any of the known parameters which have their own setter method. If done anyway, the request will fail.
Additional Parameters
- $.xgafv (query-string) - V1 error format.
- access_token (query-string) - OAuth access token.
- alt (query-string) - Data format for response.
- callback (query-string) - JSONP
- fields (query-string) - Selector specifying which fields to include in a partial response.
- key (query-string) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- oauth_token (query-string) - OAuth 2.0 token for the current user.
- prettyPrint (query-boolean) - Returns response with indentations and line breaks.
- quotaUser (query-string) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadType (query-string) - Legacy upload protocol for media (e.g. “media”, “multipart”).
- upload_protocol (query-string) - Upload protocol for media (e.g. “raw”, “multipart”).
Identifies the authorization scope for the method you are building.
Use this method to actively specify which scope should be used, instead the default Scope variant
Scope::CloudPlatform.
The scope will be added to a set of scopes. This is important as one can maintain access
tokens for more than one scope.
If None is specified, then all scopes will be removed and no default scope will be used either.
In that case, you have to specify your API-key using the key parameter (see the param()
function for details).
Usually there is more than one suitable scope to authorize an operation, some of which may encompass more rights than others. For example, for listing resources, a read-only scope will be sufficient, a read-write scope will do as well.