happygapi.retail.projects — happygapi 0.4.9

Vertex AI Search for Retail API: projects. Vertex AI Search for Retail API is made up of Retail Search, Browse and Recommendations. These discovery AI solutions help you implement personalized search, browse and recommendations, based on machine learning models, across your websites and mobile applications. See: https://cloud.google.com/recommendationsapi/reference/rest/v2/projects

locations-catalogs-attributesConfig-addCatalogAttribute$ clj

(locations-catalogs-attributesConfig-addCatalogAttribute$ auth parameters body)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/attributesConfig/addCatalogAttribute

Required parameters: attributesConfig

Optional parameters: none

Body:

{:catalogAttribute {:indexableOption string, :key string, :dynamicFacetableOption string, :type string, :searchableOption string, :inUse boolean, :facetConfig GoogleCloudRetailV2CatalogAttributeFacetConfig, :exactSearchableOption string, :retrievableOption string}}

Adds the specified CatalogAttribute to the AttributesConfig. If the CatalogAttribute to add already exists, an ALREADY_EXISTS error is returned.

locations-catalogs-attributesConfig-removeCatalogAttribute$ clj

(locations-catalogs-attributesConfig-removeCatalogAttribute$ auth
                                                             parameters
                                                             body)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/attributesConfig/removeCatalogAttribute

Required parameters: attributesConfig

Optional parameters: none

Body:

{:key string}

Removes the specified CatalogAttribute from the AttributesConfig. If the CatalogAttribute to remove does not exist, a NOT_FOUND error is returned.

locations-catalogs-attributesConfig-replaceCatalogAttribute$ clj

(locations-catalogs-attributesConfig-replaceCatalogAttribute$ auth
                                                              parameters
                                                              body)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/attributesConfig/replaceCatalogAttribute

Required parameters: attributesConfig

Optional parameters: none

Body:

{:catalogAttribute {:indexableOption string, :key string, :dynamicFacetableOption string, :type string, :searchableOption string, :inUse boolean, :facetConfig GoogleCloudRetailV2CatalogAttributeFacetConfig, :exactSearchableOption string, :retrievableOption string}, :updateMask string}

Replaces the specified CatalogAttribute in the AttributesConfig by updating the catalog attribute with the same CatalogAttribute.key. If the CatalogAttribute to replace does not exist, a NOT_FOUND error is returned.

locations-catalogs-branches-operations-get$ clj

(locations-catalogs-branches-operations-get$ auth parameters)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/branches/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-branches-products-addFulfillmentPlaces$ clj

(locations-catalogs-branches-products-addFulfillmentPlaces$ auth
                                                            parameters
                                                            body)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/branches/products/addFulfillmentPlaces

Required parameters: product

Optional parameters: none

Body:

{:type string, :placeIds [string], :addTime string, :allowMissing boolean}

We recommend that you use the ProductService.AddLocalInventories method instead of the ProductService.AddFulfillmentPlaces method. ProductService.AddLocalInventories achieves the same results but provides more fine-grained control over ingesting local inventory data. Incrementally adds place IDs to Product.fulfillment_info.place_ids. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the added place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete.

locations-catalogs-branches-products-addLocalInventories$ clj

(locations-catalogs-branches-products-addLocalInventories$ auth parameters body)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/branches/products/addLocalInventories

Required parameters: product

Optional parameters: none

Body:

{:localInventories [{:placeId string, :priceInfo GoogleCloudRetailV2PriceInfo, :attributes {}, :fulfillmentTypes [string]}], :addMask string, :addTime string, :allowMissing boolean}

Updates local inventory information for a Product at a list of places, while respecting the last update timestamps of each inventory field. This process is asynchronous and does not require the Product to exist before updating inventory information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. Local inventory information can only be modified using this method. ProductService.CreateProduct and ProductService.UpdateProduct has no effect on local inventories. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete.

locations-catalogs-branches-products-create$ clj

(locations-catalogs-branches-products-create$ auth parameters body)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/branches/products/create

Required parameters: parent

Optional parameters: productId

Body:

