- locations-catalogs-catalogItems-create$
- locations-catalogs-catalogItems-delete$
- locations-catalogs-catalogItems-get$
- locations-catalogs-catalogItems-import$
- locations-catalogs-catalogItems-list$
- locations-catalogs-catalogItems-patch$
- locations-catalogs-eventStores-operations-get$
- locations-catalogs-eventStores-operations-list$
- locations-catalogs-eventStores-placements-predict$
- locations-catalogs-eventStores-predictionApiKeyRegistrations-create$
- locations-catalogs-eventStores-predictionApiKeyRegistrations-delete$
- locations-catalogs-eventStores-predictionApiKeyRegistrations-list$
- locations-catalogs-eventStores-userEvents-collect$
- locations-catalogs-eventStores-userEvents-import$
- locations-catalogs-eventStores-userEvents-list$
- locations-catalogs-eventStores-userEvents-purge$
- locations-catalogs-eventStores-userEvents-rejoin$
- locations-catalogs-eventStores-userEvents-write$
- locations-catalogs-list$
- locations-catalogs-operations-get$
- locations-catalogs-operations-list$
- locations-catalogs-patch$
happygapi.recommendationengine.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
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$clj
(locations-catalogs-catalogItems-create$ auth parameters body)Required parameters: parent
Optional parameters: none
Body:
{:description string, :tags [string], :productMetadata {:priceRange GoogleCloudRecommendationengineV1beta1ProductCatalogItemPriceRange, :canonicalProductUri string, :costs {}, :availableQuantity string, :images [GoogleCloudRecommendationengineV1beta1Image], :currencyCode string, :exactPrice GoogleCloudRecommendationengineV1beta1ProductCatalogItemExactPrice, :stockState string}, :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 {:priceRange GoogleCloudRecommendationengineV1beta1ProductCatalogItemPriceRange,
:canonicalProductUri string,
:costs {},
:availableQuantity string,
:images [GoogleCloudRecommendationengineV1beta1Image],
:currencyCode string,
:exactPrice GoogleCloudRecommendationengineV1beta1ProductCatalogItemExactPrice,
:stockState string},
:itemAttributes {:categoricalFeatures {}, :numericalFeatures {}},
:title string,
:languageCode string,
:itemGroupId string,
:id string,
:categoryHierarchies [{:categories [string]}]}
Creates a catalog item.locations-catalogs-catalogItems-delete$clj
(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$clj
(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$clj
(locations-catalogs-catalogItems-import$ auth parameters body)Required parameters: parent
Optional parameters: none
Body:
{:requestId string, :updateMask string, :errorsConfig {:gcsPrefix string}, :inputConfig {:gcsSource GoogleCloudRecommendationengineV1beta1GcsSource, :bigQuerySource GoogleCloudRecommendationengineV1beta1BigQuerySource, :userEventInlineSource GoogleCloudRecommendationengineV1beta1UserEventInlineSource, :catalogInlineSource GoogleCloudRecommendationengineV1beta1CatalogInlineSource}}
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,
:updateMask string,
:errorsConfig {:gcsPrefix string},
:inputConfig {:gcsSource GoogleCloudRecommendationengineV1beta1GcsSource,
:bigQuerySource GoogleCloudRecommendationengineV1beta1BigQuerySource,
:userEventInlineSource GoogleCloudRecommendationengineV1beta1UserEventInlineSource,
:catalogInlineSource GoogleCloudRecommendationengineV1beta1CatalogInlineSource}}
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$clj
(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$clj
(locations-catalogs-catalogItems-patch$ auth parameters body)Required parameters: name
Optional parameters: updateMask
Body:
{:description string, :tags [string], :productMetadata {:priceRange GoogleCloudRecommendationengineV1beta1ProductCatalogItemPriceRange, :canonicalProductUri string, :costs {}, :availableQuantity string, :images [GoogleCloudRecommendationengineV1beta1Image], :currencyCode string, :exactPrice GoogleCloudRecommendationengineV1beta1ProductCatalogItemExactPrice, :stockState string}, :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 {:priceRange GoogleCloudRecommendationengineV1beta1ProductCatalogItemPriceRange,
:canonicalProductUri string,
:costs {},
:availableQuantity string,
:images [GoogleCloudRecommendationengineV1beta1Image],
:currencyCode string,
:exactPrice GoogleCloudRecommendationengineV1beta1ProductCatalogItemExactPrice,
:stockState string},
: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$clj
(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$clj
(locations-catalogs-eventStores-operations-list$ auth parameters)Required parameters: name
Optional parameters: pageSize, pageToken, filter
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
https://cloud.google.com/recommendations-ai/docsapi/reference/rest/v1beta1/projects/locations/catalogs/eventStores/operations/list
Required parameters: name
Optional parameters: pageSize, pageToken, filter
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.locations-catalogs-eventStores-placements-predict$clj
(locations-catalogs-eventStores-placements-predict$ auth parameters body)Required parameters: name
Optional parameters: none
Body:
{:params {}, :userEvent {:userInfo GoogleCloudRecommendationengineV1beta1UserInfo, :eventTime string, :eventSource string, :eventDetail GoogleCloudRecommendationengineV1beta1EventDetail, :productEventDetail GoogleCloudRecommendationengineV1beta1ProductEventDetail, :eventType string}, :filter string, :pageSize integer, :dryRun boolean, :pageToken string, :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:
{:params {},
:userEvent {:userInfo GoogleCloudRecommendationengineV1beta1UserInfo,
:eventTime string,
:eventSource string,
:eventDetail GoogleCloudRecommendationengineV1beta1EventDetail,
:productEventDetail GoogleCloudRecommendationengineV1beta1ProductEventDetail,
:eventType string},
:filter string,
:pageSize integer,
:dryRun boolean,
:pageToken string,
: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$clj
(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$clj
(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$clj
(locations-catalogs-eventStores-predictionApiKeyRegistrations-list$ auth
parameters)Required parameters: parent
Optional parameters: pageToken, pageSize
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: pageToken, pageSize List the registered apiKeys for use with predict method.
locations-catalogs-eventStores-userEvents-collect$clj
(locations-catalogs-eventStores-userEvents-collect$ auth parameters)Required parameters: parent
Optional parameters: userEvent, ets, uri
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, ets, uri 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$clj
(locations-catalogs-eventStores-userEvents-import$ auth parameters body)Required parameters: parent
Optional parameters: none
Body:
{:inputConfig {:gcsSource GoogleCloudRecommendationengineV1beta1GcsSource, :bigQuerySource GoogleCloudRecommendationengineV1beta1BigQuerySource, :userEventInlineSource GoogleCloudRecommendationengineV1beta1UserEventInlineSource, :catalogInlineSource GoogleCloudRecommendationengineV1beta1CatalogInlineSource}, :errorsConfig {:gcsPrefix string}, :requestId 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:
{:inputConfig {:gcsSource GoogleCloudRecommendationengineV1beta1GcsSource,
:bigQuerySource GoogleCloudRecommendationengineV1beta1BigQuerySource,
:userEventInlineSource GoogleCloudRecommendationengineV1beta1UserEventInlineSource,
:catalogInlineSource GoogleCloudRecommendationengineV1beta1CatalogInlineSource},
:errorsConfig {:gcsPrefix string},
:requestId 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$clj
(locations-catalogs-eventStores-userEvents-list$ auth parameters)Required parameters: parent
Optional parameters: filter, pageSize, pageToken
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: filter, pageSize, pageToken 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$clj
(locations-catalogs-eventStores-userEvents-purge$ auth parameters body)Required parameters: parent
Optional parameters: none
Body:
{:force boolean, :filter string}
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:
{:force boolean, :filter string}
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$clj
(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$clj
(locations-catalogs-eventStores-userEvents-write$ auth parameters body)Required parameters: parent
Optional parameters: none
Body:
{:userInfo {:ipAddress string, :userId string, :visitorId string, :userAgent string, :directUserRequest boolean}, :eventTime string, :eventSource string, :eventDetail {:uri string, :pageViewId string, :experimentIds [string], :recommendationToken string, :eventAttributes GoogleCloudRecommendationengineV1beta1FeatureMap, :referrerUri string}, :productEventDetail {:purchaseTransaction GoogleCloudRecommendationengineV1beta1PurchaseTransaction, :searchQuery string, :listId string, :productDetails [GoogleCloudRecommendationengineV1beta1ProductDetail], :cartId string, :pageCategories [GoogleCloudRecommendationengineV1beta1CatalogItemCategoryHierarchy]}, :eventType 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:
{:userInfo {:ipAddress string,
:userId string,
:visitorId string,
:userAgent string,
:directUserRequest boolean},
:eventTime string,
:eventSource string,
:eventDetail {:uri string,
:pageViewId string,
:experimentIds [string],
:recommendationToken string,
:eventAttributes GoogleCloudRecommendationengineV1beta1FeatureMap,
:referrerUri string},
:productEventDetail {:purchaseTransaction GoogleCloudRecommendationengineV1beta1PurchaseTransaction,
:searchQuery string,
:listId string,
:productDetails [GoogleCloudRecommendationengineV1beta1ProductDetail],
:cartId string,
:pageCategories [GoogleCloudRecommendationengineV1beta1CatalogItemCategoryHierarchy]},
:eventType string}
Writes a single user event.locations-catalogs-list$clj
(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$clj
(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$clj
(locations-catalogs-operations-list$ auth parameters)Required parameters: name
Optional parameters: filter, pageToken, pageSize
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
https://cloud.google.com/recommendations-ai/docsapi/reference/rest/v1beta1/projects/locations/catalogs/operations/list
Required parameters: name
Optional parameters: filter, pageToken, pageSize
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.locations-catalogs-patch$clj
(locations-catalogs-patch$ auth parameters body)Required parameters: name
Optional parameters: updateMask
Body:
{:catalogItemLevelConfig {:eventItemLevel string, :predictItemLevel string}, :defaultEventStoreId string, :name string, :displayName 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:
{:catalogItemLevelConfig {:eventItemLevel string,
:predictItemLevel string},
:defaultEventStoreId string,
:name string,
:displayName string}
Updates the catalog configuration.cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close