retail.v2 library Null safety

Retail API - v2

Cloud Retail 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.

For more information, see cloud.google.com/recommendations

Create an instance of CloudRetailApi to access these resources:

Classes

CloudRetailApi
Cloud Retail 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.
GoogleCloudRetailLoggingErrorContext
A description of the context in which an error occurred.
GoogleCloudRetailLoggingErrorLog
An error log which is reported to the Error Reporting system. [...]
GoogleCloudRetailLoggingHttpRequestContext
HTTP request data that is related to a reported error.
GoogleCloudRetailLoggingImportErrorContext
The error payload that is populated on LRO import APIs. [...]
GoogleCloudRetailLoggingServiceContext
Describes a running service that sends errors.
GoogleCloudRetailLoggingSourceLocation
Indicates a location in the source code of the service for which errors are reported.
GoogleCloudRetailV2AddFulfillmentPlacesRequest
Request message for AddFulfillmentPlaces method.
GoogleCloudRetailV2alphaExportProductsResponse
Response of the ExportProductsRequest. [...]
GoogleCloudRetailV2alphaExportUserEventsResponse
Response of the ExportUserEventsRequest. [...]
GoogleCloudRetailV2alphaImportCompletionDataResponse
Response of the ImportCompletionDataRequest. [...]
GoogleCloudRetailV2alphaImportProductsResponse
Response of the ImportProductsRequest. [...]
GoogleCloudRetailV2alphaImportUserEventsResponse
Response of the ImportUserEventsRequest. [...]
GoogleCloudRetailV2Audience
An intended audience of the Product for whom it's sold.
GoogleCloudRetailV2betaExportProductsResponse
Response of the ExportProductsRequest. [...]
GoogleCloudRetailV2betaExportUserEventsResponse
Response of the ExportUserEventsRequest. [...]
GoogleCloudRetailV2betaImportCompletionDataResponse
Response of the ImportCompletionDataRequest. [...]
GoogleCloudRetailV2betaImportProductsResponse
Response of the ImportProductsRequest. [...]
GoogleCloudRetailV2betaImportUserEventsResponse
Response of the ImportUserEventsRequest. [...]
GoogleCloudRetailV2BigQuerySource
BigQuery source import data from.
GoogleCloudRetailV2Catalog
The catalog configuration.
GoogleCloudRetailV2ColorInfo
The color information of a Product.
GoogleCloudRetailV2CompleteQueryResponse
Response of the auto-complete query.
GoogleCloudRetailV2CompleteQueryResponseCompletionResult
Resource that represents completion results.
GoogleCloudRetailV2CompleteQueryResponseRecentSearchResult
Recent search of this user.
GoogleCloudRetailV2CompletionDataInputConfig
The input config source for completion data.
GoogleCloudRetailV2CompletionDetail
Detailed completion information including completion attribution token and clicked completion info.
GoogleCloudRetailV2CustomAttribute
A custom attribute that is not explicitly modeled in Product.
GoogleCloudRetailV2FulfillmentInfo
Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods.
GoogleCloudRetailV2GcsSource
Google Cloud Storage location for input content. [...]
GoogleCloudRetailV2GetDefaultBranchResponse
Response message of CatalogService.GetDefaultBranch.
GoogleCloudRetailV2Image
Product thumbnail/detail image.
GoogleCloudRetailV2ImportCompletionDataRequest
Request message for ImportCompletionData methods.
GoogleCloudRetailV2ImportCompletionDataResponse
Response of the ImportCompletionDataRequest. [...]
GoogleCloudRetailV2ImportProductsRequest
Request message for Import methods.
GoogleCloudRetailV2ImportProductsResponse
Response of the ImportProductsRequest. [...]
GoogleCloudRetailV2ImportUserEventsRequest
Request message for the ImportUserEvents request.
GoogleCloudRetailV2ImportUserEventsResponse
Response of the ImportUserEventsRequest. [...]
GoogleCloudRetailV2Interval
A floating point interval.
GoogleCloudRetailV2ListCatalogsResponse
Response for CatalogService.ListCatalogs method.
GoogleCloudRetailV2ListProductsResponse
Response message for ProductService.ListProducts method.
GoogleCloudRetailV2PredictRequest
Request message for Predict method.
GoogleCloudRetailV2PredictResponse
Response message for predict method.
GoogleCloudRetailV2PredictResponsePredictionResult
PredictionResult represents the recommendation prediction results.
GoogleCloudRetailV2PriceInfo
The price information of a Product.
GoogleCloudRetailV2PriceInfoPriceRange
The price range of all variant Product having the same Product.primary_product_id.
GoogleCloudRetailV2Product
Product captures all metadata information of items to be recommended or searched.
GoogleCloudRetailV2ProductDetail
Detailed product information associated with a user event.
GoogleCloudRetailV2ProductInlineSource
The inline source for the input config for ImportProducts method.
GoogleCloudRetailV2ProductInputConfig
The input config source for products.
GoogleCloudRetailV2ProductLevelConfig
Configures what level the product should be uploaded with regards to how users will be send events and how predictions will be made.
GoogleCloudRetailV2Promotion
Promotion information.
GoogleCloudRetailV2PurchaseTransaction
A transaction represents the entire purchase transaction.
GoogleCloudRetailV2PurgeUserEventsRequest
Request message for PurgeUserEvents method.
GoogleCloudRetailV2Rating
The rating of a Product.
GoogleCloudRetailV2RejoinUserEventsRequest
Request message for RejoinUserEvents method.
GoogleCloudRetailV2RemoveFulfillmentPlacesRequest
Request message for RemoveFulfillmentPlaces method.
GoogleCloudRetailV2SearchRequest
Request message for SearchService.Search method.
GoogleCloudRetailV2SearchRequestBoostSpec
Boost specification to boost certain items.
GoogleCloudRetailV2SearchRequestBoostSpecConditionBoostSpec
Boost applies to products which match a condition.
GoogleCloudRetailV2SearchRequestDynamicFacetSpec
The specifications of dynamically generated facets.
GoogleCloudRetailV2SearchRequestFacetSpec
A facet specification to perform faceted search.
GoogleCloudRetailV2SearchRequestFacetSpecFacetKey
Specifies how a facet is computed.
GoogleCloudRetailV2SearchRequestQueryExpansionSpec
Specification to determine under which conditions query expansion should occur.
GoogleCloudRetailV2SearchResponse
Response message for SearchService.Search method.
GoogleCloudRetailV2SearchResponseFacet
A facet result.
GoogleCloudRetailV2SearchResponseFacetFacetValue
A facet value which contains value names and their count.
GoogleCloudRetailV2SearchResponseQueryExpansionInfo
Information describing query expansion including whether expansion has occurred.
GoogleCloudRetailV2SearchResponseSearchResult
Represents the search results.
GoogleCloudRetailV2SetDefaultBranchRequest
Request message to set a specified branch as new default_branch.
GoogleCloudRetailV2SetInventoryRequest
Request message for SetInventory method.
GoogleCloudRetailV2UserEvent
UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website.
GoogleCloudRetailV2UserEventInlineSource
The inline source for the input config for ImportUserEvents method.
GoogleCloudRetailV2UserEventInputConfig
The input config source for user events.
GoogleCloudRetailV2UserInfo
Information of an end user.
GoogleLongrunningListOperationsResponse
The response message for Operations.ListOperations.
GoogleLongrunningOperation
This resource represents a long-running operation that is the result of a network API call.
ProjectsLocationsCatalogsBranchesOperationsResource
ProjectsLocationsCatalogsBranchesProductsResource
ProjectsLocationsCatalogsBranchesResource
ProjectsLocationsCatalogsCompletionDataResource
ProjectsLocationsCatalogsOperationsResource
ProjectsLocationsCatalogsPlacementsResource
ProjectsLocationsCatalogsResource
ProjectsLocationsCatalogsUserEventsResource
ProjectsLocationsOperationsResource
ProjectsLocationsResource
ProjectsResource