{:promotions [{:promotionId string}], :description string, :tags [string], :availableTime string, :availability string, :sizes [string], :variants [{:promotions [GoogleCloudRetailV2Promotion], :description string, :tags [string], :availableTime string, :availability string, :sizes [string], :variants [GoogleCloudRetailV2Product], :localInventories [GoogleCloudRetailV2LocalInventory], :publishTime string, :retrievableFields string, :images [GoogleCloudRetailV2Image], :colorInfo GoogleCloudRetailV2ColorInfo, :primaryProductId string, :patterns [string], :name string, :availableQuantity integer, :collectionMemberIds [string], :type string, :title string, :priceInfo GoogleCloudRetailV2PriceInfo, :ttl string, :categories [string], :languageCode string, :conditions [string], :fulfillmentInfo [GoogleCloudRetailV2FulfillmentInfo], :id string, :audience GoogleCloudRetailV2Audience, :materials [string], :expireTime string, :uri string, :gtin string, :attributes {}, :rating GoogleCloudRetailV2Rating, :brands [string]}], :localInventories [{:placeId string, :priceInfo GoogleCloudRetailV2PriceInfo, :attributes {}, :fulfillmentTypes [string]}], :publishTime string, :retrievableFields string, :images [{:uri string, :height integer, :width integer}], :colorInfo {:colorFamilies [string], :colors [string]}, :primaryProductId string, :patterns [string], :name string, :availableQuantity integer, :collectionMemberIds [string], :type string, :title string, :priceInfo {:currencyCode string, :price number, :originalPrice number, :cost number, :priceEffectiveTime string, :priceExpireTime string, :priceRange GoogleCloudRetailV2PriceInfoPriceRange}, :ttl string, :categories [string], :languageCode string, :conditions [string], :fulfillmentInfo [{:type string, :placeIds [string]}], :id string, :audience {:genders [string], :ageGroups [string]}, :materials [string], :expireTime string, :uri string, :gtin string, :attributes {}, :rating {:ratingCount integer, :averageRating number, :ratingHistogram [integer]}, :brands [string]}

Creates a Product.

locations-catalogs-branches-products-delete$ clj

(locations-catalogs-branches-products-delete$ auth parameters)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/branches/products/delete

Required parameters: name

Optional parameters: none

Deletes a Product.

locations-catalogs-branches-products-get$ clj

(locations-catalogs-branches-products-get$ auth parameters)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/branches/products/get

Required parameters: name

Optional parameters: none

Gets a Product.

locations-catalogs-branches-products-import$ clj

(locations-catalogs-branches-products-import$ auth parameters body)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/branches/products/import

Required parameters: parent

Optional parameters: none

Body:

{:requestId string, :inputConfig {:productInlineSource GoogleCloudRetailV2ProductInlineSource, :gcsSource GoogleCloudRetailV2GcsSource, :bigQuerySource GoogleCloudRetailV2BigQuerySource}, :errorsConfig {:gcsPrefix string}, :updateMask string, :reconciliationMode string, :notificationPubsubTopic string}

Bulk import of multiple Products. Request processing may be synchronous. Non-existing items are created. Note that it is possible for a subset of the Products to be successfully updated.

locations-catalogs-branches-products-list$ clj

(locations-catalogs-branches-products-list$ auth parameters)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/branches/products/list

Required parameters: parent

Optional parameters: pageSize, pageToken, filter, readMask

Gets a list of Products.

locations-catalogs-branches-products-patch$ clj

(locations-catalogs-branches-products-patch$ auth parameters body)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/branches/products/patch

Required parameters: name

Optional parameters: updateMask, allowMissing

Body:

{:promotions [{:promotionId string}], :description string, :tags [string], :availableTime string, :availability string, :sizes [string], :variants [{:promotions [GoogleCloudRetailV2Promotion], :description string, :tags [string], :availableTime string, :availability string, :sizes [string], :variants [GoogleCloudRetailV2Product], :localInventories [GoogleCloudRetailV2LocalInventory], :publishTime string, :retrievableFields string, :images [GoogleCloudRetailV2Image], :colorInfo GoogleCloudRetailV2ColorInfo, :primaryProductId string, :patterns [string], :name string, :availableQuantity integer, :collectionMemberIds [string], :type string, :title string, :priceInfo GoogleCloudRetailV2PriceInfo, :ttl string, :categories [string], :languageCode string, :conditions [string], :fulfillmentInfo [GoogleCloudRetailV2FulfillmentInfo], :id string, :audience GoogleCloudRetailV2Audience, :materials [string], :expireTime string, :uri string, :gtin string, :attributes {}, :rating GoogleCloudRetailV2Rating, :brands [string]}], :localInventories [{:placeId string, :priceInfo GoogleCloudRetailV2PriceInfo, :attributes {}, :fulfillmentTypes [string]}], :publishTime string, :retrievableFields string, :images [{:uri string, :height integer, :width integer}], :colorInfo {:colorFamilies [string], :colors [string]}, :primaryProductId string, :patterns [string], :name string, :availableQuantity integer, :collectionMemberIds [string], :type string, :title string, :priceInfo {:currencyCode string, :price number, :originalPrice number, :cost number, :priceEffectiveTime string, :priceExpireTime string, :priceRange GoogleCloudRetailV2PriceInfoPriceRange}, :ttl string, :categories [string], :languageCode string, :conditions [string], :fulfillmentInfo [{:type string, :placeIds [string]}], :id string, :audience {:genders [string], :ageGroups [string]}, :materials [string], :expireTime string, :uri string, :gtin string, :attributes {}, :rating {:ratingCount integer, :averageRating number, :ratingHistogram [integer]}, :brands [string]}

