API documentation for retail_v2.types package.
Classes
AddCatalogAttributeRequest
Request for CatalogService.AddCatalogAttribute method.
AddControlRequest
Request for AddControl method.
AddFulfillmentPlacesMetadata
Metadata related to the progress of the AddFulfillmentPlaces operation. Currently empty because there is no meaningful metadata populated from the ProductService.AddFulfillmentPlaces method.
AddFulfillmentPlacesRequest
Request message for ProductService.AddFulfillmentPlaces method.
AddFulfillmentPlacesResponse
Response of the AddFulfillmentPlacesRequest. Currently empty because there is no meaningful response populated from the ProductService.AddFulfillmentPlaces method.
AddLocalInventoriesMetadata
Metadata related to the progress of the AddLocalInventories operation. Currently empty because there is no meaningful metadata populated from the ProductService.AddLocalInventories method.
AddLocalInventoriesRequest
Request message for ProductService.AddLocalInventories method.
AddLocalInventoriesResponse
Response of the ProductService.AddLocalInventories API. Currently empty because there is no meaningful response populated from the ProductService.AddLocalInventories method.
AttributeConfigLevel
At which level we offer configuration for attributes.
Values: ATTRIBUTE_CONFIG_LEVEL_UNSPECIFIED (0): Value used when unset. In this case, server behavior defaults to CATALOG_LEVEL_ATTRIBUTE_CONFIG. PRODUCT_LEVEL_ATTRIBUTE_CONFIG (1): At this level, we honor the attribute configurations set in Product.attributes. CATALOG_LEVEL_ATTRIBUTE_CONFIG (2): At this level, we honor the attribute configurations set in [CatalogConfig.attribute_configs][].
AttributesConfig
Catalog level attribute config.
Audience
An intended audience of the Product for whom it's sold.
BigQuerySource
BigQuery source import data from.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Catalog
The catalog configuration.
CatalogAttribute
Catalog level attribute config for an attribute. For example, if customers want to enable/disable facet for a specific attribute.
CollectUserEventRequest
Request message for CollectUserEvent method.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ColorInfo
The color information of a Product.
CompleteQueryRequest
Autocomplete parameters.
CompleteQueryResponse
Response of the autocomplete query.
CompletionConfig
Catalog level autocomplete config for customers to customize autocomplete feature's settings.
CompletionDataInputConfig
The input config source for completion data.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
CompletionDetail
Detailed completion information including completion attribution token and clicked completion info.
Condition
Metadata that is used to define a condition that triggers an action. A valid condition must specify at least one of 'query_terms' or 'products_filter'. If multiple fields are specified, the condition is met if all the fields are satisfied e.g. if a set of query terms and product_filter are set, then only items matching the product_filter for requests with a query matching the query terms wil get boosted.
Control
Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
CreateControlRequest
Request for CreateControl method.
CreateModelMetadata
Metadata associated with a create operation.
CreateModelRequest
Request for creating a model.
CreateProductRequest
Request message for ProductService.CreateProduct method.
CreateServingConfigRequest
Request for CreateServingConfig method.
CustomAttribute
A custom attribute that is not explicitly modeled in Product.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
DeleteControlRequest
Request for DeleteControl method.
DeleteModelRequest
Request for deleting a model.
DeleteProductRequest
Request message for ProductService.DeleteProduct method.
DeleteServingConfigRequest
Request for DeleteServingConfig method.
ExperimentInfo
Metadata for active A/B testing [Experiments][].
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
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.
GetAttributesConfigRequest
Request for CatalogService.GetAttributesConfig method.
GetCompletionConfigRequest
Request for CatalogService.GetCompletionConfig method.
GetControlRequest
Request for GetControl method.
GetDefaultBranchRequest
Request message to show which branch is currently the default branch.
GetDefaultBranchResponse
Response message of CatalogService.GetDefaultBranch.
GetModelRequest
Request for getting a model.
GetProductRequest
Request message for ProductService.GetProduct method.
GetServingConfigRequest
Request for GetServingConfig method.
Image
Product image. Recommendations AI and Retail Search do not use product images to improve prediction and search results. However, product images can be returned in results, and are shown in prediction or search previews in the console.
ImportCompletionDataRequest
Request message for ImportCompletionData methods.
ImportCompletionDataResponse
Response of the 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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ImportMetadata
Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.
ImportProductsRequest
Request message for Import methods.
ImportProductsResponse
Response of the 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.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ListCatalogsRequest
Request for CatalogService.ListCatalogs method.
ListCatalogsResponse
Response for CatalogService.ListCatalogs method.
ListControlsRequest
Request for ListControls method.
ListControlsResponse
Response for ListControls method.
ListModelsRequest
Request for listing models associated with a resource.
ListModelsResponse
Response to a ListModelRequest.
ListProductsRequest
Request message for ProductService.ListProducts method.
ListProductsResponse
Response message for ProductService.ListProducts method.
ListServingConfigsRequest
Request for ListServingConfigs method.
ListServingConfigsResponse
Response for ListServingConfigs method.
LocalInventory
The inventory information at a place (e.g. a store) identified by a place ID.
Model
Metadata that describes the training and serving parameters of a Model. A Model can be associated with a ServingConfig and then queried through the Predict API.
PauseModelRequest
Request for pausing training of a model.
PredictRequest
Request message for Predict method.
PredictResponse
Response message for predict method.
PriceInfo
The price information of a Product.
Product
Product captures all metadata information of items to be recommended or searched.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
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.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ProductLevelConfig
Configures what level the product should be uploaded with regards to how users will be send events and how predictions will be made.
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.
RecommendationsFilteringOption
If filtering for recommendations is enabled.
Values: RECOMMENDATIONS_FILTERING_OPTION_UNSPECIFIED (0): Value used when unset. In this case, server behavior defaults to RECOMMENDATIONS_FILTERING_DISABLED. RECOMMENDATIONS_FILTERING_DISABLED (1): Recommendation filtering is disabled. RECOMMENDATIONS_FILTERING_ENABLED (3): Recommendation filtering is enabled.
RejoinUserEventsMetadata
Metadata for RejoinUserEvents method.
RejoinUserEventsRequest
Request message for RejoinUserEvents method.
RejoinUserEventsResponse
Response message for RejoinUserEvents method.
RemoveCatalogAttributeRequest
Request for CatalogService.RemoveCatalogAttribute method.
RemoveControlRequest
Request for RemoveControl method.
RemoveFulfillmentPlacesMetadata
Metadata related to the progress of the RemoveFulfillmentPlaces operation. Currently empty because there is no meaningful metadata populated from the ProductService.RemoveFulfillmentPlaces method.
RemoveFulfillmentPlacesRequest
Request message for ProductService.RemoveFulfillmentPlaces method.
RemoveFulfillmentPlacesResponse
Response of the RemoveFulfillmentPlacesRequest. Currently empty because there is no meaningful response populated from the ProductService.RemoveFulfillmentPlaces method.
RemoveLocalInventoriesMetadata
Metadata related to the progress of the RemoveLocalInventories operation. Currently empty because there is no meaningful metadata populated from the ProductService.RemoveLocalInventories method.
RemoveLocalInventoriesRequest
Request message for ProductService.RemoveLocalInventories method.
RemoveLocalInventoriesResponse
Response of the ProductService.RemoveLocalInventories API. Currently empty because there is no meaningful response populated from the ProductService.RemoveLocalInventories method.
ReplaceCatalogAttributeRequest
Request for CatalogService.ReplaceCatalogAttribute method.
ResumeModelRequest
Request for resuming training of a model.
Rule
A rule is a condition-action pair
- A condition defines when a rule is to be triggered.
- An action specifies what occurs on that trigger. Currently rules only work for controls with SOLUTION_TYPE_SEARCH.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
SearchRequest
Request message for SearchService.Search method.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
SearchResponse
Response message for SearchService.Search method.
SearchSolutionUseCase
The use case of Cloud Retail Search.
Values: SEARCH_SOLUTION_USE_CASE_UNSPECIFIED (0): The value when it's unspecified. In this case, server behavior defaults to SEARCH_SOLUTION_USE_CASE_SEARCH. SEARCH_SOLUTION_USE_CASE_SEARCH (1): Search use case. Expects the traffic has a non-empty query. SEARCH_SOLUTION_USE_CASE_BROWSE (2): Browse use case. Expects the traffic has an empty query.
ServingConfig
Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions).
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 ProductService.SetInventory method.
SetInventoryRequest
Request message for ProductService.SetInventory method.
SetInventoryResponse
Response of the SetInventoryRequest. Currently empty because there is no meaningful response populated from the ProductService.SetInventory method.
SolutionType
The type of solution.
Values: SOLUTION_TYPE_UNSPECIFIED (0): Default value. SOLUTION_TYPE_RECOMMENDATION (1): Used for Recommendations AI. SOLUTION_TYPE_SEARCH (2): Used for Retail Search.
TuneModelMetadata
Metadata associated with a tune operation.
TuneModelRequest
Request to manually start a tuning process now (instead of waiting for the periodically scheduled tuning to happen).
TuneModelResponse
Response associated with a tune operation.
UpdateAttributesConfigRequest
Request for CatalogService.UpdateAttributesConfig method.
UpdateCatalogRequest
Request for CatalogService.UpdateCatalog method.
UpdateCompletionConfigRequest
Request for CatalogService.UpdateCompletionConfig method.
UpdateControlRequest
Request for UpdateControl method.
UpdateModelRequest
Request for updating an existing model.
UpdateProductRequest
Request message for ProductService.UpdateProduct method.
UpdateServingConfigRequest
Request for UpdateServingConfig 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.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
UserInfo
Information of an end user.
WriteUserEventRequest
Request message for WriteUserEvent method.