Package types

API documentation for retail_v2.types package.

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 AddFulfillmentPlacesRequest. Currently empty because there is no meaningful response populated from the [AddFulfillmentPlaces][] method.

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.

CollectUserEventRequest

Request message for CollectUserEvent method.

ColorInfo

The color information of a Product.

CompleteQueryRequest

Auto-complete parameters.

CompleteQueryResponse

Response of the auto-complete query.

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.

CreateProductRequest

Request message for [CreateProduct][] method.

CustomAttribute

A custom attribute that is not explicitly modeled in 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.

GetProductRequest

Request message for [GetProduct][] method.

Image

Product thumbnail/detail image.

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 will be 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.

ListProductsRequest

Request message for ProductService.ListProducts method.

ListProductsResponse

Response message for ProductService.ListProducts method.

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.

RejoinUserEventsMetadata

Metadata for RejoinUserEvents method.

RejoinUserEventsRequest

Request message for RejoinUserEvents method.

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 method.

SearchResponse

Response message for SearchService.Search method.

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

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.