Updates a Product.

locations-catalogs-branches-products-purge$ clj

(locations-catalogs-branches-products-purge$ auth parameters body)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/branches/products/purge

Required parameters: parent

Optional parameters: none

Body:

{:filter string, :force boolean}

Permanently deletes all selected Products under a branch. This process is asynchronous. If the request is valid, the removal will be enqueued and processed offline. Depending on the number of Products, this operation could take hours to complete. Before the operation completes, some Products may still be returned by ProductService.GetProduct or ProductService.ListProducts. Depending on the number of Products, this operation could take hours to complete. To get a sample of Products that would be deleted, set PurgeProductsRequest.force to false.

locations-catalogs-branches-products-removeFulfillmentPlaces$ clj

(locations-catalogs-branches-products-removeFulfillmentPlaces$ auth
                                                               parameters
                                                               body)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/branches/products/removeFulfillmentPlaces

Required parameters: product

Optional parameters: none

Body:

{:type string, :placeIds [string], :removeTime string, :allowMissing boolean}

We recommend that you use the ProductService.RemoveLocalInventories method instead of the ProductService.RemoveFulfillmentPlaces method. ProductService.RemoveLocalInventories achieves the same results but provides more fine-grained control over ingesting local inventory data. Incrementally removes place IDs from a Product.fulfillment_info.place_ids. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the removed place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete.

locations-catalogs-branches-products-removeLocalInventories$ clj

(locations-catalogs-branches-products-removeLocalInventories$ auth
                                                              parameters
                                                              body)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/branches/products/removeLocalInventories

Required parameters: product

Optional parameters: none

Body:

{:placeIds [string], :removeTime string, :allowMissing boolean}

Remove local inventory information for a Product at a list of places at a removal timestamp. This process is asynchronous. If the request is valid, the removal will be enqueued and processed downstream. As a consequence, when a response is returned, removals are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. Local inventory information can only be removed using this method. ProductService.CreateProduct and ProductService.UpdateProduct has no effect on local inventories. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete.

locations-catalogs-branches-products-setInventory$ clj

(locations-catalogs-branches-products-setInventory$ auth parameters body)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/branches/products/setInventory

Required parameters: name

Optional parameters: none

Body:

{:inventory {:promotions [GoogleCloudRetailV2Promotion], :description string, :tags [string], :availableTime string, :availability string, :sizes [string], :variants [GoogleCloudRetailV2Product], :localInventories [GoogleCloudRetailV2LocalInventory], :publishTime string, :retrievableFields string, :images [GoogleCloudRetailV2Image], :colorInfo GoogleCloudRetailV2ColorInfo, :primaryProductId string, :patterns [string], :name string, :availableQuantity integer, :collectionMemberIds [string], :type string, :title string, :priceInfo GoogleCloudRetailV2PriceInfo, :ttl string, :categories [string], :languageCode string, :conditions [string], :fulfillmentInfo [GoogleCloudRetailV2FulfillmentInfo], :id string, :audience GoogleCloudRetailV2Audience, :materials [string], :expireTime string, :uri string, :gtin string, :attributes {}, :rating GoogleCloudRetailV2Rating, :brands [string]}, :setMask string, :setTime string, :allowMissing boolean}

