Recommendations AI (Beta): projects. Note that we now highly recommend new customers to use Retail API, which incorporates the GA version of the Recommendations AI funtionalities. To enable Retail API, please visit https://console.cloud.google.com/apis/library/retail.googleapis.com. The Recommendations AI 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. See: https://cloud.google.com/recommendations-ai/docsapi/reference/rest/v1beta1/projects
Recommendations AI (Beta): projects. Note that we now highly recommend new customers to use Retail API, which incorporates the GA version of the Recommendations AI funtionalities. To enable Retail API, please visit https://console.cloud.google.com/apis/library/retail.googleapis.com. The Recommendations AI 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. See: https://cloud.google.com/recommendations-ai/docsapi/reference/rest/v1beta1/projects
(locations-catalogs-catalogItems-create$ auth parameters body)
Required parameters: parent
Optional parameters: none
Body:
{:description string, :tags [string], :productMetadata {:exactPrice GoogleCloudRecommendationengineV1beta1ProductCatalogItemExactPrice, :priceRange GoogleCloudRecommendationengineV1beta1ProductCatalogItemPriceRange, :costs {}, :currencyCode string, :stockState string, :availableQuantity string, :canonicalProductUri string, :images [GoogleCloudRecommendationengineV1beta1Image]}, :itemAttributes {:categoricalFeatures {}, :numericalFeatures {}}, :title string, :languageCode string, :itemGroupId string, :id string, :categoryHierarchies [{:categories [string]}]}
Creates a catalog item.
https://cloud.google.com/recommendations-ai/docsapi/reference/rest/v1beta1/projects/locations/catalogs/catalogItems/create Required parameters: parent Optional parameters: none Body: {:description string, :tags [string], :productMetadata {:exactPrice GoogleCloudRecommendationengineV1beta1ProductCatalogItemExactPrice, :priceRange GoogleCloudRecommendationengineV1beta1ProductCatalogItemPriceRange, :costs {}, :currencyCode string, :stockState string, :availableQuantity string, :canonicalProductUri string, :images [GoogleCloudRecommendationengineV1beta1Image]}, :itemAttributes {:categoricalFeatures {}, :numericalFeatures {}}, :title string, :languageCode string, :itemGroupId string, :id string, :categoryHierarchies [{:categories [string]}]} Creates a catalog item.
(locations-catalogs-catalogItems-delete$ auth parameters)
Required parameters: name
Optional parameters: none
Deletes a catalog item.
https://cloud.google.com/recommendations-ai/docsapi/reference/rest/v1beta1/projects/locations/catalogs/catalogItems/delete Required parameters: name Optional parameters: none Deletes a catalog item.
(locations-catalogs-catalogItems-get$ auth parameters)
Required parameters: name
Optional parameters: none
Gets a specific catalog item.
https://cloud.google.com/recommendations-ai/docsapi/reference/rest/v1beta1/projects/locations/catalogs/catalogItems/get Required parameters: name Optional parameters: none Gets a specific catalog item.
(locations-catalogs-catalogItems-import$ auth parameters body)
Required parameters: parent
Optional parameters: none
Body:
{:requestId string, :inputConfig {:catalogInlineSource GoogleCloudRecommendationengineV1beta1CatalogInlineSource, :gcsSource GoogleCloudRecommendationengineV1beta1GcsSource, :userEventInlineSource GoogleCloudRecommendationengineV1beta1UserEventInlineSource, :bigQuerySource GoogleCloudRecommendationengineV1beta1BigQuerySource}, :errorsConfig {:gcsPrefix string}, :updateMask string}
Bulk import of multiple catalog items. Request processing may be synchronous. No partial updating supported. Non-existing items will be created. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully updated.
https://cloud.google.com/recommendations-ai/docsapi/reference/rest/v1beta1/projects/locations/catalogs/catalogItems/import Required parameters: parent Optional parameters: none Body: {:requestId string, :inputConfig {:catalogInlineSource GoogleCloudRecommendationengineV1beta1CatalogInlineSource, :gcsSource GoogleCloudRecommendationengineV1beta1GcsSource, :userEventInlineSource GoogleCloudRecommendationengineV1beta1UserEventInlineSource, :bigQuerySource GoogleCloudRecommendationengineV1beta1BigQuerySource}, :errorsConfig {:gcsPrefix string}, :updateMask string} Bulk import of multiple catalog items. Request processing may be synchronous. No partial updating supported. Non-existing items will be created. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully updated.
(locations-catalogs-catalogItems-list$ auth parameters)
Required parameters: parent
Optional parameters: pageSize, pageToken, filter
Gets a list of catalog items.
https://cloud.google.com/recommendations-ai/docsapi/reference/rest/v1beta1/projects/locations/catalogs/catalogItems/list Required parameters: parent Optional parameters: pageSize, pageToken, filter Gets a list of catalog items.
(locations-catalogs-catalogItems-patch$ auth parameters body)
Required parameters: name
Optional parameters: updateMask
Body:
{:description string, :tags [string], :productMetadata {:exactPrice GoogleCloudRecommendationengineV1beta1ProductCatalogItemExactPrice, :priceRange GoogleCloudRecommendationengineV1beta1ProductCatalogItemPriceRange, :costs {}, :currencyCode string, :stockState string, :availableQuantity string, :canonicalProductUri string, :images [GoogleCloudRecommendationengineV1beta1Image]}, :itemAttributes {:categoricalFeatures {}, :numericalFeatures {}}, :title string, :languageCode string, :itemGroupId string, :id string, :categoryHierarchies [{:categories [string]}]}
Updates a catalog item. Partial updating is supported. Non-existing items will be created.
https://cloud.google.com/recommendations-ai/docsapi/reference/rest/v1beta1/projects/locations/catalogs/catalogItems/patch Required parameters: name Optional parameters: updateMask Body: {:description string, :tags [string], :productMetadata {:exactPrice GoogleCloudRecommendationengineV1beta1ProductCatalogItemExactPrice, :priceRange GoogleCloudRecommendationengineV1beta1ProductCatalogItemPriceRange, :costs {}, :currencyCode string, :stockState string, :availableQuantity string, :canonicalProductUri string, :images [GoogleCloudRecommendationengineV1beta1Image]}, :itemAttributes {:categoricalFeatures {}, :numericalFeatures {}}, :title string, :languageCode string, :itemGroupId string, :id string, :categoryHierarchies [{:categories [string]}]} Updates a catalog item. Partial updating is supported. Non-existing items will be created.
(locations-catalogs-eventStores-operations-get$ auth parameters)
Required parameters: name
Optional parameters: none
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
https://cloud.google.com/recommendations-ai/docsapi/reference/rest/v1beta1/projects/locations/catalogs/eventStores/operations/get Required parameters: name Optional parameters: none Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
(locations-catalogs-eventStores-operations-list$ auth parameters)
Required parameters: name
Optional parameters: filter, pageSize, pageToken
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
https://cloud.google.com/recommendations-ai/docsapi/reference/rest/v1beta1/projects/locations/catalogs/eventStores/operations/list Required parameters: name Optional parameters: filter, pageSize, pageToken Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
(locations-catalogs-eventStores-placements-predict$ auth parameters body)
Required parameters: name
Optional parameters: none
Body:
{:userEvent {:eventType string, :userInfo GoogleCloudRecommendationengineV1beta1UserInfo, :eventDetail GoogleCloudRecommendationengineV1beta1EventDetail, :productEventDetail GoogleCloudRecommendationengineV1beta1ProductEventDetail, :eventTime string, :eventSource string}, :pageSize integer, :pageToken string, :filter string, :dryRun boolean, :params {}, :labels {}}
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/docsapi/reference/rest/v1beta1/projects/locations/catalogs/eventStores/placements/predict Required parameters: name Optional parameters: none Body: {:userEvent {:eventType string, :userInfo GoogleCloudRecommendationengineV1beta1UserInfo, :eventDetail GoogleCloudRecommendationengineV1beta1EventDetail, :productEventDetail GoogleCloudRecommendationengineV1beta1ProductEventDetail, :eventTime string, :eventSource string}, :pageSize integer, :pageToken string, :filter string, :dryRun boolean, :params {}, :labels {}} 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).
(locations-catalogs-eventStores-predictionApiKeyRegistrations-create$ auth
parameters
body)
Required parameters: parent
Optional parameters: none
Body:
{:predictionApiKeyRegistration {:apiKey string}}
Register an API key for use with predict method.
https://cloud.google.com/recommendations-ai/docsapi/reference/rest/v1beta1/projects/locations/catalogs/eventStores/predictionApiKeyRegistrations/create Required parameters: parent Optional parameters: none Body: {:predictionApiKeyRegistration {:apiKey string}} Register an API key for use with predict method.
(locations-catalogs-eventStores-predictionApiKeyRegistrations-delete$
auth
parameters)
Required parameters: name
Optional parameters: none
Unregister an apiKey from using for predict method.
https://cloud.google.com/recommendations-ai/docsapi/reference/rest/v1beta1/projects/locations/catalogs/eventStores/predictionApiKeyRegistrations/delete Required parameters: name Optional parameters: none Unregister an apiKey from using for predict method.
(locations-catalogs-eventStores-predictionApiKeyRegistrations-list$ auth
parameters)
Required parameters: parent
Optional parameters: pageSize, pageToken
List the registered apiKeys for use with predict method.
https://cloud.google.com/recommendations-ai/docsapi/reference/rest/v1beta1/projects/locations/catalogs/eventStores/predictionApiKeyRegistrations/list Required parameters: parent Optional parameters: pageSize, pageToken List the registered apiKeys for use with predict method.
(locations-catalogs-eventStores-userEvents-collect$ auth parameters)
Required parameters: parent
Optional parameters: userEvent, uri, ets
Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain. This method is used only by the Recommendations AI JavaScript pixel. Users should not call this method directly.
https://cloud.google.com/recommendations-ai/docsapi/reference/rest/v1beta1/projects/locations/catalogs/eventStores/userEvents/collect Required parameters: parent Optional parameters: userEvent, uri, ets Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain. This method is used only by the Recommendations AI JavaScript pixel. Users should not call this method directly.
(locations-catalogs-eventStores-userEvents-import$ auth parameters body)
Required parameters: parent
Optional parameters: none
Body:
{:requestId string, :inputConfig {:catalogInlineSource GoogleCloudRecommendationengineV1beta1CatalogInlineSource, :gcsSource GoogleCloudRecommendationengineV1beta1GcsSource, :userEventInlineSource GoogleCloudRecommendationengineV1beta1UserEventInlineSource, :bigQuerySource GoogleCloudRecommendationengineV1beta1BigQuerySource}, :errorsConfig {:gcsPrefix string}}
Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.
https://cloud.google.com/recommendations-ai/docsapi/reference/rest/v1beta1/projects/locations/catalogs/eventStores/userEvents/import Required parameters: parent Optional parameters: none Body: {:requestId string, :inputConfig {:catalogInlineSource GoogleCloudRecommendationengineV1beta1CatalogInlineSource, :gcsSource GoogleCloudRecommendationengineV1beta1GcsSource, :userEventInlineSource GoogleCloudRecommendationengineV1beta1UserEventInlineSource, :bigQuerySource GoogleCloudRecommendationengineV1beta1BigQuerySource}, :errorsConfig {:gcsPrefix string}} Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.
(locations-catalogs-eventStores-userEvents-list$ auth parameters)
Required parameters: parent
Optional parameters: pageSize, pageToken, filter
Gets a list of user events within a time range, with potential filtering. The method does not list unjoined user events. Unjoined user event definition: when a user event is ingested from Recommendations AI User Event APIs, the catalog item included in the user event is connected with the current catalog. If a catalog item of the ingested event is not in the current catalog, it could lead to degraded model quality. This is called an unjoined event.
https://cloud.google.com/recommendations-ai/docsapi/reference/rest/v1beta1/projects/locations/catalogs/eventStores/userEvents/list Required parameters: parent Optional parameters: pageSize, pageToken, filter Gets a list of user events within a time range, with potential filtering. The method does not list unjoined user events. Unjoined user event definition: when a user event is ingested from Recommendations AI User Event APIs, the catalog item included in the user event is connected with the current catalog. If a catalog item of the ingested event is not in the current catalog, it could lead to degraded model quality. This is called an unjoined event.
(locations-catalogs-eventStores-userEvents-purge$ auth parameters body)
Required parameters: parent
Optional parameters: none
Body:
{:filter string, :force boolean}
Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first.
https://cloud.google.com/recommendations-ai/docsapi/reference/rest/v1beta1/projects/locations/catalogs/eventStores/userEvents/purge Required parameters: parent Optional parameters: none Body: {:filter string, :force boolean} Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first.
(locations-catalogs-eventStores-userEvents-rejoin$ auth parameters body)
Required parameters: parent
Optional parameters: none
Body:
{:userEventRejoinScope string}
Triggers a user event rejoin operation with latest catalog data. Events will not be annotated with detailed catalog information if catalog item is missing at the time the user event is ingested, and these events are stored as unjoined events with a limited usage on training and serving. This API can be used to trigger a 'join' operation on specified events with latest version of catalog items. It can also be used to correct events joined with wrong catalog items.
https://cloud.google.com/recommendations-ai/docsapi/reference/rest/v1beta1/projects/locations/catalogs/eventStores/userEvents/rejoin Required parameters: parent Optional parameters: none Body: {:userEventRejoinScope string} Triggers a user event rejoin operation with latest catalog data. Events will not be annotated with detailed catalog information if catalog item is missing at the time the user event is ingested, and these events are stored as unjoined events with a limited usage on training and serving. This API can be used to trigger a 'join' operation on specified events with latest version of catalog items. It can also be used to correct events joined with wrong catalog items.
(locations-catalogs-eventStores-userEvents-write$ auth parameters body)
Required parameters: parent
Optional parameters: none
Body:
{:eventType string, :userInfo {:visitorId string, :userId string, :ipAddress string, :userAgent string, :directUserRequest boolean}, :eventDetail {:uri string, :referrerUri string, :pageViewId string, :experimentIds [string], :recommendationToken string, :eventAttributes GoogleCloudRecommendationengineV1beta1FeatureMap}, :productEventDetail {:searchQuery string, :pageCategories [GoogleCloudRecommendationengineV1beta1CatalogItemCategoryHierarchy], :productDetails [GoogleCloudRecommendationengineV1beta1ProductDetail], :listId string, :cartId string, :purchaseTransaction GoogleCloudRecommendationengineV1beta1PurchaseTransaction}, :eventTime string, :eventSource string}
Writes a single user event.
https://cloud.google.com/recommendations-ai/docsapi/reference/rest/v1beta1/projects/locations/catalogs/eventStores/userEvents/write Required parameters: parent Optional parameters: none Body: {:eventType string, :userInfo {:visitorId string, :userId string, :ipAddress string, :userAgent string, :directUserRequest boolean}, :eventDetail {:uri string, :referrerUri string, :pageViewId string, :experimentIds [string], :recommendationToken string, :eventAttributes GoogleCloudRecommendationengineV1beta1FeatureMap}, :productEventDetail {:searchQuery string, :pageCategories [GoogleCloudRecommendationengineV1beta1CatalogItemCategoryHierarchy], :productDetails [GoogleCloudRecommendationengineV1beta1ProductDetail], :listId string, :cartId string, :purchaseTransaction GoogleCloudRecommendationengineV1beta1PurchaseTransaction}, :eventTime string, :eventSource string} Writes a single user event.
(locations-catalogs-list$ auth parameters)
Required parameters: parent
Optional parameters: pageSize, pageToken
Lists all the catalog configurations associated with the project.
https://cloud.google.com/recommendations-ai/docsapi/reference/rest/v1beta1/projects/locations/catalogs/list Required parameters: parent Optional parameters: pageSize, pageToken Lists all the catalog configurations associated with the project.
(locations-catalogs-operations-get$ auth parameters)
Required parameters: name
Optional parameters: none
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
https://cloud.google.com/recommendations-ai/docsapi/reference/rest/v1beta1/projects/locations/catalogs/operations/get Required parameters: name Optional parameters: none Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
(locations-catalogs-operations-list$ auth parameters)
Required parameters: name
Optional parameters: filter, pageSize, pageToken
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
https://cloud.google.com/recommendations-ai/docsapi/reference/rest/v1beta1/projects/locations/catalogs/operations/list Required parameters: name Optional parameters: filter, pageSize, pageToken Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
(locations-catalogs-patch$ auth parameters body)
Required parameters: name
Optional parameters: updateMask
Body:
{:name string, :displayName string, :defaultEventStoreId string, :catalogItemLevelConfig {:eventItemLevel string, :predictItemLevel string}}
Updates the catalog configuration.
https://cloud.google.com/recommendations-ai/docsapi/reference/rest/v1beta1/projects/locations/catalogs/patch Required parameters: name Optional parameters: updateMask Body: {:name string, :displayName string, :defaultEventStoreId string, :catalogItemLevelConfig {:eventItemLevel string, :predictItemLevel string}} Updates the catalog configuration.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close