Typedefs

GoogleApiHttpBody = $HttpBody
Message that represents an arbitrary HTTP body. [...]
GoogleCloudRetailV2AddFulfillmentPlacesMetadata = $Empty
Metadata related to the progress of the AddFulfillmentPlaces operation. [...]
GoogleCloudRetailV2AddFulfillmentPlacesResponse = $Empty
Response of the RemoveFulfillmentPlacesRequest. [...]
GoogleCloudRetailV2alphaAddFulfillmentPlacesMetadata = $Empty
Metadata related to the progress of the AddFulfillmentPlaces operation. [...]
GoogleCloudRetailV2alphaAddFulfillmentPlacesResponse = $Empty
Response of the RemoveFulfillmentPlacesRequest. [...]
GoogleCloudRetailV2alphaEnrollSolutionMetadata = $Empty
Metadata related to the EnrollSolution method. [...]
GoogleCloudRetailV2alphaExportErrorsConfig = $ExportErrorsConfig
Configuration of destination for Export related errors.
GoogleCloudRetailV2alphaExportMetadata = $ExportMetadata
Metadata related to the progress of the Export operation. [...]
GoogleCloudRetailV2alphaImportErrorsConfig = $ImportErrorsConfig
Configuration of destination for Import related errors.
GoogleCloudRetailV2alphaImportMetadata = $ImportMetadata
Metadata related to the progress of the Import operation. [...]
GoogleCloudRetailV2alphaPurgeMetadata = $Empty
Metadata related to the progress of the Purge operation. [...]
GoogleCloudRetailV2alphaPurgeUserEventsResponse = $PurgeUserEventsResponse
Response of the PurgeUserEventsRequest. [...]
GoogleCloudRetailV2alphaRejoinUserEventsMetadata = $Empty
Metadata for RejoinUserEvents method.
GoogleCloudRetailV2alphaRejoinUserEventsResponse = $RejoinUserEventsResponse
Response message for RejoinUserEvents method.
GoogleCloudRetailV2alphaRemoveFulfillmentPlacesMetadata = $Empty
Metadata related to the progress of the RemoveFulfillmentPlaces operation. [...]
GoogleCloudRetailV2alphaRemoveFulfillmentPlacesResponse = $Empty
Response of the RemoveFulfillmentPlacesRequest. [...]
GoogleCloudRetailV2alphaSetInventoryMetadata = $Empty
Metadata related to the progress of the SetInventory operation. [...]
GoogleCloudRetailV2alphaSetInventoryResponse = $Empty
Response of the SetInventoryRequest. [...]
GoogleCloudRetailV2alphaUserEventImportSummary = $UserEventImportSummary
A summary of import result. [...]
GoogleCloudRetailV2betaAddFulfillmentPlacesMetadata = $Empty
Metadata related to the progress of the AddFulfillmentPlaces operation. [...]
GoogleCloudRetailV2betaAddFulfillmentPlacesResponse = $Empty
Response of the RemoveFulfillmentPlacesRequest. [...]
GoogleCloudRetailV2betaExportErrorsConfig = $ExportErrorsConfig
Configuration of destination for Export related errors.
GoogleCloudRetailV2betaExportMetadata = $ExportMetadata
Metadata related to the progress of the Export operation. [...]
GoogleCloudRetailV2betaImportErrorsConfig = $ImportErrorsConfig
Configuration of destination for Import related errors.
GoogleCloudRetailV2betaImportMetadata = $ImportMetadata
Metadata related to the progress of the Import operation. [...]
GoogleCloudRetailV2betaPurgeMetadata = $Empty
Metadata related to the progress of the Purge operation. [...]
GoogleCloudRetailV2betaPurgeUserEventsResponse = $PurgeUserEventsResponse
Response of the PurgeUserEventsRequest. [...]
GoogleCloudRetailV2betaRejoinUserEventsMetadata = $Empty
Metadata for RejoinUserEvents method.
GoogleCloudRetailV2betaRejoinUserEventsResponse = $RejoinUserEventsResponse
Response message for RejoinUserEvents method.
GoogleCloudRetailV2betaRemoveFulfillmentPlacesMetadata = $Empty
Metadata related to the progress of the RemoveFulfillmentPlaces operation. [...]
GoogleCloudRetailV2betaRemoveFulfillmentPlacesResponse = $Empty
Response of the RemoveFulfillmentPlacesRequest. [...]
GoogleCloudRetailV2betaSetInventoryMetadata = $Empty
Metadata related to the progress of the SetInventory operation. [...]
GoogleCloudRetailV2betaSetInventoryResponse = $Empty
Response of the SetInventoryRequest. [...]
GoogleCloudRetailV2betaUserEventImportSummary = $UserEventImportSummary
A summary of import result. [...]
GoogleCloudRetailV2ImportErrorsConfig = $ImportErrorsConfig
Configuration of destination for Import related errors.
GoogleCloudRetailV2ImportMetadata = $ImportMetadata
Metadata related to the progress of the Import operation. [...]
GoogleCloudRetailV2PurgeMetadata = $Empty
Metadata related to the progress of the Purge operation. [...]
GoogleCloudRetailV2PurgeUserEventsResponse = $PurgeUserEventsResponse
Response of the PurgeUserEventsRequest. [...]
GoogleCloudRetailV2RejoinUserEventsMetadata = $Empty
Metadata for RejoinUserEvents method.
GoogleCloudRetailV2RejoinUserEventsResponse = $RejoinUserEventsResponse
Response message for RejoinUserEvents method.
GoogleCloudRetailV2RemoveFulfillmentPlacesMetadata = $Empty
Metadata related to the progress of the RemoveFulfillmentPlaces operation. [...]
GoogleCloudRetailV2RemoveFulfillmentPlacesResponse = $Empty
Response of the RemoveFulfillmentPlacesRequest. [...]
GoogleCloudRetailV2SetInventoryMetadata = $Empty
Metadata related to the progress of the SetInventory operation. [...]
GoogleCloudRetailV2SetInventoryResponse = $Empty
Response of the SetInventoryRequest. [...]
GoogleCloudRetailV2UserEventImportSummary = $UserEventImportSummary
A summary of import result. [...]
GoogleProtobufEmpty = $Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. [...]
GoogleRpcStatus = $Status
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. [...]
GoogleTypeDate = $Date
Represents a whole or partial calendar date, such as a birthday. [...]

Exceptions / Errors

ApiRequestError
Represents a general error reported by the API endpoint.
DetailedApiRequestError
Represents a specific error reported by the API endpoint.