Updates inventory information for a Product while respecting the last update timestamps of each inventory field. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update is enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. When inventory is updated with ProductService.CreateProduct and ProductService.UpdateProduct, the specified inventory field value(s) overwrite any existing value(s) while ignoring the last update time for this field. Furthermore, the last update times for the specified inventory fields are overwritten by the times of the ProductService.CreateProduct or ProductService.UpdateProduct request. If no inventory fields are set in CreateProductRequest.product, then any pre-existing inventory information for this product is used. If no inventory fields are set in SetInventoryRequest.set_mask, then any existing inventory information is preserved. Pre-existing inventory information can only be updated with ProductService.SetInventory, ProductService.AddFulfillmentPlaces, and ProductService.RemoveFulfillmentPlaces. The returned Operations is obsolete after one day, and the GetOperation API returns NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates are not marked as done until they are obsolete.

locations-catalogs-completeQuery$ clj

(locations-catalogs-completeQuery$ auth parameters)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/completeQuery

Required parameters: catalog

Optional parameters: query, visitorId, languageCodes, deviceType, dataset, maxSuggestions, entity

Completes the specified prefix with keyword suggestions. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

locations-catalogs-completionData-import$ clj

(locations-catalogs-completionData-import$ auth parameters body)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/completionData/import

Required parameters: parent

Optional parameters: none

Body:

{:inputConfig {:bigQuerySource GoogleCloudRetailV2BigQuerySource}, :notificationPubsubTopic string}

Bulk import of processed completion dataset. Request processing is asynchronous. Partial updating is not supported. The operation is successfully finished only after the imported suggestions are indexed successfully and ready for serving. The process takes hours. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

locations-catalogs-controls-create$ clj

(locations-catalogs-controls-create$ auth parameters body)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/controls/create

Required parameters: parent

Optional parameters: controlId

Body:

{:rule {:ignoreAction GoogleCloudRetailV2RuleIgnoreAction, :doNotAssociateAction GoogleCloudRetailV2RuleDoNotAssociateAction, :twowaySynonymsAction GoogleCloudRetailV2RuleTwowaySynonymsAction, :forceReturnFacetAction GoogleCloudRetailV2RuleForceReturnFacetAction, :redirectAction GoogleCloudRetailV2RuleRedirectAction, :condition GoogleCloudRetailV2Condition, :onewaySynonymsAction GoogleCloudRetailV2RuleOnewaySynonymsAction, :replacementAction GoogleCloudRetailV2RuleReplacementAction, :removeFacetAction GoogleCloudRetailV2RuleRemoveFacetAction, :boostAction GoogleCloudRetailV2RuleBoostAction, :filterAction GoogleCloudRetailV2RuleFilterAction}, :name string, :displayName string, :associatedServingConfigIds [string], :solutionTypes [string], :searchSolutionUseCase [string]}

Creates a Control. If the Control to create already exists, an ALREADY_EXISTS error is returned.

locations-catalogs-controls-delete$ clj

(locations-catalogs-controls-delete$ auth parameters)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/controls/delete

Required parameters: name

Optional parameters: none

Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned.

locations-catalogs-controls-get$ clj

(locations-catalogs-controls-get$ auth parameters)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/controls/get

Required parameters: name

Optional parameters: none

Gets a Control.

locations-catalogs-controls-list$ clj

(locations-catalogs-controls-list$ auth parameters)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/controls/list

Required parameters: parent

Optional parameters: pageSize, pageToken, filter

Lists all Controls by their parent Catalog.

locations-catalogs-controls-patch$ clj

(locations-catalogs-controls-patch$ auth parameters body)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/controls/patch

Required parameters: name

Optional parameters: updateMask

Body:

{:rule {:ignoreAction GoogleCloudRetailV2RuleIgnoreAction, :doNotAssociateAction GoogleCloudRetailV2RuleDoNotAssociateAction, :twowaySynonymsAction GoogleCloudRetailV2RuleTwowaySynonymsAction, :forceReturnFacetAction GoogleCloudRetailV2RuleForceReturnFacetAction, :redirectAction GoogleCloudRetailV2RuleRedirectAction, :condition GoogleCloudRetailV2Condition, :onewaySynonymsAction GoogleCloudRetailV2RuleOnewaySynonymsAction, :replacementAction GoogleCloudRetailV2RuleReplacementAction, :removeFacetAction GoogleCloudRetailV2RuleRemoveFacetAction, :boostAction GoogleCloudRetailV2RuleBoostAction, :filterAction GoogleCloudRetailV2RuleFilterAction}, :name string, :displayName string, :associatedServingConfigIds [string], :solutionTypes [string], :searchSolutionUseCase [string]}

