Classes
AddFulfillmentPlacesMetadata
Metadata related to the progress of the AddFulfillmentPlaces operation. Currently empty because there is no meaningful metadata populated from the [AddFulfillmentPlaces][] method.
AddFulfillmentPlacesRequest
Request message for [AddFulfillmentPlaces][] method.
AddFulfillmentPlacesResponse
Response of the RemoveFulfillmentPlacesRequest. Currently empty because there is no meaningful response populated from the [AddFulfillmentPlaces][] method.
Audience
An intended audience of the [Product][google.cloud.retail.v2.Product] for whom it's sold.
BigQuerySource
BigQuery source import data from.
BranchName
Resource name for the Branch resource.
Catalog
The catalog configuration.
CatalogName
Resource name for the Catalog resource.
CatalogService
Service for managing catalog configuration.
CatalogService.CatalogServiceBase
Base class for server-side implementations of CatalogService
CatalogService.CatalogServiceClient
Client for CatalogService
CatalogServiceClient
CatalogService client wrapper, for convenient use.
CatalogServiceClientBuilder
Builder class for CatalogServiceClient to provide simple configuration of credentials, endpoint etc.
CatalogServiceClientImpl
CatalogService client wrapper implementation, for convenient use.
CatalogServiceSettings
Settings for CatalogServiceClient instances.
CollectUserEventRequest
Request message for CollectUserEvent method.
ColorInfo
The color information of a [Product][google.cloud.retail.v2.Product].
CompleteQueryRequest
Auto-complete parameters.
CompleteQueryResponse
Response of the auto-complete query.
CompleteQueryResponse.Types
Container for nested types declared in the CompleteQueryResponse message type.
CompleteQueryResponse.Types.CompletionResult
Resource that represents completion results.
CompleteQueryResponse.Types.RecentSearchResult
Recent search of this user.
CompletionDataInputConfig
The input config source for completion data.
CompletionDetail
Detailed completion information including completion attribution token and clicked completion info.
CompletionService
Auto-completion service for retail.
This feature is only available for users who have Retail Search enabled. Please submit a form here to contact cloud sales if you are interested in using Retail Search.
CompletionService.CompletionServiceBase
Base class for server-side implementations of CompletionService
CompletionService.CompletionServiceClient
Client for CompletionService
CompletionServiceClient
CompletionService client wrapper, for convenient use.
CompletionServiceClientBuilder
Builder class for CompletionServiceClient to provide simple configuration of credentials, endpoint etc.
CompletionServiceClientImpl
CompletionService client wrapper implementation, for convenient use.
CompletionServiceSettings
Settings for CompletionServiceClient instances.
CreateProductRequest
Request message for [CreateProduct][] method.
CustomAttribute
A custom attribute that is not explicitly modeled in [Product][google.cloud.retail.v2.Product].
DeleteProductRequest
Request message for [DeleteProduct][] method.
FulfillmentInfo
Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods.
GcsSource
Google Cloud Storage location for input content. format.
GetDefaultBranchRequest
Request message to show which branch is currently the default branch.
GetDefaultBranchResponse
Response message of [CatalogService.GetDefaultBranch][google.cloud.retail.v2.CatalogService.GetDefaultBranch].
GetProductRequest
Request message for [GetProduct][] method.
Image
[Product][google.cloud.retail.v2.Product] thumbnail/detail image.
ImportCompletionDataRequest
Request message for ImportCompletionData methods.
ImportCompletionDataResponse
Response of the [ImportCompletionDataRequest][google.cloud.retail.v2.ImportCompletionDataRequest]. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.
ImportErrorsConfig
Configuration of destination for Import related errors.
ImportMetadata
Metadata related to the progress of the Import operation. This will be returned by the google.longrunning.Operation.metadata field.
ImportProductsRequest
Request message for Import methods.
ImportProductsRequest.Types
Container for nested types declared in the ImportProductsRequest message type.
ImportProductsResponse
Response of the [ImportProductsRequest][google.cloud.retail.v2.ImportProductsRequest]. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
ImportUserEventsRequest
Request message for the ImportUserEvents request.
ImportUserEventsResponse
Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
Interval
A floating point interval.
ListCatalogsRequest
Request for [CatalogService.ListCatalogs][google.cloud.retail.v2.CatalogService.ListCatalogs] method.
ListCatalogsResponse
Response for [CatalogService.ListCatalogs][google.cloud.retail.v2.CatalogService.ListCatalogs] method.
ListProductsRequest
Request message for [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts] method.
ListProductsResponse
Response message for [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts] method.
PredictionService
Service for making recommendation prediction.
PredictionService.PredictionServiceBase
Base class for server-side implementations of PredictionService
PredictionService.PredictionServiceClient
Client for PredictionService
PredictionServiceClient
PredictionService client wrapper, for convenient use.
PredictionServiceClientBuilder
Builder class for PredictionServiceClient to provide simple configuration of credentials, endpoint etc.
PredictionServiceClientImpl
PredictionService client wrapper implementation, for convenient use.
PredictionServiceSettings
Settings for PredictionServiceClient instances.
PredictRequest
Request message for Predict method.
PredictResponse
Response message for predict method.
PredictResponse.Types
Container for nested types declared in the PredictResponse message type.
PredictResponse.Types.PredictionResult
PredictionResult represents the recommendation prediction results.
PriceInfo
The price information of a [Product][google.cloud.retail.v2.Product].
PriceInfo.Types
Container for nested types declared in the PriceInfo message type.
PriceInfo.Types.PriceRange
The price range of all [variant][google.cloud.retail.v2.Product.Type.VARIANT] [Product][google.cloud.retail.v2.Product] having the same [Product.primary_product_id][google.cloud.retail.v2.Product.primary_product_id].
Product
Product captures all metadata information of items to be recommended or searched.
Product.Types
Container for nested types declared in the Product message type.
ProductDetail
Detailed product information associated with a user event.
ProductInlineSource
The inline source for the input config for ImportProducts method.
ProductInputConfig
The input config source for products.
ProductLevelConfig
Configures what level the product should be uploaded with regards to how users will be send events and how predictions will be made.
ProductName
Resource name for the Product resource.
ProductService
Service for ingesting [Product][google.cloud.retail.v2.Product] information of the customer's website.
ProductService.ProductServiceBase
Base class for server-side implementations of ProductService
ProductService.ProductServiceClient
Client for ProductService
ProductServiceClient
ProductService client wrapper, for convenient use.
ProductServiceClientBuilder
Builder class for ProductServiceClient to provide simple configuration of credentials, endpoint etc.
ProductServiceClientImpl
ProductService client wrapper implementation, for convenient use.
ProductServiceSettings
Settings for ProductServiceClient instances.
Promotion
Promotion information.
PurchaseTransaction
A transaction represents the entire purchase transaction.
PurgeMetadata
Metadata related to the progress of the Purge operation. This will be returned by the google.longrunning.Operation.metadata field.
PurgeUserEventsRequest
Request message for PurgeUserEvents method.
PurgeUserEventsResponse
Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.
Rating
The rating of a [Product][google.cloud.retail.v2.Product].
RejoinUserEventsMetadata
Metadata for RejoinUserEvents method.
RejoinUserEventsRequest
Request message for RejoinUserEvents method.
RejoinUserEventsRequest.Types
Container for nested types declared in the RejoinUserEventsRequest message type.
RejoinUserEventsResponse
Response message for RejoinUserEvents method.
RemoveFulfillmentPlacesMetadata
Metadata related to the progress of the RemoveFulfillmentPlaces operation. Currently empty because there is no meaningful metadata populated from the [RemoveFulfillmentPlaces][] method.
RemoveFulfillmentPlacesRequest
Request message for [RemoveFulfillmentPlaces][] method.
RemoveFulfillmentPlacesResponse
Response of the RemoveFulfillmentPlacesRequest. Currently empty because there is no meaningful response populated from the [RemoveFulfillmentPlaces][] method.
SearchRequest
Request message for [SearchService.Search][google.cloud.retail.v2.SearchService.Search] method.
SearchRequest.Types
Container for nested types declared in the SearchRequest message type.
SearchRequest.Types.BoostSpec
Boost specification to boost certain items.
SearchRequest.Types.BoostSpec.Types
Container for nested types declared in the BoostSpec message type.
SearchRequest.Types.BoostSpec.Types.ConditionBoostSpec
Boost applies to products which match a condition.
SearchRequest.Types.DynamicFacetSpec
The specifications of dynamically generated facets.
SearchRequest.Types.DynamicFacetSpec.Types
Container for nested types declared in the DynamicFacetSpec message type.
SearchRequest.Types.FacetSpec
A facet specification to perform faceted search.
SearchRequest.Types.FacetSpec.Types
Container for nested types declared in the FacetSpec message type.
SearchRequest.Types.FacetSpec.Types.FacetKey
Specifies how a facet is computed.
SearchRequest.Types.QueryExpansionSpec
Specification to determine under which conditions query expansion should occur.
SearchRequest.Types.QueryExpansionSpec.Types
Container for nested types declared in the QueryExpansionSpec message type.
SearchResponse
Response message for [SearchService.Search][google.cloud.retail.v2.SearchService.Search] method.
SearchResponse.Types
Container for nested types declared in the SearchResponse message type.
SearchResponse.Types.Facet
A facet result.
SearchResponse.Types.Facet.Types
Container for nested types declared in the Facet message type.
SearchResponse.Types.Facet.Types.FacetValue
A facet value which contains value names and their count.
SearchResponse.Types.QueryExpansionInfo
Information describing query expansion including whether expansion has occurred.
SearchResponse.Types.SearchResult
Represents the search results.
SearchService
Service for search.
This feature is only available for users who have Retail Search enabled. Please submit a form here to contact cloud sales if you are interested in using Retail Search.
SearchService.SearchServiceBase
Base class for server-side implementations of SearchService
SearchService.SearchServiceClient
Client for SearchService
SearchServiceClient
SearchService client wrapper, for convenient use.
SearchServiceClientBuilder
Builder class for SearchServiceClient to provide simple configuration of credentials, endpoint etc.
SearchServiceClientImpl
SearchService client wrapper implementation, for convenient use.
SearchServiceSettings
Settings for SearchServiceClient instances.
SetDefaultBranchRequest
Request message to set a specified branch as new default_branch.
SetInventoryMetadata
Metadata related to the progress of the SetInventory operation. Currently empty because there is no meaningful metadata populated from the [SetInventory][] method.
SetInventoryRequest
Request message for [SetInventory][] method.
SetInventoryResponse
Response of the SetInventoryRequest. Currently empty because there is no meaningful response populated from the [SetInventory][] method.
UpdateCatalogRequest
Request for [CatalogService.UpdateCatalog][google.cloud.retail.v2.CatalogService.UpdateCatalog] method.
UpdateProductRequest
Request message for [UpdateProduct][] method.
UserEvent
UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website.
UserEventImportSummary
A summary of import result. The UserEventImportSummary summarizes the import status for user events.
UserEventInlineSource
The inline source for the input config for ImportUserEvents method.
UserEventInputConfig
The input config source for user events.
UserEventService
Service for ingesting end user actions on the customer website.
UserEventService.UserEventServiceBase
Base class for server-side implementations of UserEventService
UserEventService.UserEventServiceClient
Client for UserEventService
UserEventServiceClient
UserEventService client wrapper, for convenient use.
UserEventServiceClientBuilder
Builder class for UserEventServiceClient to provide simple configuration of credentials, endpoint etc.
UserEventServiceClientImpl
UserEventService client wrapper implementation, for convenient use.
UserEventServiceSettings
Settings for UserEventServiceClient instances.
UserInfo
Information of an end user.
WriteUserEventRequest
Request message for WriteUserEvent method.
Enums
BigQuerySource.PartitionOneofCase
Enum of possible cases for the "partition" oneof.
BranchName.ResourceNameType
The possible contents of BranchName.
CatalogName.ResourceNameType
The possible contents of CatalogName.
CompletionDataInputConfig.SourceOneofCase
Enum of possible cases for the "source" oneof.
ImportErrorsConfig.DestinationOneofCase
Enum of possible cases for the "destination" oneof.
ImportProductsRequest.Types.ReconciliationMode
Indicates how imported products are reconciled with the existing products created or imported before.
Interval.MaxOneofCase
Enum of possible cases for the "max" oneof.
Interval.MinOneofCase
Enum of possible cases for the "min" oneof.
Product.ExpirationOneofCase
Enum of possible cases for the "expiration" oneof.
Product.Types.Availability
Product availability. If this field is unspecified, the product is assumed to be in stock.
Product.Types.Type
The type of this product.
ProductInputConfig.SourceOneofCase
Enum of possible cases for the "source" oneof.
ProductName.ResourceNameType
The possible contents of ProductName.
RejoinUserEventsRequest.Types.UserEventRejoinScope
The scope of user events to be rejoined with the latest product catalog. If the rejoining aims at reducing number of unjoined events, set UserEventRejoinScope to UNJOINED_EVENTS. If the rejoining aims at correcting product catalog information in joined events, set UserEventRejoinScope to JOINED_EVENTS. If all events needs to be rejoined, set UserEventRejoinScope to USER_EVENT_REJOIN_SCOPE_UNSPECIFIED.
SearchRequest.Types.DynamicFacetSpec.Types.Mode
Enum to control DynamicFacet mode
SearchRequest.Types.QueryExpansionSpec.Types.Condition
Enum describing under which condition query expansion should occur.
SearchResponse.Types.Facet.Types.FacetValue.FacetValueOneofCase
Enum of possible cases for the "facet_value" oneof.
UserEventInputConfig.SourceOneofCase
Enum of possible cases for the "source" oneof.