* $recommendationengineService = new Google\Service\RecommendationsAI(...); * $placements = $recommendationengineService->placements; * */ class ProjectsLocationsCatalogsEventStoresPlacements extends \Google\Service\Resource { /** * Makes a recommendation prediction. If using API Key based authentication, the * API Key must be registered using the PredictionApiKeyRegistry service. [Learn * more](https://cloud.google.com/recommendations-ai/docs/setting-up#register- * key). (placements.predict) * * @param string $name Required. Full resource name of the format: `{name=projec * ts/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 * @param GoogleCloudRecommendationengineV1beta1PredictRequest $postBody * @param array $optParams Optional parameters. * @return GoogleCloudRecommendationengineV1beta1PredictResponse */ public function predict($name, GoogleCloudRecommendationengineV1beta1PredictRequest $postBody, $optParams = []) { $params = ['name' => $name, 'postBody' => $postBody]; $params = array_merge($params, $optParams); return $this->call('predict', [$params], GoogleCloudRecommendationengineV1beta1PredictResponse::class); } } // Adding a class alias for backwards compatibility with the previous class name. class_alias(ProjectsLocationsCatalogsEventStoresPlacements::class, 'Google_Service_RecommendationsAI_Resource_ProjectsLocationsCatalogsEventStoresPlacements');