Updates a Control. Control cannot be set to a different oneof field, if so an INVALID_ARGUMENT is returned. If the Control to update does not exist, a NOT_FOUND error is returned.

locations-catalogs-exportAnalyticsMetrics$ clj

(locations-catalogs-exportAnalyticsMetrics$ auth parameters body)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/exportAnalyticsMetrics

Required parameters: catalog

Optional parameters: none

Body:

{:outputConfig {:gcsDestination GoogleCloudRetailV2OutputConfigGcsDestination, :bigqueryDestination GoogleCloudRetailV2OutputConfigBigQueryDestination}, :filter string}

Exports analytics metrics. Operation.response is of type ExportAnalyticsMetricsResponse. Operation.metadata is of type ExportMetadata.

locations-catalogs-getAttributesConfig$ clj

(locations-catalogs-getAttributesConfig$ auth parameters)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/getAttributesConfig

Required parameters: name

Optional parameters: none

Gets an AttributesConfig.

locations-catalogs-getCompletionConfig$ clj

(locations-catalogs-getCompletionConfig$ auth parameters)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/getCompletionConfig

Required parameters: name

Optional parameters: none

Gets a CompletionConfig.

locations-catalogs-getDefaultBranch$ clj

(locations-catalogs-getDefaultBranch$ auth parameters)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/getDefaultBranch

Required parameters: catalog

Optional parameters: none

Get which branch is currently default branch set by CatalogService.SetDefaultBranch method under a specified parent catalog.

locations-catalogs-list$ clj

(locations-catalogs-list$ auth parameters)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/list

Required parameters: parent

Optional parameters: pageSize, pageToken

Lists all the Catalogs associated with the project.

locations-catalogs-models-create$ clj

(locations-catalogs-models-create$ auth parameters body)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/models/create

Required parameters: parent

Optional parameters: dryRun

Body:

{:servingState string, :displayName string, :tuningOperation string, :name string, :servingConfigLists [{:servingConfigIds [string]}], :createTime string, :dataState string, :type string, :periodicTuningState string, :updateTime string, :optimizationObjective string, :trainingState string, :modelFeaturesConfig {:frequentlyBoughtTogetherConfig GoogleCloudRetailV2ModelFrequentlyBoughtTogetherFeaturesConfig}, :filteringOption string, :lastTuneTime string}

Creates a new model.

locations-catalogs-models-delete$ clj

(locations-catalogs-models-delete$ auth parameters)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/models/delete

Required parameters: name

Optional parameters: none

Deletes an existing model.

locations-catalogs-models-get$ clj

(locations-catalogs-models-get$ auth parameters)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/models/get

Required parameters: name

Optional parameters: none

Gets a model.

locations-catalogs-models-list$ clj

(locations-catalogs-models-list$ auth parameters)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/models/list

Required parameters: parent

Optional parameters: pageSize, pageToken

Lists all the models linked to this event store.

locations-catalogs-models-patch$ clj

(locations-catalogs-models-patch$ auth parameters body)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/models/patch

Required parameters: name

Optional parameters: updateMask

Body:

{:servingState string, :displayName string, :tuningOperation string, :name string, :servingConfigLists [{:servingConfigIds [string]}], :createTime string, :dataState string, :type string, :periodicTuningState string, :updateTime string, :optimizationObjective string, :trainingState string, :modelFeaturesConfig {:frequentlyBoughtTogetherConfig GoogleCloudRetailV2ModelFrequentlyBoughtTogetherFeaturesConfig}, :filteringOption string, :lastTuneTime string}

Update of model metadata. Only fields that currently can be updated are: filtering_option and periodic_tuning_state. If other values are provided, this API method ignores them.

locations-catalogs-models-pause$ clj

(locations-catalogs-models-pause$ auth parameters body)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/models/pause

Required parameters: name

Optional parameters: none

Body:

{}

Pauses the training of an existing model.

locations-catalogs-models-resume$ clj

(locations-catalogs-models-resume$ auth parameters body)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/models/resume

Required parameters: name

Optional parameters: none

Body:

{}

Resumes the training of an existing model.

locations-catalogs-models-tune$ clj

(locations-catalogs-models-tune$ auth parameters body)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/models/tune

Required parameters: name

Optional parameters: none

Body:

{}

Tunes an existing model.

locations-catalogs-operations-get$ clj

(locations-catalogs-operations-get$ auth parameters)

https://cloud.google.com/recommendationsapi/reference/rest/v2/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)

https://cloud.google.com/recommendationsapi/reference/rest/v2/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$ clj

(locations-catalogs-patch$ auth parameters body)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/patch

Required parameters: name

Optional parameters: updateMask

Body:

{:name string, :displayName string, :productLevelConfig {:ingestionProductType string, :merchantCenterProductIdField string}}

Updates the Catalogs.

locations-catalogs-placements-predict$ clj

(locations-catalogs-placements-predict$ auth parameters body)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/placements/predict

Required parameters: placement

Optional parameters: none

Body:

{:userEvent {:completionDetail GoogleCloudRetailV2CompletionDetail, :eventType string, :cartId string, :pageViewId string, :sessionId string, :offset integer, :productDetails [GoogleCloudRetailV2ProductDetail], :purchaseTransaction GoogleCloudRetailV2PurchaseTransaction, :searchQuery string, :filter string, :visitorId string, :referrerUri string, :pageCategories [string], :eventTime string, :uri string, :attributes {}, :entity string, :attributionToken string, :experimentIds [string], :userInfo GoogleCloudRetailV2UserInfo, :orderBy string}, :pageSize integer, :pageToken string, :filter string, :validateOnly boolean, :params {}, :labels {}}

Makes a recommendation prediction.

locations-catalogs-placements-search$ clj

(locations-catalogs-placements-search$ auth parameters body)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/placements/search

Required parameters: placement

Optional parameters: none

Body:

{:dynamicFacetSpec {:mode string}, :labels {}, :searchMode string, :canonicalFilter string, :offset integer, :pageToken string, :facetSpecs [{:facetKey GoogleCloudRetailV2SearchRequestFacetSpecFacetKey, :limit integer, :excludedFilterKeys [string], :enableDynamicPosition boolean}], :filter string, :pageSize integer, :visitorId string, :pageCategories [string], :variantRollupKeys [string], :query string, :branch string, :entity string, :queryExpansionSpec {:condition string, :pinUnexpandedResults boolean}, :boostSpec {:conditionBoostSpecs [GoogleCloudRetailV2SearchRequestBoostSpecConditionBoostSpec], :skipBoostSpecValidation boolean}, :spellCorrectionSpec {:mode string}, :userInfo {:userId string, :ipAddress string, :userAgent string, :directUserRequest boolean}, :orderBy string, :personalizationSpec {:mode string}}

Performs a search. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

locations-catalogs-servingConfigs-addControl$ clj

(locations-catalogs-servingConfigs-addControl$ auth parameters body)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/servingConfigs/addControl

Required parameters: servingConfig

Optional parameters: none

Body:

{:controlId string}

Enables a Control on the specified ServingConfig. The control is added in the last position of the list of controls it belongs to (e.g. if it's a facet spec control it will be applied in the last position of servingConfig.facetSpecIds) Returns a ALREADY_EXISTS error if the control has already been applied. Returns a FAILED_PRECONDITION error if the addition could exceed maximum number of control allowed for that type of control.

locations-catalogs-servingConfigs-create$ clj

(locations-catalogs-servingConfigs-create$ auth parameters body)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/servingConfigs/create

Required parameters: parent

Optional parameters: servingConfigId

Body:

{:dynamicFacetSpec {:mode string}, :onewaySynonymsControlIds [string], :displayName string, :filterControlIds [string], :name string, :diversityLevel string, :modelId string, :facetControlIds [string], :solutionTypes [string], :doNotAssociateControlIds [string], :enableCategoryFilterLevel string, :priceRerankingLevel string, :diversityType string, :redirectControlIds [string], :twowaySynonymsControlIds [string], :ignoreControlIds [string], :replacementControlIds [string], :boostControlIds [string], :personalizationSpec {:mode string}}

Creates a ServingConfig. A maximum of 100 ServingConfigs are allowed in a Catalog, otherwise a FAILED_PRECONDITION error is returned.

locations-catalogs-servingConfigs-delete$ clj

(locations-catalogs-servingConfigs-delete$ auth parameters)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/servingConfigs/delete

Required parameters: name

Optional parameters: none

Deletes a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.

locations-catalogs-servingConfigs-get$ clj

(locations-catalogs-servingConfigs-get$ auth parameters)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/servingConfigs/get

Required parameters: name

Optional parameters: none

Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.

locations-catalogs-servingConfigs-list$ clj

(locations-catalogs-servingConfigs-list$ auth parameters)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/servingConfigs/list

Required parameters: parent

Optional parameters: pageSize, pageToken

Lists all ServingConfigs linked to this catalog.

locations-catalogs-servingConfigs-patch$ clj

(locations-catalogs-servingConfigs-patch$ auth parameters body)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/servingConfigs/patch

Required parameters: name

Optional parameters: updateMask

Body:

{:dynamicFacetSpec {:mode string}, :onewaySynonymsControlIds [string], :displayName string, :filterControlIds [string], :name string, :diversityLevel string, :modelId string, :facetControlIds [string], :solutionTypes [string], :doNotAssociateControlIds [string], :enableCategoryFilterLevel string, :priceRerankingLevel string, :diversityType string, :redirectControlIds [string], :twowaySynonymsControlIds [string], :ignoreControlIds [string], :replacementControlIds [string], :boostControlIds [string], :personalizationSpec {:mode string}}

Updates a ServingConfig.

locations-catalogs-servingConfigs-predict$ clj

(locations-catalogs-servingConfigs-predict$ auth parameters body)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/servingConfigs/predict

Required parameters: placement

Optional parameters: none

Body:

{:userEvent {:completionDetail GoogleCloudRetailV2CompletionDetail, :eventType string, :cartId string, :pageViewId string, :sessionId string, :offset integer, :productDetails [GoogleCloudRetailV2ProductDetail], :purchaseTransaction GoogleCloudRetailV2PurchaseTransaction, :searchQuery string, :filter string, :visitorId string, :referrerUri string, :pageCategories [string], :eventTime string, :uri string, :attributes {}, :entity string, :attributionToken string, :experimentIds [string], :userInfo GoogleCloudRetailV2UserInfo, :orderBy string}, :pageSize integer, :pageToken string, :filter string, :validateOnly boolean, :params {}, :labels {}}

Makes a recommendation prediction.

locations-catalogs-servingConfigs-removeControl$ clj

(locations-catalogs-servingConfigs-removeControl$ auth parameters body)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/servingConfigs/removeControl

Required parameters: servingConfig

Optional parameters: none

Body:

{:controlId string}

Disables a Control on the specified ServingConfig. The control is removed from the ServingConfig. Returns a NOT_FOUND error if the Control is not enabled for the ServingConfig.

locations-catalogs-servingConfigs-search$ clj

(locations-catalogs-servingConfigs-search$ auth parameters body)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/servingConfigs/search

Required parameters: placement

Optional parameters: none

Body:

{:dynamicFacetSpec {:mode string}, :labels {}, :searchMode string, :canonicalFilter string, :offset integer, :pageToken string, :facetSpecs [{:facetKey GoogleCloudRetailV2SearchRequestFacetSpecFacetKey, :limit integer, :excludedFilterKeys [string], :enableDynamicPosition boolean}], :filter string, :pageSize integer, :visitorId string, :pageCategories [string], :variantRollupKeys [string], :query string, :branch string, :entity string, :queryExpansionSpec {:condition string, :pinUnexpandedResults boolean}, :boostSpec {:conditionBoostSpecs [GoogleCloudRetailV2SearchRequestBoostSpecConditionBoostSpec], :skipBoostSpecValidation boolean}, :spellCorrectionSpec {:mode string}, :userInfo {:userId string, :ipAddress string, :userAgent string, :directUserRequest boolean}, :orderBy string, :personalizationSpec {:mode string}}

Performs a search. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

locations-catalogs-setDefaultBranch$ clj

(locations-catalogs-setDefaultBranch$ auth parameters body)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/setDefaultBranch

Required parameters: catalog

Optional parameters: none

Body:

{:branchId string, :note string, :force boolean}

Set a specified branch id as default branch. API methods such as SearchService.Search, ProductService.GetProduct, ProductService.ListProducts will treat requests using "default_branch" to the actual branch id set as default. For example, if projects/*/locations/*/catalogs/*/branches/1 is set as default, setting SearchRequest.branch to projects/*/locations/*/catalogs/*/branches/default_branch is equivalent to setting SearchRequest.branch to projects/*/locations/*/catalogs/*/branches/1. Using multiple branches can be useful when developers would like to have a staging branch to test and verify for future usage. When it becomes ready, developers switch on the staging branch using this API while keeping using projects/*/locations/*/catalogs/*/branches/default_branch as SearchRequest.branch to route the traffic to this staging branch. CAUTION: If you have live predict/search traffic, switching the default branch could potentially cause outages if the ID space of the new branch is very different from the old one. More specifically: * PredictionService will only return product IDs from branch {newBranch}. * SearchService will only return product IDs from branch {newBranch} (if branch is not explicitly set). * UserEventService will only join events with products from branch {newBranch}.

locations-catalogs-updateAttributesConfig$ clj

(locations-catalogs-updateAttributesConfig$ auth parameters body)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/updateAttributesConfig

Required parameters: name

Optional parameters: updateMask

Body:

{:name string, :catalogAttributes {}, :attributeConfigLevel string}

Updates the AttributesConfig. The catalog attributes in the request will be updated in the catalog, or inserted if they do not exist. Existing catalog attributes not included in the request will remain unchanged. Attributes that are assigned to products, but do not exist at the catalog level, are always included in the response. The product attribute is assigned default values for missing catalog attribute fields, e.g., searchable and dynamic facetable options.

locations-catalogs-updateCompletionConfig$ clj

(locations-catalogs-updateCompletionConfig$ auth parameters body)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/updateCompletionConfig

Required parameters: name

Optional parameters: updateMask

Body:

{:minPrefixLength integer, :maxSuggestions integer, :name string, :matchingOrder string, :denylistInputConfig {:bigQuerySource GoogleCloudRetailV2BigQuerySource}, :lastSuggestionsImportOperation string, :lastDenylistImportOperation string, :autoLearning boolean, :lastAllowlistImportOperation string, :suggestionsInputConfig {:bigQuerySource GoogleCloudRetailV2BigQuerySource}, :allowlistInputConfig {:bigQuerySource GoogleCloudRetailV2BigQuerySource}}

Updates the CompletionConfigs.

locations-catalogs-userEvents-collect$ clj

(locations-catalogs-userEvents-collect$ auth parameters)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/userEvents/collect

Required parameters: parent

Optional parameters: prebuiltRule, userEvent, uri, ets, rawJson

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 Retail API JavaScript pixel and Google Tag Manager. Users should not call this method directly.

locations-catalogs-userEvents-import$ clj

(locations-catalogs-userEvents-import$ auth parameters body)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/userEvents/import

Required parameters: parent

Optional parameters: none

Body:

{:inputConfig {:userEventInlineSource GoogleCloudRetailV2UserEventInlineSource, :gcsSource GoogleCloudRetailV2GcsSource, :bigQuerySource GoogleCloudRetailV2BigQuerySource}, :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-userEvents-purge$ clj

(locations-catalogs-userEvents-purge$ auth parameters body)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/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-userEvents-rejoin$ clj

(locations-catalogs-userEvents-rejoin$ auth parameters body)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/userEvents/rejoin

Required parameters: parent

Optional parameters: none

Body:

{:userEventRejoinScope string}

Starts a user-event rejoin operation with latest product catalog. Events are not annotated with detailed product information for products that are missing from the catalog when the user event is ingested. These events are stored as unjoined events with limited usage on training and serving. You can use this method to start a join operation on specified events with the latest version of product catalog. You can also use this method to correct events joined with the wrong product catalog. A rejoin operation can take hours or days to complete.

locations-catalogs-userEvents-write$ clj

(locations-catalogs-userEvents-write$ auth parameters body)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/catalogs/userEvents/write

Required parameters: parent

Optional parameters: writeAsync

Body:

{:completionDetail {:completionAttributionToken string, :selectedSuggestion string, :selectedPosition integer}, :eventType string, :cartId string, :pageViewId string, :sessionId string, :offset integer, :productDetails [{:product GoogleCloudRetailV2Product, :quantity integer}], :purchaseTransaction {:id string, :revenue number, :tax number, :cost number, :currencyCode string}, :searchQuery string, :filter string, :visitorId string, :referrerUri string, :pageCategories [string], :eventTime string, :uri string, :attributes {}, :entity string, :attributionToken string, :experimentIds [string], :userInfo {:userId string, :ipAddress string, :userAgent string, :directUserRequest boolean}, :orderBy string}

Writes a single user event.

locations-operations-get$ clj

(locations-operations-get$ auth parameters)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/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-operations-list$ clj

(locations-operations-list$ auth parameters)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/locations/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.

operations-get$ clj

(operations-get$ auth parameters)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/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.

operations-list$ clj

(operations-list$ auth parameters)

https://cloud.google.com/recommendationsapi/reference/rest/v2/projects/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.